Worker Assignments

Describes a relationship between an Application and an Agency Worker. Multiple Agency Workers may be assigned to an Application for different purposes - an Application may have an approvals worker and a case carrying worker, for example. See the possible options for the "role" key in the below schema for the different possible Worker Assignments.

id* (string) - The primary key for the record.
type* (string) - The JSON:API type specifier.
attributes* (object) - Primary record attributes.
- created-at* (string) - Date and time that the worker was assigned to the Application.
- role* (string) - The assigned worker's role on the Application.
  Allowed values
  - approvals
  - support
  - cbo
relationships (object) - Related objects. For each relationship, you can find detailed information about the object by issuing another API call to look it up by ID, or for certain endpoints, you will find details in the "included" section.
- applicant-profile (object) - A relationship with a single entry.
  - data* (object) - A reference to the User Agency Profile of the applicant to whom this Agency Worker is assigned.
    - id* (string) - The ID of the other object.
    - type* (string) - Always user-agency-profiles
      Allowed values
      
      user-agency-profiles
- application (object) - A relationship with a single entry.
  - data* (object) - A reference to the Application to which this Agency Worker is assigned.
    - id* (string) - The ID of the other object.
    - type* (string) - Always initial-applications / renewal-applications
      Allowed values
      
      initial-applications
      
      renewal-applications
- worker (object) - A relationship with a single entry.
  - data* (object) - A reference to the Agency Worker for this worker assignment.
    - id* (string) - The ID of the other object.
    - type* (string) - Always agency-workers
      Allowed values
      
      agency-workers