Department
Create, manipulate and retrieve departments
GET /plans/[:plan_id]/departments
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The department entity ID. | NO |
| code | The department code. | YES |
| default_description | The department description in English. | YES |
| alter_description | The department description in Spanish. | NO |
| created_at | The department creation date. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.departments.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.departments.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /plans/[:plan_id]/departments
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The department entity ID. | NO |
| code | The department code. | YES |
| default_description | The department description in English. | YES |
| alter_description | The department description in Spanish. | NO |
| created_at | The department creation date. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.departments.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.departments.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.departments.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /plans/[:plan_id]/departments[/:department_id]
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The department entity ID. | NO |
| code | The department code. | YES |
| default_description | The department description in English. | YES |
| alter_description | The department description in Spanish. | NO |
| created_at | The department creation date. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.departments.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.departments.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /plans/[:plan_id]/departments[/:department_id]
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The department entity ID. | NO |
| code | The department code. | YES |
| default_description | The department description in English. | YES |
| alter_description | The department description in Spanish. | NO |
| created_at | The department creation date. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.departments.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.departments.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.departments.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /plans/[:plan_id]/departments[/:department_id]
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The department entity ID. | NO |
| code | The department code. | YES |
| default_description | The department description in English. | YES |
| alter_description | The department description in Spanish. | NO |
| created_at | The department creation date. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.departments.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.departments.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.departments.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /plans/[:plan_id]/departments[/:department_id]
Fields
| Field | Description | Required |
|---|---|---|
| entity_id | The department entity ID. | NO |
| code | The department code. | YES |
| default_description | The department description in English. | YES |
| alter_description | The department description in Spanish. | NO |
| created_at | The department creation date. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.departments.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.departments.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |