GET action not supported
get
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds tax credit results using a unique key.
Finder Variables- CandidateNumber; string; Candidate number of the candidate.
- PartnerId; string; Partner ID for the recruiting tax credits account.
- RequisitionNumber; string; Unique number assigned to each job requisition.
- PrimaryKey Finds tax credit results using a unique key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CandidateNumber; string; Candidate number of the candidate.
- CandidateToken; string; Candidate token in the recruiting tax credits candidate results.
- ClientReferenceKey; string; Client reference key for the recruiting tax credits account.
- PartnerId; string; Partner ID for the recruiting tax credits account.
- RequisitionNumber; string; Unique number assigned to each job requisition.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingTaxCreditsCandidateResults-item-response
Type:
Show Source
object
-
CandidateNumber: string
Candidate number of the candidate.
-
CandidateToken: string
Candidate token in the recruiting tax credits candidate results.
-
ClientReferenceKey: string
Client reference key for the recruiting tax credits account.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
packages: array
Recruiting Tax Credits Package Results
Title:
Recruiting Tax Credits Package Results
The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PartnerId: string
Maximum Length:
255
Partner ID for the recruiting tax credits account. -
RequisitionNumber: string
Unique number assigned to each job requisition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recruiting Tax Credits Package Results
Type:
array
Title:
Recruiting Tax Credits Package Results
The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
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.
Nested Schema : recruitingTaxCreditsCandidateResults-packages-item-response
Type:
Show Source
object
-
AdditionalResultsAttributes: array
Additional Candidate Tax Credits Results
Title:
Additional Candidate Tax Credits Results
The additionalResultsAttributes resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes additional results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Comments: string
Comments for the overall result.
-
CreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for any credits.
-
CreditsEstimateCurrencyCode: string
Currency code for the tax credits estimate.
-
FederalCreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for federal credits.
-
FederalCreditsEstimate: string
Specifies the federal tax credits estimate for the candidate.
-
FederalCreditsIdentifier: string
Specifies the federal tax credits identifier.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherEligibleCredits: array
Other Eligible Credits for Recruiting Tax Credits Package Results
Title:
Other Eligible Credits for Recruiting Tax Credits Package Results
The otherEligibleCredits resource is a child of the packages resource. It includes all other eligible credits the candidate has been reviewed for. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PackageCode: string
Unique code identifying the tax credits package.
-
PackageName: string
Name of the tax credits account package.
-
PackageResultId: string
Unique ID for each recruiting tax credits package result.
-
StateCreditsEligibleFlag: boolean
Indicates whether the candidate is eligible for state credits.
-
StateCreditsEstimate: string
Specifies the state tax credits estimate for the candidate.
-
StateCreditsIdentifier: string
Specifies the state tax credits identifier.
-
StatusCode: string
Result status code.
-
TotalCreditsEstimate: string
Specifies the total tax credits estimate for the candidate.
Nested Schema : Additional Candidate Tax Credits Results
Type:
array
Title:
Additional Candidate Tax Credits Results
The additionalResultsAttributes resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes additional results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Other Eligible Credits for Recruiting Tax Credits Package Results
Type:
array
Title:
Other Eligible Credits for Recruiting Tax Credits Package Results
The otherEligibleCredits resource is a child of the packages resource. It includes all other eligible credits the candidate has been reviewed for. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingTaxCreditsCandidateResults-packages-AdditionalResultsAttributes-item-response
Type:
Show Source
object
-
AttributeName: string
Attribute name of the tax credits service additional results.
-
AttributeValue: string
Maximum Length:
255
Attribute value of the tax credits service additional results. -
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 : 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