Form

Create, manipulate and retrieve forms.

GET /plans/[:plan_id]/forms

Fields

Field Description Required
entity_id The form entity_id. NO
description The form description. YES
valid_from The date from the form is valid. YES
valid_to The expiration form validation date. YES
created_at The form creation date. NO

Request

Headers

Header Value
Accept
application/vnd.forms.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.forms.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /plans/[:plan_id]/forms

Fields

Field Description Required
entity_id The form entity_id. NO
description The form description. YES
valid_from The date from the form is valid. YES
valid_to The expiration form validation date. YES
created_at The form creation date. NO

Request

Headers

Header Value
Accept
application/vnd.forms.v1+json
application/hal+json
application/json
Content-Type
application/vnd.forms.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.forms.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /plans/[:plan_id]/forms[/:form_id]

Fields

Field Description Required
entity_id The form entity_id. NO
description The form description. YES
valid_from The date from the form is valid. YES
valid_to The expiration form validation date. YES
created_at The form creation date. NO

Request

Headers

Header Value
Accept
application/vnd.forms.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.forms.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /plans/[:plan_id]/forms[/:form_id]

Fields

Field Description Required
entity_id The form entity_id. NO
description The form description. YES
valid_from The date from the form is valid. YES
valid_to The expiration form validation date. YES
created_at The form creation date. NO

Request

Headers

Header Value
Accept
application/vnd.forms.v1+json
application/hal+json
application/json
Content-Type
application/vnd.forms.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.forms.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PUT /plans/[:plan_id]/forms[/:form_id]

Fields

Field Description Required
entity_id The form entity_id. NO
description The form description. YES
valid_from The date from the form is valid. YES
valid_to The expiration form validation date. YES
created_at The form creation date. NO

Request

Headers

Header Value
Accept
application/vnd.forms.v1+json
application/hal+json
application/json
Content-Type
application/vnd.forms.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.forms.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /plans/[:plan_id]/forms[/:form_id]

Fields

Field Description Required
entity_id The form entity_id. NO
description The form description. YES
valid_from The date from the form is valid. YES
valid_to The expiration form validation date. YES
created_at The form creation date. NO

Request

Headers

Header Value
Accept
application/vnd.forms.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.forms.v1+json
application/hal+json
application/json
Allow Comma-separated list of all HTTP methods allowed