Workday Benefit Enrollment Event Offerings v1 — full pinned service

Runtime

/api/purple-suite/{instanceId}/contracts/hris/workday

[
  {
    "method": "get",
    "path": "/benefitEnrollmentEventOfferings/v1/employeeEnrollmentEvent",
    "operationId": "workdayBenefitEnrollmentEventOfferingsGetEmployeeEnrollmentEvent"
  },
  {
    "method": "get",
    "path": "/benefitEnrollmentEventOfferings/v1/employeeEnrollmentEvent/:ID",
    "operationId": "workdayBenefitEnrollmentEventOfferingsGetEmployeeEnrollmentEventByID"
  }
]

Credentials

• OAuth 2.0 bearer token: Authorization: Bearer <TOKEN>

  The painted runtime validates a PurpleSuite instance key in the Workday bearer-token transport.

  Credential model: instance-key

Coverage and limitations

{
  "documentScope": "full",
  "runtimeFidelity": "modeled",
  "counts": {
    "operations": 2
  },
  "notes": [
    "All 2 operations in the pinned 2026-07-27 Workday Benefit Enrollment Event Offerings v1 artifact are mounted: 0 captured handlers and 2 per-instance repository-backed operations.",
    "Modeled reads return stored resources, relationship-scoped collections, or native 404s; modeled writes provide read-after-write lifecycle behavior and never return request-seeded schema witnesses.",
    "Full means the complete pinned service artifact, not the whole Workday platform.",
    "Explicitly excluded: Workday Web Services (SOAP/WWS); Workday Graph API; Workday Query Language (WQL), a separate Platform API family; Reports-as-a-Service (RaaS) and tenant custom reports; Finance, Payroll, Student, and non-HR Platform REST services; Experimental alpha, beta, and labs services; Tenant-configured actions absent from the pinned public artifacts."
  ]
}

Servers

[
  {
    "url": "/api/purple-suite/{instanceId}/contracts/hris/workday",
    "description": "PurpleSuite Workday-painted instance boundary",
    "variables": {
      "instanceId": {
        "default": "INSTANCE_ID",
        "description": "PurpleSuite instance identifier"
      }
    }
  }
]

Authentication schemes

{
  "OAuth2": {
    "type": "oauth2",
    "flows": {
      "implicit": {
        "authorizationUrl": "https://<tenantAuthorizationHostname>",
        "scopes": {}
      }
    }
  }
}

Each operation lists its security requirements. An empty security array permits an unauthenticated request. Use the scheme and headers declared for the selected contract.

Operations

• GET /benefitEnrollmentEventOfferings/v1/employeeEnrollmentEvent
• GET /benefitEnrollmentEventOfferings/v1/employeeEnrollmentEvent/{ID}

[
  {
    "OAuth2": []
  }
]

