Jump to

• Request
• Response

Get an enrollment

get

/hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}

Request

Path Parameters

• EnrollmentResultId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : benefitEnrollments-item-response

Type: object

Show Source

• costs: array Costs
  Title: Costs

  The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan.
• CoverageAmount: number
  Title: Benefit Coverage Amount

  Read Only: true

  Amount of coverage that a benefit offers.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the benefit record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the benefit record was created.
• CurrencyCode: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 30

  Currency of the coverage amount, such as USD.
• dependents: array Dependents
  Title: Dependents

  The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program.
• EnrollmentCoverageEndDate: string (date)
  Title: Enrollment Coverage End Date

  Read Only: true

  Date when the continuous enrollment coverage ends.
• EnrollmentCoverageStartDate: string (date)
  Title: Enrollment Coverage Start Date

  Read Only: true

  Date when the enrollment coverage starts.
• EnrollmentResultId: integer (int64)
  Title: Enrollment Result ID

  Read Only: true

  Unique identifier of the enrollment result. This is an application generated primary key of the enrollment result.
• InterimFlag: boolean
  Title: Interim

  Read Only: true

  Maximum Length: 30

  Indicates whether the participant has interim coverage for the offering. Valid values are True and False.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the benefit record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the benefit record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NonMonetaryUnit: string
  Title: Nonmonetary Units

  Read Only: true

  Maximum Length: 30

  Nonmonetary unit of measure of the coverage amount, such as shares, hours, and units.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  Read Only: true

  Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried.
• OptionId: integer (int64)
  Title: Option ID

  Read Only: true

  Unique identifier for the enrolled option. This is an application generated primary key.
• OptionName: string
  Title: Option Name

  Read Only: true

  Maximum Length: 240

  Name of the option in which the participant has enrolled.
• OriginalCoverageStartDate: string (date)
  Title: Original Coverage Start Date

  Read Only: true

  Date when the continuous enrollment coverage starts.
• PersonId: integer (int64)
  Title: Person ID

  Read Only: true

  Unique identifier for the participant.
• PersonName: string
  Title: Person Name

  Read Only: true

  Maximum Length: 240

  Display name of the participant.
• PlanId: integer (int64)
  Title: Plan ID

  Read Only: true

  Unique identifier for the enrolled plan. This is an application generated primary key.
• PlanName: string
  Title: Plan Name

  Read Only: true

  Maximum Length: 240

  Name of the plan in which the participant has enrolled.
• PlanTypeId: integer (int64)
  Title: Plan Type ID

  Read Only: true

  Unique identifier for the enrolled plan type. This is an application generated primary key.
• PlanTypeName: string
  Title: Plan Type Name

  Read Only: true

  Maximum Length: 240

  Name of the plan type in which the person enrolled.
• ProgramId: integer (int64)
  Title: Program ID

  Read Only: true

  Unique identifier for the enrolled program. This is an application generated primary key.
• ProgramName: string
  Title: Program Name

  Read Only: true

  Maximum Length: 240

  Name of the benefits program in which the person enrolled.
• providers: array Providers
  Title: Providers

  The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies.
• SuspendFlag: boolean
  Title: Suspended

  Read Only: true

  Maximum Length: 30

  Indicates whether the enrollment is suspended. Valid values are True and False.

