digitaluapi

<back to all web services

SchedulesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/schedules
SchedulesAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodyintYes
IntervalsIdbodyintYes
RunAtbodyDateTime?No
Mondaybodybool?No
Tuesdaybodybool?No
Wednesdaybodybool?No
Thursdaybodybool?No
Fridaybodybool?No
Saturdaybodybool?No
Sundaybodybool?No
DayOfMonthbodyint?No
MonthOfYearbodyint?No
StartDatebodyDateTimeNo
EndDatebodyDateTimeNo
SchedulesAddResponse Parameters:
NameParameterData TypeRequiredDescription
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 .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.

POST /schedules HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
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,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01
}
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,
	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
		}
	}
}