| All Verbs | /api/contactroles/{LicenseeId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LicenseeId | query | Guid | Yes | Get contact roles (custom and/or standard) for the specified licensee |
| ContactTypes | query | List<Guid> | No | Contact Types |
| OwnerFilterIds | query | List<Guid> | No | Custom/Standard filter |
| RecordStatus | query | string | No | Active/Archived filter |
| SearchText | query | string | No | Text filter |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Roles | form | List<RoleModel> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RoleId | form | Guid | Yes | Role Id |
| RoleName | form | string | No | Role Name |
| IsLicenseeRole | form | bool | No | Is the role a licensee role? |
| IsManageContacts | form | bool | No | Is manage contacts role? |
| IsPlatformRole | form | bool | No | Is the role a Platform role? |
| IsServiceRole | form | bool | No | Is the role a services role? |
| IsCustomerRole | form | bool | No | Is the role a customer role? |
| IsFunctionalRole | form | bool | No | Is the role a functional role? |
| IsRequestAutoAccepted | form | bool | No | Is the role an auto-accept role? |
| SuiteId | form | Guid | No | Suite that the role belongs to |
| SuiteName | form | string | No | Suite that the role belongs to |
| RecordStatus | form | string | No | 'A' (Active) or 'I' (Inactive) |
| ObjectConnectionId | form | Guid | No | Object Connection Id, which is populated when the roles are returned based on those that are connected to an object. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contactroles/{LicenseeId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"OwnerFilterIds":["00000000-0000-0000-0000-000000000000"],"RecordStatus":"String","SearchText":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","IsLicenseeRole":false,"IsManageContacts":false,"IsPlatformRole":false,"IsServiceRole":false,"IsCustomerRole":false,"IsFunctionalRole":false,"IsRequestAutoAccepted":false,"SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","RecordStatus":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}