Platform API

AddContactRole

Add a custom role for the licensee

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

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 ListItemFilterModel() = 
        member val ListItemFilterId:Guid = new Guid() with get,set
        member val FilterName:String = null with get,set
        member val ListId:Guid = new Guid() with get,set
        member val ListItemId:Guid = new Guid() with get,set
        member val ListItemIsInFilter:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RoleDetailsModel() = 
        ///<summary>
        ///Role Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")>]
        member val RoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Role Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Role Name", Name="RoleName")>]
        member val RoleName:String = null with get,set

        ///<summary>
        ///Role Connection Definition Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")>]
        member val RoleConnectionDefinitionId:Guid = new Guid() with get,set

        ///<summary>
        ///Contact Types the Role applies to
        ///</summary>
        [<ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")>]
        member val ContactTypes:ResizeArray<Guid> = null with 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")>]
        member val RequireContactsToAccept:Boolean = new Boolean() with get,set

        ///<summary>
        ///Filters linked to the custom role.
        ///</summary>
        [<ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")>]
        member val ListItemFilters:ResizeArray<ListItemFilterModel> = null with get,set

    ///<summary>
    ///Add a custom role for the licensee
    ///</summary>
    [<Api(Description="Add a custom role for the licensee")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val RoleDetails:RoleDetailsModel = null with get,set

F# AddContactRole DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

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