digitaluapi

<back to all web services

SchedulesAdd

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

// @DataContract
public class SchedulesAdd : Codable
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var tenantsId:Int

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var intervalsId:Int

    // @DataMember(Order=4)
    public var runAt:Date?

    // @DataMember(Order=5)
    public var monday:Bool?

    // @DataMember(Order=6)
    public var tuesday:Bool?

    // @DataMember(Order=7)
    public var wednesday:Bool?

    // @DataMember(Order=8)
    public var thursday:Bool?

    // @DataMember(Order=9)
    public var friday:Bool?

    // @DataMember(Order=10)
    public var saturday:Bool?

    // @DataMember(Order=11)
    public var sunday:Bool?

    // @DataMember(Order=12)
    public var dayOfMonth:Int?

    // @DataMember(Order=13)
    public var monthOfYear:Int?

    // @DataMember(Order=14)
    public var startDate:Date

    // @DataMember(Order=15)
    public var endDate:Date

    required public init(){}
}

public class SchedulesAddResponse : Codable
{
    // @DataMember(Order=2)
    public var tenantsId:Int

    // @DataMember(Order=3)
    public var intervalsId:Int

    // @DataMember(Order=4)
    public var runAt:Date?

    // @DataMember(Order=5)
    public var monday:Bool?

    // @DataMember(Order=6)
    public var tuesday:Bool?

    // @DataMember(Order=7)
    public var wednesday:Bool?

    // @DataMember(Order=8)
    public var thursday:Bool?

    // @DataMember(Order=9)
    public var friday:Bool?

    // @DataMember(Order=10)
    public var saturday:Bool?

    // @DataMember(Order=11)
    public var sunday:Bool?

    // @DataMember(Order=12)
    public var dayOfMonth:Int?

    // @DataMember(Order=13)
    public var monthOfYear:Int?

    // @DataMember(Order=14)
    public var startDate:Date

    // @DataMember(Order=15)
    public var endDate:Date

    // @DataMember(Order=16)
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift SchedulesAdd 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.

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

<SchedulesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <TenantsId>0</TenantsId>
  <IntervalsId>0</IntervalsId>
  <RunAt>0001-01-01T00:00:00</RunAt>
  <Monday>false</Monday>
  <Tuesday>false</Tuesday>
  <Wednesday>false</Wednesday>
  <Thursday>false</Thursday>
  <Friday>false</Friday>
  <Saturday>false</Saturday>
  <Sunday>false</Sunday>
  <DayOfMonth>0</DayOfMonth>
  <MonthOfYear>0</MonthOfYear>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <EndDate>0001-01-01T00:00:00</EndDate>
</SchedulesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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