Trendsic Platform Service

<back to all web services

ProjectLocationRequest

Requires Authentication
The following routes are available for this service:
POST,PUT/v1/projectlocation
GET,DELETE/v1/projectlocation/{ProjectLocationID}
"use strict";
export class ProjectLocationArea {
    /** @param {{ProjectLocationAreaID?:number,ProjectLocationID?:number,Name?:string,Measurement?:number,MeasurementUnit?:string,Notes?:string,DisplayOrder?:number,Active?:boolean,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectLocationAreaID;
    /** @type {number} */
    ProjectLocationID;
    /** @type {string} */
    Name;
    /** @type {?number} */
    Measurement;
    /** @type {string} */
    MeasurementUnit;
    /** @type {string} */
    Notes;
    /** @type {number} */
    DisplayOrder;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class ProjectLocationEquipment {
    /** @param {{ProjectLocationEquipmentID?:number,ProjectLocationID?:number,Name?:string,Description?:string,Manufacturer?:string,Model?:string,SerialNumber?:string,AssetTag?:string,Notes?:string,Active?:boolean,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectLocationEquipmentID;
    /** @type {number} */
    ProjectLocationID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    Manufacturer;
    /** @type {string} */
    Model;
    /** @type {string} */
    SerialNumber;
    /** @type {string} */
    AssetTag;
    /** @type {string} */
    Notes;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class ProjectLocationSiteDetail {
    /** @param {{ProjectLocationSiteDetailID?:number,ProjectLocationID?:number,DetailType?:string,Label?:string,Value?:string,IsSensitive?:boolean,EncVersion?:number,HasValue?:boolean,Notes?:string,DisplayOrder?:number,Active?:boolean,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectLocationSiteDetailID;
    /** @type {number} */
    ProjectLocationID;
    /** @type {string} */
    DetailType;
    /** @type {string} */
    Label;
    /** @type {string} */
    Value;
    /** @type {boolean} */
    IsSensitive;
    /** @type {number} */
    EncVersion;
    /** @type {boolean} */
    HasValue;
    /** @type {string} */
    Notes;
    /** @type {number} */
    DisplayOrder;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class ProjectLocationAttachment {
    /** @param {{ProjectLocationAttachmentID?:number,ProjectLocationID?:number,ProjectLocationAreaID?:number,Kind?:string,DocTitle?:string,FileName?:string,Url?:string,MimeType?:string,UploadDate?:string,UploadedBy?:string,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectLocationAttachmentID;
    /** @type {number} */
    ProjectLocationID;
    /** @type {?number} */
    ProjectLocationAreaID;
    /** @type {string} */
    Kind;
    /** @type {string} */
    DocTitle;
    /** @type {string} */
    FileName;
    /** @type {string} */
    Url;
    /** @type {string} */
    MimeType;
    /** @type {?string} */
    UploadDate;
    /** @type {string} */
    UploadedBy;
    /** @type {boolean} */
    Active;
}
export class ProjectLocation {
    /** @param {{ProjectLocationID?:number,ProjectID?:number,Name?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Latitude?:number,Longitude?:number,TotalArea?:number,AreaUnit?:string,AccessInstructions?:string,IsPrimary?:boolean,DisplayOrder?:number,Active?:boolean,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,Areas?:ProjectLocationArea[],Equipment?:ProjectLocationEquipment[],SiteDetails?:ProjectLocationSiteDetail[],Attachments?:ProjectLocationAttachment[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectLocationID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {?number} */
    Latitude;
    /** @type {?number} */
    Longitude;
    /** @type {?number} */
    TotalArea;
    /** @type {string} */
    AreaUnit;
    /** @type {string} */
    AccessInstructions;
    /** @type {boolean} */
    IsPrimary;
    /** @type {number} */
    DisplayOrder;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {ProjectLocationArea[]} */
    Areas = [];
    /** @type {ProjectLocationEquipment[]} */
    Equipment = [];
    /** @type {ProjectLocationSiteDetail[]} */
    SiteDetails = [];
    /** @type {ProjectLocationAttachment[]} */
    Attachments = [];
}
export class ProjectLocationResponse {
    /** @param {{Locations?:ProjectLocation[],Areas?:ProjectLocationArea[],Equipment?:ProjectLocationEquipment[],SiteDetails?:ProjectLocationSiteDetail[],Attachments?:ProjectLocationAttachment[],SiteDetail?:ProjectLocationSiteDetail,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ProjectLocation[]} */
    Locations = [];
    /** @type {ProjectLocationArea[]} */
    Areas = [];
    /** @type {ProjectLocationEquipment[]} */
    Equipment = [];
    /** @type {ProjectLocationSiteDetail[]} */
    SiteDetails = [];
    /** @type {ProjectLocationAttachment[]} */
    Attachments = [];
    /** @type {ProjectLocationSiteDetail} */
    SiteDetail;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ProjectLocationRequest {
    /** @param {{ProjectLocationID?:number,Locations?:ProjectLocation[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectLocationID;
    /** @type {ProjectLocation[]} */
    Locations = [];
}

JavaScript ProjectLocationRequest 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/projectlocation HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ProjectLocationID":0,"Locations":[{"ProjectLocationID":0,"ProjectID":0,"Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Latitude":0,"Longitude":0,"TotalArea":0,"AreaUnit":"String","AccessInstructions":"String","IsPrimary":false,"DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","Areas":[{"ProjectLocationAreaID":0,"ProjectLocationID":0,"Name":"String","Measurement":0,"MeasurementUnit":"String","Notes":"String","DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Equipment":[{"ProjectLocationEquipmentID":0,"ProjectLocationID":0,"Name":"String","Description":"String","Manufacturer":"String","Model":"String","SerialNumber":"String","AssetTag":"String","Notes":"String","Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"SiteDetails":[{"ProjectLocationSiteDetailID":0,"ProjectLocationID":0,"DetailType":"String","Label":"String","Value":"String","IsSensitive":false,"EncVersion":0,"HasValue":false,"Notes":"String","DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Attachments":[{"ProjectLocationAttachmentID":0,"ProjectLocationID":0,"ProjectLocationAreaID":0,"Kind":"String","DocTitle":"String","FileName":"String","Url":"String","MimeType":"String","UploadDate":"0001-01-01T00:00:00.0000000","UploadedBy":"String","Active":false}]}]}

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

{"Locations":[{"ProjectLocationID":0,"ProjectID":0,"Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Latitude":0,"Longitude":0,"TotalArea":0,"AreaUnit":"String","AccessInstructions":"String","IsPrimary":false,"DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","Areas":[{"ProjectLocationAreaID":0,"ProjectLocationID":0,"Name":"String","Measurement":0,"MeasurementUnit":"String","Notes":"String","DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Equipment":[{"ProjectLocationEquipmentID":0,"ProjectLocationID":0,"Name":"String","Description":"String","Manufacturer":"String","Model":"String","SerialNumber":"String","AssetTag":"String","Notes":"String","Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"SiteDetails":[{"ProjectLocationSiteDetailID":0,"ProjectLocationID":0,"DetailType":"String","Label":"String","Value":"String","IsSensitive":false,"EncVersion":0,"HasValue":false,"Notes":"String","DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Attachments":[{"ProjectLocationAttachmentID":0,"ProjectLocationID":0,"ProjectLocationAreaID":0,"Kind":"String","DocTitle":"String","FileName":"String","Url":"String","MimeType":"String","UploadDate":"0001-01-01T00:00:00.0000000","UploadedBy":"String","Active":false}]}],"Areas":[{"ProjectLocationAreaID":0,"ProjectLocationID":0,"Name":"String","Measurement":0,"MeasurementUnit":"String","Notes":"String","DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Equipment":[{"ProjectLocationEquipmentID":0,"ProjectLocationID":0,"Name":"String","Description":"String","Manufacturer":"String","Model":"String","SerialNumber":"String","AssetTag":"String","Notes":"String","Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"SiteDetails":[{"ProjectLocationSiteDetailID":0,"ProjectLocationID":0,"DetailType":"String","Label":"String","Value":"String","IsSensitive":false,"EncVersion":0,"HasValue":false,"Notes":"String","DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Attachments":[{"ProjectLocationAttachmentID":0,"ProjectLocationID":0,"ProjectLocationAreaID":0,"Kind":"String","DocTitle":"String","FileName":"String","Url":"String","MimeType":"String","UploadDate":"0001-01-01T00:00:00.0000000","UploadedBy":"String","Active":false}],"SiteDetail":{"ProjectLocationSiteDetailID":0,"ProjectLocationID":0,"DetailType":"String","Label":"String","Value":"String","IsSensitive":false,"EncVersion":0,"HasValue":false,"Notes":"String","DisplayOrder":0,"Active":false,"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}