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.

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

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

{"ObjectId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000","Name":"String","Colour":"String","RmsTableCtxId":"00000000-0000-0000-0000-000000000000"}

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

{"Tags":[{"Id":"00000000-0000-0000-0000-000000000000","Name":"String","RmsTableCtxId":"00000000-0000-0000-0000-000000000000","ContactOwnerId":"00000000-0000-0000-0000-000000000000","Colour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}