POST api/UserInstitution/GetUserInstitutionsByUser

Get all UserInstitutions created by the current Sophtron user account.

Request Information

URI Parameters

None.

Body Parameters

Name	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

Sample:

{
  "UserID": "ad1e0f52-81c3-41df-9a5a-db0e8b1505f9"
}

application/xml, text/xml

Sample:

Coming soon.

Response Information

Resource Description

List of UserInstitutions created by the current Sophtron user account.

Collection of 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.
Email	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

Sample:

[
  {
    "UserID": "ea243726-7b70-44fd-ab68-3d1f33dfc7a5",
    "InstitutionID": "c640452e-3ed8-4bca-bee4-de1acc517a3c",
    "UserInstitutionID": "566be748-0264-4dec-9e57-ecb0051db58a",
    "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": "ea243726-7b70-44fd-ab68-3d1f33dfc7a5",
    "InstitutionID": "c640452e-3ed8-4bca-bee4-de1acc517a3c",
    "UserInstitutionID": "566be748-0264-4dec-9e57-ecb0051db58a",
    "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

Sample:

Coming soon.