POST api/UserInstitution/GetUserInstitutionsByUser

Get all UserInstitutions created by the current Sophtron user account.

Request Information

URI Parameters

None.

Body Parameters

GetUserParams
NameDescriptionTypeAdditional 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": "5ab11ea3-8f3b-4267-9740-816f37ae891c"
}

application/xml, text/xml

Sample: 
Coming soon.

Response Information

Resource Description

List of UserInstitutions created by the current Sophtron user account.

Collection of UserInstitutionInformation
NameDescriptionTypeAdditional 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": "ab6a8acc-912e-4440-a3c8-54beee09937b",
    "InstitutionID": "38841358-a8c7-4f5a-9838-982b440ceacb",
    "UserInstitutionID": "566c1cc3-4967-4670-9873-ad3f08217105",
    "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": "ab6a8acc-912e-4440-a3c8-54beee09937b",
    "InstitutionID": "38841358-a8c7-4f5a-9838-982b440ceacb",
    "UserInstitutionID": "566c1cc3-4967-4670-9873-ad3f08217105",
    "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.