Platform API

SaveNewTagForObject

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

The following routes are available for this service:
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 .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.

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

{
	Name: String,
	Colour: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Tags: 
	[
		{
			Name: String,
			Colour: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}