{
    "type":"object",
    "properties":{
        "CoverageAmount":{
            "title":"Benefit Coverage Amount",
            "type":"number",
            "description":"Amount of coverage that a benefit offers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the benefit record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the benefit record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"Currency of the coverage amount, such as USD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnrollmentCoverageEndDate":{
            "title":"Enrollment Coverage End Date",
            "type":"string",
            "description":"Date when the continuous enrollment coverage ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnrollmentCoverageStartDate":{
            "title":"Enrollment Coverage Start Date",
            "type":"string",
            "description":"Date when the enrollment coverage starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EnrollmentResultId":{
            "title":"Enrollment Result ID",
            "type":"integer",
            "description":"Unique identifier of the enrollment result. This is an application generated primary key of the enrollment result.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InterimFlag":{
            "title":"Interim",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the participant has interim coverage for the offering. Valid values are True and False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the benefit record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the benefit record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NonMonetaryUnit":{
            "title":"Nonmonetary Units",
            "maxLength":30,
            "type":"string",
            "description":"Nonmonetary unit of measure of the coverage amount, such as shares, hours, and units.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OptionId":{
            "title":"Option ID",
            "type":"integer",
            "description":"Unique identifier for the enrolled option. This is an application generated primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptionName":{
            "title":"Option Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the option in which the participant has enrolled.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "resourceURL":"/resources/latest/benefitOptionsLOV?onlyData=true&finder=PrimaryKey"
            },
            "x-queryable":true
        },
        "OriginalCoverageStartDate":{
            "title":"Original Coverage Start Date",
            "type":"string",
            "description":"Date when the continuous enrollment coverage starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier for the participant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "title":"Plan ID",
            "type":"integer",
            "description":"Unique identifier for the enrolled plan. This is an application generated primary key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanName":{
            "title":"Plan Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the plan in which the participant has enrolled.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "resourceURL":"/resources/latest/benefitPlansLOV?onlyData=true&finder=PrimaryKey"
            },
            "x-queryable":true
        },
        "PlanTypeId":{
            "title":"Plan Type ID",
            "type":"integer",
            "description":"Unique identifier for the enrolled plan type. This is an application generated primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanTypeName":{
            "title":"Plan Type Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the plan type in which the person enrolled.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "resourceURL":"/resources/latest/benefitPlanTypesLOV?onlyData=true&finder=PrimaryKey"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "title":"Program ID",
            "type":"integer",
            "description":"Unique identifier for the enrolled program. This is an application generated primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the benefits program in which the person enrolled.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "resourceURL":"/resources/latest/benefitProgramsLOV?onlyData=true&finder=PrimaryKey"
            },
            "x-queryable":true
        },
        "SuspendFlag":{
            "title":"Suspended",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the enrollment is suspended. Valid values are True and False.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "costs":{
            "title":"Costs",
            "type":"array",
            "description":"The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan.",
            "items":{
                "$ref":"#/components/schemas/benefitEnrollments-costs-item-response"
            }
        },
        "dependents":{
            "title":"Dependents",
            "type":"array",
            "description":"The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program.",
            "items":{
                "$ref":"#/components/schemas/benefitEnrollments-dependents-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "providers":{
            "title":"Providers",
            "type":"array",
            "description":"The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies.",
            "items":{
                "$ref":"#/components/schemas/benefitEnrollments-providers-item-response"
            }
        }
    }
}

Nested Schema : Costs

Type: array

Title: Costs

The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan.

Show Source

• Array of: object benefitEnrollments-costs-item-response

{
    "title":"Costs",
    "type":"array",
    "description":"The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan.",
    "items":{
        "$ref":"#/components/schemas/benefitEnrollments-costs-item-response"
    }
}

Nested Schema : Dependents

Type: array

Title: Dependents

The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program.

Show Source

• Array of: object benefitEnrollments-dependents-item-response

{
    "title":"Dependents",
    "type":"array",
    "description":"The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program.",
    "items":{
        "$ref":"#/components/schemas/benefitEnrollments-dependents-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Providers

Type: array

Title: Providers

The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies.

Show Source

• Array of: object benefitEnrollments-providers-item-response

{
    "title":"Providers",
    "type":"array",
    "description":"The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies.",
    "items":{
        "$ref":"#/components/schemas/benefitEnrollments-providers-item-response"
    }
}

Nested Schema : benefitEnrollments-costs-item-response

Type: object

Show Source

• ActivityTypeCode: string
  Title: Activity Type

  Read Only: true

  Maximum Length: 30

  Activity type for the rate.
• AnnualRateAmount: number
  Title: Annual Rate Amount

  Read Only: true

  Annual rate value.
• CommunicatedRateAmount: number
  Title: Communicated Amount

  Read Only: true

  Communicated amount for the rate.
• EnrollmentResultId: integer (int64)
  Title: Enrollment Result ID

  Read Only: true

  Unique identifier for the enrollment result. This is an application generated primary key of the enrollment result.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RateEndDate: string (date)
  Title: Rate End Date

  Read Only: true

  Date when the rate ends.
• RateStartDate: string (date)
  Title: Rate Start Date

  Read Only: true

  Date when the rate starts.
• RateValueId: integer (int64)
  Title: Rate Value ID

  Read Only: true

  Unique identifier for the rate value. This is an application generated primary key.
• TaxTypeCode: string
  Title: Tax Type

  Read Only: true

  Maximum Length: 30

  Tax type for the rate.

{
    "type":"object",
    "properties":{
        "ActivityTypeCode":{
            "title":"Activity Type",
            "maxLength":30,
            "type":"string",
            "description":"Activity type for the rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnnualRateAmount":{
            "title":"Annual Rate Amount",
            "type":"number",
            "description":"Annual rate value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":15,
                "scale":2
            }
        },
        "CommunicatedRateAmount":{
            "title":"Communicated Amount",
            "type":"number",
            "description":"Communicated amount for the rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":15,
                "scale":2
            }
        },
        "EnrollmentResultId":{
            "title":"Enrollment Result ID",
            "type":"integer",
            "description":"Unique identifier for the enrollment result. This is an application generated primary key of the enrollment result.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateEndDate":{
            "title":"Rate End Date",
            "type":"string",
            "description":"Date when the rate ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RateStartDate":{
            "title":"Rate Start Date",
            "type":"string",
            "description":"Date when the rate starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RateValueId":{
            "title":"Rate Value ID",
            "type":"integer",
            "description":"Unique identifier for the rate value. This is an application generated primary key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxTypeCode":{
            "title":"Tax Type",
            "maxLength":30,
            "type":"string",
            "description":"Tax type for the rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : benefitEnrollments-dependents-item-response

Type: object

Show Source

• CoveredDependentId: integer (int64)
  Title: Covered Dependent ID

  Read Only: true

  Unique identifier for the covered dependent. This is an application generated primary key.
• DependentCoverageEndDate: string
  Title: Coverage End Date

  Read Only: true

  Maximum Length: 18

  Date when the benefit coverage ends.
• DependentCoverageStartDate: string (date)
  Title: Coverage Start Date

  Read Only: true

  Date when the benefit coverage starts.
• DependentName: string
  Title: Dependent Name

  Read Only: true

  Maximum Length: 240

  Display name of the covered dependent .
• DependentPersonId: integer (int64)
  Title: Dependent Person ID

  Read Only: true

  Unique identifier for the dependent. This is an application generated primary key.
• EnrollmentResultId: integer (int64)
  Title: Enrollment Result ID

  Read Only: true

  Unique identifier for the enrollment result. This is an application generated primary key of the enrollment result.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelationshipCode: string
  Read Only: true

  Maximum Length: 30

  Relationship of the dependent with the participant.

{
    "type":"object",
    "properties":{
        "CoveredDependentId":{
            "title":"Covered Dependent ID",
            "type":"integer",
            "description":"Unique identifier for the covered dependent. This is an application generated primary key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DependentCoverageEndDate":{
            "title":"Coverage End Date",
            "maxLength":18,
            "type":"string",
            "description":"Date when the benefit coverage ends.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DependentCoverageStartDate":{
            "title":"Coverage Start Date",
            "type":"string",
            "description":"Date when the benefit coverage starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DependentName":{
            "title":"Dependent Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the covered dependent .",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "resourceURL":"/resources/latest/contacts?onlyData=true&fields=names:DisplayName&finder=findByPersonId"
            },
            "x-queryable":true
        },
        "DependentPersonId":{
            "title":"Dependent Person ID",
            "type":"integer",
            "description":"Unique identifier for the dependent. This is an application generated primary key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrollmentResultId":{
            "title":"Enrollment Result ID",
            "type":"integer",
            "description":"Unique identifier for the enrollment result. This is an application generated primary key of the enrollment result.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "maxLength":30,
            "type":"string",
            "description":"Relationship of the dependent with the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : benefitEnrollments-providers-item-response

Type: object

Show Source

• CustomerNumber: number
  Title: Customer Identifier Number

  Read Only: true

  Customer number for the provider organization.
• EffectiveEndDate: string (date)
  Title: End Date

  Read Only: true

  Date when the provider organization ceases to be effective.
• EffectiveStartDate: string (date)
  Title: Start Date

  Read Only: true

  Start date when the provider organization is effective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Title: Organization ID

  Read Only: true

  Unique identifier for the organization. This is an application generated primary key.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  Maximum Length: 240

  Name of the plan provider organization.
• PlanId: integer (int64)
  Title: Plan ID

  Read Only: true

  Unique identifier for the provider plan. This is an application generated primary key.
• PolicyNumber: string
  Title: Policy or Group Identifier

  Read Only: true

  Maximum Length: 90

  Unique identifier for the policy or group. This is an application generated primary key.
• ProviderOrganizationId: integer
  Title: Provider Organization ID

  Read Only: true

  Unique identifier for the plan provider organization. This is an application generated primary key.
• providerRoles: array Provider Roles
  Title: Provider Roles

  The providerRoles resource is a child of the providers resource. It includes the services or functions performed by an organization to the participants of the enrolled plan.

{
    "type":"object",
    "properties":{
        "CustomerNumber":{
            "title":"Customer Identifier Number",
            "type":"number",
            "description":"Customer number for the provider organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the provider organization ceases to be effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date when the provider organization is effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Unique identifier for the organization. This is an application generated primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the plan provider organization.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "resourceURL":"/resources/latest/organizations?onlyData=true&finder=findByOrganizationId"
            },
            "x-queryable":true
        },
        "PlanId":{
            "title":"Plan ID",
            "type":"integer",
            "description":"Unique identifier for the provider plan. This is an application generated primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PolicyNumber":{
            "title":"Policy or Group Identifier",
            "maxLength":90,
            "type":"string",
            "description":"Unique identifier for the policy or group. This is an application generated primary key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProviderOrganizationId":{
            "title":"Provider Organization ID",
            "type":"integer",
            "description":"Unique identifier for the plan provider organization. This is an application generated primary key.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "providerRoles":{
            "title":"Provider Roles",
            "type":"array",
            "description":"The providerRoles resource is a child of the providers resource. It includes the services or functions performed by an organization to the participants of the enrolled plan.",
            "items":{
                "$ref":"#/components/schemas/benefitEnrollments-providers-providerRoles-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Provider Roles

Type: array

Title: Provider Roles

The providerRoles resource is a child of the providers resource. It includes the services or functions performed by an organization to the participants of the enrolled plan.

Show Source

• Array of: object benefitEnrollments-providers-providerRoles-item-response

{
    "title":"Provider Roles",
    "type":"array",
    "description":"The providerRoles resource is a child of the providers resource. It includes the services or functions performed by an organization to the participants of the enrolled plan.",
    "items":{
        "$ref":"#/components/schemas/benefitEnrollments-providers-providerRoles-item-response"
    }
}

Nested Schema : benefitEnrollments-providers-providerRoles-item-response

Type: object

Show Source

• DesigneeName: string
  Title: Organization Designee

  Read Only: true

  Maximum Length: 240

  Name of the organization role in the program or plan.
• DesigneeRole: string
  Title: Organization Role

  Read Only: true

  Maximum Length: 80

  Organization role type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProviderOrganizationId: integer (int64)
  Title: Provider Organization ID

  Read Only: true

  Unique identifier for the plan provider organization. This is an application generated primary key.
• ProviderOrganizationRoleId: integer
  Title: Provider Organization Role ID

  Read Only: true

  Unique identifier for the provider organization role. This is an application generated primary key.

{
    "type":"object",
    "properties":{
        "DesigneeName":{
            "title":"Organization Designee",
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization role in the program or plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DesigneeRole":{
            "title":"Organization Role",
            "maxLength":80,
            "type":"string",
            "description":"Organization role type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProviderOrganizationId":{
            "title":"Provider Organization ID",
            "type":"integer",
            "description":"Unique identifier for the plan provider organization. This is an application generated primary key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProviderOrganizationRoleId":{
            "title":"Provider Organization Role ID",
            "type":"integer",
            "description":"Unique identifier for the provider organization role. This is an application generated primary key.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

costs

Operation: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/costs

Parameters:

• EnrollmentResultId: $request.path.EnrollmentResultId

The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan.

dependents

Operation: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/dependents

Parameters:

• EnrollmentResultId: $request.path.EnrollmentResultId

The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program.

providers

Operation: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/providers

Parameters:

• EnrollmentResultId: $request.path.EnrollmentResultId

The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies.

Back to Top