Contract.AeAssessmentAction

Schema

Name / Description Type / Format Example
action string "NoChange" "Enrol" "Exit" "Inconclusive" "Postpone" "ReEnrol"
employeeState 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 string "B1" "B2" "B3" "B4"
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

JSON Example 

{
  "action": "NoChange",
  "employeeState": "Automatic",
  "actionCompleted": true,
  "actionCompletedMessage": "string",
  "requiredLetter": "B1",
  "pensionSchemeId": "string",
  "workerGroupId": "string",
  "letterNotYetSent": true
}

References

Contained in Models
Contract.AeAssessmentResponse
Consumed by Operations

- none -

Returned by Operations

- none -