MassBeneficiary
This model is a representation of a mass beneficiary. FieldsThe generic error message for the mass beneficiary request, if any. (Always)
The MassBeneficiaryLinks. (Always)
The MassBeneficiarySummary. (Always)
The MassBeneficiaryStatus. (Always)
MassBeneficiaryStatus
The possible values for the “status” of every mass beneficiary instruction. ValuesMassBeneficiarySummary
This is an object containing categorized counters for the mass beneficiary. FieldsMassBeneficiaryLinks
This is an object containing links for the mass beneficiary related information. Each link helps the user agent to fetch resources related to errored beneficiaries, and also those created successfully. Themass_beneficiary_id does not need to be stored as the said resources may be accessed with the provided links.
Fields
The link to the errors endpoint
/mass-beneficiaries/$mass_beneficiary_id/errors (Always)The link to the result endpoint
/mass-beneficiaries/$mass_beneficiary_id/beneficiaries (Always)BeneficiaryCreationError
Creation errors of every beneficiary. FieldsThe original position of the beneficiary on the submission file. It starts at 0. (Always)
BeneficiaryCreated
Created beneficiaries. FieldsThe original position of the beneficiary on the submission file. It starts at 0. (Always)
The BeneficiaryCreatedLinks. (Always)