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}
import Foundation
import ServiceStack

public class PinsForEntityRequest : Codable
{
    public var entityType:String
    public var entityID:Int?
    public var entityUID:String?

    required public init(){}
}

public class SheetPinListResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var pins:[SheetPin] = []

    required public init(){}
}

public class SheetPin : Codable
{
    public var sheetPinID:Int
    public var sheetID:Int
    public var entityType:String
    public var entityID:Int?
    public var entityUID:String?
    public var x:Double
    public var y:Double
    public var label:String
    public var createdBy:String
    public var createdAt:Date?
    public var entityNo:String
    public var entityTitle:String
    public var entityStatus:String
    public var inspectionUID:String?
    public var sheetNumber:String
    public var sheetTitle:String
    public var planSetID:Int?
    public var planSetUID:String?
    public var planSetName:String

    required public init(){}
}


Swift PinsForEntityRequest DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			EntityNo: String,
			EntityTitle: String,
			EntityStatus: String,
			InspectionUID: 00000000000000000000000000000000,
			SheetNumber: String,
			SheetTitle: String,
			PlanSetID: 0,
			PlanSetUID: 00000000000000000000000000000000,
			PlanSetName: String
		}
	]
}