Platform API

<back to all web services

LinkTagForObject

Link existing tag to an object. Returns the list of tags assigned to the object.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

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 virtual Guid Id { get; set; }

        ///<summary>
        ///Tag name
        ///</summary>
        [ApiMember(Description="Tag name", ParameterType="query")]
        public virtual string Name { get; set; }

        ///<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 virtual Guid RmsTableCtxId { get; set; }

        ///<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 virtual Guid ContactOwnerId { get; set; }

        ///<summary>
        ///Associated tag colour
        ///</summary>
        [ApiMember(Description="Associated tag colour", ParameterType="query")]
        public virtual string Colour { get; set; }

        ///<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 virtual Guid ObjectConnectionId { get; set; }
    }

}

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 virtual List<TagModel> Tags { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    ///<summary>
    ///Link existing tag to an object. Returns the list of tags assigned to the object.
    ///</summary>
    [Api(Description="Link existing tag to an object. Returns the list of tags assigned to the object.")]
    public partial class LinkTagForObject
    {
        ///<summary>
        ///Object Id to link the tag to.
        ///</summary>
        [ApiMember(Description="Object Id to link the tag to.", ParameterType="query")]
        public virtual Guid ObjectId { get; set; }

        ///<summary>
        ///Licensee Id owner of the object.
        ///</summary>
        [ApiMember(Description="Licensee Id owner of the object.", ParameterType="query")]
        public virtual Guid LicenseeId { get; set; }

        ///<summary>
        ///Id of the tag
        ///</summary>
        [ApiMember(Description="Id of the tag", ParameterType="query")]
        public virtual Guid Id { get; set; }

        ///<summary>
        ///Associated tag colour, if this is passed we will update the existing tags colour.
        ///</summary>
        [ApiMember(Description="Associated tag colour, if this is passed we will update the existing tags colour.", ParameterType="query")]
        public virtual string Colour { get; set; }
    }

}

C# LinkTagForObject DTOs

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

{
	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
		}
	}
}