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}

export class SchedulesEditResponse
{
    // @DataMember(Order=1)
    public Id: number;

    // @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;

    // @DataMember(Order=16)
    public ResponseStatus: ResponseStatus;

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

// @DataContract
export class SchedulesEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public Id: number;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public TenantsId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    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<SchedulesEdit>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}