Trendsic Platform Service

<back to all web services

AgreementPlannerRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/planner
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class AgreementPlannerRequest
{
    open var From:String? = null
    open var Scope:String? = null
}

open class AgreementPlannerResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var FromIso:String? = null
    open var ToIso:String? = null
    open var WeekdayCapacity:Int? = null
    open var Rows:ArrayList<AgreementPlannerRow> = ArrayList<AgreementPlannerRow>()
    open var Crews:ArrayList<AgreementPlannerCrew> = ArrayList<AgreementPlannerCrew>()
}

open class AgreementPlannerRow
{
    open var AgreementID:Int? = null
    open var Name:String? = null
    open var ProjectName:String? = null
    open var ServiceType:String? = null
    open var Area:String? = null
    open var Zip:String? = null
    open var Frequency:String? = null
    open var NextDueIso:String? = null
    open var NextDueLabel:String? = null
    open var Overdue:Boolean? = null
    open var DurationMin:Int? = null
    open var EligibleDow:ArrayList<Int> = ArrayList<Int>()
    open var ScheduledDow:Int? = null
    open var WeeklyAll:Boolean? = null
    open var DueThisWeek:Boolean? = null
    open var AssignedCrewID:Int? = null
    open var AssignedCrewName:String? = null
    open var ThisWeekJobID:Int? = null
    open var ThisWeekBackingJobID:Int? = null
    open var ThisWeekOccIso:String? = null
    open var ThisWeekStandingIso:String? = null
    open var StandingDow:Int? = null
    open var Moved:Boolean? = null
}

open class AgreementPlannerCrew
{
    open var CrewID:Int? = null
    open var CrewName:String? = null
    open var CrewColor:String? = null
}

Kotlin AgreementPlannerRequest 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 /v1/serviceagreement/planner HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	FromIso: String,
	ToIso: String,
	WeekdayCapacity: 0,
	Rows: 
	[
		{
			AgreementID: 0,
			Name: String,
			ProjectName: String,
			ServiceType: String,
			Area: String,
			Zip: String,
			Frequency: String,
			NextDueIso: String,
			NextDueLabel: String,
			Overdue: False,
			DurationMin: 0,
			EligibleDow: 
			[
				0
			],
			ScheduledDow: 0,
			WeeklyAll: False,
			DueThisWeek: False,
			AssignedCrewID: 0,
			AssignedCrewName: String,
			ThisWeekJobID: 0,
			ThisWeekBackingJobID: 0,
			ThisWeekOccIso: String,
			ThisWeekStandingIso: String,
			StandingDow: 0,
			Moved: False
		}
	],
	Crews: 
	[
		{
			CrewID: 0,
			CrewName: String,
			CrewColor: String
		}
	]
}