POST api/v1/forms/instructions/{FormId}/instructions

Create form instruction

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FormId

Form id

universally unique identifier

Required

Body Parameters

request

CreateFormInstructionV1Request
NameDescriptionTypeAdditional information
Message

Message

string

Example value: Please complete the order

Max length: 250

InformationDate

Information date

date

Example value: 12/31/2018 23:59:59 +02:00

FormData

Form data

string

None.

PublishDate

Publish date

date

Required

Example value: 12/31/2018 23:59:59 +02:00

AppUserIds

Recipients Value has to be a user id

Collection of universally unique identifier

Required

Min items: 1

Request Formats

application/json

Sample:
{
  "Message": "Please complete the order",
  "InformationDate": "2018-12-31T21:59:59.999+00:00",
  "FormData": "Test Data",
  "PublishDate": "2018-12-31T21:59:59.999+00:00",
  "AppUserIds": [
    "4b663902-8b23-47fe-bedc-4a5d4a669401",
    "4b663902-8b23-47fe-bedc-4a5d4a669502"
  ]
}

Response Information

Resource Description

Create form instruction

CreateFormInstructionV1Response
NameDescriptionTypeAdditional information
FormInstructionId

Form instruction id

universally unique identifier

Required

Example value: 4b663902-8b23-47fe-bedc-4a5d4a669401

Max length: 50

Location

Location of created form instruction

URI

Required

Data type: Url

Example value: https://localhost/api/v1/forms/instructions/B123A61D-27CC-469B-92A4-4248B583D641

Response Formats

application/json

Sample:
{
  "FormInstructionId": "4b663902-8b23-47fe-bedc-4a5d4a669401",
  "Location": "https://localhost/api/v1/forms/instructions/B123A61D-27CC-469B-92A4-4248B583D641"
}