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
"use strict";
export class SchedulesLookup {
    /** @param {{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} */
    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 SchedulesLookup 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.

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

[
	{
		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,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]