Jump to

• Request
• Response

Update a candidate language

patch

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages/{LanguageId}

Request

Path Parameters

• CandidateNumber(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=
• LanguageId(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=

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AbleToTeachFlag: boolean
  Title: Able to Teach

  Maximum Length: 30

  Indicates whether the candidate can teach in the candidate language.
• AbleToTranslateFlag: boolean
  Title: Able to Translate

  Maximum Length: 30

  Indicates whether the candidate can translate in the candidate language.
• Comments: string (byte)
  Title: Comments

  Comments in candidate language.
• ContentItemId: integer (int64)
  Title: Language

  Content item identifier in candidate language.
• EvaluatedOn: string (date)
  Title: Evaluated On

  Evaluated on in candidate language.
• EvaluationLocation: string
  Title: Evaluation Location

  Maximum Length: 240

  Evaluation location in candidate language.
• Language: string
  Maximum Length: 240

  Language in candidate language.
• NativeSpeakerFlag: boolean
  Title: Native

  Maximum Length: 30

  Indicates whether the candidate is a native speaker in the candidate language.
• ReadingLevelId: integer (int64)
  Title: Reading

  Reading level identifier in candidate language.
• ReadingModelId: integer (int64)
  Title: Reading Rating Model

  Reading model identifier in candidate language.
• SectionId: integer (int64)
  Section identifier in candidate language.
• SpeakingLevelId: integer (int64)
  Title: Speaking

  Speaking level identifier in candidate language.
• SpeakingModelId: integer (int64)
  Title: Speaking Rating Model

  Speaking model identifier in candidate language.
• WritingLevelId: integer (int64)
  Title: Writing

  Writing level identifier in candidate language.
• WritingModelId: integer (int64)
  Title: Writing Rating Model

  Writing model identifier in candidate language.

{
    "type":"object",
    "properties":{
        "AbleToTranslateFlag":{
            "title":"Able to Translate",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the candidate can translate in the candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "AbleToTeachFlag":{
            "title":"Able to Teach",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the candidate can teach in the candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "ReadingModelId":{
            "title":"Reading Rating Model",
            "type":"integer",
            "description":"Reading model identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments in candidate language.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SpeakingModelId":{
            "title":"Speaking Rating Model",
            "type":"integer",
            "description":"Speaking model identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SpeakingLevelId":{
            "title":"Speaking",
            "type":"integer",
            "description":"Speaking level identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NativeSpeakerFlag":{
            "title":"Native",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the candidate is a native speaker in the candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "ReadingLevelId":{
            "title":"Reading",
            "type":"integer",
            "description":"Reading level identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContentItemId":{
            "title":"Language",
            "type":"integer",
            "description":"Content item identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WritingLevelId":{
            "title":"Writing",
            "type":"integer",
            "description":"Writing level identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Language":{
            "maxLength":240,
            "type":"string",
            "description":"Language in candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "EvaluatedOn":{
            "title":"Evaluated On",
            "type":"string",
            "description":"Evaluated on in candidate language.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WritingModelId":{
            "title":"Writing Rating Model",
            "type":"integer",
            "description":"Writing model identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SectionId":{
            "type":"integer",
            "description":"Section identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EvaluationLocation":{
            "title":"Evaluation Location",
            "maxLength":240,
            "type":"string",
            "description":"Evaluation location in candidate language.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : recruitingJobSiteCandidates-languages-item-response

Type: object

Show Source

• AbleToTeachFlag: boolean
  Title: Able to Teach

  Maximum Length: 30

  Indicates whether the candidate can teach in the candidate language.
• AbleToTranslateFlag: boolean
  Title: Able to Translate

  Maximum Length: 30

  Indicates whether the candidate can translate in the candidate language.
• Comments: string (byte)
  Title: Comments

  Comments in candidate language.
• ContentItemId: integer (int64)
  Title: Language

  Content item identifier in candidate language.
• EvaluatedOn: string (date)
  Title: Evaluated On

  Evaluated on in candidate language.
• EvaluationLocation: string
  Title: Evaluation Location

  Maximum Length: 240

  Evaluation location in candidate language.
• Language: string
  Maximum Length: 240

  Language in candidate language.
• LanguageId: integer (int64)
  Language identifier in candidate language.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NativeSpeakerFlag: boolean
  Title: Native

  Maximum Length: 30

  Indicates whether the candidate is a native speaker in the candidate language.
• ReadingLevelId: integer (int64)
  Title: Reading

  Reading level identifier in candidate language.
• ReadingModelId: integer (int64)
  Title: Reading Rating Model

  Reading model identifier in candidate language.
• SectionId: integer (int64)
  Section identifier in candidate language.
• SpeakingLevelId: integer (int64)
  Title: Speaking

  Speaking level identifier in candidate language.
• SpeakingModelId: integer (int64)
  Title: Speaking Rating Model

  Speaking model identifier in candidate language.
• WritingLevelId: integer (int64)
  Title: Writing

  Writing level identifier in candidate language.
• WritingModelId: integer (int64)
  Title: Writing Rating Model

  Writing model identifier in candidate language.

{
    "type":"object",
    "properties":{
        "AbleToTranslateFlag":{
            "title":"Able to Translate",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the candidate can translate in the candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "AbleToTeachFlag":{
            "title":"Able to Teach",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the candidate can teach in the candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "ReadingModelId":{
            "title":"Reading Rating Model",
            "type":"integer",
            "description":"Reading model identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments in candidate language.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SpeakingModelId":{
            "title":"Speaking Rating Model",
            "type":"integer",
            "description":"Speaking model identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SpeakingLevelId":{
            "title":"Speaking",
            "type":"integer",
            "description":"Speaking level identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NativeSpeakerFlag":{
            "title":"Native",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the candidate is a native speaker in the candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "ReadingLevelId":{
            "title":"Reading",
            "type":"integer",
            "description":"Reading level identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContentItemId":{
            "title":"Language",
            "type":"integer",
            "description":"Content item identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WritingLevelId":{
            "title":"Writing",
            "type":"integer",
            "description":"Writing level identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Language":{
            "maxLength":240,
            "type":"string",
            "description":"Language in candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "EvaluatedOn":{
            "title":"Evaluated On",
            "type":"string",
            "description":"Evaluated on in candidate language.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WritingModelId":{
            "title":"Writing Rating Model",
            "type":"integer",
            "description":"Writing model identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SectionId":{
            "type":"integer",
            "description":"Section identifier in candidate language.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EvaluationLocation":{
            "title":"Evaluation Location",
            "maxLength":240,
            "type":"string",
            "description":"Evaluation location in candidate language.",
            "nullable":true,
            "x-queryable":false
        },
        "LanguageId":{
            "type":"integer",
            "description":"Language identifier in candidate language.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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