Platform API

<back to all web services

AddContactRole

Add a custom role for the licensee

Requires Authentication
The following routes are available for this service:
POST/api/roles
AddContactRole Parameters:
NameParameterData TypeRequiredDescription
RoleDetailsqueryRoleDetailsModelYesDetails of the Contact Role to be Added.
RoleDetailsModel Parameters:
NameParameterData TypeRequiredDescription
RoleIdformGuidNoRole Id
RoleNameformstringNoRole Name
RoleConnectionDefinitionIdformGuidNoRole Connection Definition Id
ContactTypesformListNoContact Types the Role applies to
RequireContactsToAcceptformboolNoDoes the role require contacts to accept it?
ListItemFiltersformListNoFilters linked to the custom role.
ListItemFilterModel Parameters:
NameParameterData TypeRequiredDescription
ListItemFilterIdformGuidNo
FilterNameformstringNo
ListIdformGuidNo
ListItemIdformGuidNo
ListItemIsInFilterformboolNo

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

HTTP + OTHER

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

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