Jump to

• Request
• Response

Get details of all verification token

get

/hcmRestApi/resources/11.13.18.05/recruitingCEVerificationTokens

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 verification token using a unique identifier
    Finder Variables
    • TokenId; integer; Finds verification token using a unique identifier and a token ID
• 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:
  

  • AccessCode; string; Access Code in the verification token.
  • AccessCodeExpirationDate; string; Expiration date of the access code.
  • AttemptsRemaining; integer; Number of attempts remaining to validate the short code.
  • CandidateNumber; string; Candidate Number in the verification token.
  • CaptchaToken; string; Token used to validate the CAPTCHA.
  • ChallengeFlag; boolean; Indicates a short code challenge is required for verification.
  • ConsumerResponse; string; Consumer Response in the verification token.
  • Control; string; Control field used for security.
  • CookieId; string; ID assigned to each cookie identifying the user.
  • CookieMatchedFlag; boolean; Indicates that the cookie matched with expected value for the user.
  • DateOfBirth; string; Date of birth for the user.
  • Email; string; Email in the verification token.
  • IndeedKey; string; Key used for verifying the login with Indeed.
  • LastName; string; Last Name of the user.
  • Mode; string; Mode in the verification token.
  • NextField; string; Next field required for the validation failure.
  • PersistAccessFlag; boolean; Indicates whether the request to keep the user signed in across sessions is enabled or disabled.
  • Phone; string; Phone number in the verification token.
  • PhoneLegislationCode; string; Legislation code of the phone number in the verification token.
  • ResendFlag; boolean; Resend indicator in the verification token.
  • ShortCode; integer; Short code for verification.
  • SiteNumber; string; Site Number in the verification token.
  • SourceTrackingId; integer; Source Tracking ID in the verification token.
  • Target; string; Target URL after the shortened URL is resolved
  • Token; string; Token in the verification token.
  • TokenId; integer; Token ID in the verification token.
  • URLShortCode; string; Shortened URL to resolve on CE.
• 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 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 : recruitingCEVerificationTokens

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEVerificationTokens-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingCEVerificationTokens-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEVerificationTokens-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 : recruitingCEVerificationTokens-item-response

Type: object

Show Source

• AccessCode: string
  Access Code in the verification token.
• AccessCodeExpirationDate: string (date-time)
  Expiration date of the access code.
• AttemptsRemaining: integer
  Number of attempts remaining to validate the short code.
• CandidateNumber: string
  Candidate Number in the verification token.
• CaptchaToken: string
  Token used to validate the CAPTCHA.
• ChallengeFlag: boolean
  Indicates a short code challenge is required for verification.
• ConsumerResponse: string
  Consumer Response in the verification token.
• Control: string
  Maximum Length: 255

  Control field used for security.
• CookieId: string
  ID assigned to each cookie identifying the user.
• CookieMatchedFlag: boolean
  Indicates that the cookie matched with expected value for the user.
• DateOfBirth: string
  Date of birth for the user.
• Email: string
  Email in the verification token.
• IndeedKey: string
  Key used for verifying the login with Indeed.
• LastName: string
  Last Name of the user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Mode: string
  Mode in the verification token.
• NextField: string
  Maximum Length: 255

  Next field required for the validation failure.
• PersistAccessFlag: boolean
  Indicates whether the request to keep the user signed in across sessions is enabled or disabled.
• Phone: string
  Phone number in the verification token.
• PhoneLegislationCode: string
  Maximum Length: 255

  Legislation code of the phone number in the verification token.
• RequisitionNumber: string
  Requisition Number in the verification token.
• ResendFlag: boolean
  Maximum Length: 255

  Resend indicator in the verification token.
• ShortCode: integer
  Short code for verification.
• SiteNumber: string
  Site Number in the verification token.
• SourceTrackingId: integer (int64)
  Source Tracking ID in the verification token.
• Target: string
  Target URL after the shortened URL is resolved
• Token: string
  Token in the verification token.
• TokenId: integer (int64)
  Token ID in the verification token.
• URLShortCode: string
  Shortened URL to resolve on CE.

{
    "type":"object",
    "properties":{
        "Email":{
            "type":"string",
            "description":"Email in the verification token.",
            "nullable":false,
            "x-queryable":true
        },
        "AccessCodeExpirationDate":{
            "type":"string",
            "description":"Expiration date of the access code.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Token":{
            "type":"string",
            "description":"Token in the verification token.",
            "nullable":false,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "type":"string",
            "description":"Requisition Number in the verification token.",
            "nullable":false,
            "x-queryable":false
        },
        "Control":{
            "maxLength":"255",
            "type":"string",
            "description":"Control field used for security.",
            "nullable":true,
            "x-queryable":true
        },
        "Target":{
            "type":"string",
            "description":"Target URL after the shortened URL is resolved",
            "nullable":true,
            "x-queryable":true
        },
        "Phone":{
            "type":"string",
            "description":"Phone number in the verification token.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersistAccessFlag":{
            "type":"boolean",
            "description":"Indicates whether the request to keep the user signed in across sessions is enabled or disabled.",
            "nullable":true,
            "x-queryable":true
        },
        "CookieMatchedFlag":{
            "type":"boolean",
            "description":"Indicates that the cookie matched with expected value for the user.",
            "nullable":true,
            "x-queryable":true
        },
        "TokenId":{
            "type":"integer",
            "description":"Token ID in the verification token.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTrackingId":{
            "type":"integer",
            "description":"Source Tracking ID in the verification token.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShortCode":{
            "type":"integer",
            "description":"Short code for verification.",
            "nullable":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "type":"string",
            "description":"Date of birth for the user.",
            "nullable":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "type":"string",
            "description":"Candidate Number in the verification token.",
            "nullable":true,
            "x-queryable":true
        },
        "AttemptsRemaining":{
            "type":"integer",
            "description":"Number of attempts remaining to validate the short code.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneLegislationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Legislation code of the phone number in the verification token.",
            "nullable":true,
            "x-queryable":true
        },
        "Mode":{
            "type":"string",
            "description":"Mode in the verification token.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessCode":{
            "type":"string",
            "description":"Access Code in the verification token.",
            "nullable":true,
            "x-queryable":true
        },
        "URLShortCode":{
            "type":"string",
            "description":"Shortened URL to resolve on CE.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteNumber":{
            "type":"string",
            "description":"Site Number in the verification token.",
            "nullable":true,
            "x-queryable":true
        },
        "IndeedKey":{
            "type":"string",
            "description":"Key used for verifying the login with Indeed.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumerResponse":{
            "type":"string",
            "description":"Consumer Response in the verification token.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "type":"string",
            "description":"Last Name of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "ResendFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Resend indicator in the verification token.",
            "nullable":true,
            "x-queryable":true
        },
        "NextField":{
            "maxLength":"255",
            "type":"string",
            "description":"Next field required for the validation failure.",
            "nullable":true,
            "x-queryable":true
        },
        "CookieId":{
            "type":"string",
            "description":"ID assigned to each cookie identifying the user.",
            "nullable":true,
            "x-queryable":true
        },
        "CaptchaToken":{
            "type":"string",
            "description":"Token used to validate the CAPTCHA.",
            "nullable":true,
            "x-queryable":true
        },
        "ChallengeFlag":{
            "type":"boolean",
            "description":"Indicates a short code challenge is required for verification.",
            "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