DC_OnDemandReport


Click here for a complete list of operations.

GetCalendarDetails

Get Calendar Details List

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
Calendar:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /web1244/services/DC_OnDemandReport.asmx HTTP/1.1
Host: dc01.rmdatacentral.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://restaurantmagic.com/services/GetCalendarDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="http://restaurantmagic.com/services">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
    <AuthenticationKey xmlns="http://restaurantmagic.com/services">
      <IntegrationKey>string</IntegrationKey>
    </AuthenticationKey>
  </soap:Header>
  <soap:Body>
    <GetCalendarDetails xmlns="http://restaurantmagic.com/services">
      <Calendar>string</Calendar>
    </GetCalendarDetails>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCalendarDetailsResponse xmlns="http://restaurantmagic.com/services">
      <GetCalendarDetailsResult>
        <TCalendarDetail>
          <NewFiscalYearStart>boolean</NewFiscalYearStart>
          <FiscalYear>int</FiscalYear>
          <NewPeriodStart>boolean</NewPeriodStart>
          <PeriodName>string</PeriodName>
          <PeriodNumber>int</PeriodNumber>
          <SubPeriodName>string</SubPeriodName>
          <SubPeriodNumber>int</SubPeriodNumber>
          <SubPeriodStart>dateTime</SubPeriodStart>
          <SubPeriodEnd>dateTime</SubPeriodEnd>
        </TCalendarDetail>
        <TCalendarDetail>
          <NewFiscalYearStart>boolean</NewFiscalYearStart>
          <FiscalYear>int</FiscalYear>
          <NewPeriodStart>boolean</NewPeriodStart>
          <PeriodName>string</PeriodName>
          <PeriodNumber>int</PeriodNumber>
          <SubPeriodName>string</SubPeriodName>
          <SubPeriodNumber>int</SubPeriodNumber>
          <SubPeriodStart>dateTime</SubPeriodStart>
          <SubPeriodEnd>dateTime</SubPeriodEnd>
        </TCalendarDetail>
      </GetCalendarDetailsResult>
    </GetCalendarDetailsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /web1244/services/DC_OnDemandReport.asmx HTTP/1.1
Host: dc01.rmdatacentral.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthenticationHeader xmlns="http://restaurantmagic.com/services">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
    <AuthenticationKey xmlns="http://restaurantmagic.com/services">
      <IntegrationKey>string</IntegrationKey>
    </AuthenticationKey>
  </soap12:Header>
  <soap12:Body>
    <GetCalendarDetails xmlns="http://restaurantmagic.com/services">
      <Calendar>string</Calendar>
    </GetCalendarDetails>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCalendarDetailsResponse xmlns="http://restaurantmagic.com/services">
      <GetCalendarDetailsResult>
        <TCalendarDetail>
          <NewFiscalYearStart>boolean</NewFiscalYearStart>
          <FiscalYear>int</FiscalYear>
          <NewPeriodStart>boolean</NewPeriodStart>
          <PeriodName>string</PeriodName>
          <PeriodNumber>int</PeriodNumber>
          <SubPeriodName>string</SubPeriodName>
          <SubPeriodNumber>int</SubPeriodNumber>
          <SubPeriodStart>dateTime</SubPeriodStart>
          <SubPeriodEnd>dateTime</SubPeriodEnd>
        </TCalendarDetail>
        <TCalendarDetail>
          <NewFiscalYearStart>boolean</NewFiscalYearStart>
          <FiscalYear>int</FiscalYear>
          <NewPeriodStart>boolean</NewPeriodStart>
          <PeriodName>string</PeriodName>
          <PeriodNumber>int</PeriodNumber>
          <SubPeriodName>string</SubPeriodName>
          <SubPeriodNumber>int</SubPeriodNumber>
          <SubPeriodStart>dateTime</SubPeriodStart>
          <SubPeriodEnd>dateTime</SubPeriodEnd>
        </TCalendarDetail>
      </GetCalendarDetailsResult>
    </GetCalendarDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /web1244/services/DC_OnDemandReport.asmx/GetCalendarDetails?Calendar=string HTTP/1.1
Host: dc01.rmdatacentral.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTCalendarDetail xmlns="http://restaurantmagic.com/services">
  <TCalendarDetail>
    <NewFiscalYearStart>boolean</NewFiscalYearStart>
    <FiscalYear>int</FiscalYear>
    <NewPeriodStart>boolean</NewPeriodStart>
    <PeriodName>string</PeriodName>
    <PeriodNumber>int</PeriodNumber>
    <SubPeriodName>string</SubPeriodName>
    <SubPeriodNumber>int</SubPeriodNumber>
    <SubPeriodStart>dateTime</SubPeriodStart>
    <SubPeriodEnd>dateTime</SubPeriodEnd>
  </TCalendarDetail>
  <TCalendarDetail>
    <NewFiscalYearStart>boolean</NewFiscalYearStart>
    <FiscalYear>int</FiscalYear>
    <NewPeriodStart>boolean</NewPeriodStart>
    <PeriodName>string</PeriodName>
    <PeriodNumber>int</PeriodNumber>
    <SubPeriodName>string</SubPeriodName>
    <SubPeriodNumber>int</SubPeriodNumber>
    <SubPeriodStart>dateTime</SubPeriodStart>
    <SubPeriodEnd>dateTime</SubPeriodEnd>
  </TCalendarDetail>
</ArrayOfTCalendarDetail>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /web1244/services/DC_OnDemandReport.asmx/GetCalendarDetails HTTP/1.1
Host: dc01.rmdatacentral.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Calendar=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTCalendarDetail xmlns="http://restaurantmagic.com/services">
  <TCalendarDetail>
    <NewFiscalYearStart>boolean</NewFiscalYearStart>
    <FiscalYear>int</FiscalYear>
    <NewPeriodStart>boolean</NewPeriodStart>
    <PeriodName>string</PeriodName>
    <PeriodNumber>int</PeriodNumber>
    <SubPeriodName>string</SubPeriodName>
    <SubPeriodNumber>int</SubPeriodNumber>
    <SubPeriodStart>dateTime</SubPeriodStart>
    <SubPeriodEnd>dateTime</SubPeriodEnd>
  </TCalendarDetail>
  <TCalendarDetail>
    <NewFiscalYearStart>boolean</NewFiscalYearStart>
    <FiscalYear>int</FiscalYear>
    <NewPeriodStart>boolean</NewPeriodStart>
    <PeriodName>string</PeriodName>
    <PeriodNumber>int</PeriodNumber>
    <SubPeriodName>string</SubPeriodName>
    <SubPeriodNumber>int</SubPeriodNumber>
    <SubPeriodStart>dateTime</SubPeriodStart>
    <SubPeriodEnd>dateTime</SubPeriodEnd>
  </TCalendarDetail>
</ArrayOfTCalendarDetail>