GET api/v1/forms/instructions/{FormInstructionId}

Get form instruction

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FormInstructionId

App user id

universally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Retrieve a single form instruction

GetFormInstructionV1Response
NameDescriptionTypeAdditional information
FormInstructionId

Form Instruction Id

universally unique identifier

Required

Example value: ee1f7957-3402-45dc-93e4-6689b7e26776

FormId

Form Instruction Id

universally unique identifier

Required

Example value: ee1f7957-3402-45dc-93e4-6689b7e26776

Message

Email

string

Data type: EmailAddress

Example value: Please fill out this report

Max length: 500

FormData

Email

string

Data type: EmailAddress

Example value: Form JSON

CreateDate

Create date

date

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

InformationDate

Information date

date

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

PublishDate

Publish date

date

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

AppUserIds

Form Instruction Users

Collection of universally unique identifier

None.

Response Formats

application/json

Sample:
{
  "FormInstructionId": "ee1f7957-3402-45dc-93e4-6689b7e26776",
  "FormId": "ee1f7957-3402-45dc-93e4-6689b7e26776",
  "Message": "Please fill out this report",
  "FormData": "Form JSON",
  "CreateDate": "2018-12-31T21:59:59.999+00:00",
  "InformationDate": "2018-12-31T21:59:59.999+00:00",
  "PublishDate": "2018-12-31T21:59:59.999+00:00",
  "AppUserIds": [
    "4b663902-8b23-47fe-bedc-4a5d4a669401",
    "4b663902-8b23-47fe-bedc-4a5d4a669502"
  ]
}