Trendsic Platform Service

<back to all web services

ProjectLocationListRequest

Requires Authentication
The following routes are available for this service:
GET/v1/projectlocation/byproject/{ProjectID}
"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 ProjectLocationListRequest {
    /** @param {{ProjectID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
}

JavaScript ProjectLocationListRequest DTOs

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

HTTP + XML

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

GET /v1/projectlocation/byproject/{ProjectID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectLocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Areas>
    <ProjectLocationArea>
      <Active>false</Active>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DisplayOrder>0</DisplayOrder>
      <Measurement>0</Measurement>
      <MeasurementUnit>String</MeasurementUnit>
      <Name>String</Name>
      <Notes>String</Notes>
      <ProjectLocationAreaID>0</ProjectLocationAreaID>
      <ProjectLocationID>0</ProjectLocationID>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </ProjectLocationArea>
  </Areas>
  <Attachments>
    <ProjectLocationAttachment>
      <Active>false</Active>
      <DocTitle>String</DocTitle>
      <FileName>String</FileName>
      <Kind>String</Kind>
      <MimeType>String</MimeType>
      <ProjectLocationAreaID>0</ProjectLocationAreaID>
      <ProjectLocationAttachmentID>0</ProjectLocationAttachmentID>
      <ProjectLocationID>0</ProjectLocationID>
      <UploadDate>0001-01-01T00:00:00</UploadDate>
      <UploadedBy>String</UploadedBy>
      <Url>String</Url>
    </ProjectLocationAttachment>
  </Attachments>
  <Equipment>
    <ProjectLocationEquipment>
      <Active>false</Active>
      <AssetTag>String</AssetTag>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Description>String</Description>
      <Manufacturer>String</Manufacturer>
      <Model>String</Model>
      <Name>String</Name>
      <Notes>String</Notes>
      <ProjectLocationEquipmentID>0</ProjectLocationEquipmentID>
      <ProjectLocationID>0</ProjectLocationID>
      <SerialNumber>String</SerialNumber>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </ProjectLocationEquipment>
  </Equipment>
  <Locations>
    <ProjectLocation>
      <AccessInstructions>String</AccessInstructions>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <AreaUnit>String</AreaUnit>
      <Areas>
        <ProjectLocationArea>
          <Active>false</Active>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <DisplayOrder>0</DisplayOrder>
          <Measurement>0</Measurement>
          <MeasurementUnit>String</MeasurementUnit>
          <Name>String</Name>
          <Notes>String</Notes>
          <ProjectLocationAreaID>0</ProjectLocationAreaID>
          <ProjectLocationID>0</ProjectLocationID>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
        </ProjectLocationArea>
      </Areas>
      <Attachments>
        <ProjectLocationAttachment>
          <Active>false</Active>
          <DocTitle>String</DocTitle>
          <FileName>String</FileName>
          <Kind>String</Kind>
          <MimeType>String</MimeType>
          <ProjectLocationAreaID>0</ProjectLocationAreaID>
          <ProjectLocationAttachmentID>0</ProjectLocationAttachmentID>
          <ProjectLocationID>0</ProjectLocationID>
          <UploadDate>0001-01-01T00:00:00</UploadDate>
          <UploadedBy>String</UploadedBy>
          <Url>String</Url>
        </ProjectLocationAttachment>
      </Attachments>
      <City>String</City>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DisplayOrder>0</DisplayOrder>
      <Equipment>
        <ProjectLocationEquipment>
          <Active>false</Active>
          <AssetTag>String</AssetTag>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <Description>String</Description>
          <Manufacturer>String</Manufacturer>
          <Model>String</Model>
          <Name>String</Name>
          <Notes>String</Notes>
          <ProjectLocationEquipmentID>0</ProjectLocationEquipmentID>
          <ProjectLocationID>0</ProjectLocationID>
          <SerialNumber>String</SerialNumber>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
        </ProjectLocationEquipment>
      </Equipment>
      <IsPrimary>false</IsPrimary>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <Name>String</Name>
      <ProjectID>0</ProjectID>
      <ProjectLocationID>0</ProjectLocationID>
      <SiteDetails>
        <ProjectLocationSiteDetail>
          <Active>false</Active>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <DetailType>String</DetailType>
          <DisplayOrder>0</DisplayOrder>
          <EncVersion>0</EncVersion>
          <HasValue>false</HasValue>
          <IsSensitive>false</IsSensitive>
          <Label>String</Label>
          <Notes>String</Notes>
          <ProjectLocationID>0</ProjectLocationID>
          <ProjectLocationSiteDetailID>0</ProjectLocationSiteDetailID>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
          <Value>String</Value>
        </ProjectLocationSiteDetail>
      </SiteDetails>
      <State>String</State>
      <TotalArea>0</TotalArea>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <Zip>String</Zip>
    </ProjectLocation>
  </Locations>
  <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>
  <SiteDetail>
    <Active>false</Active>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <DetailType>String</DetailType>
    <DisplayOrder>0</DisplayOrder>
    <EncVersion>0</EncVersion>
    <HasValue>false</HasValue>
    <IsSensitive>false</IsSensitive>
    <Label>String</Label>
    <Notes>String</Notes>
    <ProjectLocationID>0</ProjectLocationID>
    <ProjectLocationSiteDetailID>0</ProjectLocationSiteDetailID>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <Value>String</Value>
  </SiteDetail>
  <SiteDetails>
    <ProjectLocationSiteDetail>
      <Active>false</Active>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DetailType>String</DetailType>
      <DisplayOrder>0</DisplayOrder>
      <EncVersion>0</EncVersion>
      <HasValue>false</HasValue>
      <IsSensitive>false</IsSensitive>
      <Label>String</Label>
      <Notes>String</Notes>
      <ProjectLocationID>0</ProjectLocationID>
      <ProjectLocationSiteDetailID>0</ProjectLocationSiteDetailID>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <Value>String</Value>
    </ProjectLocationSiteDetail>
  </SiteDetails>
</ProjectLocationResponse>