digitaluapi

<back to all web services

SchedulesLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/schedules

// @DataContract
export class SchedulesLookup
{
    // @DataMember(Order=2)
    public TenantsId: number;

    // @DataMember(Order=3)
    public IntervalsId: number;

    // @DataMember(Order=4)
    public RunAt?: string;

    // @DataMember(Order=5)
    public Monday?: boolean;

    // @DataMember(Order=6)
    public Tuesday?: boolean;

    // @DataMember(Order=7)
    public Wednesday?: boolean;

    // @DataMember(Order=8)
    public Thursday?: boolean;

    // @DataMember(Order=9)
    public Friday?: boolean;

    // @DataMember(Order=10)
    public Saturday?: boolean;

    // @DataMember(Order=11)
    public Sunday?: boolean;

    // @DataMember(Order=12)
    public DayOfMonth?: number;

    // @DataMember(Order=13)
    public MonthOfYear?: number;

    // @DataMember(Order=14)
    public StartDate: string;

    // @DataMember(Order=15)
    public EndDate: string;

    public constructor(init?: Partial<SchedulesLookup>) { (Object as any).assign(this, init); }
}

TypeScript SchedulesLookup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /schedules HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSchedulesLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <SchedulesLookupResponse>
    <DayOfMonth>0</DayOfMonth>
    <Friday>false</Friday>
    <IntervalsId>0</IntervalsId>
    <Monday>false</Monday>
    <MonthOfYear>0</MonthOfYear>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <RunAt>0001-01-01T00:00:00</RunAt>
    <Saturday>false</Saturday>
    <Sunday>false</Sunday>
    <TenantsId>0</TenantsId>
    <Thursday>false</Thursday>
    <Tuesday>false</Tuesday>
    <Wednesday>false</Wednesday>
  </SchedulesLookupResponse>
</ArrayOfSchedulesLookupResponse>