POST api/UserInstitution/GetUserInstitutionsByUser
Get all UserInstitutions created by the current Sophtron user account.
Request Information
URI Parameters
None.
Body Parameters
GetUserParamsName | Description | Type | Additional information |
---|---|---|---|
UserID |
Guid-type UserID is associated with a Sophtron account. UserID can be found under Developer Profile -> Direct Auth. |
globally unique identifier |
None. |
Request Formats
application/json, text/json
{ "UserID": "1a8d6e12-0331-4b0b-b361-929ffcf4e223" }
application/xml, text/xml
Coming soon.
Response Information
Resource Description
List of UserInstitutions created by the current Sophtron user account.
Collection of UserInstitutionInformationName | 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": "680ae675-346f-430d-9a10-90c1e9a8cadc", "InstitutionID": "1bb19efb-2bdf-4107-b78f-15feb14bb632", "UserInstitutionID": "6650fb5f-6be8-48d8-90d3-fdb259b3d1c7", "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" }, { "UserID": "680ae675-346f-430d-9a10-90c1e9a8cadc", "InstitutionID": "1bb19efb-2bdf-4107-b78f-15feb14bb632", "UserInstitutionID": "6650fb5f-6be8-48d8-90d3-fdb259b3d1c7", "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.