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
"use strict";
export class ListItemFilterModel {
    /** @param {{ListItemFilterId?:string,FilterName?:string,ListId?:string,ListItemId?:string,ListItemIsInFilter?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ListItemFilterId;
    /** @type {string} */
    FilterName;
    /** @type {string} */
    ListId;
    /** @type {string} */
    ListItemId;
    /** @type {boolean} */
    ListItemIsInFilter;
}
export class RoleDetailsModel {
    /** @param {{RoleId?:string,RoleName?:string,RoleConnectionDefinitionId?:string,ContactTypes?:string[],RequireContactsToAccept?:boolean,ListItemFilters?:ListItemFilterModel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Role Id */
    RoleId;
    /**
     * @type {string}
     * @description Role Name */
    RoleName;
    /**
     * @type {string}
     * @description Role Connection Definition Id */
    RoleConnectionDefinitionId;
    /**
     * @type {string[]}
     * @description Contact Types the Role applies to */
    ContactTypes;
    /**
     * @type {boolean}
     * @description Does the role require contacts to accept it? */
    RequireContactsToAccept;
    /**
     * @type {ListItemFilterModel[]}
     * @description Filters linked to the custom role. */
    ListItemFilters;
}
export class AddContactRole {
    /** @param {{RoleDetails?:RoleDetailsModel}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {RoleDetailsModel}
     * @description Details of the Contact Role to be Added. */
    RoleDetails;
}

JavaScript 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"}}