1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Contacts
  4. Contact Addresses

Get all addresses

get

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address

Request

Path Parameters
  • The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • AddressIdAltKey: Finds an address by an alternate key for the address ID.
      Finder Variables:
      • AddressId; integer; The unique identifier that is generated internally during create.
    • AddressNumberAltKey: Finds an address by an alternate key for the address number.
      Finder Variables:
      • AddressNumber; string; The alternate unique identifier for the address.
    • AddressNumberRF: Finds an address by the unique address identifier.
      Finder Variables:
      • AddressNumber; string; The primary unique identifier for the address.
    • PrimaryKey: Finds an address by the primary key information.
      Finder Variables:
      • AddressId; integer; The unique identifier that is generated internally during create.
      • LocationId; integer; The unique identifier for this location.
    • SourceSystemReferenceAltKey: Finds an address by source system information for address number.
      Finder Variables:
      • SourceSystem; string; The name of external source system for the address.
      • SourceSystemReferenceValue; string; The unique identifier for the address from the external source system.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AddrElementAttribute1; string; The additional address element to support flexible address format.
    • AddrElementAttribute2; string; The additional address element to support flexible address format.
    • AddrElementAttribute3; string; The additional address element to support flexible address format.
    • AddrElementAttribute4; string; The additional address element to support flexible address format.
    • AddrElementAttribute5; string; The additional address element to support flexible address format.
    • Address1; string; The first line for address.
    • Address2; string; The second line for address.
    • Address3; string; The third line for address.
    • Address4; string; The fourth line for address.
    • AddressId; integer; The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
    • AddressLinesPhonetic; string; The phonetic or kana representation of the Kanji address lines (used in Japan).
    • AddressNumber; string; The unique alternate identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
    • Building; string; The specific building name or number at a given address.
    • City; string; The city element of the address.
    • ClliCode; string; The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
    • Comments; string; User comments for the address.
    • ConflictId; integer; The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
    • CorpCurrencyCode; string; The corporate currency code associated with the addresses. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
    • Country; string; The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
    • County; string; The county element of Address.
    • CreatedBy; string; The user who created the address record.
    • CreatedByModule1; string; The user who created the module.
    • CreationDate; string; The date and time when the address record was created.
    • CurcyConvRateType; string; The currency conversion rate type associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
    • CurrencyCode; string; The currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
    • DateValidated; string; The date when the address was last validated.
    • Description; string; An extensive description of the location of the address.
    • DoNotValidateFlag; boolean; Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.
    • DunsNumberC; string; The D-U-N-S number of the business location.
    • EffectiveDate; string; The date when the address becomes effective.
    • EndDateActive; string; Date on which this address is no longer active.
    • FloorNumber; string; The specific floor number at a given address or in a particular building when building number is provided.
    • HouseType; string; The type of building. A list of accepted values for this attribute is defined in the lookup HZ_HOUSE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
    • LastUpdateDate; string; The date when the address data was last updated.
    • LastUpdateLogin; string; The session login associated to the user who last updated the address record.
    • LastUpdatedBy; string; The user who last updated the address record.
    • Latitude; number; Used to store latitude information for the location for spatial proximity and containment purposes.
    • LocationDirections; string; The directions to the location.
    • LocationId; integer; The unique identifier for this location.
    • Longitude; number; Used to store longitude information for the location for spatial proximity and containment purposes.
    • Mailstop; string; A user-defined code to indicate a mail drop point within their organization.
    • ObjectVersionNumber; integer; Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
    • ObjectVersionNumber1; integer; The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
    • PartyId; integer; The unique Identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
    • PartyNumber; string; The alternate unique identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. The default value for PartyNumber is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. You can update the PartyNumber depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of accepted values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
    • PartySiteName; string; User-defined name for the address.
    • PartySourceSystem; string; The name of external source system of the contact with which the address is associated. Part of Alternate Key for the contact record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task.
    • PartySourceSystemReferenceValue; string; The unique identifier from external source system for the contact with which the address is associated. Part of Alternate Key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated.
    • PostalCode; string; The postal code as defined by the formal countrywide postal system.
    • PostalPlus4Code; string; The four digit extension to the United States Postal ZIP code.
    • PrimaryFlag; boolean; Indicates if this is the primary address of the contact irrespective of the context. If the value is True, then the address is the primary address of the contact. The default value is False.
    • Province; string; The province element of Address.
    • SSROwnerTableName; string; The name of the table that holds the record data and is referenced to manage source system reference.
    • SSRPartyOwnerTableName; string; The name of the table that holds the party record data and is referenced to manage source system reference.
    • SourceSystem; string; The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
    • SourceSystemReferenceValue; string; The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
    • StartDateActive; string; Date on which this address becomes active.
    • State; string; The state element of Address.
    • Status; string; The status of the address. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
    • ValidatedFlag; boolean; Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing.
    • ValidationStatusCode; string; The code indicating the status of the validation. Internally set by system during address cleansing.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : contacts-Address
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : contacts-Address-item-response
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Address Line 1
    Maximum Length: 240
    The first line for address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line for address.
  • Title: Address Line 3
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line for address.
  • Read Only: true
    The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or kana representation of the Kanji address lines (used in Japan).
  • Address Locales
    Title: Address Locales
    The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
  • Title: Site Number
    Maximum Length: 30
    The unique alternate identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
  • Contact Address Purposes
    Title: Contact Address Purposes
    The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
  • Title: Type
    The additional information as type of address like BillTo, ShipTo.
  • Title: Building
    Maximum Length: 240
    The specific building name or number at a given address.
  • The formatted address.
  • Title: City
    Maximum Length: 60
    The city element of the address.
  • Title: CLLI Code
    Maximum Length: 60
    The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
  • Title: Comments
    Maximum Length: 2000
    User comments for the address.
  • Default Value: 0
    The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
  • Title: Corporate Currency
    Maximum Length: 15
    The corporate currency code associated with the addresses. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Country
    Maximum Length: 2
    The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
  • Title: County
    Maximum Length: 60
    The county element of Address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the address record.
  • Default Value: HZ_WS
    The application module that created the address record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
  • Title: Created by Application
    Maximum Length: 30
    The user who created the module.
  • Title: Creation Date
    Read Only: true
    The date and time when the address record was created.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency Code
    Maximum Length: 15
    The currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Validated Date
    The date when the address was last validated.
  • Title: Description
    Maximum Length: 2000
    An extensive description of the location of the address.
  • Title: Contact Preferences
    Default Value: false
    Indicates if this address should be used for mailing. If the value is True, then the address should not be used for mailing. The default value is False.
  • Title: Don't Validate
    Maximum Length: 1
    Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.
  • Title: D-U-N-S Number
    Maximum Length: 30
    The D-U-N-S number of the business location.
  • The date when the address becomes effective.
  • Title: End Date
    Date on which this address is no longer active.
  • Title: Floor
    Maximum Length: 40
    The specific floor number at a given address or in a particular building when building number is provided.
  • Title: Address
    Read Only: true
    The formatted address information.
  • Title: Formatted Address 1
    Read Only: true
    The formatted address of the contact address record.
  • Title: Address
    Read Only: true
    The formatted multiple line address information.
  • Title: Address
    Read Only: true
    The formatted address in multiline of the contact address record.
  • Title: House Type
    Maximum Length: 30
    The type of building. A list of accepted values for this attribute is defined in the lookup HZ_HOUSE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Last Updated Date
    Read Only: true
    The date when the address data was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the address record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the address record.
  • Title: Latitude
    Used to store latitude information for the location for spatial proximity and containment purposes.
  • Links
  • Title: Location Directions
    Maximum Length: 640
    The directions to the location.
  • Title: Location ID
    The unique identifier for this location.
  • Title: Longitude
    Used to store longitude information for the location for spatial proximity and containment purposes.
  • Title: Mail Stop
    Maximum Length: 60
    A user-defined code to indicate a mail drop point within their organization.
  • Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • Title: Party ID
    The unique Identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
  • Title: Party Number
    The alternate unique identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. The default value for PartyNumber is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. You can update the PartyNumber depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of accepted values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
  • Title: Site Name
    Maximum Length: 240
    User-defined name for the address.
  • Title: Party Source System
    The name of external source system of the contact with which the address is associated. Part of Alternate Key for the contact record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task.
  • Title: Party Source System Reference Value
    The unique identifier from external source system for the contact with which the address is associated. Part of Alternate Key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated.
  • Title: Postal Code
    Maximum Length: 60
    The postal code as defined by the formal countrywide postal system.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four digit extension to the United States Postal ZIP code.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates if this is the primary address of the contact irrespective of the context. If the value is True, then the address is the primary address of the contact. The default value is False.
  • Title: Province
    Maximum Length: 60
    The province element of Address.
  • The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • Read Only: true
    Maximum Length: 255
    The name of the table that holds the record data and is referenced to manage source system reference.
  • Read Only: true
    Maximum Length: 255
    Default Value: HZ_PARTIES
    The name of the table that holds the party record data and is referenced to manage source system reference.
  • Title: Start Date
    Date on which this address becomes active.
  • Title: State
    Maximum Length: 60
    The state element of Address.
  • Title: Status
    Maximum Length: 1
    Default Value: A
    The status of the address. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Validated
    Maximum Length: 1
    Default Value: false
    Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing.
  • Read Only: true
    The date when the address validation started. The value is internally set by system during address cleansing.
  • Title: Validation Status
    Maximum Length: 30
    The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type: array
