Platform API

<back to all web services

SaveNewTagForObject

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

Requires Authentication
The following routes are available for this service:
POST/api/tags/add/{ObjectId}
import 'package:servicestack/servicestack.dart';

class TagModel implements IConvertible
{
    /**
    * Id of the tag
    */
    // @ApiMember(Description="Id of the tag", ParameterType="query")
    String? Id;

    /**
    * Tag name
    */
    // @ApiMember(Description="Tag name", ParameterType="query")
    String? Name;

    /**
    * RmsTableCtx Id that represents the type of object the tag an be linked to
    */
    // @ApiMember(Description="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType="query")
    String? RmsTableCtxId;

    /**
    * Owner Id to use to retrieve tags for a particular licensee
    */
    // @ApiMember(Description="Owner Id to use to retrieve tags for a particular licensee", ParameterType="query")
    String? ContactOwnerId;

    /**
    * Associated tag colour
    */
    // @ApiMember(Description="Associated tag colour", ParameterType="query")
    String? Colour;

    /**
    * Object Connection Id linking an object to the tag
    */
    // @ApiMember(Description="Object Connection Id linking an object to the tag", ParameterType="query")
    String? ObjectConnectionId;

    TagModel({this.Id,this.Name,this.RmsTableCtxId,this.ContactOwnerId,this.Colour,this.ObjectConnectionId});
    TagModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        RmsTableCtxId = json['RmsTableCtxId'];
        ContactOwnerId = json['ContactOwnerId'];
        Colour = json['Colour'];
        ObjectConnectionId = json['ObjectConnectionId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'RmsTableCtxId': RmsTableCtxId,
        'ContactOwnerId': ContactOwnerId,
        'Colour': Colour,
        'ObjectConnectionId': ObjectConnectionId
    };

    getTypeName() => "TagModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="A list of tags")
class GetTagsListResponse implements IConvertible
{
    /**
    * List of tags.
    */
    // @ApiMember(Description="List of tags.", ParameterType="query")
    List<TagModel>? Tags;

    ResponseStatus? ResponseStatus;

    GetTagsListResponse({this.Tags,this.ResponseStatus});
    GetTagsListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Tags = JsonConverters.fromJson(json['Tags'],'List<TagModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Tags': JsonConverters.toJson(Tags,'List<TagModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetTagsListResponse";
    TypeContext? context = _ctx;
}

/**
* Add a new tag and link to an object. Returns the list of tags assigned to the object.
*/
// @Api(Description="Add a new tag and link to an object. Returns the list of tags assigned to the object.")
class SaveNewTagForObject implements IConvertible
{
    /**
    * Object Id to retrieve tags for.
    */
    // @ApiMember(Description="Object Id to retrieve tags for.", ParameterType="query")
    String? ObjectId;

    /**
    * Licensee Id owner of the object.
    */
    // @ApiMember(Description="Licensee Id owner of the object.", ParameterType="query")
    String? LicenseeId;

    /**
    * Tag name
    */
    // @ApiMember(Description="Tag name", ParameterType="query")
    String? Name;

    /**
    * Associated tag colour
    */
    // @ApiMember(Description="Associated tag colour", ParameterType="query")
    String? Colour;

    /**
    * RmsTableCtx Id that represents the type of object the tag an be linked to
    */
    // @ApiMember(Description="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType="query")
    String? RmsTableCtxId;

    SaveNewTagForObject({this.ObjectId,this.LicenseeId,this.Name,this.Colour,this.RmsTableCtxId});
    SaveNewTagForObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectId = json['ObjectId'];
        LicenseeId = json['LicenseeId'];
        Name = json['Name'];
        Colour = json['Colour'];
        RmsTableCtxId = json['RmsTableCtxId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectId': ObjectId,
        'LicenseeId': LicenseeId,
        'Name': Name,
        'Colour': Colour,
        'RmsTableCtxId': RmsTableCtxId
    };

    getTypeName() => "SaveNewTagForObject";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'TagModel': TypeInfo(TypeOf.Class, create:() => TagModel()),
    'GetTagsListResponse': TypeInfo(TypeOf.Class, create:() => GetTagsListResponse()),
    'List<TagModel>': TypeInfo(TypeOf.Class, create:() => <TagModel>[]),
    'SaveNewTagForObject': TypeInfo(TypeOf.Class, create:() => SaveNewTagForObject()),
});

Dart 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>