DataRequest Specification (GET)

DataRequest Specification (GET)


GET json/DataRequest/Specification/{serviceName}?serviceVersion={serviceVersion}

This returns the specifications of the provided services

The authentication of this JSON API is based on a standard HMAC Authentication implementation.

Request information

URI Parameters

Name Type Description
serviceName string Required
serviceVersion integer None.

Body Parameters

None.

Response information

DataRequestSpecificationResponseServiceDescription

Name Type Description
Name string None.
Version integer None.
Description string None.
Actions Collection of DataRequestSpecificationResponseActionDescription None.

Response formats

{
  "Actions": [
    {
      "Name": "sample string 1",
      "Type": 0,
      "Default": true,
      "Description": "sample string 3",
      "RequestParameters": [
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        },
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        }
      ],
      "ResponseParameters": [
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        },
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Type": 0,
      "Default": true,
      "Description": "sample string 3",
      "RequestParameters": [
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        },
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        }
      ],
      "ResponseParameters": [
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        },
        {
          "ListItemDescriptions": [
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            },
            {
              "Value": "sample string 1",
              "Description": "sample string 1",
              "GroupName": "sample string 2"
            }
          ],
          "isRequestParameter": true,
          "Name": "sample string 1",
          "DataType": 0,
          "MaxLength": 2,
          "MaxOccurs": 3,
          "Required": true,
          "Global": true,
          "Group": "sample string 6",
          "Description": "sample string 7",
          "ExplanationHTML": "sample string 8",
          "DisplayName": "sample string 9",
          "InputPattern": "sample string 10",
          "AutoCompleteType": "sample string 11"
        }
      ]
    }
  ],
  "Name": "sample string 1",
  "Version": 2,
  "Description": "sample string 3"
}

Was this article helpful?

What's Next