| GET,OPTIONS | /v1/pins/{EntityType}/{EntityID} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/pins/{EntityType} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EntityType | path | string | No | |
| EntityID | path | int? | No | |
| EntityUID | query | Guid? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Pins | form | List<SheetPin> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SheetPinID | form | int | No | |
| SheetID | form | int | No | |
| EntityType | form | string | No | |
| EntityID | form | int? | No | |
| EntityUID | form | Guid? | No | |
| X | form | double | No | |
| Y | form | double | No | |
| Label | form | string | No | |
| CreatedBy | form | string | No | |
| CreatedAt | form | DateTime? | No | |
| EntityNo | form | string | No | |
| EntityTitle | form | string | No | |
| EntityStatus | form | string | No | |
| InspectionUID | form | Guid? | No | |
| SheetNumber | form | string | No | |
| SheetTitle | form | string | No | |
| PlanSetID | form | int? | No | |
| PlanSetUID | form | Guid? | No | |
| PlanSetName | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}