Trendsic Platform Service

<back to all web services

AgreementPrefillRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/project/{ProjectID}/agreement-prefill
"use strict";
export class ServiceAgreement {
    /** @param {{AgreementID?:number,AgreementUID?:string,TenantId?:string,BranchId?:string,BranchName?:string,ProjectID?:number,ProjectName?:string,ProjectLocationID?:number,ProjectLocationName?:string,Name?:string,Status?:string,PricingShape?:string,MonthlyAmount?:number,PerVisitAmount?:number,SkipPolicy?:string,SeasonStartMonth?:number,SeasonStartDay?:number,SeasonEndMonth?:number,SeasonEndDay?:number,RecurrenceFrequency?:string,RecurrenceBy?:string,RecurrenceByValue?:string,RecurrenceInterval?:number,WeeklyDayMode?:string,EffectiveStartDate?:string,EndDate?:string,CompletionAnchored?:boolean,PreferredCrewID?:number,PreferredCrewName?:string,BackingJobID?:number,ExternalRef?:string,EstimatedDurationMinutes?:number,ActualDurationMinutes?:number,CreatedBy?:string,CreatedAt?:string,UpdatedBy?:string,UpdatedAt?:string,NextVisitDate?:string,VisitsThisPeriod?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementID;
    /** @type {string} */
    AgreementUID;
    /** @type {string} */
    TenantId;
    /** @type {string} */
    BranchId;
    /** @type {string} */
    BranchName;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ProjectName;
    /** @type {?number} */
    ProjectLocationID;
    /** @type {string} */
    ProjectLocationName;
    /** @type {string} */
    Name;
    /** @type {string} */
    Status;
    /** @type {string} */
    PricingShape;
    /** @type {?number} */
    MonthlyAmount;
    /** @type {?number} */
    PerVisitAmount;
    /** @type {string} */
    SkipPolicy;
    /** @type {?number} */
    SeasonStartMonth;
    /** @type {?number} */
    SeasonStartDay;
    /** @type {?number} */
    SeasonEndMonth;
    /** @type {?number} */
    SeasonEndDay;
    /** @type {string} */
    RecurrenceFrequency;
    /** @type {string} */
    RecurrenceBy;
    /** @type {string} */
    RecurrenceByValue;
    /** @type {?number} */
    RecurrenceInterval;
    /** @type {string} */
    WeeklyDayMode;
    /** @type {?string} */
    EffectiveStartDate;
    /** @type {?string} */
    EndDate;
    /** @type {?boolean} */
    CompletionAnchored;
    /** @type {?number} */
    PreferredCrewID;
    /** @type {string} */
    PreferredCrewName;
    /** @type {?number} */
    BackingJobID;
    /** @type {string} */
    ExternalRef;
    /** @type {?number} */
    EstimatedDurationMinutes;
    /** @type {?number} */
    ActualDurationMinutes;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {string} */
    UpdatedBy;
    /** @type {?string} */
    UpdatedAt;
    /** @type {?string} */
    NextVisitDate;
    /** @type {number} */
    VisitsThisPeriod;
}
export class ServiceAgreementResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ServiceAgreement?:ServiceAgreement[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ServiceAgreement[]} */
    ServiceAgreement = [];
}
export class AgreementPrefillRequest {
    /** @param {{ProjectID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
}

JavaScript AgreementPrefillRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/project/{ProjectID}/agreement-prefill HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ServiceAgreement":[{"AgreementID":0,"AgreementUID":"00000000000000000000000000000000","TenantId":"00000000000000000000000000000000","BranchId":"00000000000000000000000000000000","BranchName":"String","ProjectID":0,"ProjectName":"String","ProjectLocationID":0,"ProjectLocationName":"String","Name":"String","Status":"String","PricingShape":"String","MonthlyAmount":0,"PerVisitAmount":0,"SkipPolicy":"String","SeasonStartMonth":0,"SeasonStartDay":0,"SeasonEndMonth":0,"SeasonEndDay":0,"RecurrenceFrequency":"String","RecurrenceBy":"String","RecurrenceByValue":"String","RecurrenceInterval":0,"WeeklyDayMode":"String","EffectiveStartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","CompletionAnchored":false,"PreferredCrewID":0,"PreferredCrewName":"String","BackingJobID":0,"ExternalRef":"String","EstimatedDurationMinutes":0,"ActualDurationMinutes":0,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedBy":"String","UpdatedAt":"0001-01-01T00:00:00.0000000","NextVisitDate":"0001-01-01T00:00:00.0000000","VisitsThisPeriod":0}]}