digitaluapi

<back to all web services

SchedulesEdit

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

// @DataContract
public class SchedulesEdit : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var id:Int

    // @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 SchedulesEditResponse : Codable
{
    // @DataMember(Order=1)
    public var id:Int

    // @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 SchedulesEdit DTOs

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

HTTP + JSV

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

PUT /schedules/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	TenantsId: 0,
	IntervalsId: 0,
	RunAt: 0001-01-01,
	Monday: False,
	Tuesday: False,
	Wednesday: False,
	Thursday: False,
	Friday: False,
	Saturday: False,
	Sunday: False,
	DayOfMonth: 0,
	MonthOfYear: 0,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	TenantsId: 0,
	IntervalsId: 0,
	RunAt: 0001-01-01,
	Monday: False,
	Tuesday: False,
	Wednesday: False,
	Thursday: False,
	Friday: False,
	Saturday: False,
	Sunday: False,
	DayOfMonth: 0,
	MonthOfYear: 0,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}