GET v1/Site/AllSites

Retrieves all sites

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Short information about all sites. Known internal error is NotFound.

AllSitesResponse

Name	Description	Type	Additional information
Sites		Collection of SimpleSiteInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "Sites": [
    {
      "SiteId": 1,
      "ExternalId": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "AddressLine1": "sample string 5",
      "Postal": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Latitude": 9.1,
      "Longitude": 10.1,
      "IsLoyaltyEnabled": true,
      "BrowsableState": 12,
      "OrderingState": 13,
      "SupportedOrderModes": 14,
      "IsEnabled": true,
      "LastModifiedTimestamp": "2024-09-28T19:14:23.6379712-05:00",
      "VoicePhone": "sample string 17",
      "StoreIdentifier": 1,
      "IsEmergencyClosed": true,
      "OpenCheckEnabled": true,
      "StartTabEnabled": true,
      "OpenCheckAutoCloseEnabled": true,
      "DineInEnabled": false
    },
    {
      "SiteId": 1,
      "ExternalId": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "AddressLine1": "sample string 5",
      "Postal": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Latitude": 9.1,
      "Longitude": 10.1,
      "IsLoyaltyEnabled": true,
      "BrowsableState": 12,
      "OrderingState": 13,
      "SupportedOrderModes": 14,
      "IsEnabled": true,
      "LastModifiedTimestamp": "2024-09-28T19:14:23.6379712-05:00",
      "VoicePhone": "sample string 17",
      "StoreIdentifier": 1,
      "IsEmergencyClosed": true,
      "OpenCheckEnabled": true,
      "StartTabEnabled": true,
      "OpenCheckAutoCloseEnabled": true,
      "DineInEnabled": false
    }
  ]
}

application/xml, text/xml

Sample:

<AllSitesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Models">
  <Sites>
    <SimpleSiteInfo>
      <AddressLine1>sample string 5</AddressLine1>
      <BrowsableState>12</BrowsableState>
      <City>sample string 7</City>
      <Description>sample string 4</Description>
      <ExternalId>sample string 2</ExternalId>
      <IsEmergencyClosed>true</IsEmergencyClosed>
      <IsEnabled>true</IsEnabled>
      <IsLoyaltyEnabled>true</IsLoyaltyEnabled>
      <LastModifiedTimestamp>2024-09-28T19:14:23.6379712-05:00</LastModifiedTimestamp>
      <Latitude>9.1</Latitude>
      <Longitude>10.1</Longitude>
      <Name>sample string 3</Name>
      <OpenCheckAutoCloseEnabled>true</OpenCheckAutoCloseEnabled>
      <OpenCheckEnabled>true</OpenCheckEnabled>
      <OrderingState>13</OrderingState>
      <Postal>sample string 6</Postal>
      <SiteId>1</SiteId>
      <StartTabEnabled>true</StartTabEnabled>
      <State>sample string 8</State>
      <StoreIdentifier>1</StoreIdentifier>
      <SupportedOrderModes>14</SupportedOrderModes>
      <VoicePhone>sample string 17</VoicePhone>
    </SimpleSiteInfo>
    <SimpleSiteInfo>
      <AddressLine1>sample string 5</AddressLine1>
      <BrowsableState>12</BrowsableState>
      <City>sample string 7</City>
      <Description>sample string 4</Description>
      <ExternalId>sample string 2</ExternalId>
      <IsEmergencyClosed>true</IsEmergencyClosed>
      <IsEnabled>true</IsEnabled>
      <IsLoyaltyEnabled>true</IsLoyaltyEnabled>
      <LastModifiedTimestamp>2024-09-28T19:14:23.6379712-05:00</LastModifiedTimestamp>
      <Latitude>9.1</Latitude>
      <Longitude>10.1</Longitude>
      <Name>sample string 3</Name>
      <OpenCheckAutoCloseEnabled>true</OpenCheckAutoCloseEnabled>
      <OpenCheckEnabled>true</OpenCheckEnabled>
      <OrderingState>13</OrderingState>
      <Postal>sample string 6</Postal>
      <SiteId>1</SiteId>
      <StartTabEnabled>true</StartTabEnabled>
      <State>sample string 8</State>
      <StoreIdentifier>1</StoreIdentifier>
      <SupportedOrderModes>14</SupportedOrderModes>
      <VoicePhone>sample string 17</VoicePhone>
    </SimpleSiteInfo>
  </Sites>
</AllSitesResponse>