Foundry API

<back to all web services

GetProfileRequest

Requires Authentication
The following routes are available for this service:
GET/profile/{Id}
GetProfileRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
GetProfileResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProfileformProfileNo
Profile Parameters:
NameParameterData TypeRequiredDescription
DefaultOrganisationIdformstringNo
ProfileBasic Parameters:
NameParameterData TypeRequiredDescription
NameformPersonNameNo
DisplayNameformstringNo
EmailAddressformstringNo
PhoneNumberformstringNo
TimezoneformstringNo
IdformstringNo
PersonName Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
GetProfileResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProfileformProfileNo

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.

GET /profile/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"profile":{"defaultOrganisationId":"String","name":{"firstName":"String","lastName":"String"},"displayName":"String","emailAddress":"String","phoneNumber":"String","timezone":"String","id":"String"}}