POST api/UserInstitution/GetUserInstitutionByID
Get a UserInstitution's information by UserInstitutionID
Request Information
URI Parameters
None.
Body Parameters
GetUserInstitutionByIDParams| Name | Description | Type | Additional information |
|---|---|---|---|
| UserInstitutionID |
Guid-type UserInstitutionID. |
globally unique identifier |
None. |
Request Formats
application/json, text/json
{
"UserInstitutionID": "470ab7c9-f7de-43b4-abd8-0e168475ebae"
}
application/xml, text/xml
Coming soon.
Response Information
Resource Description
UserInstitution's information
UserInstitutionInformation| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID |
Guid-type ID of current Sophtron user account. |
globally unique identifier |
None. |
| InstitutionID |
Guid-type ID of the Institution for the login account. |
globally unique identifier |
None. |
| UserInstitutionID |
Guid-type ID of the UserInstitution. |
globally unique identifier |
None. |
| UserName |
UserName of the UserInstitution(login account). |
string |
None. |
| CompanyID |
CompanyID of the UserInstitution(business login account). |
string |
None. |
| OwnerName |
Owner's name shown in the profile setting of the UserInstitution(login account). |
string |
None. |
| Address |
Owner's address shown in the profile setting of the UserInstitution(login account). |
string |
None. |
| Phone |
Owner's phone numbers shown in the profile setting of the UserInstitution(login account). Note: Phone string is a stringified array that may include multiple phone numbers, e.g. "['Primary: 425-000-1234', 'Secondary: 206-123-5678']". |
string |
None. |
|
Owner's email addresses shown in the profile setting of the UserInstitution(login account). Note: Email string is a stringified array that may include multiple email addresses, e.g. "['Work: xxxx@work.com', 'Home: xxxx@gmail.com']". |
string |
None. |
|
| LastModified |
Last time the UserInstitution gets updated from calling either api/UserInstitution/UpdateUserInstitution or api/UserInstitutionAccount/RefreshUserInstitutionAccount. |
string |
None. |
Response Formats
application/json, text/json
{
"UserID": "849fd349-ff85-4d0a-8a22-5935a26371d4",
"InstitutionID": "c1f2d48a-12af-40fd-b7c0-8a223909ec53",
"UserInstitutionID": "118101c2-a374-4519-9682-1d41ce9ac003",
"UserName": "sample string 4",
"CompanyID": "sample string 5",
"OwnerName": "sample string 6",
"Address": "sample string 7",
"Phone": "sample string 8",
"Email": "sample string 9",
"LastModified": "sample string 10"
}
application/xml, text/xml
Coming soon.