GET api/v1/forms/registrations/data/{formRegistrationId}

List form registration data for registration

Request Information

URI Parameters

NameDescriptionTypeAdditional information
formRegistrationId

form registration Id

universally unique identifier

Required

Select

Select columns

Collection of ListFormRegistrationDataForRegistrationV1Select

Default value: All

Example value: Name, ValueText

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 registration data

ListFormRegistrationDataForRegistrationV1Response
NameDescriptionTypeAdditional information
FormRegistrationDataElements

List of form registration data element

Collection of ListFormRegistrationDataForRegistrationV1ResponseElement

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:
{
  "FormRegistrationDataElements": [
    {
      "FormRegistrationDataElementId": "9cdaf736-d3ac-4426-be8e-4230a96bf1c5",
      "ParentFormRegistrationDataElementId": "ff733e74-244d-4e83-bda7-a6476afd4665",
      "Depth": 0,
      "Index": 0,
      "Order": 0,
      "Kind": "Dictionary",
      "Name": "date",
      "FullName": "image.pins[].data.date",
      "Path": "image.pins[1].data.date",
      "Value": {
        "Text": "John Doe",
        "Boolean": true,
        "Integer": 7,
        "Decimal": 7.5,
        "Date": "2018-12-31T21:59:59.999+00:00",
        "Time": "10675199.02:48:05.4775807",
        "Uuid": "77d0a315-3c8b-4b2b-97e3-5a2038798474"
      }
    },
    {
      "FormRegistrationDataElementId": "9cdaf736-d3ac-4426-be8e-4230a96bf1c5",
      "ParentFormRegistrationDataElementId": "ff733e74-244d-4e83-bda7-a6476afd4665",
      "Depth": 0,
      "Index": 0,
      "Order": 0,
      "Kind": "Dictionary",
      "Name": "date",
      "FullName": "image.pins[].data.date",
      "Path": "image.pins[1].data.date",
      "Value": {
        "Text": "John Doe",
        "Boolean": true,
        "Integer": 7,
        "Decimal": 7.5,
        "Date": "2018-12-31T21:59:59.999+00:00",
        "Time": "10675199.02:48:05.4775807",
        "Uuid": "77d0a315-3c8b-4b2b-97e3-5a2038798474"
      }
    }
  ],
  "Total": 42
}