| POST | /api/tags/add/{ObjectId} |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TagModel:
# @ApiMember(Description="Id of the tag", ParameterType="query")
id: Optional[str] = None
"""
Id of the tag
"""
# @ApiMember(Description="Tag name", ParameterType="query")
name: Optional[str] = None
"""
Tag name
"""
# @ApiMember(Description="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType="query")
rms_table_ctx_id: Optional[str] = None
"""
RmsTableCtx Id that represents the type of object the tag an be linked to
"""
# @ApiMember(Description="Owner Id to use to retrieve tags for a particular licensee", ParameterType="query")
contact_owner_id: Optional[str] = None
"""
Owner Id to use to retrieve tags for a particular licensee
"""
# @ApiMember(Description="Associated tag colour", ParameterType="query")
colour: Optional[str] = None
"""
Associated tag colour
"""
# @ApiMember(Description="Object Connection Id linking an object to the tag", ParameterType="query")
object_connection_id: Optional[str] = None
"""
Object Connection Id linking an object to the tag
"""
# @ApiResponse(Description="A list of tags")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTagsListResponse:
# @ApiMember(Description="List of tags.", ParameterType="query")
tags: Optional[List[TagModel]] = None
"""
List of tags.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Add a new tag and link to an object. Returns the list of tags assigned to the object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveNewTagForObject:
"""
Add a new tag and link to an object. Returns the list of tags assigned to the object.
"""
# @ApiMember(Description="Object Id to retrieve tags for.", ParameterType="query")
object_id: Optional[str] = None
"""
Object Id to retrieve tags for.
"""
# @ApiMember(Description="Licensee Id owner of the object.", ParameterType="query")
licensee_id: Optional[str] = None
"""
Licensee Id owner of the object.
"""
# @ApiMember(Description="Tag name", ParameterType="query")
name: Optional[str] = None
"""
Tag name
"""
# @ApiMember(Description="Associated tag colour", ParameterType="query")
colour: Optional[str] = None
"""
Associated tag colour
"""
# @ApiMember(Description="RmsTableCtx Id that represents the type of object the tag an be linked to", ParameterType="query")
rms_table_ctx_id: Optional[str] = None
"""
RmsTableCtx Id that represents the type of object the tag an be linked to
"""
Python SaveNewTagForObject DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>