Jump to

• Request
• Response

Get all organizations

post

/hcmRestApi/resources/11.13.18.05/volunteeringAddresses

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AddlAddressAttribute1: string
  Title: Additional Address Attribute 1

  Maximum Length: 150

  Cause or area of interest supported by volunteering organization.
• AddlAddressAttribute2: string
  Title: Additional Address Attribute 2

  Maximum Length: 150

  Email of the volunteering organization.
• AddlAddressAttribute3: string
  Title: Additional Address Attribute 3

  Maximum Length: 150

  Fax contact for the volunteering organization.
• AddlAddressAttribute4: string
  Title: Additional Address Attribute 4

  Maximum Length: 150

  First name of the contact.
• AddlAddressAttribute5: string
  Title: Additional Address Attribute 5

  Maximum Length: 150

  Last name of the contact.
• AddressId: integer (int64)
  Title: Address ID

  Web address of the volunteering organization.
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  Phone of the contact.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  Title of the contact.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  Description for the volunteering organization.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  EIN number of the volunteering organization.
• Building: string
  Title: Building

  Maximum Length: 240

  EIN status of the volunteering organization.
• Country: string
  Title: Country

  Maximum Length: 60

  Location identifier of the volunteering organization.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Placeholder for volunteering organization logo.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Lookup code for volunteering organization.
• EntityId: integer
• EntityType: string
  Maximum Length: 255
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  Lookup type for volunteering organization.
• Latitude: number
  Title: Latitude

  Meaning for volunteering organization.
• Longitude: number
  Title: Longitude

  Name of the volunteering organization.
• LongPostalCode: string
  Title: Long Postal Code

  Maximum Length: 30

  Mission statement of the volunteering organization.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 30

  Location details of the volunteering organization.
• Provider: string
  Title: Provider

  Maximum Length: 150

  Unique identifier of the volunteering organization.
• Region1: string
  Title: Region 1

  Maximum Length: 120

  Classification of the organization.
• Region2: string
  Title: Region 2

  Maximum Length: 120

  Parent organization the organization is affiliated to.
• Region3: string
  Title: Region 3

  Maximum Length: 120

  Location details of the parent organization.
• TownOrCity: string
  Title: Town or City

  Maximum Length: 60

  User who submitted the volunteering organization.
