Platform API

AddContactRole

Add a custom role for the licensee

The following routes are available for this service:
POST	/api/roles

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class ListItemFilterModel
    {
        public virtual Guid ListItemFilterId { get; set; }
        public virtual string FilterName { get; set; }
        public virtual Guid ListId { get; set; }
        public virtual Guid ListItemId { get; set; }
        public virtual bool ListItemIsInFilter { get; set; }
    }

    public partial class RoleDetailsModel
    {
        ///<summary>
        ///Role Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")]
        public virtual Guid RoleId { get; set; }

        ///<summary>
        ///Role Name
        ///</summary>
        [ApiMember(DataType="string", Description="Role Name", Name="RoleName")]
        public virtual string RoleName { get; set; }

        ///<summary>
        ///Role Connection Definition Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")]
        public virtual Guid RoleConnectionDefinitionId { get; set; }

        ///<summary>
        ///Contact Types the Role applies to
        ///</summary>
        [ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")]
        public virtual List<Guid> ContactTypes { get; set; }

        ///<summary>
        ///Does the role require contacts to accept it?
        ///</summary>
        [ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")]
        public virtual bool RequireContactsToAccept { get; set; }

        ///<summary>
        ///Filters linked to the custom role.
        ///</summary>
        [ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")]
        public virtual List<ListItemFilterModel> ListItemFilters { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Add a custom role for the licensee
    ///</summary>
    [Api(Description="Add a custom role for the licensee")]
    public partial class AddContactRole
    {
        ///<summary>
        ///Details of the Contact Role to be Added.
        ///</summary>
        [ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Added.", IsRequired=true, Name="RoleDetails", ParameterType="query")]
        public virtual RoleDetailsModel RoleDetails { get; set; }
    }

}

C# AddContactRole DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RoleDetails":{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","RoleConnectionDefinitionId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"RequireContactsToAccept":false,"ListItemFilters":[{"ListItemFilterId":"00000000-0000-0000-0000-000000000000","FilterName":"String","ListId":"00000000-0000-0000-0000-000000000000","ListItemId":"00000000-0000-0000-0000-000000000000","ListItemIsInFilter":false}]}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}