Create results for other eligible credits for a tax credit screening
post
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/OtherEligibleCredits
Request
Path Parameters
-
PackageResultId(required): string
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=
-
recruitingTaxCreditsCandidateResultsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PartnerId, RequisitionNumber and CandidateNumber ---for the Recruiting Tax Credits Results resource and used to uniquely identify an instance of Recruiting Tax Credits Results. The client should not generate the hash key value. Instead, the client should query on the Recruiting Tax Credits Results collection resource with a filter on the primary key values in order to navigate to a specific instance of Recruiting Tax Credits Results.
For example: recruitingTaxCreditsCandidateResults?q=PartnerId=<value1>;RequisitionNumber=<value2>;CandidateNumber=<value3>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdditionalResultId: string
Result ID for the other tax credit.
-
Comments: string
Comments for the other tax credit.
-
CreditsEligibleFlag: boolean
Maximum Length:
255
Indicates whether the candidate is eligible for the tax credit. -
CreditsEstimate: string
Maximum Length:
255
Other tax credit estimated amount. -
CreditsEstimateCurrencyCode: string
Other tax credit currency code.
-
CreditsIdentifier: string
Other tax credit identifier.
-
CreditsName: string
Other tax credit name.
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.
Root Schema : recruitingTaxCreditsCandidateResults-packages-OtherEligibleCredits-item-response
Type:
Show Source
object
-
AdditionalResultId: string
Result ID for the other tax credit.
-
Comments: string
Comments for the other tax credit.
-
CreditsEligibleFlag: boolean
Maximum Length:
255
Indicates whether the candidate is eligible for the tax credit. -
CreditsEstimate: string
Maximum Length:
255
Other tax credit estimated amount. -
CreditsEstimateCurrencyCode: string
Other tax credit currency code.
-
CreditsIdentifier: string
Other tax credit identifier.
-
CreditsName: string
Other tax credit name.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.