Platform API

<back to all web services

SaveNewTagForObject

Add a new tag and link to an object. Returns the list of tags assigned to the object.

Requires Authentication
The following routes are available for this service:
POST/api/tags/add/{ObjectId}
SaveNewTagForObject Parameters:
NameParameterData TypeRequiredDescription
ObjectIdqueryGuidNoObject Id to retrieve tags for.
LicenseeIdqueryGuidNoLicensee Id owner of the object.
NamequerystringNoTag name
ColourquerystringNoAssociated tag colour
RmsTableCtxIdqueryGuidNoRmsTableCtx Id that represents the type of object the tag an be linked to
GetTagsListResponse Parameters:
NameParameterData TypeRequiredDescription
TagsqueryList<TagModel>NoList of tags.
ResponseStatusformResponseStatusNo
TagModel Parameters:
NameParameterData TypeRequiredDescription
IdqueryGuidNoId of the tag
NamequerystringNoTag name
RmsTableCtxIdqueryGuidNoRmsTableCtx Id that represents the type of object the tag an be linked to
ContactOwnerIdqueryGuidNoOwner Id to use to retrieve tags for a particular licensee
ColourquerystringNoAssociated tag colour
ObjectConnectionIdqueryGuidNoObject Connection Id linking an object to the tag

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/tags/add/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","Name":"String","Colour":"String","RmsTableCtxId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}