GET api/v1/forms

List form

Request Information

URI Parameters

Name	Description	Type	Additional information
Filter	Filter records	ListFormV1Filter	None.
Select	Select columns	Collection of ListFormV1Select	Default value: All Example value: Name, Description Unique items
Sort	Sort records Sort by the first column, then by the second column, and so on	Collection of ListFormV1Sort	Default value: Name Example value: Name Max items: 3 Unique items
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 forms

ListFormV1Response

Name	Description	Type	Additional information
Forms	List of forms	Collection of ListFormV1ResponseForm	None.
Total	Total number of records matching the request	integer (32 bits)	Required Example value: 42 Range: inclusive between 0 and 2147483647

Name

Description

Type

Additional information

Forms

List of forms

Collection of ListFormV1ResponseForm

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:

{
  "Forms": [
    {
      "FormId": "d28cab53-d69b-448c-91e5-5d52fef1a42f",
      "Name": "Time registration",
      "Description": "Time registration form for inspectors",
      "Number": "R5464",
      "BusinessGroupId": "5a34697a-ff33-4fc5-9248-1bde1bfbd77a",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    },
    {
      "FormId": "d28cab53-d69b-448c-91e5-5d52fef1a42f",
      "Name": "Time registration",
      "Description": "Time registration form for inspectors",
      "Number": "R5464",
      "BusinessGroupId": "5a34697a-ff33-4fc5-9248-1bde1bfbd77a",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    }
  ],
  "Total": 42
}