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}
SchedulesEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathlongYes
TenantsIdbodyintYes
IntervalsIdbodyintYes
RunAtbodyDateTime?No
Mondaybodybool?No
Tuesdaybodybool?No
Wednesdaybodybool?No
Thursdaybodybool?No
Fridaybodybool?No
Saturdaybodybool?No
Sundaybodybool?No
DayOfMonthbodyint?No
MonthOfYearbodyint?No
StartDatebodyDateTimeNo
EndDatebodyDateTimeNo
SchedulesEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TenantsIdformintNo
IntervalsIdformintNo
RunAtformDateTime?No
Mondayformbool?No
Tuesdayformbool?No
Wednesdayformbool?No
Thursdayformbool?No
Fridayformbool?No
Saturdayformbool?No
Sundayformbool?No
DayOfMonthformint?No
MonthOfYearformint?No
StartDateformDateTimeNo
EndDateformDateTimeNo
ResponseStatusformResponseStatusNo

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