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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SheetPin() = 
        member val SheetPinID:Int32 = new Int32() with get,set
        member val SheetID:Int32 = new Int32() with get,set
        member val EntityType:String = null with get,set
        member val EntityID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EntityUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val X:Double = new Double() with get,set
        member val Y:Double = new Double() with get,set
        member val Label:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EntityNo:String = null with get,set
        member val EntityTitle:String = null with get,set
        member val EntityStatus:String = null with get,set
        member val InspectionUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val SheetNumber:String = null with get,set
        member val SheetTitle:String = null with get,set
        member val PlanSetID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PlanSetUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val PlanSetName:String = null with get,set

    [<AllowNullLiteral>]
    type SheetPinListResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Pins:ResizeArray<SheetPin> = new ResizeArray<SheetPin>() with get,set

    [<AllowNullLiteral>]
    type PinsForEntityRequest() = 
        member val EntityType:String = null with get,set
        member val EntityID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EntityUID:Nullable<Guid> = new Nullable<Guid>() with get,set

F# 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
		}
	]
}