Platform API

AddContactRole

Add a custom role for the licensee

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

import Foundation
import ServiceStack

/**
* Add a custom role for the licensee
*/
// @Api(Description="Add a custom role for the licensee")
public class AddContactRole : Codable
{
    /**
    * Details of the Contact Role to be Added.
    */
    // @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Added.", IsRequired=true, Name="RoleDetails", ParameterType="query")
    public var roleDetails:RoleDetailsModel

    required public init(){}
}

public class RoleDetailsModel : Codable
{
    /**
    * Role Id
    */
    // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    public var roleId:String

    /**
    * Role Name
    */
    // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    public var roleName:String

    /**
    * Role Connection Definition Id
    */
    // @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
    public var roleConnectionDefinitionId:String

    /**
    * Contact Types the Role applies to
    */
    // @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
    public var contactTypes:[String]

    /**
    * Does the role require contacts to accept it?
    */
    // @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
    public var requireContactsToAccept:Bool

    /**
    * Filters linked to the custom role.
    */
    // @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
    public var listItemFilters:[ListItemFilterModel]

    required public init(){}
}

public class ListItemFilterModel : Codable
{
    public var listItemFilterId:String
    public var filterName:String
    public var listId:String
    public var listItemId:String
    public var listItemIsInFilter:Bool

    required public init(){}
}

Swift AddContactRole DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<AddContactRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <RoleDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ContactTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </d2p1:ContactTypes>
    <d2p1:ListItemFilters>
      <d2p1:ListItemFilterModel>
        <d2p1:FilterName>String</d2p1:FilterName>
        <d2p1:ListId>00000000-0000-0000-0000-000000000000</d2p1:ListId>
        <d2p1:ListItemFilterId>00000000-0000-0000-0000-000000000000</d2p1:ListItemFilterId>
        <d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
        <d2p1:ListItemIsInFilter>false</d2p1:ListItemIsInFilter>
      </d2p1:ListItemFilterModel>
    </d2p1:ListItemFilters>
    <d2p1:RequireContactsToAccept>false</d2p1:RequireContactsToAccept>
    <d2p1:RoleConnectionDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:RoleConnectionDefinitionId>
    <d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
    <d2p1:RoleName>String</d2p1:RoleName>
  </RoleDetails>
</AddContactRole>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>