Jump to

• Request
• Response

GET action not supported

get

/hcmRestApi/resources/11.13.18.05/healthCareFsaCalculator/{healthCareFsaCalculatorUniqID}

Request

Path Parameters

• healthCareFsaCalculatorUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Health Care FSA Calculators resource and used to uniquely identify an instance of Health Care FSA Calculators. The client should not generate the hash key value. Instead, the client should query on the Health Care FSA Calculators collection resource in order to navigate to a specific instance of Health Care FSA Calculators to get the hash key.

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:
  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.

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(required):
  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(required):
  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 : healthCareFsaCalculator-item-response

Type: object

Show Source

• AnnualDeductible: string
  Medical annual deductible of the employee.
• AnnualIncome: string
  Annual income of the employee.
• AnnualLimit: number
  Annual contribution limit for the employee's health care FSA.
• Copayment: string
  Copayment and coinsurance amount paid by the employee.
• Currency: string
  Maximum Length: 80

  Symbol of the currency.
• DentalExpense: string
  Dental expenses of the employee.
• EligibleOtcExpense: string
  Eligible over-the-counter items expenses of the employee.
• EstimatedTaxRate: string
  Estimated tax rate applicable for the employee.
• EyeExamExpense: string
  Expenses of the employee for eye examinations, contacts and glasses.
• HospitalizationExpense: string
  Hospitalization or surgery expenses of the employee.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OtherMedicalExpenses: string
  Other medical expenses of the employee.
• PotentialTaxSavings: string
  Potential tax savings of the employee.
• PrescriptionDrugExpense: string
  Expenses of the employee for prescription drugs.
• RecommendedContribution: string
  Recommended contribution by the employee.
• SpecialtyCareExpense: string
  Specialty care expenses of the employee.
• TaxYear: string
  Maximum Length: 80

  Start year for taxes.

{
    "type":"object",
    "properties":{
        "EligibleOtcExpense":{
            "type":"string",
            "description":"Eligible over-the-counter items expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "PrescriptionDrugExpense":{
            "type":"string",
            "description":"Expenses of the employee for prescription drugs.",
            "nullable":true,
            "x-queryable":true
        },
        "SpecialtyCareExpense":{
            "type":"string",
            "description":"Specialty care expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualLimit":{
            "type":"number",
            "description":"Annual contribution limit for the employee's health care FSA.",
            "nullable":true,
            "x-queryable":true
        },
        "PotentialTaxSavings":{
            "type":"string",
            "description":"Potential tax savings of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualDeductible":{
            "type":"string",
            "description":"Medical annual deductible of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "HospitalizationExpense":{
            "type":"string",
            "description":"Hospitalization or surgery expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "DentalExpense":{
            "type":"string",
            "description":"Dental expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherMedicalExpenses":{
            "type":"string",
            "description":"Other medical expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendedContribution":{
            "type":"string",
            "description":"Recommended contribution by the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "EyeExamExpense":{
            "type":"string",
            "description":"Expenses of the employee for eye examinations, contacts and glasses.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedTaxRate":{
            "type":"string",
            "description":"Estimated tax rate applicable for the employee.",
            "nullable":false,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":80,
            "type":"string",
            "description":"Symbol of the currency.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Copayment":{
            "type":"string",
            "description":"Copayment and coinsurance amount paid by the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualIncome":{
            "type":"string",
            "description":"Annual income of the employee.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxYear":{
            "maxLength":80,
            "type":"string",
            "description":"Start year for taxes.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Back to Top