| POST | /api/tags/add/{ObjectId} |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type TagModel() =
///<summary>
///Id of the tag
///</summary>
[<ApiMember(Description="Id of the tag", ParameterType="query")>]
member val Id:Guid = new Guid() with get,set
///<summary>
///Tag name
///</summary>
[<ApiMember(Description="Tag name", ParameterType="query")>]
member val Name:String = null with 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")>]
member val RmsTableCtxId:Guid = new Guid() with 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")>]
member val ContactOwnerId:Guid = new Guid() with get,set
///<summary>
///Associated tag colour
///</summary>
[<ApiMember(Description="Associated tag colour", ParameterType="query")>]
member val Colour:String = null with 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")>]
member val ObjectConnectionId:Guid = new Guid() with get,set
[<ApiResponse(Description="A list of tags")>]
[<AllowNullLiteral>]
type GetTagsListResponse() =
///<summary>
///List of tags.
///</summary>
[<ApiMember(Description="List of tags.", ParameterType="query")>]
member val Tags:ResizeArray<TagModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Add a new tag and link to an object. Returns the list of tags assigned to the object.
///</summary>
[<Api(Description="Add a new tag and link to an object. Returns the list of tags assigned to the object.")>]
[<AllowNullLiteral>]
type SaveNewTagForObject() =
///<summary>
///Object Id to retrieve tags for.
///</summary>
[<ApiMember(Description="Object Id to retrieve tags for.", ParameterType="query")>]
member val ObjectId:Guid = new Guid() with get,set
///<summary>
///Licensee Id owner of the object.
///</summary>
[<ApiMember(Description="Licensee Id owner of the object.", ParameterType="query")>]
member val LicenseeId:Guid = new Guid() with get,set
///<summary>
///Tag name
///</summary>
[<ApiMember(Description="Tag name", ParameterType="query")>]
member val Name:String = null with get,set
///<summary>
///Associated tag colour
///</summary>
[<ApiMember(Description="Associated tag colour", ParameterType="query")>]
member val Colour:String = null with 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")>]
member val RmsTableCtxId:Guid = new Guid() with get,set
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>