GET api/v1/forms/registrations

List form registration

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Filter

Filter records

ListFormRegistrationV1Filter

None.

Select

Select columns

Collection of ListFormRegistrationV1Select

Default value: All

Example value: SerialNumber, FormId

Unique items

Sort

Sort records Sort by the first column, then by the second column, and so on

Collection of ListFormRegistrationV1Sort

Default value: SerialNumber

Example value: SerialNumber

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 form registrations

ListFormRegistrationV1Response
NameDescriptionTypeAdditional information
FormRegistrations

List of form registrations

Collection of ListFormRegistrationV1ResponseRegistration

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:
{
  "FormRegistrations": [
    {
      "FormRegistrationId": "bd69da16-8cd9-4ca9-8ba3-cbe815227382",
      "FormId": "25715cd4-1f9f-4ac6-bd62-12e592eab3f5",
      "SerialNumber": 16,
      "RegistrationDate": "2018-12-31T21:59:59.999+00:00",
      "CreditCount": 2,
      "SentByUser": "example@email",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    },
    {
      "FormRegistrationId": "bd69da16-8cd9-4ca9-8ba3-cbe815227382",
      "FormId": "25715cd4-1f9f-4ac6-bd62-12e592eab3f5",
      "SerialNumber": 16,
      "RegistrationDate": "2018-12-31T21:59:59.999+00:00",
      "CreditCount": 2,
      "SentByUser": "example@email",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    }
  ],
  "Total": 42
}