GET api/sites

Get details about a company's' sites.

Required Scopes

ReferenceData.System

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A site object.

Collection of SiteDetails

Name	Type	Additional information
SiteId	string	None.
SiteName	string	None.
ExternalType	string	None.
Status	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
AddressLine4	string	None.
AddressLine5	string	None.
Postcode	string	None.
Telephone	string	None.
Fax	string	None.
SiteOptions	Collection of SiteOption	None.

[
  {
    "SiteId": "sample string 1",
    "SiteName": "sample string 2",
    "ExternalType": "sample string 3",
    "Status": "sample string 4",
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "AddressLine3": "sample string 7",
    "AddressLine4": "sample string 8",
    "AddressLine5": "sample string 9",
    "Postcode": "sample string 10",
    "Telephone": "sample string 11",
    "Fax": "sample string 12",
    "SiteOptions": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  {
    "SiteId": "sample string 1",
    "SiteName": "sample string 2",
    "ExternalType": "sample string 3",
    "Status": "sample string 4",
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "AddressLine3": "sample string 7",
    "AddressLine4": "sample string 8",
    "AddressLine5": "sample string 9",
    "Postcode": "sample string 10",
    "Telephone": "sample string 11",
    "Fax": "sample string 12",
    "SiteOptions": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
]

<ArrayOfSiteDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models">
  <SiteDetails>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <AddressLine3>sample string 7</AddressLine3>
    <AddressLine4>sample string 8</AddressLine4>
    <AddressLine5>sample string 9</AddressLine5>
    <ExternalType>sample string 3</ExternalType>
    <Fax>sample string 12</Fax>
    <Postcode>sample string 10</Postcode>
    <SiteId>sample string 1</SiteId>
    <SiteName>sample string 2</SiteName>
    <SiteOptions>
      <SiteOption>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </SiteOption>
      <SiteOption>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </SiteOption>
    </SiteOptions>
    <Status>sample string 4</Status>
    <Telephone>sample string 11</Telephone>
  </SiteDetails>
  <SiteDetails>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <AddressLine3>sample string 7</AddressLine3>
    <AddressLine4>sample string 8</AddressLine4>
    <AddressLine5>sample string 9</AddressLine5>
    <ExternalType>sample string 3</ExternalType>
    <Fax>sample string 12</Fax>
    <Postcode>sample string 10</Postcode>
    <SiteId>sample string 1</SiteId>
    <SiteName>sample string 2</SiteName>
    <SiteOptions>
      <SiteOption>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </SiteOption>
      <SiteOption>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </SiteOption>
    </SiteOptions>
    <Status>sample string 4</Status>
    <Telephone>sample string 11</Telephone>
  </SiteDetails>
</ArrayOfSiteDetails>