Title: Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Contact Address Purposes
Type: array
Title: Contact Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : contacts-Address-AddressLocale-item-response
Type: object
Show Source
  • Title: Address Element Attribute 1
    Maximum Length: 150
    The additional address element 1 to support flexible address format in local language.
  • Title: Address Element Attribute 2
    Maximum Length: 150
    The additional address element 2 to support flexible address format in local language.
  • Title: Address Element Attribute 3
    Maximum Length: 150
    The additional address element 3 to support flexible address format in local language.
  • Title: Address Element Attribute 4
    Maximum Length: 150
    The additional address element 4 to support flexible address format in local language.
  • Title: Address Element Attribute 5
    Maximum Length: 150
    The additional address element 5 to support flexible address format in local language.
  • Title: Address Line 1
    Maximum Length: 240
    The first line of the address in the local language.
  • Title: Address Line 2
    Maximum Length: 240
    The second line of the address in the local language.
  • Title: Address Line 3
    Maximum Length: 240
    The third line of the address in the local language.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line of the address in the local language.
  • Title: Site Number
    Read Only: true
    Maximum Length: 30
    The unique address identifier that's internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue.
  • Title: Building
    Maximum Length: 240
    The specific building name or number at a given address in local language.
  • Title: City
    Maximum Length: 60
    The specific name of the city in local language.
  • Title: Country
    Read Only: true
    Maximum Length: 2
    The specific name of the country in local language.
  • Title: County
    Maximum Length: 60
    The specific name of the county in local language.
  • Read Only: true
    Maximum Length: 64
    The user who created the address locale record.
  • Read Only: true
    The date and time when the address locale record was created.
  • Title: Floor
    Maximum Length: 240
    The specific floor number at a given address or a particular building when building number is provided in local language.
  • Read Only: true
    The formatted read only version of the locale address.
  • Read Only: true
    The date and time when the address locale was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the address locale record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the address locale record.
  • Links
  • The unique identifier of the location record.
  • Read Only: true
    The unique identifier of the location locale record.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four digit extension to the United States Postal ZIP code in local language.
  • Title: Province
    Maximum Length: 60
    The name of the province in local language.
  • The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • Title: State
    Maximum Length: 60
    The name of the State in the local language.
  • Title: Transliteration Language
    Maximum Length: 4
    Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : contacts-Address-AddressPurpose-item-response
