POST api/UserInstitution/CreateUserInstitutionWithRewardsInfo
Create user institution and get rewards information including rewards unit, rewards balance for all accounts under UserInstitution.
Request Information
URI Parameters
None.
Body Parameters
CreateUserInstitutionParams| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID |
Guid-type UserID can be found under Developer Profile -> Direct Auth. |
globally unique identifier |
None. |
| InstitutionID |
Guid-type InstitutionID can be looked up by api/Institution/GetInstitutionByName method. If an institution does not exist in Sophtron's list, use api/Institution/AddInstitution to add it to the list. |
globally unique identifier |
None. |
| UserName |
UserName for login account. |
string |
None. |
| Password |
Password for login account. |
string |
None. |
| PIN |
PIN for login account (Optional). |
string |
None. |
| CompanyID |
CompanyID for business login account (Optional). |
string |
None. |
Request Formats
application/json, text/json
{
"UserID": "afcb5874-9c88-45b0-bdf3-c593645c876f",
"InstitutionID": "f15bcad7-7cd5-4283-9d64-617795e97191",
"UserName": "sample string 3",
"Password": "sample string 4",
"PIN": "sample string 5",
"CompanyID": "sample string 6"
}
application/xml, text/xml
Coming soon.
Response Information
Resource Description
JobID of the new job triggerd by trying to create user institution and retrieve rewards information. Use api/Job/GetJobInformationByID with this JobID to look up current job's MFA information and status.
CreateUserInstitutionJobTracker| Name | Description | Type | Additional information |
|---|---|---|---|
| JobID |
Guid-type JobID is used to track current job. Use api/Job/GetJobInformationByID with this JobID to look up current job's MFA information and status. |
globally unique identifier |
None. |
| UserInstitutionID |
Guid-type UserInstitutionID is used to track the UserInstitution just created. After the current CreateUserInstitution job succeeds, use api/UserInstitution/GetUserInstitutionAccounts to get retrieved accounts belonging to this UserInstitution. |
globally unique identifier |
None. |
Response Formats
application/json, text/json
{
"JobID": "c949f688-2823-4778-a182-fa73670ebf20",
"UserInstitutionID": "3845978e-2f54-425a-91b7-c2a77430aa84"
}
application/xml, text/xml
Coming soon.