POST api/UserInstitution/UpdateUserInstitution

Update a UserInstitution with new login information such as new username or new password.

Request Information

URI Parameters

None.

Body Parameters

UpdateUserInstitutionParams
NameDescriptionTypeAdditional information
UserInstitutionID

Guid-type ID of the UserInstitution to be updated.

globally unique identifier

None.

UserName

Current UserName of the login account. Note: even if the UserName has not changed, please still include the UserName information in the post data.

string

None.

Password

Current Password of the login account. Note: even if the Password has not changed, please still include the Password information in the post data.

string

None.

PIN

Current PIN of the login account. (Optional) Note: if a PIN exists, even if it has not changed, please still include the PIN information in the post data.

string

None.

CompanyID

Current CompanyID of the business login account. (Optional) Note: if a CompanyID exists, even if it has not changed, please still include the CompanyID information in the post data.

string

None.

Request Formats

application/json, text/json

Sample:
{ 
 "UserInstitutionID": "35383341-1a1b-4dfc-b30e-1beb7bbd900d", 
 "UserName": "Bob1234",
 "Password": "Password5678!", 
 "PIN": "7654", (optional) 
 "CompanyID": "BobCorp1" (optional) 
}

application/xml, text/xml

Sample:
Coming soon.

Response Information

Resource Description

0 for success, -1 for failure.

TransmitStatusEnums

Response Formats

application/json, text/json

Sample:
0

application/xml, text/xml

Sample:
Coming soon.