Type: object
Show Source
  • The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
  • Title: Site Number
    Read Only: true
    Maximum Length: 30
    The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
  • Read Only: true
    The unique identifier for the address purpose of an address.
  • Title: Comments
    Maximum Length: 2000
    The user comments for the address purpose.
  • Read Only: true
    Maximum Length: 64
    The user who created the address purpose record.
  • Maximum Length: 30
    Default Value: HZ_WS
    The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
  • Read Only: true
    The date and time when the address purpose record was created.
  • Indicates if the address purpose for an address was deleted. If the value is True, then the address purpose is deleted. The default value is False.
  • Title: To Date
    The date on which the address purpose is no longer valid.
  • Read Only: true
    The date and time when the address purpose was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the address purpose record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the address purpose record.
  • Links
  • Title: Primary
    Maximum Length: 1
    Default Value: N
    Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.
  • Title: Purpose
    Maximum Length: 30
    The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
  • The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
  • Title: From Date
    The date from which the address purpose is valid.
  • Title: Status
    Maximum Length: 1
    Default Value: A
    Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Back to Top

Examples

The following example shows how to get all addresses by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CDRM_336943/child/Address

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "PartyId": 300100046397219,
            "PartyNumber": "CDRM_336943",
            "AddressId": 300100046397222,
            "AddressNumber": "CDRM_100950",
            "CreatedByModule": "HZ_WS",
            "FormattedAddress": "600 Oracle Parkway,1001 Sunset  Boulevard,ROCKLIN, CA",
            "Address1": "600 Oracle Parkway",
            "Address2": "1001 Sunset Boulevard",
            "City": "Rocklin",
            "Country": "US",
            "State": "CA",
            
        }...
    ]...
}
Back to Top