{
  "tags": [
    "employeeEnrollmentEvent"
  ],
  "summary": "Retrieves the latest benefit enrollment event of the processing worker.",
  "description": "Retrieves the latest benefit enrollment event of the processing worker.\n\n<b>Secured By Domain:</b> Self-Service: Benefit Elections, Self-Service: Retirement Savings\n\n<b>Scope:</b> Benefits",
  "parameters": [
    {
      "name": "enrollmentOfferingTypeWID",
      "in": "query",
      "description": "WID of Enrollment Offering Type such as Medical, Dental, Vision, 401(k), Basic Group Life etc",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "onlyCurrentElections",
      "in": "query",
      "description": "Boolean value. If it is true, the API would return the current active enrollment offerings of the processing worker as of processing date. If false, API returns the most latest enrollment offerings of the worker that could be from the most latest finalized or not started/in progress future event.",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "planType",
      "in": "query",
      "description": "Benefit Election or Plan Type such as \"Healthcare\", \"Retirement Savings\"",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/enrollmentOfferingsByType_4d0b89015192100018e31387450f0000"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "4d0b89015192100018f781eb621d0000",
  "x-workday-secured-by-domains": [
    "Self-Service: Benefit Elections",
    "Self-Service: Retirement Savings"
  ]
}

[
  {
    "OAuth2": []
  }
]

{
  "tags": [
    "employeeEnrollmentEvent"
  ],
  "summary": "Retrieves the latest benefit enrollment event of the processing worker. This resource will return one event that is New, In Progress or the latest finalized.",
  "description": "Retrieves the latest benefit enrollment event of the processing worker. This resource will return one event that is New, In Progress or the latest finalized.\n\n<b>Secured By Domain:</b> Self-Service: Benefit Elections, Self-Service: Retirement Savings\n\n<b>Scope:</b> Benefits",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/enrollmentOfferingsByType_4d0b89015192100018e31387450f0000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "4d0b89015192100018f781eb621d0000",
  "x-workday-secured-by-domains": [
    "Self-Service: Benefit Elections",
    "Self-Service: Retirement Savings"
  ]
}

Schemas and reusable components

{
  "required": [
    "id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$",
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance",
      "readOnly": true
    },
    "href": {
      "type": "string",
      "description": "A link to the instance",
      "readOnly": true
    }
  }
}

{
  "required": [
    "error"
  ],
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "A description of the error"
    },
    "code": {
      "type": "string",
      "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change"
    },
    "field": {
      "type": "string",
      "description": "The field related to the error"
    },
    "path": {
      "type": "string",
      "description": "The path of the field related to the error"
    },
    "severity": {
      "type": "string",
      "description": "Severity of the validation (e.g. Critical, Warning)."
    },
    "internalMessage": {
      "type": "string",
      "description": "Internal message providing additional context for the validation (e.g. representation content validation details)."
    }
  }
}

{
  "allOf": [
    {
      "required": [
        "error"
      ],
      "type": "object",
      "properties": {
        "error": {
          "type": "string",
          "description": "A description of the error"
        },
        "errors": {
          "type": "array",
          "description": "An array of validation errors",
          "items": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  ]
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "descriptor": {
        "type": "string",
        "description": "A description of the facet"
      },
      "facetParameter": {
        "type": "string",
        "description": "The alias used to select the facet"
      },
      "values": {
        "type": "array",
        "description": "the facet values",
        "items": {
          "required": [
            "id"
          ],
          "type": "object",
          "properties": {
            "count": {
              "type": "integer",
              "description": "The number of instances returned by this facet",
              "format": "int32"
            },
            "id": {
              "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$",
              "type": "string",
              "description": "Workday Id or Reference Id of the instance."
            },
            "descriptor": {
              "type": "string",
              "description": "A description of the facet"
            },
            "href": {
              "type": "string",
              "description": "A link to the instance",
              "readOnly": true
            }
          }
        }
      }
    },
    "description": "This object represents the possible facets for this resource",
    "readOnly": true
  }
}

{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int32"
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
      }
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/retirementSavingsElections_86947b855674100011207a1074c40000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Enrollment Offering"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/healthcareElections_12efc4fddc4010001d8e4d466d7b0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Enrollment Offering"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "retirementSavingsEnrollmentOfferings": {
          "type": "array",
          "description": "Retirement Savings Enrollment Offerings for Employee Enrollment Event",
          "items": {
            "$ref": "#/components/schemas/retirementSavingsEnrollmentOfferings_bb9c89eab9d6100025935561ee690000"
          },
          "x-workday-type": "Multi-instance"
        },
        "healthcareEnrollmentOfferings": {
          "type": "array",
          "description": "Healthcare Enrollment Offerings for Employee Enrollment Event",
          "items": {
            "$ref": "#/components/schemas/healthcareEnrollmentOfferings_4d0b8901519210001cbee1efecdb0000"
          },
          "x-workday-type": "Multi-instance"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Employee Enrollment Event"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/healthcareElectionsInEnrollmentOffering_12efc4fddc4010001bbe501350b30000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Health Care Election"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "healthcareElectionsFromEnrollmentOffering": {
          "type": "array",
          "description": "Health Care Elections in Health Care Enrollment Offering",
          "items": {
            "$ref": "#/components/schemas/healthcareElectionsFromEnrollmentOffering_12efc4fddc4010001d8e4d466d7b0001"
          },
          "x-workday-type": "Multi-instance"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Enrollment Offering"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "beneficiaryName": {
          "type": "string",
          "description": "The name of the beneficiary the allocation is for.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text",
          "x-workday-confidence-level": "Production"
        },
        "contingentPercentage": {
          "type": "number",
          "description": "The Contingent Percentage allocation for the beneficiary.",
          "format": "double",
          "example": 999.99,
          "x-workday-type": "Numeric",
          "x-workday-confidence-level": "Production"
        },
        "primaryPercentage": {
          "type": "number",
          "description": "The Primary Percentage allocation for the Beneficiary.",
          "format": "double",
          "example": 999.99,
          "x-workday-type": "Numeric",
          "x-workday-confidence-level": "Production"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

{
  "description": "coverage Level",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "coverageLevel": {
          "$ref": "#/components/schemas/coverageLevel_4f42502ff6c510000ed6f1333f850001"
        },
        "employeeCost": {
          "type": "string",
          "description": "Employee Cost",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/retirementSavingsElectionsForEnrollmentOffering_86947b855674100011980aa390a30000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Retirement Savings Election"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "retirementSavingsElectionsForEnrollmentOffering": {
          "type": "array",
          "description": "Retirement Savings Elections For Enrollment Offering",
          "items": {
            "$ref": "#/components/schemas/retirementSavingsElectionsForEnrollmentOffering_86947b855674100011207aaa23530000"
          },
          "x-workday-type": "Multi-instance"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Enrollment Offering"
        }
      }
    }
  ]
}

