Jump to

• Request
• Response

Update an event location

patch

/hcmRestApi/resources/11.13.18.05/recruitingUIEventDetails/{EventId}/child/eventLocation/{LocationUsageId}

Request

Path Parameters

• EventId(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=
• LocationUsageId(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: string
  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: string
  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

• AccessCode: string
  Maximum Length: 30

  Access code for the event location.
• AddlAddressAttribute1: string
  Maximum Length: 255

  Additional address attribute 1 for the event location.
• AddlAddressAttribute2: string
  Maximum Length: 255

  Additional address attribute 2 for the event location.
• AddlAddressAttribute3: string
  Maximum Length: 255

  Additional address attribute 3 for the event location.
• AddlAddressAttribute4: string
  Maximum Length: 255

  Additional address attribute 4 for the event location.
• AddlAddressAttribute5: string
  Maximum Length: 255

  Additional address attribute 5 for the event location.
• AddressId: integer (int64)
  Unique identifier for the address of the event location.
• AddressLine1: string
  Maximum Length: 255

  Address line 1 of the event location.
• AddressLine2: string
  Maximum Length: 255

  Address line 2 of the event location.
• AddressLine3: string
  Maximum Length: 255

  Address line 3 of the event location.
• AddressLine4: string
  Maximum Length: 255

  Address line 4 of the event location.
• Building: string
  Maximum Length: 255

  Building name or number for the event location.
• Country: string
  Maximum Length: 255

  Country for the event location.
• EventFormatCode: string
  Maximum Length: 30

  Code for the format of the event.
• EventId: integer (int64)
  Unique identifier for the event in event locations.
• FloorNumber: string
  Maximum Length: 255

  Floor number of the event location.
• LocationId: integer (int64)
  Unique identifier for the location.
• LocationTypeCode: string
  Maximum Length: 30

  Type code for the event location.
• LongPostalCode: string
  Maximum Length: 255

  Extended postal code for the event location.
• MaxCapacity: integer (int32)
  Maximum capacity for the event location.
• MeetingId: string
  Maximum Length: 60

  Unique identifier for the meeting location.
• PhoneAreaCode: string
  Maximum Length: 30

  Phone area code for the event location.
• PhoneCountryCode: string
  Maximum Length: 30

  Candidate's phone country code in the recruiting tax credits.
• PhoneLegislationCode: string
  Maximum Length: 4

  Candidate's phone country code in the recruiting tax credits.
• PhoneNumber: string
  Maximum Length: 60

  Phone number for the event location.
• PostalCode: string
  Maximum Length: 255

  Postal code for the event location.
• Region1: string
  Maximum Length: 255

  Region 1 for the event location.
• Region2: string
  Maximum Length: 255

  Region 2 for the event location.
• Region3: string
  Maximum Length: 255

  Region 3 for the event location.
• TownOrCity: string
  Maximum Length: 255

  Town or city for the event location.
• WebConfLink: string
  Maximum Length: 300

  Web conferencing link for the event location.

{
    "type":"object",
    "properties":{
        "Building":{
            "maxLength":255,
            "type":"string",
            "description":"Building name or number for the event location.",
            "nullable":true
        },
        "FloorNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Floor number of the event location.",
            "nullable":true
        },
        "EventFormatCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the format of the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code for the event location.",
            "nullable":true
        },
        "WebConfLink":{
            "maxLength":300,
            "type":"string",
            "description":"Web conferencing link for the event location.",
            "nullable":true
        },
        "PhoneAreaCode":{
            "maxLength":30,
            "type":"string",
            "description":"Phone area code for the event location.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Candidate's phone country code in the recruiting tax credits.",
            "nullable":true
        },
        "TownOrCity":{
            "maxLength":255,
            "type":"string",
            "description":"Town or city for the event location.",
            "nullable":true
        },
        "AddlAddressAttribute5":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 5 for the event location.",
            "nullable":true
        },
        "LocationTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type code for the event location.",
            "nullable":true
        },
        "AddlAddressAttribute4":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 4 for the event location.",
            "nullable":true
        },
        "AddlAddressAttribute3":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 3 for the event location.",
            "nullable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event in event locations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"Unique identifier for the address of the event location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MaxCapacity":{
            "type":"integer",
            "description":"Maximum capacity for the event location.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "PhoneLegislationCode":{
            "maxLength":4,
            "type":"string",
            "description":"Candidate's phone country code in the recruiting tax credits.",
            "nullable":true
        },
        "LongPostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Extended postal code for the event location.",
            "nullable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Region1":{
            "maxLength":255,
            "type":"string",
            "description":"Region 1 for the event location.",
            "nullable":true
        },
        "AddlAddressAttribute2":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 2 for the event location.",
            "nullable":true
        },
        "AccessCode":{
            "maxLength":30,
            "type":"string",
            "description":"Access code for the event location.",
            "nullable":true
        },
        "AddlAddressAttribute1":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 1 for the event location.",
            "nullable":true
        },
        "Region3":{
            "maxLength":255,
            "type":"string",
            "description":"Region 3 for the event location.",
            "nullable":true
        },
        "Region2":{
            "maxLength":255,
            "type":"string",
            "description":"Region 2 for the event location.",
            "nullable":true
        },
        "AddressLine3":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 3 of the event location.",
            "nullable":true
        },
        "AddressLine2":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 2 of the event location.",
            "nullable":true
        },
        "AddressLine1":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 1 of the event location.",
            "nullable":true
        },
        "AddressLine4":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 4 of the event location.",
            "nullable":true
        },
        "MeetingId":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the meeting location.",
            "nullable":true
        },
        "PhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Phone number for the event location.",
            "nullable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country for the event location.",
            "nullable":true
        }
    }
}

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 : recruitingUIEventDetails-eventLocation-item-response

