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
SchedulesLookup Parameters:
NameParameterData TypeRequiredDescription
TenantsIdqueryintNo
IntervalsIdqueryintNo
RunAtqueryDateTime?No
Mondayquerybool?No
Tuesdayquerybool?No
Wednesdayquerybool?No
Thursdayquerybool?No
Fridayquerybool?No
Saturdayquerybool?No
Sundayquerybool?No
DayOfMonthqueryint?No
MonthOfYearqueryint?No
StartDatequeryDateTimeNo
EndDatequeryDateTimeNo

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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