{
  "description": "The default time frequency associated to a benefit plan, such as Monthly or Semi-Monthly.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/beneficiaryAllocation_86947b85567410001c8e5f2717520000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Beneficiary Allocation"
        }
      }
    }
  ]
}

{
  "description": "The type of the benefit plan, such as Medical, Dental, Vision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "description": "The name of the benefit plan the \\~worker\\~ selects for the enrollment election.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "planFrequency": {
          "$ref": "#/components/schemas/planFrequency_86947b85567410001c2b97213a490000"
        },
        "employerContributionAmountByPlanFrequency": {
          "type": "string",
          "description": "The amount the employer contributes towards an \\~employee's\\~ retirement savings account election. Example: $1,000",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "employeeContributionPercentage": {
          "type": "number",
          "description": "The percentage of pay that an \\~employee\\~ contributes to a retirement savings plan only if in the settings we are showing \\~employee\\~ contribution.",
          "format": "double",
          "example": 999.99,
          "x-workday-type": "Numeric"
        },
        "employerContributionPercent": {
          "type": "number",
          "description": "The percentage the employer contributes towards an \\~employee's\\~ retirement savings account election. Example: 3%",
          "format": "double",
          "example": 999.99,
          "x-workday-type": "Numeric"
        },
        "employeeContributionAmountMinimumByPlanFrequency": {
          "type": "string",
          "description": "The minimum amount an \\~employee\\~ contributes for a retirement savings account election. Example: $1.00",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "employeeContributionAmountByPlanFrequency": {
          "type": "object",
          "description": "The amount that an \\~employee\\~ will contribute to the cost of the benefit plan per the time frequency associated to the plan.",
          "example": "99999999999.999999",
          "x-workday-type": "Currency"
        },
        "employeeContributionAmountMaximumByPlanFrequency": {
          "type": "string",
          "description": "The maximum amount an \\~employee\\~ contributes for a retirement savings account election. Example: $20,000",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "employeeContributionPercentageMinimum": {
          "type": "number",
          "description": "The minimum percentage an \\~employee\\~ contributes for a retirement savings account election. Example: 0%",
          "format": "double",
          "example": 999.99,
          "x-workday-type": "Numeric"
        },
        "employeeContributionPercentageMaximum": {
          "type": "number",
          "description": "The maximum percentage an \\~employee\\~ contributes for a retirement savings account election. Example: 100%",
          "format": "double",
          "example": 999.99,
          "x-workday-type": "Numeric"
        },
        "beneficiaryAllocation": {
          "type": "array",
          "description": "The beneficiary's allocation for the enrollment election.",
          "items": {
            "$ref": "#/components/schemas/beneficiaryAllocation_86947b85567410001c20970c1cc90000"
          },
          "x-workday-type": "Multi-instance"
        },
        "enrollmentOfferingType": {
          "$ref": "#/components/schemas/enrollmentOfferingType_86947b85567410001bba474ce3f90000"
        },
        "planName": {
          "$ref": "#/components/schemas/planName_86947b855674100011980b4952990000"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

{
  "description": "Returns the Person for the Dependent Election",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "description": "Relationship Type of the Dependent Person for the Dependent Election",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "dependent": {
          "$ref": "#/components/schemas/dependent_bb9c89eab9d6100021d0b03bd5010000"
        },
        "providerID": {
          "type": "string",
          "description": "The Provider ID selected for the dependent on the health care election.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "dependentRelationship": {
          "$ref": "#/components/schemas/dependentRelationship_bb9c89eab9d6100021d0b03bd5010002"
        },
        "couldBeCoveredForHealthcareCoverageElsewhere": {
          "type": "boolean",
          "description": "Returns whether the Dependent could covered for health care elsewhere (relevant for spousal surcharge)",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "The id for Dependent Election"
        }
      }
    }
  ]
}

{
  "description": "Benefit Plan for Election",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/dependentElectionView_bb9c89eab9d6100021d0afa20a5e0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Dependent Election"
        }
      }
    }
  ]
}

