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

Create form instruction

Request Information

URI Parameters

Name	Description	Type	Additional information
FormId	Form id	universally unique identifier	Required

Body Parameters

request

CreateInformAppFormInstructionV1Request

Name	Description	Type	Additional 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	Dictionary of string [key] and Object [value]	None.
PublishDate	Publish date	date	Required Example value: 12/31/2018 23:59:59 +02:00
Recipients	Recipients Value can be an email adres or a user id	Collection of string	Required Min items: 1

Request Formats

application/json

Sample:

{
  "Message": "Please complete the order",
  "InformationDate": "2018-12-31T21:59:59.999+00:00",
  "FormData": {
    "customerId": 4353,
    "customerName": "Customer ABC",
    "order": [
      {
        "productId": 6123,
        "productName": "Product A",
        "quantity": 2
      },
      {
        "productId": 4619,
        "productName": "Product B",
        "quantity": 3
      }
    ]
  },
  "PublishDate": "2018-12-31T21:59:59.999+00:00",
  "Recipients": [
    "58e213fcf1386c37ce86ba1a",
    "example@email"
  ]
}

Response Information

Resource Description

Create form instruction

CreateInformAppFormInstructionV1Response

Name	Description	Type	Additional information
InstructionId	Instruction id	string	Required Example value: 5cbf0039a6feee2523549291 Max length: 100
Recipients	Recipients	Collection of string	None.
Message	Message	string	Example value: Please complete the order
Status	Status	InstructionV1Status	Example value: InProgress
CreationDate	Creation 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
InformationDate	Information date	date	Example value: 12/31/2018 23:59:59 +02:00

Response Formats

application/json

Sample:

{
  "InstructionId": "5cbf0039a6feee2523549291",
  "Recipients": [
    "58e213fcf1386c37ce86ba1a",
    "58e213fcf1563246534fe21b"
  ],
  "Message": "Please complete the order",
  "Status": "InProgress",
  "CreationDate": "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"
}