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": "a1948fad-6455-463b-9e66-7cb1d0f299aa"
}

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": "8d55bba8-1c62-4d89-bc94-27aa036ed56a"
}

application/xml, text/xml

Sample:
Coming soon.