| POST | /api/tags/link/{ObjectId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | query | Guid | No | Object Id to link the tag to. |
| LicenseeId | query | Guid | No | Licensee Id owner of the object. |
| Id | query | Guid | No | Id of the tag |
| Colour | query | string | No | Associated tag colour, if this is passed we will update the existing tags colour. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Tags | query | List<TagModel> | No | List of tags. |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | query | Guid | No | Id of the tag |
| Name | query | string | No | Tag name |
| RmsTableCtxId | query | Guid | No | RmsTableCtx Id that represents the type of object the tag an be linked to |
| ContactOwnerId | query | Guid | No | Owner Id to use to retrieve tags for a particular licensee |
| Colour | query | string | No | Associated tag colour |
| ObjectConnectionId | query | Guid | No | Object Connection Id linking an object to the tag |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/tags/link/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ObjectId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","Id":"00000000-0000-0000-0000-000000000000","Colour":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Tags":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String","RmsTableCtxId":"00000000-0000-0000-0000-000000000000","ContactOwnerId":"00000000-0000-0000-0000-000000000000","Colour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}