Customers
GET /customers
Fields
| Field | Description | Required |
|---|---|---|
| name | YES | |
| location | NO | |
| activity | NO | |
| phone | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.my-company.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /customers
Fields
| Field | Description | Required |
|---|---|---|
| name | YES | |
| location | NO | |
| activity | NO | |
| phone | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.my-company.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /customers[/:id]
Fields
| Field | Description | Required |
|---|---|---|
| name | YES | |
| location | NO | |
| activity | NO | |
| phone | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.my-company.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /customers[/:id]
Fields
| Field | Description | Required |
|---|---|---|
| name | YES | |
| location | NO | |
| activity | NO | |
| phone | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.my-company.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /customers[/:id]
Fields
| Field | Description | Required |
|---|---|---|
| name | YES | |
| location | NO | |
| activity | NO | |
| phone | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.my-company.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /customers[/:id]
Fields
| Field | Description | Required |
|---|---|---|
| name | YES | |
| location | NO | |
| activity | NO | |
| phone | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.my-company.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.my-company.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |