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}
"use strict";
export class SchedulesEditResponse {
    /** @param {{Id?:number,TenantsId?:number,IntervalsId?:number,RunAt?:string,Monday?:boolean,Tuesday?:boolean,Wednesday?:boolean,Thursday?:boolean,Friday?:boolean,Saturday?:boolean,Sunday?:boolean,DayOfMonth?:number,MonthOfYear?:number,StartDate?:string,EndDate?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    IntervalsId;
    /** @type {?string} */
    RunAt;
    /** @type {?boolean} */
    Monday;
    /** @type {?boolean} */
    Tuesday;
    /** @type {?boolean} */
    Wednesday;
    /** @type {?boolean} */
    Thursday;
    /** @type {?boolean} */
    Friday;
    /** @type {?boolean} */
    Saturday;
    /** @type {?boolean} */
    Sunday;
    /** @type {?number} */
    DayOfMonth;
    /** @type {?number} */
    MonthOfYear;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SchedulesEdit {
    /** @param {{Id?:number,TenantsId?:number,IntervalsId?:number,RunAt?:string,Monday?:boolean,Tuesday?:boolean,Wednesday?:boolean,Thursday?:boolean,Friday?:boolean,Saturday?:boolean,Sunday?:boolean,DayOfMonth?:number,MonthOfYear?:number,StartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    IntervalsId;
    /** @type {?string} */
    RunAt;
    /** @type {?boolean} */
    Monday;
    /** @type {?boolean} */
    Tuesday;
    /** @type {?boolean} */
    Wednesday;
    /** @type {?boolean} */
    Thursday;
    /** @type {?boolean} */
    Friday;
    /** @type {?boolean} */
    Saturday;
    /** @type {?boolean} */
    Sunday;
    /** @type {?number} */
    DayOfMonth;
    /** @type {?number} */
    MonthOfYear;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
}

JavaScript SchedulesEdit DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"Id":0,"TenantsId":0,"IntervalsId":0,"RunAt":"0001-01-01T00:00:00.0000000","Monday":false,"Tuesday":false,"Wednesday":false,"Thursday":false,"Friday":false,"Saturday":false,"Sunday":false,"DayOfMonth":0,"MonthOfYear":0,"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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