GET api/v1/informapp/forms/{FormId}/instructions

List form instruction

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FormId

Form id

 universally unique identifier

Required
Filter

Filter records

 ListInformAppFormInstructionV1Filter

None.
Sort

Sort records

 ListInformAppFormInstructionV1Sort

Default value: CreateDateDesc

Example value: CreateDateDesc
PageNumber

Page number

 integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647
PageSize

Number of records per page

 integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of form instructions

ListInformAppFormInstructionV1Response
NameDescriptionTypeAdditional information
Instructions

List of form instructions

 Collection of ListInformAppFormInstructionV1ResponseInstruction

None.
Total

Total number of records matching the request

 integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample: 
{
  "Instructions": [
    {
      "InstructionId": "5cbf0039a6feee2523549291",
      "Message": "Please fill out this report",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "PublishDate": "2018-12-31T21:59:59.999+00:00",
      "InformationDate": "2018-12-31T21:59:59.999+00:00",
      "Status": "Completed",
      "Recipients": [
        "58e213fcf1386c37ce86ba1a",
        "58e213fcf1563246534fe21b"
      ]
    },
    {
      "InstructionId": "5cbf0039a6feee2523549291",
      "Message": "Please fill out this report",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "PublishDate": "2018-12-31T21:59:59.999+00:00",
      "InformationDate": "2018-12-31T21:59:59.999+00:00",
      "Status": "Completed",
      "Recipients": [
        "58e213fcf1386c37ce86ba1a",
        "58e213fcf1563246534fe21b"
      ]
    }
  ],
  "Total": 42
}