Trendsic Platform Service

<back to all web services

PinsForEntityRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pins/{EntityType}/{EntityID}
GET,OPTIONS/v1/pins/{EntityType}

export class SheetPin
{
    public SheetPinID: number;
    public SheetID: number;
    public EntityType: string;
    public EntityID?: number;
    public EntityUID?: string;
    public X: number;
    public Y: number;
    public Label: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public EntityNo: string;
    public EntityTitle: string;
    public EntityStatus: string;
    public InspectionUID?: string;
    public SheetNumber: string;
    public SheetTitle: string;
    public PlanSetID?: number;
    public PlanSetUID?: string;
    public PlanSetName: string;

    public constructor(init?: Partial<SheetPin>) { (Object as any).assign(this, init); }
}

export class SheetPinListResponse
{
    public ResponseStatus: ResponseStatus;
    public Pins: SheetPin[] = [];

    public constructor(init?: Partial<SheetPinListResponse>) { (Object as any).assign(this, init); }
}

export class PinsForEntityRequest
{
    public EntityType: string;
    public EntityID?: number;
    public EntityUID?: string;

    public constructor(init?: Partial<PinsForEntityRequest>) { (Object as any).assign(this, init); }
}

TypeScript PinsForEntityRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Pins":[{"SheetPinID":0,"SheetID":0,"EntityType":"String","EntityID":0,"EntityUID":"00000000000000000000000000000000","X":0,"Y":0,"Label":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","EntityNo":"String","EntityTitle":"String","EntityStatus":"String","InspectionUID":"00000000000000000000000000000000","SheetNumber":"String","SheetTitle":"String","PlanSetID":0,"PlanSetUID":"00000000000000000000000000000000","PlanSetName":"String"}]}