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}

"use strict";
export class TagModel {
    /** @param {{Id?:string,Name?:string,RmsTableCtxId?:string,ContactOwnerId?:string,Colour?:string,ObjectConnectionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the tag */
    Id;
    /**
     * @type {string}
     * @description Tag name */
    Name;
    /**
     * @type {string}
     * @description RmsTableCtx Id that represents the type of object the tag an be linked to */
    RmsTableCtxId;
    /**
     * @type {string}
     * @description Owner Id to use to retrieve tags for a particular licensee */
    ContactOwnerId;
    /**
     * @type {string}
     * @description Associated tag colour */
    Colour;
    /**
     * @type {string}
     * @description Object Connection Id linking an object to the tag */
    ObjectConnectionId;
}
export class GetTagsListResponse {
    /** @param {{Tags?:TagModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {TagModel[]}
     * @description List of tags. */
    Tags;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SaveNewTagForObject {
    /** @param {{ObjectId?:string,LicenseeId?:string,Name?:string,Colour?:string,RmsTableCtxId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Object Id to retrieve tags for. */
    ObjectId;
    /**
     * @type {string}
     * @description Licensee Id owner of the object. */
    LicenseeId;
    /**
     * @type {string}
     * @description Tag name */
    Name;
    /**
     * @type {string}
     * @description Associated tag colour */
    Colour;
    /**
     * @type {string}
     * @description RmsTableCtx Id that represents the type of object the tag an be linked to */
    RmsTableCtxId;
}

JavaScript SaveNewTagForObject DTOs

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

HTTP + 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>