| All Verbs | /api/permissions/{PermissionId}/licensee/ | ||
|---|---|---|---|
| All Verbs | /api/permissions/{PermissionId}/role/ | ||
| All Verbs | /api/permissions/{PermissionId}/contact/ |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PermissionId | path | Guid | Yes | A permission Id that we're saving the permission for. |
| ObjectId | query | Guid | No | The object to save a permission for. This will either be a contact or role list item. Leave this blank if we're saving for the licensee. |
| PermissionValue | query | bool? | No | Value to set the permission to, may be true, false or null. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/permissions/{PermissionId}/licensee/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"PermissionId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","PermissionValue":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}