Trendsic Platform Service

<back to all web services

AgreementNeedsSetRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/territory/agreementneeds
"use strict";
export class Territory {
    /** @param {{TerritoryID?:number,TerritoryUID?:string,Name?:string,Color?:string,ZipCsv?:string,CrewID?:number,CrewName?:string,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TerritoryID;
    /** @type {string} */
    TerritoryUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Color;
    /** @type {string} */
    ZipCsv;
    /** @type {?number} */
    CrewID;
    /** @type {string} */
    CrewName;
    /** @type {boolean} */
    Active;
}
export class TerritoryPropertyRow {
    /** @param {{TerritoryID?:number,AgreementID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TerritoryID;
    /** @type {number} */
    AgreementID;
}
export class CrewEquipmentRow {
    /** @param {{CrewID?:number,EquipmentID?:number,EquipmentName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CrewID;
    /** @type {number} */
    EquipmentID;
    /** @type {string} */
    EquipmentName;
}
export class AgreementNeedRow {
    /** @param {{AgreementID?:number,EquipmentID?:number,EquipmentName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementID;
    /** @type {number} */
    EquipmentID;
    /** @type {string} */
    EquipmentName;
}
export class TerritoryResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Territories?:Territory[],Properties?:TerritoryPropertyRow[],CrewEquipment?:CrewEquipmentRow[],AgreementNeeds?:AgreementNeedRow[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Territory[]} */
    Territories = [];
    /** @type {TerritoryPropertyRow[]} */
    Properties = [];
    /** @type {CrewEquipmentRow[]} */
    CrewEquipment = [];
    /** @type {AgreementNeedRow[]} */
    AgreementNeeds = [];
}
export class AgreementNeedsSetRequest {
    /** @param {{AgreementID?:number,EquipmentIDs?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementID;
    /** @type {number[]} */
    EquipmentIDs = [];
}

JavaScript AgreementNeedsSetRequest DTOs

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

HTTP + OTHER

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

POST /v1/territory/agreementneeds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AgreementID":0,"EquipmentIDs":[0]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Territories":[{"TerritoryID":0,"TerritoryUID":"String","Name":"String","Color":"String","ZipCsv":"String","CrewID":0,"CrewName":"String","Active":false}],"Properties":[{"TerritoryID":0,"AgreementID":0}],"CrewEquipment":[{"CrewID":0,"EquipmentID":0,"EquipmentName":"String"}],"AgreementNeeds":[{"AgreementID":0,"EquipmentID":0,"EquipmentName":"String"}]}