POST api/UserInstitution/RefreshUserInstitutionWithRewardsInfo

Refresh user institution and get rewards information including rewards unit, rewards balance for all accounts under UserInstitution.

Request Information

URI Parameters

None.

Body Parameters

RefreshUserInstitutionParams
NameDescriptionTypeAdditional information
UserInstitutionID

Guid-type ID of the UserInstitution.

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "UserInstitutionID": "831377d7-474e-4efb-99fe-76f3eac7edb0"
}

application/xml, text/xml

Sample:
Coming soon.

Response Information

Resource Description

JobID of the new job triggerd by trying to refresh user institution and retrieve rewards information. Use api/Job/GetJobInformationByID with this JobID to look up current job's MFA information and status.

JobToTrack
NameDescriptionTypeAdditional information
JobID

Guid-type ID of the job.

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "JobID": "ec80cb4d-9f3d-4cbd-9678-de7b51fe74cf"
}

application/xml, text/xml

Sample:
Coming soon.