| GET,OPTIONS | /v1/serviceagreement/planner |
|---|
"use strict";
export class AgreementPlannerRow {
/** @param {{AgreementID?:number,Name?:string,ProjectName?:string,ServiceType?:string,Area?:string,Zip?:string,Frequency?:string,NextDueIso?:string,NextDueLabel?:string,Overdue?:boolean,DurationMin?:number,EligibleDow?:number[],ScheduledDow?:number,WeeklyAll?:boolean,DueThisWeek?:boolean,AssignedCrewID?:number,AssignedCrewName?:string,ThisWeekJobID?:number,ThisWeekBackingJobID?:number,ThisWeekOccIso?:string,ThisWeekStandingIso?:string,StandingDow?:number,Moved?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgreementID;
/** @type {string} */
Name;
/** @type {string} */
ProjectName;
/** @type {string} */
ServiceType;
/** @type {string} */
Area;
/** @type {string} */
Zip;
/** @type {string} */
Frequency;
/** @type {string} */
NextDueIso;
/** @type {string} */
NextDueLabel;
/** @type {boolean} */
Overdue;
/** @type {number} */
DurationMin;
/** @type {number[]} */
EligibleDow = [];
/** @type {number} */
ScheduledDow;
/** @type {boolean} */
WeeklyAll;
/** @type {boolean} */
DueThisWeek;
/** @type {?number} */
AssignedCrewID;
/** @type {string} */
AssignedCrewName;
/** @type {?number} */
ThisWeekJobID;
/** @type {?number} */
ThisWeekBackingJobID;
/** @type {string} */
ThisWeekOccIso;
/** @type {string} */
ThisWeekStandingIso;
/** @type {?number} */
StandingDow;
/** @type {boolean} */
Moved;
}
export class AgreementPlannerCrew {
/** @param {{CrewID?:number,CrewName?:string,CrewColor?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CrewID;
/** @type {string} */
CrewName;
/** @type {string} */
CrewColor;
}
export class AgreementPlannerResponse {
/** @param {{ResponseStatus?:ResponseStatus,FromIso?:string,ToIso?:string,WeekdayCapacity?:number,Rows?:AgreementPlannerRow[],Crews?:AgreementPlannerCrew[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {string} */
FromIso;
/** @type {string} */
ToIso;
/** @type {number} */
WeekdayCapacity;
/** @type {AgreementPlannerRow[]} */
Rows = [];
/** @type {AgreementPlannerCrew[]} */
Crews = [];
}
export class AgreementPlannerRequest {
/** @param {{From?:string,Scope?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
From;
/** @type {string} */
Scope;
}
JavaScript AgreementPlannerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}