GET api/DataAccess?APIKey={APIKey}&ClientId={ClientId}&FetchXml={FetchXml}&PageNumber={PageNumber}&PageCount={PageCount}&PagingCookie={PagingCookie}

Request Information

URI Parameters

Name	Type	Additional information
APIKey	string	Required
ClientId	string	Required
FetchXml	string	Required
PageNumber	integer	Default value is 1
PageCount	integer	Default value is 250
PagingCookie	string	Default value is

Body Parameters

None.

Response Information

Resource Description

FetchXmlReturn

Name	Type	Additional information
Status	Status	None.
Description	string	None.
PagingCookie	string	None.
MoreRecords	boolean	None.
RecordsCount	integer	None.
Record	Collection of Record	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "Description": "sample string 1",
  "PagingCookie": "sample string 2",
  "MoreRecords": true,
  "RecordsCount": 4,
  "Record": [
    {
      "Attributes": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3",
          "AttributeType": "sample string 4"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3",
          "AttributeType": "sample string 4"
        }
      ]
    },
    {
      "Attributes": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3",
          "AttributeType": "sample string 4"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2",
          "FormattedValue": "sample string 3",
          "AttributeType": "sample string 4"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<FetchXmlReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Core">
  <Description>sample string 1</Description>
  <MoreRecords>true</MoreRecords>
  <PagingCookie>sample string 2</PagingCookie>
  <Record>
    <Record>
      <Attributes>
        <Attributes>
          <AttributeType>sample string 4</AttributeType>
          <FormattedValue>sample string 3</FormattedValue>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </Attributes>
        <Attributes>
          <AttributeType>sample string 4</AttributeType>
          <FormattedValue>sample string 3</FormattedValue>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </Attributes>
      </Attributes>
    </Record>
    <Record>
      <Attributes>
        <Attributes>
          <AttributeType>sample string 4</AttributeType>
          <FormattedValue>sample string 3</FormattedValue>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </Attributes>
        <Attributes>
          <AttributeType>sample string 4</AttributeType>
          <FormattedValue>sample string 3</FormattedValue>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </Attributes>
      </Attributes>
    </Record>
  </Record>
  <RecordsCount>4</RecordsCount>
  <Status>Success</Status>
</FetchXmlReturn>