Plan
Create, manipulate and retrieve plans
GET /plans
Fields
| Field | Description | Required |
|---|---|---|
| code | The code to be used for the node_id identifier in the web services. | YES |
| name | The name of the plan to be displayed in the plan list view. | YES |
| description | The description of the plan to be shown in the plan list view. | YES |
| icon | The icon URL of the plan to be shown in the plan list view. | YES |
| image | The plan image URL to be shown as header in several views. | YES |
| node_location_id | The plan node location ID. | YES |
| parent_id | The plan parent ID. | NO |
| leaf | It states if the plan is a leaf or no. | YES |
| children | This is just used in the output. The plan children subplans. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.plans.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.plans.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /plans
Fields
| Field | Description | Required |
|---|---|---|
| code | The code to be used for the node_id identifier in the web services. | YES |
| name | The name of the plan to be displayed in the plan list view. | YES |
| description | The description of the plan to be shown in the plan list view. | YES |
| icon | The icon URL of the plan to be shown in the plan list view. | YES |
| image | The plan image URL to be shown as header in several views. | YES |
| node_location_id | The plan node location ID. | YES |
| parent_id | The plan parent ID. | NO |
| leaf | It states if the plan is a leaf or no. | YES |
| children | This is just used in the output. The plan children subplans. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.plans.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.plans.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.plans.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /plans[/:plan_id]
Fields
| Field | Description | Required |
|---|---|---|
| code | The code to be used for the node_id identifier in the web services. | YES |
| name | The name of the plan to be displayed in the plan list view. | YES |
| description | The description of the plan to be shown in the plan list view. | YES |
| icon | The icon URL of the plan to be shown in the plan list view. | YES |
| image | The plan image URL to be shown as header in several views. | YES |
| node_location_id | The plan node location ID. | YES |
| parent_id | The plan parent ID. | NO |
| leaf | It states if the plan is a leaf or no. | YES |
| children | This is just used in the output. The plan children subplans. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.plans.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.plans.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /plans[/:plan_id]
Fields
| Field | Description | Required |
|---|---|---|
| code | The code to be used for the node_id identifier in the web services. | YES |
| name | The name of the plan to be displayed in the plan list view. | YES |
| description | The description of the plan to be shown in the plan list view. | YES |
| icon | The icon URL of the plan to be shown in the plan list view. | YES |
| image | The plan image URL to be shown as header in several views. | YES |
| node_location_id | The plan node location ID. | YES |
| parent_id | The plan parent ID. | NO |
| leaf | It states if the plan is a leaf or no. | YES |
| children | This is just used in the output. The plan children subplans. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.plans.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.plans.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.plans.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /plans[/:plan_id]
Fields
| Field | Description | Required |
|---|---|---|
| code | The code to be used for the node_id identifier in the web services. | YES |
| name | The name of the plan to be displayed in the plan list view. | YES |
| description | The description of the plan to be shown in the plan list view. | YES |
| icon | The icon URL of the plan to be shown in the plan list view. | YES |
| image | The plan image URL to be shown as header in several views. | YES |
| node_location_id | The plan node location ID. | YES |
| parent_id | The plan parent ID. | NO |
| leaf | It states if the plan is a leaf or no. | YES |
| children | This is just used in the output. The plan children subplans. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.plans.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.plans.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.plans.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /plans[/:plan_id]
Fields
| Field | Description | Required |
|---|---|---|
| code | The code to be used for the node_id identifier in the web services. | YES |
| name | The name of the plan to be displayed in the plan list view. | YES |
| description | The description of the plan to be shown in the plan list view. | YES |
| icon | The icon URL of the plan to be shown in the plan list view. | YES |
| image | The plan image URL to be shown as header in several views. | YES |
| node_location_id | The plan node location ID. | YES |
| parent_id | The plan parent ID. | NO |
| leaf | It states if the plan is a leaf or no. | YES |
| children | This is just used in the output. The plan children subplans. | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.plans.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.plans.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |