Jump to

• Request
• Response

Update a candidate address

patch

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/addresses/{AddressId}

Request

Path Parameters

• AddressId(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=
• 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=

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

• AddlAddressAttribute1: string
  Maximum Length: 150

  Additional address attribute 1 of the candidate address.
• AddlAddressAttribute2: string
  Maximum Length: 150

  Additional address attribute 2 of the candidate address.
• AddlAddressAttribute3: string
  Maximum Length: 150

  Additional address attribute 3 of the candidate address.
• AddlAddressAttribute4: string
  Maximum Length: 150

  Additional address attribute 4 of the candidate address.
• AddlAddressAttribute5: string
  Maximum Length: 150

  Additional address attribute 5 of the candidate address.
• AddressLine1: string
  Maximum Length: 240

  Address line 1 of the candidates address.
• AddressLine2: string
  Maximum Length: 240

  Address line 2 of the candidates address.
• AddressLine3: string
  Maximum Length: 240

  Address line 3 of the candidates address.
• Building: string
  Maximum Length: 240

  Building of the candidate address.
• City: string
  Maximum Length: 60

  City of the candidate address.
• Country: string
  Maximum Length: 60

  Country of the candidate address.
• FloorNumber: string
  Maximum Length: 40

  Floor number of the candidate address.
• LongPostalCode: string
  Maximum Length: 30

  Long postal code of the candidate address.
• PostalCode: string
  Maximum Length: 30

  Postal code of the candidate address.
• Region1: string
  Maximum Length: 120

  Region 1 of the candidate address.
• Region2: string
  Maximum Length: 120

  Region 2 of the candidate address.
• Region3: string
  Maximum Length: 120

  Region 3 of the candidate address.

{
    "type":"object",
    "properties":{
        "Building":{
            "maxLength":240,
            "type":"string",
            "description":"Building of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "FloorNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Floor number of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "LongPostalCode":{
            "maxLength":30,
            "type":"string",
            "description":"Long postal code of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "Region1":{
            "maxLength":120,
            "type":"string",
            "description":"Region 1 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute2":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 2 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalCode":{
            "maxLength":30,
            "type":"string",
            "description":"Postal code of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute1":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 1 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "Region3":{
            "maxLength":120,
            "type":"string",
            "description":"Region 3 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "Region2":{
            "maxLength":120,
            "type":"string",
            "description":"Region 2 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine3":{
            "maxLength":240,
            "type":"string",
            "description":"Address line 3 of the candidates address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine2":{
            "maxLength":240,
            "type":"string",
            "description":"Address line 2 of the candidates address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine1":{
            "maxLength":240,
            "type":"string",
            "description":"Address line 1 of the candidates address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute5":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 5 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute4":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 4 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute3":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 3 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"Country of the candidate address.",
            "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-addresses-item-response

Type: object

Show Source

• AddlAddressAttribute1: string
  Maximum Length: 150

  Additional address attribute 1 of the candidate address.
• AddlAddressAttribute2: string
  Maximum Length: 150

  Additional address attribute 2 of the candidate address.
• AddlAddressAttribute3: string
  Maximum Length: 150

  Additional address attribute 3 of the candidate address.
• AddlAddressAttribute4: string
  Maximum Length: 150

  Additional address attribute 4 of the candidate address.
• AddlAddressAttribute5: string
  Maximum Length: 150

  Additional address attribute 5 of the candidate address.
• AddressId: string
  Read Only: true

  Identifier of the candidate address.
• AddressLine1: string
  Maximum Length: 240

  Address line 1 of the candidates address.
• AddressLine2: string
  Maximum Length: 240

  Address line 2 of the candidates address.
• AddressLine3: string
  Maximum Length: 240

  Address line 3 of the candidates address.
• Building: string
  Maximum Length: 240

  Building of the candidate address.
• City: string
  Maximum Length: 60

  City of the candidate address.
• Country: string
  Maximum Length: 60

  Country of the candidate address.
• CreatedBy: string
  Read Only: true

  Person who created the candidate address.
• CreationDate: string (date-time)
  Read Only: true

  Creation date of the candidate address.
• FloorNumber: string
  Maximum Length: 40

  Floor number of the candidate address.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last update date of the candidate address.
• LastUpdatedBy: string
  Read Only: true

  Person who last updated the candidate address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongPostalCode: string
  Maximum Length: 30

  Long postal code of the candidate address.
• PostalCode: string
  Maximum Length: 30

  Postal code of the candidate address.
• Region1: string
  Maximum Length: 120

  Region 1 of the candidate address.
• Region2: string
  Maximum Length: 120

  Region 2 of the candidate address.
• Region3: string
  Maximum Length: 120

  Region 3 of the candidate address.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "type":"string",
            "description":"Person who last updated the candidate address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Building":{
            "maxLength":240,
            "type":"string",
            "description":"Building of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the candidate address.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FloorNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Floor number of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "type":"string",
            "description":"Person who created the candidate address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LongPostalCode":{
            "maxLength":30,
            "type":"string",
            "description":"Long postal code of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "Region1":{
            "maxLength":120,
            "type":"string",
            "description":"Region 1 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute2":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 2 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalCode":{
            "maxLength":30,
            "type":"string",
            "description":"Postal code of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute1":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 1 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "Region3":{
            "maxLength":120,
            "type":"string",
            "description":"Region 3 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "Region2":{
            "maxLength":120,
            "type":"string",
            "description":"Region 2 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine3":{
            "maxLength":240,
            "type":"string",
            "description":"Address line 3 of the candidates address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine2":{
            "maxLength":240,
            "type":"string",
            "description":"Address line 2 of the candidates address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLine1":{
            "maxLength":240,
            "type":"string",
            "description":"Address line 1 of the candidates address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute5":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 5 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute4":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 4 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddlAddressAttribute3":{
            "maxLength":150,
            "type":"string",
            "description":"Additional address attribute 3 of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"Country of the candidate address.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressId":{
            "type":"string",
            "description":"Identifier of the candidate address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last update date of the candidate address.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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