AeAssessmentAction

Name / Description Type / Format Example
action
The action that is being taken as a result of this assessment
string "NoChange" "Enrol" "Exit" "Inconclusive"
employeeState
The user action, if any, that triggered this assessment
string "Automatic" "OptOut" "OptIn" "VoluntaryJoiner" "ContractualPension" "CeasedMembership" "Leaver" "Excluded" "Enrol"
actionCompleted
Indicates whether or not the required action was successfully completed
boolean true
actionCompletedMessage
Gives further information about the action taken or the reason if wasn't successfully completed
string "string"
requiredLetter
If a letter is required to be sent to the Employee due to this action then it'll be specified here.
string "B1" "B2" "B3"
pensionSchemeId
The PensionSchemeId that a completed action relates to
string uuid "string"
workerGroupId
The WorkerGroupId that a completed action relates to
string uuid "string"
letterNotYetSent
Indicates whether or not any required letter has been sent
boolean true
{
  "action": "NoChange",
  "employeeState": "Automatic",
  "actionCompleted": true,
  "actionCompletedMessage": "string",
  "requiredLetter": "B1",
  "pensionSchemeId": "string",
  "workerGroupId": "string",
  "letterNotYetSent": true
}
Contained in Models
AeAssessment
Consumed by Operations

- none -

Returned by Operations

- none -