| GET,OPTIONS | /v1/pins/{EntityType}/{EntityID} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/pins/{EntityType} |
"use strict";
export class SheetPin {
/** @param {{SheetPinID?:number,SheetID?:number,EntityType?:string,EntityID?:number,EntityUID?:string,X?:number,Y?:number,Label?:string,CreatedBy?:string,CreatedAt?:string,EntityNo?:string,EntityTitle?:string,EntityStatus?:string,InspectionUID?:string,SheetNumber?:string,SheetTitle?:string,PlanSetID?:number,PlanSetUID?:string,PlanSetName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SheetPinID;
/** @type {number} */
SheetID;
/** @type {string} */
EntityType;
/** @type {?number} */
EntityID;
/** @type {?string} */
EntityUID;
/** @type {number} */
X;
/** @type {number} */
Y;
/** @type {string} */
Label;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {string} */
EntityNo;
/** @type {string} */
EntityTitle;
/** @type {string} */
EntityStatus;
/** @type {?string} */
InspectionUID;
/** @type {string} */
SheetNumber;
/** @type {string} */
SheetTitle;
/** @type {?number} */
PlanSetID;
/** @type {?string} */
PlanSetUID;
/** @type {string} */
PlanSetName;
}
export class SheetPinListResponse {
/** @param {{ResponseStatus?:ResponseStatus,Pins?:SheetPin[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {SheetPin[]} */
Pins = [];
}
export class PinsForEntityRequest {
/** @param {{EntityType?:string,EntityID?:number,EntityUID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
EntityType;
/** @type {?number} */
EntityID;
/** @type {?string} */
EntityUID;
}
JavaScript PinsForEntityRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/pins/{EntityType}/{EntityID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SheetPinListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Pins>
<SheetPin>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<EntityID>0</EntityID>
<EntityNo>String</EntityNo>
<EntityStatus>String</EntityStatus>
<EntityTitle>String</EntityTitle>
<EntityType>String</EntityType>
<EntityUID>00000000-0000-0000-0000-000000000000</EntityUID>
<InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
<Label>String</Label>
<PlanSetID>0</PlanSetID>
<PlanSetName>String</PlanSetName>
<PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
<SheetID>0</SheetID>
<SheetNumber>String</SheetNumber>
<SheetPinID>0</SheetPinID>
<SheetTitle>String</SheetTitle>
<X>0</X>
<Y>0</Y>
</SheetPin>
</Pins>
<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>
</SheetPinListResponse>