Trendsic Platform Service

<back to all web services

AgreementPlannerRequest

"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

GET /v1/serviceagreement/planner HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementPlannerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Crews>
    <AgreementPlannerCrew>
      <CrewColor>String</CrewColor>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
    </AgreementPlannerCrew>
  </Crews>
  <FromIso>String</FromIso>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Rows>
    <AgreementPlannerRow>
      <AgreementID>0</AgreementID>
      <Area>String</Area>
      <AssignedCrewID>0</AssignedCrewID>
      <AssignedCrewName>String</AssignedCrewName>
      <DueThisWeek>false</DueThisWeek>
      <DurationMin>0</DurationMin>
      <EligibleDow xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </EligibleDow>
      <Frequency>String</Frequency>
      <Moved>false</Moved>
      <Name>String</Name>
      <NextDueIso>String</NextDueIso>
      <NextDueLabel>String</NextDueLabel>
      <Overdue>false</Overdue>
      <ProjectName>String</ProjectName>
      <ScheduledDow>0</ScheduledDow>
      <ServiceType>String</ServiceType>
      <StandingDow>0</StandingDow>
      <ThisWeekBackingJobID>0</ThisWeekBackingJobID>
      <ThisWeekJobID>0</ThisWeekJobID>
      <ThisWeekOccIso>String</ThisWeekOccIso>
      <ThisWeekStandingIso>String</ThisWeekStandingIso>
      <WeeklyAll>false</WeeklyAll>
      <Zip>String</Zip>
    </AgreementPlannerRow>
  </Rows>
  <ToIso>String</ToIso>
  <WeekdayCapacity>0</WeekdayCapacity>
</AgreementPlannerResponse>