GET v1/Site/SpecialEvents

Get All Special Events for the company

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ResponseOfGetSiteSpecialEvents

Name	Type	Additional information
Verbose	string	None.
Message	string	None.
ErrorCode	integer	None.
Result	GetSiteSpecialEvents	None.

Response Formats

application/json, text/json

Sample:

{
  "Verbose": "sample string 1",
  "Message": "sample string 2",
  "ErrorCode": 3,
  "Result": {
    "SpecialEvents": [
      {
        "SpecialEventId": 1,
        "SpecialEventName": "sample string 2",
        "SpecialEventStartDate": "sample string 3",
        "SpecialEventEndDate": "sample string 4",
        "SpecialEventPurpose": "sample string 5",
        "IsSiteClosed": true,
        "SiteOpeningTime": "sample string 7",
        "SiteClosingTime": "sample string 8",
        "IsSiteClosedForDelivery": true,
        "DeliveryPeriod1StartTime": "sample string 10",
        "DeliveryPeriod1EndTime": "sample string 11",
        "DeliveryPeriod2StartTime": "sample string 12",
        "DeliveryPeriod2EndTime": "sample string 13",
        "IsCompanyWideSpecialEvent": true,
        "Sites": [
          1,
          2
        ]
      },
      {
        "SpecialEventId": 1,
        "SpecialEventName": "sample string 2",
        "SpecialEventStartDate": "sample string 3",
        "SpecialEventEndDate": "sample string 4",
        "SpecialEventPurpose": "sample string 5",
        "IsSiteClosed": true,
        "SiteOpeningTime": "sample string 7",
        "SiteClosingTime": "sample string 8",
        "IsSiteClosedForDelivery": true,
        "DeliveryPeriod1StartTime": "sample string 10",
        "DeliveryPeriod1EndTime": "sample string 11",
        "DeliveryPeriod2StartTime": "sample string 12",
        "DeliveryPeriod2EndTime": "sample string 13",
        "IsCompanyWideSpecialEvent": true,
        "Sites": [
          1,
          2
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfGetSiteSpecialEventsmHMPg1WY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Models">
  <ErrorCode>3</ErrorCode>
  <Message>sample string 2</Message>
  <Result>
    <SpecialEvents>
      <GetSpecialEvent>
        <DeliveryPeriod1EndTime>sample string 11</DeliveryPeriod1EndTime>
        <DeliveryPeriod1StartTime>sample string 10</DeliveryPeriod1StartTime>
        <DeliveryPeriod2EndTime>sample string 13</DeliveryPeriod2EndTime>
        <DeliveryPeriod2StartTime>sample string 12</DeliveryPeriod2StartTime>
        <IsCompanyWideSpecialEvent>true</IsCompanyWideSpecialEvent>
        <IsSiteClosed>true</IsSiteClosed>
        <IsSiteClosedForDelivery>true</IsSiteClosedForDelivery>
        <SiteClosingTime>sample string 8</SiteClosingTime>
        <SiteOpeningTime>sample string 7</SiteOpeningTime>
        <Sites xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </Sites>
        <SpecialEventEndDate>sample string 4</SpecialEventEndDate>
        <SpecialEventId>1</SpecialEventId>
        <SpecialEventName>sample string 2</SpecialEventName>
        <SpecialEventPurpose>sample string 5</SpecialEventPurpose>
        <SpecialEventStartDate>sample string 3</SpecialEventStartDate>
      </GetSpecialEvent>
      <GetSpecialEvent>
        <DeliveryPeriod1EndTime>sample string 11</DeliveryPeriod1EndTime>
        <DeliveryPeriod1StartTime>sample string 10</DeliveryPeriod1StartTime>
        <DeliveryPeriod2EndTime>sample string 13</DeliveryPeriod2EndTime>
        <DeliveryPeriod2StartTime>sample string 12</DeliveryPeriod2StartTime>
        <IsCompanyWideSpecialEvent>true</IsCompanyWideSpecialEvent>
        <IsSiteClosed>true</IsSiteClosed>
        <IsSiteClosedForDelivery>true</IsSiteClosedForDelivery>
        <SiteClosingTime>sample string 8</SiteClosingTime>
        <SiteOpeningTime>sample string 7</SiteOpeningTime>
        <Sites xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </Sites>
        <SpecialEventEndDate>sample string 4</SpecialEventEndDate>
        <SpecialEventId>1</SpecialEventId>
        <SpecialEventName>sample string 2</SpecialEventName>
        <SpecialEventPurpose>sample string 5</SpecialEventPurpose>
        <SpecialEventStartDate>sample string 3</SpecialEventStartDate>
      </GetSpecialEvent>
    </SpecialEvents>
  </Result>
  <Verbose>sample string 1</Verbose>
</ResponseOfGetSiteSpecialEventsmHMPg1WY>