{
  "description": "The health care coverage target selected for the health care election.  Examples include EE Only, EE + 1 dependent, and EE + 2 or more dependents.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "description": "Benefit Plan Frequency",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "description": "Benefit Plan Currency",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "description": "The type of the benefit plan, such as Medical, Dental, Vision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/healthcareCoverageOptions_4f42502ff6c510000ed6f1333f850000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Derived Health Care Coverage Cost"
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "benefitPlanForElection": {
          "$ref": "#/components/schemas/benefitPlanForElection_9234851c14b210002a58789b3fb20000"
        },
        "employerCostPerPlanFrequency": {
          "type": "object",
          "description": "The amount that an employer will contribute to the cost of the benefit plan per the time frequency associated to the plan.",
          "example": "99999999999.999999",
          "x-workday-type": "Currency"
        },
        "benefitPlanExternalDescriptionURL": {
          "type": "string",
          "description": "Benefit Election's Benefit Plan External Plan Description URL",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "benefitProviderWebsite": {
          "type": "string",
          "description": "Benefit Provider External URL for Benefit Election",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "employeeCostPerPlanFrequency": {
          "type": "object",
          "description": "The amount that an \\~employee\\~ will contribute to the cost of the benefit plan per the time frequency associated to the plan.",
          "example": "99999999999.999999",
          "x-workday-type": "Currency"
        },
        "dependentElections": {
          "type": "array",
          "description": "Dependent Elections",
          "items": {
            "$ref": "#/components/schemas/dependentElections_bb9c89eab9d61000101ef432e76c0000"
          },
          "x-workday-type": "Multi-instance"
        },
        "healthcareCoverageTarget": {
          "$ref": "#/components/schemas/healthcareCoverageTarget_57271b00461a10001bf1eb601a2b0000"
        },
        "benefitPlanProviderAndName": {
          "type": "string",
          "description": "Benefit Plan provider description",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "planFrequency": {
          "$ref": "#/components/schemas/planFrequency_9234851c14b21000284617a46c4b0001"
        },
        "benefitPlanCurrency": {
          "$ref": "#/components/schemas/benefitPlanCurrency_9234851c14b21000284617a46c4b0002"
        },
        "expandedBenefitPlanDetailsAdditionalText": {
          "type": "string",
          "description": "Customized information to describe benefit plan details, as of the effective date.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Rich Text"
        },
        "expandedPlanDetails": {
          "type": "string",
          "description": "Expanded Plan Details",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "enrollmentOfferingType": {
          "$ref": "#/components/schemas/enrollmentOfferingType_12efc4fddc4010001bbe501350b30002"
        },
        "coverageOptions": {
          "type": "array",
          "description": "Coverage Options",
          "items": {
            "$ref": "#/components/schemas/coverageOptions_12efc4fddc4010001bbe501350b30001"
          },
          "x-workday-type": "Multi-instance"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "The id for Health Care Election"
        }
      }
    }
  ]
}

{
  "type": "oauth2",
  "flows": {
    "implicit": {
      "authorizationUrl": "https://<tenantAuthorizationHostname>",
      "scopes": {}
    }
  }
}

Document metadata and extensions

{
  "openapi": "3.0.1",
  "info": {
    "title": "benefitEnrollmentEventOfferings",
    "description": "The Benefit Enrollment Event Offerings REST API enable you to get worker benefit enrollment offerings for a single and active benefit enrollment event.",
    "version": "v1",
    "x-workday-confidence-level": "Production",
    "x-workday-internal-source": "xo",
    "x-workday-internal-routing": "Public",
    "x-workday-internal-protected-usage-enabled": false,
    "x-workday-internal-service-container-id": "1370b5d6990210001992ceff87f70001"
  },
  "tags": [
    {
      "name": "employeeEnrollmentEvent",
      "description": "Processing Worker's Latest Employee Enrollment Event"
    }
  ],
  "security": [
    {
      "OAuth2": []
    }
  ],
  "x-purple-suite-contract": "full-service-repository-modeled-runtime",
  "x-purple-suite-upstream-servers": [
    {
      "url": "https://<tenantHostname>/benefitEnrollmentEventOfferings/v1"
    }
  ],
  "x-purple-suite-runtime-fidelity": {
    "capturedOperationIds": [],
    "modeledOperationIds": [
      "workdayBenefitEnrollmentEventOfferingsGetEmployeeEnrollmentEvent",
      "workdayBenefitEnrollmentEventOfferingsGetEmployeeEnrollmentEventByID"
    ],
    "operations": [
      {
        "operationId": "workdayBenefitEnrollmentEventOfferingsGetEmployeeEnrollmentEvent",
        "method": "get",
        "path": "/benefitEnrollmentEventOfferings/v1/employeeEnrollmentEvent",
        "upstreamPath": "/employeeEnrollmentEvent",
        "fidelity": "modeled",
        "xWorkdayOperationId": "4d0b89015192100018f781eb621d0000"
      },
      {
        "operationId": "workdayBenefitEnrollmentEventOfferingsGetEmployeeEnrollmentEventByID",
        "method": "get",
        "path": "/benefitEnrollmentEventOfferings/v1/employeeEnrollmentEvent/{ID}",
        "upstreamPath": "/employeeEnrollmentEvent/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "4d0b89015192100018f781eb621d0000"
      }
    ]
  },
  "x-purple-suite-exclusions": [
    "Workday Web Services (SOAP/WWS)",
    "Workday Graph API",
    "Workday Query Language (WQL), a separate Platform API family",
    "Reports-as-a-Service (RaaS) and tenant custom reports",
    "Finance, Payroll, Student, and non-HR Platform REST services",
    "Experimental alpha, beta, and labs services",
    "Tenant-configured actions absent from the pinned public artifacts"
  ]
}