| POST | /api/tags/add/{ObjectId} |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models
Namespace Global
Namespace Eros.Saguna.Common.WebAPIModel.Models
Public Partial Class TagModel
'''<Summary>
'''Id of the tag
'''</Summary>
<ApiMember(Description:="Id of the tag", ParameterType:="query")>
Public Overridable Property Id As Guid
'''<Summary>
'''Tag name
'''</Summary>
<ApiMember(Description:="Tag name", ParameterType:="query")>
Public Overridable Property Name As String
'''<Summary>
'''RmsTableCtx Id that represents the type of object the tag an be linked to
'''</Summary>
<ApiMember(Description:="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType:="query")>
Public Overridable Property RmsTableCtxId As Guid
'''<Summary>
'''Owner Id to use to retrieve tags for a particular licensee
'''</Summary>
<ApiMember(Description:="Owner Id to use to retrieve tags for a particular licensee", ParameterType:="query")>
Public Overridable Property ContactOwnerId As Guid
'''<Summary>
'''Associated tag colour
'''</Summary>
<ApiMember(Description:="Associated tag colour", ParameterType:="query")>
Public Overridable Property Colour As String
'''<Summary>
'''Object Connection Id linking an object to the tag
'''</Summary>
<ApiMember(Description:="Object Connection Id linking an object to the tag", ParameterType:="query")>
Public Overridable Property ObjectConnectionId As Guid
End Class
End Namespace
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
<ApiResponse(Description:="A list of tags")>
Public Partial Class GetTagsListResponse
'''<Summary>
'''List of tags.
'''</Summary>
<ApiMember(Description:="List of tags.", ParameterType:="query")>
Public Overridable Property Tags As List(Of TagModel)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
'''<Summary>
'''Add a new tag and link to an object. Returns the list of tags assigned to the object.
'''</Summary>
<Api(Description:="Add a new tag and link to an object. Returns the list of tags assigned to the object.")>
Public Partial Class SaveNewTagForObject
'''<Summary>
'''Object Id to retrieve tags for.
'''</Summary>
<ApiMember(Description:="Object Id to retrieve tags for.", ParameterType:="query")>
Public Overridable Property ObjectId As Guid
'''<Summary>
'''Licensee Id owner of the object.
'''</Summary>
<ApiMember(Description:="Licensee Id owner of the object.", ParameterType:="query")>
Public Overridable Property LicenseeId As Guid
'''<Summary>
'''Tag name
'''</Summary>
<ApiMember(Description:="Tag name", ParameterType:="query")>
Public Overridable Property Name As String
'''<Summary>
'''Associated tag colour
'''</Summary>
<ApiMember(Description:="Associated tag colour", ParameterType:="query")>
Public Overridable Property Colour As String
'''<Summary>
'''RmsTableCtx Id that represents the type of object the tag an be linked to
'''</Summary>
<ApiMember(Description:="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType:="query")>
Public Overridable Property RmsTableCtxId As Guid
End Class
End Namespace
End Namespace
VB.NET SaveNewTagForObject DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<SaveNewTagForObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Colour>String</Colour>
<LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
<Name>String</Name>
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
<RmsTableCtxId>00000000-0000-0000-0000-000000000000</RmsTableCtxId>
</SaveNewTagForObject>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetTagsListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Tags xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:TagModel>
<d2p1:Colour>String</d2p1:Colour>
<d2p1:ContactOwnerId>00000000-0000-0000-0000-000000000000</d2p1:ContactOwnerId>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
<d2p1:RmsTableCtxId>00000000-0000-0000-0000-000000000000</d2p1:RmsTableCtxId>
</d2p1:TagModel>
</Tags>
</GetTagsListResponse>