Trendsic Platform Service

<back to all web services

AgreementPlannerRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/planner
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class AgreementPlannerCrew
    {
        public virtual int CrewID { get; set; }
        public virtual string CrewName { get; set; }
        public virtual string CrewColor { get; set; }
    }

    public partial class AgreementPlannerRequest
    {
        public virtual string From { get; set; }
        public virtual string Scope { get; set; }
    }

    public partial class AgreementPlannerResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string FromIso { get; set; }
        public virtual string ToIso { get; set; }
        public virtual int WeekdayCapacity { get; set; }
        public virtual List<AgreementPlannerRow> Rows { get; set; } = [];
        public virtual List<AgreementPlannerCrew> Crews { get; set; } = [];
    }

    public partial class AgreementPlannerRow
    {
        public virtual int AgreementID { get; set; }
        public virtual string Name { get; set; }
        public virtual string ProjectName { get; set; }
        public virtual string ServiceType { get; set; }
        public virtual string Area { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Frequency { get; set; }
        public virtual string NextDueIso { get; set; }
        public virtual string NextDueLabel { get; set; }
        public virtual bool Overdue { get; set; }
        public virtual int DurationMin { get; set; }
        public virtual List<int> EligibleDow { get; set; } = [];
        public virtual int ScheduledDow { get; set; }
        public virtual bool WeeklyAll { get; set; }
        public virtual bool DueThisWeek { get; set; }
        public virtual int? AssignedCrewID { get; set; }
        public virtual string AssignedCrewName { get; set; }
        public virtual int? ThisWeekJobID { get; set; }
        public virtual int? ThisWeekBackingJobID { get; set; }
        public virtual string ThisWeekOccIso { get; set; }
        public virtual string ThisWeekStandingIso { get; set; }
        public virtual int? StandingDow { get; set; }
        public virtual bool Moved { get; set; }
    }

}

C# 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
		}
	]
}