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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class SchedulesLookup
            <DataMember(Order:=2)>
            Public Overridable Property TenantsId As Integer

            <DataMember(Order:=3)>
            Public Overridable Property IntervalsId As Integer

            <DataMember(Order:=4)>
            Public Overridable Property RunAt As Date?

            <DataMember(Order:=5)>
            Public Overridable Property Monday As Boolean?

            <DataMember(Order:=6)>
            Public Overridable Property Tuesday As Boolean?

            <DataMember(Order:=7)>
            Public Overridable Property Wednesday As Boolean?

            <DataMember(Order:=8)>
            Public Overridable Property Thursday As Boolean?

            <DataMember(Order:=9)>
            Public Overridable Property Friday As Boolean?

            <DataMember(Order:=10)>
            Public Overridable Property Saturday As Boolean?

            <DataMember(Order:=11)>
            Public Overridable Property Sunday As Boolean?

            <DataMember(Order:=12)>
            Public Overridable Property DayOfMonth As Integer?

            <DataMember(Order:=13)>
            Public Overridable Property MonthOfYear As Integer?

            <DataMember(Order:=14)>
            Public Overridable Property StartDate As Date

            <DataMember(Order:=15)>
            Public Overridable Property EndDate As Date
        End Class
    End Namespace
End Namespace

VB.NET 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
			}
		}
	}
]