Customer service

This is the description of the service to individual customer resources

Methods:

GET
/customers/{id}

Get one 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
Field name Value

Responses:

200 - Successful execution

Headers:
Field name Value
Content-Type application/json
Cookies: Not Defined
Field name Value

Test Cases:

Get Customer
/customers/1

Successfully retrieves one 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
Field name Value

Response:

Headers:
Field name Value
Content-Type application/json
Cookies: Not Defined
Field name Value
DELETE
/customers/{id}

Delete a customer

Request:

Parameters:
Parameter kind type default required summary
id QUERY number 1 true

The id of the customer record to be deleted
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
Field name Value

Responses:

200 - Successful execution

Headers:
Field name Value
Content-Type application/json
Cookies: Not Defined
Field name Value

Test Cases:

Delete Customer
/customers/1

Successfully delete the 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
Field name Value

Response:

Headers:
Field name Value
Content-Type application/json
Cookies: Not Defined
Field name Value
PUT
/customers/{id}

Update a customer

Request:

Parameters:
Parameter kind type default required summary
id QUERY number 1 true

The id of the customer record to be updated
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
Field name Value

Responses:

200 - Successful execution

mock body: putCustomer-responseBody.json

Headers:
Field name Value
Content-Type application/json
Cookies: Not Defined
Field name Value

Test Cases:

Update Customer
/customers/1

Succesfully updates a 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
Field name Value

Response:

Validation schema: putCustomer-responseBody-validationSchema.json

Headers:
Field name Value
Content-Type application/json
Cookies: Not Defined
Field name Value