Billiecart API

<back to all web services

GetPersonRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/persons/{Id}
GetPersonRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
GetPersonResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PersonformPersonNo
Person Parameters:
NameParameterData TypeRequiredDescription
NameformUserAccountNameNo
DisplayNameformstringNo
EmailformstringNo
PhoneNumberformstringNo
TimezoneformstringNo
DefaultOrganisationIdformstringNo
IdformstringNo
UserAccountName Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
GetPersonResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PersonformPersonNo

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

HTTP + JSON

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