Requires the role: | manager |
GET | /persons/{Id} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Person | form | Person | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | UserAccountName | No | |
DisplayName | form | string | No | |
form | string | No | ||
PhoneNumber | form | string | No | |
Timezone | form | string | No | |
DefaultOrganisationId | form | string | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FirstName | form | string | No | |
LastName | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Person | form | Person | 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.
GET /persons/{Id} HTTP/1.1 Host: staging-api.billiecart.com.au Accept: application/json
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"}},"person":{"name":{"firstName":"String","lastName":"String"},"displayName":"String","email":"String","phoneNumber":"String","timezone":"String","defaultOrganisationId":"String","id":"String"}}