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: application/xml
Content-Type: application/xml
Content-Length: length

<LinkTagForObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Colour>String</Colour>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
</LinkTagForObject>

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>