Customers service
This is the description of the service to customer collection resources
Methods:
List all the customers
Request:
Parameters: Not Defined
| Parameter | kind | type | default | required | summary |
|---|
Headers:
| Field name | Value |
|---|---|
| Accept | text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 |
| Accept-Encoding | gzip, deflate |
Cookies: Not Defined
Responses:
200 - Successful execution
mock body: getCustomers-responseBody.json
Headers:
| Field name | Value |
|---|---|
| Content-Type | application/json |
Cookies: Not Defined
Test Cases:
Get Customers
Successfully retrieves all the customers
Request:
Headers:
| Field name | Value |
|---|---|
| Accept | text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 |
| Accept-Encoding | gzip, deflate |
Cookies: Not Defined
Response:
Validation schema:
getCustomers-responseBody-validationschema.json
Headers:
| Field name | Value |
|---|---|
| Content-Type | application/json |
Cookies: Not Defined
Create a new customer
Request:
Parameters: Not Defined
| Parameter | kind | type | default | required | summary |
|---|
Headers:
| Field name | Value |
|---|---|
| Accept | text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 |
| Accept-Encoding | gzip, deflate |
Cookies: Not Defined
Responses:
200 - Successful execution
mock body: postCustomer-responseBody.json
Headers:
| Field name | Value |
|---|---|
| Content-Type | application/json |
Cookies: Not Defined
Test Cases:
Create Customer
Succesfully creates a new customer
Request:
Headers:
| Field name | Value |
|---|---|
| Accept | text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 |
| Accept-Encoding | gzip, deflate |
Cookies: Not Defined
Response:
Validation schema:
postCustomer-responseBody-validationSchema.json
Headers:
| Field name | Value |
|---|---|
| Content-Type | application/json |