• ValidationStatusCode: string
  Title: Validation Status Code

  Maximum Length: 120

  Web address of the volunteering organization.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"EIN status of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":40,
            "type":"string",
            "description":"Lookup type for volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":30,
            "type":"string",
            "description":"Location details of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"Meaning for volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TownOrCity":{
            "title":"Town or City",
            "maxLength":60,
            "type":"string",
            "description":"User who submitted the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddlAddressAttribute5":{
            "title":"Additional Address Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute4":{
            "title":"Additional Address Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"First name of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute3":{
            "title":"Additional Address Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Fax contact for the volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"Web address of the volunteering organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Placeholder for volunteering organization logo.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status Code",
            "maxLength":120,
            "type":"string",
            "description":"Web address of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LongPostalCode":{
            "title":"Long Postal Code",
            "maxLength":30,
            "type":"string",
            "description":"Mission statement of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Region1":{
            "title":"Region 1",
            "maxLength":120,
            "type":"string",
            "description":"Classification of the organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddlAddressAttribute2":{
            "title":"Additional Address Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Email of the volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute1":{
            "title":"Additional Address Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Cause or area of interest supported by volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Region3":{
            "title":"Region 3",
            "maxLength":120,
            "type":"string",
            "description":"Location details of the parent organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Region2":{
            "title":"Region 2",
            "maxLength":120,
            "type":"string",
            "description":"Parent organization the organization is affiliated to.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"Name of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Provider":{
            "title":"Provider",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"Description for the volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EntityId":{
            "type":"integer",
            "nullable":false,
            "x-queryable":true
        },
        "EntityType":{
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Title of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Phone of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"EIN number of the volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "description":"Location identifier of the volunteering organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Lookup code for volunteering organization.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":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 : volunteeringAddresses-item-response

Type: object

Show Source

• AddlAddressAttribute1: string
  Title: Additional Address Attribute 1

  Maximum Length: 150

  Cause or area of interest supported by volunteering organization.
• AddlAddressAttribute2: string
  Title: Additional Address Attribute 2

  Maximum Length: 150

  Email of the volunteering organization.
• AddlAddressAttribute3: string
  Title: Additional Address Attribute 3

  Maximum Length: 150

  Fax contact for the volunteering organization.
• AddlAddressAttribute4: string
  Title: Additional Address Attribute 4

  Maximum Length: 150

  First name of the contact.
• AddlAddressAttribute5: string
  Title: Additional Address Attribute 5

  Maximum Length: 150

  Last name of the contact.
• AddressId: integer (int64)
  Title: Address ID

  Web address of the volunteering organization.
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  Phone of the contact.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  Title of the contact.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  Description for the volunteering organization.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  EIN number of the volunteering organization.
• Building: string
  Title: Building

  Maximum Length: 240

  EIN status of the volunteering organization.
• Country: string
  Title: Country

  Maximum Length: 60

  Location identifier of the volunteering organization.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the volunteering organization.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date the volunteering organization was created.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Placeholder for volunteering organization logo.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Lookup code for volunteering organization.
• EntityId: integer
• EntityType: string
  Maximum Length: 255
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  Lookup type for volunteering organization.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date the volunteering organization was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the volunteering organization.
• Latitude: number
  Title: Latitude

  Meaning for volunteering organization.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Title: Longitude

  Name of the volunteering organization.
• LongPostalCode: string
  Title: Long Postal Code

  Maximum Length: 30

  Mission statement of the volunteering organization.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 30

  Location details of the volunteering organization.
• Provider: string
  Title: Provider

  Maximum Length: 150

  Unique identifier of the volunteering organization.
• Region1: string
  Title: Region 1

  Maximum Length: 120

  Classification of the organization.
• Region2: string
  Title: Region 2

  Maximum Length: 120

  Parent organization the organization is affiliated to.
• Region3: string
  Title: Region 3

  Maximum Length: 120

  Location details of the parent organization.
• TownOrCity: string
  Title: Town or City

  Maximum Length: 60

  User who submitted the volunteering organization.
• ValidationStatusCode: string
  Title: Validation Status Code

  Maximum Length: 120

  Web address of the volunteering organization.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"EIN status of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date the volunteering organization was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":40,
            "type":"string",
            "description":"Lookup type for volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":30,
            "type":"string",
            "description":"Location details of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"Meaning for volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TownOrCity":{
            "title":"Town or City",
            "maxLength":60,
            "type":"string",
            "description":"User who submitted the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddlAddressAttribute5":{
            "title":"Additional Address Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute4":{
            "title":"Additional Address Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"First name of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute3":{
            "title":"Additional Address Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"Fax contact for the volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"Web address of the volunteering organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the volunteering organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the volunteering organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Placeholder for volunteering organization logo.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status Code",
            "maxLength":120,
            "type":"string",
            "description":"Web address of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LongPostalCode":{
            "title":"Long Postal Code",
            "maxLength":30,
            "type":"string",
            "description":"Mission statement of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Region1":{
            "title":"Region 1",
            "maxLength":120,
            "type":"string",
            "description":"Classification of the organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddlAddressAttribute2":{
            "title":"Additional Address Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"Email of the volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddlAddressAttribute1":{
            "title":"Additional Address Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"Cause or area of interest supported by volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Region3":{
            "title":"Region 3",
            "maxLength":120,
            "type":"string",
            "description":"Location details of the parent organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Region2":{
            "title":"Region 2",
            "maxLength":120,
            "type":"string",
            "description":"Parent organization the organization is affiliated to.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"Name of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Provider":{
            "title":"Provider",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the volunteering organization.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"Description for the volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EntityId":{
            "type":"integer",
            "nullable":false,
            "x-queryable":true
        },
        "EntityType":{
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Title of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Phone of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"EIN number of the volunteering organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "description":"Location identifier of the volunteering organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Lookup code for volunteering organization.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date the volunteering organization was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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

countriesLov

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The following properties are defined on the LOV link relation:

• Source Attribute: Country; Target Attribute: TerritoryCode
• Display Attribute: TerritoryCode, CountryName

Back to Top