Type: object

Show Source

• AccessCode: string
  Maximum Length: 30

  Access code for the event location.
• AddlAddressAttribute1: string
  Maximum Length: 255

  Additional address attribute 1 for the event location.
• AddlAddressAttribute2: string
  Maximum Length: 255

  Additional address attribute 2 for the event location.
• AddlAddressAttribute3: string
  Maximum Length: 255

  Additional address attribute 3 for the event location.
• AddlAddressAttribute4: string
  Maximum Length: 255

  Additional address attribute 4 for the event location.
• AddlAddressAttribute5: string
  Maximum Length: 255

  Additional address attribute 5 for the event location.
• AddressId: integer (int64)
  Unique identifier for the address of the event location.
• AddressLine1: string
  Maximum Length: 255

  Address line 1 of the event location.
• AddressLine2: string
  Maximum Length: 255

  Address line 2 of the event location.
• AddressLine3: string
  Maximum Length: 255

  Address line 3 of the event location.
• AddressLine4: string
  Maximum Length: 255

  Address line 4 of the event location.
• Building: string
  Maximum Length: 255

  Building name or number for the event location.
• Country: string
  Maximum Length: 255

  Country for the event location.
• EventFormatCode: string
  Maximum Length: 30

  Code for the format of the event.
• EventId: integer (int64)
  Unique identifier for the event in event locations.
• FloorNumber: string
  Maximum Length: 255

  Floor number of the event location.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Unique identifier for the location.
• LocationTypeCode: string
  Maximum Length: 30

  Type code for the event location.
• LocationUsageId: integer (int64)
  Unique identifier for the usage of the location.
• LongPostalCode: string
  Maximum Length: 255

  Extended postal code for the event location.
• MaxCapacity: integer (int32)
  Maximum capacity for the event location.
• MeetingId: string
  Maximum Length: 60

  Unique identifier for the meeting location.
• PhoneAreaCode: string
  Maximum Length: 30

  Phone area code for the event location.
• PhoneCountryCode: string
  Maximum Length: 30

  Candidate's phone country code in the recruiting tax credits.
• PhoneLegislationCode: string
  Maximum Length: 4

  Candidate's phone country code in the recruiting tax credits.
• PhoneNumber: string
  Maximum Length: 60

  Phone number for the event location.
• PostalCode: string
  Maximum Length: 255

  Postal code for the event location.
• Region1: string
  Maximum Length: 255

  Region 1 for the event location.
• Region2: string
  Maximum Length: 255

  Region 2 for the event location.
• Region3: string
  Maximum Length: 255

  Region 3 for the event location.
• TownOrCity: string
  Maximum Length: 255

  Town or city for the event location.
• WebConfLink: string
  Maximum Length: 300

  Web conferencing link for the event location.

{
    "type":"object",
    "properties":{
        "Building":{
            "maxLength":255,
            "type":"string",
            "description":"Building name or number for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Floor number of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "EventFormatCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the format of the event.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "WebConfLink":{
            "maxLength":300,
            "type":"string",
            "description":"Web conferencing link for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":30,
            "type":"string",
            "description":"Phone area code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Candidate's phone country code in the recruiting tax credits.",
            "nullable":true,
            "x-queryable":true
        },
        "TownOrCity":{
            "maxLength":255,
            "type":"string",
            "description":"Town or city for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute5":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 5 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute4":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 4 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute3":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 3 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Unique identifier for the event in event locations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"Unique identifier for the address of the event location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaxCapacity":{
            "type":"integer",
            "description":"Maximum capacity for the event location.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PhoneLegislationCode":{
            "maxLength":4,
            "type":"string",
            "description":"Candidate's phone country code in the recruiting tax credits.",
            "nullable":true,
            "x-queryable":true
        },
        "LongPostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Extended postal code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Region1":{
            "maxLength":255,
            "type":"string",
            "description":"Region 1 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute2":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 2 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessCode":{
            "maxLength":30,
            "type":"string",
            "description":"Access code for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddlAddressAttribute1":{
            "maxLength":255,
            "type":"string",
            "description":"Additional address attribute 1 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationUsageId":{
            "type":"integer",
            "description":"Unique identifier for the usage of the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Region3":{
            "maxLength":255,
            "type":"string",
            "description":"Region 3 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "Region2":{
            "maxLength":255,
            "type":"string",
            "description":"Region 2 for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 3 of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine2":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 2 of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine1":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 1 of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine4":{
            "maxLength":255,
            "type":"string",
            "description":"Address line 4 of the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "MeetingId":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier for the meeting location.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Phone number for the event location.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country for the event location.",
            "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."
        }
    }
}

Links

EventFormatCodeLookupLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_IRC_REC_EVT_FORMAT

The following properties are defined on the LOV link relation:

• Source Attribute: EventFormatCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top