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

Get all primary addresses

get

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress

Request

Path Parameters
  • The unique primary identifier for the household 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:

    • PrimaryAddressNumberRF: Finds a primary address with specified party site.
      Finder Variables:
      • AddressNumber; string; The party site number.
    • PrimaryKey: Finds a primary address with address identifier.
      Finder Variables:
      • AddressId; integer; the unique address identifier.
      • LocationLocationId; integer; The unique identifier of the location.
  • 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:
    • AddressElementAttribute1; string; Additional address element to support flexible address format.
    • AddressElementAttribute2; string; Additional address element to support flexible address format.
    • AddressElementAttribute3; string; Additional address element to support flexible address format.
    • AddressElementAttribute4; string; Additional address element to support flexible address format.
    • AddressElementAttribute5; string; Additional address element to support flexible address format.
    • AddressId; integer; The unique identifier of the address that is internally generated during create. One of addressId, addressnumber or SourceSystem and sourcesystemreferencevalue keys is used to identify the address record during update.
    • AddressLine1; string; The first line for address.
    • AddressLine2; string; The second line for address.
    • AddressLine3; string; The third line for address.
    • AddressLine4; string; The fourth line for address.
    • AddressLinesPhonetic; string; Phonetic or Kana representation of the Kanji address lines (used in Japan).
    • AddressNumber; string; The alternate key identifier of 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. Prefix is defined as in profile option ZCA_PUID_PREFIX, concatenated with an internally generated unique sequence number.
    • Addressee; string; The addressee of the household.
    • Building; string; The specific building name or number at a given address.
    • City; string; The city element of the primary address.
    • Comments; string; The user-provided comments for the primary address.
    • ConflictId; integer; The unique identifier of the conflict for the primary address record. This number is used by mobile or portable applications that consume the web service.
    • CorpCurrencyCode; string; The corporate currency code. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
    • Country; string; The country code of the primary address. Review the list of country codes using the Manage Geographies task.
    • County; string; The county element of the primary address.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • CurcyConvRateType; string; The currency conversion rate type associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
    • CurrencyCode; string; The currency code associated with the primary address. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.
    • DateValidated; string; The date when the address was last validated.
    • DeleteFlag; boolean; Indicates whether the primary address is to be deleted. If the value is True, then the primary address will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
    • Description; string; An extensive description of the location.
    • DoNotValidateFlag; boolean; Indicator to specify that a particular location isn't eligible for address validation irrespective of the current validation.
    • EndDateActive; string; The last date for a primary address record in active status.
    • 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 the building mentioned in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • Latitude; number; The latitude information for the address. This is used for spatial proximity and containment purposes.
    • LocationComments; string; The additional information for the record in free text format.
    • LocationDirections; string; The directions to the location.
    • LocationId; integer; The unique identifier for the location record for this address.
    • LocationIntegrationKey; string; The integration key for the location record.
    • LocationLocationId; integer; The system identifier for the location record of the primary address.
    • LocationSourceSystem; string; The name of source system for the location record.
    • LocationSourceSystemReferenceValue; string; The unique identifier of the relationship from external source system.
    • LocationStatusFlag; boolean; The location record of primary address.
    • Longitude; number; The longitude information for the address. This is used for spatial proximity and containment purposes.
    • Mailstop; string; The user-defined code that indicates a mail drop point within the organization.
    • ObjectVersionNumberLocation; integer; The internal version number for the location for the primary address. The number is used to implement 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 determine whether another session has updated the row.
    • ObjectVersionNumberPartySite; integer; The internal version number for the party site for primary address. The number is used to implement 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 determine whether another session has updated the row.
    • OverallPrimaryFlag; boolean; Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.
    • PartyId; integer; The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.
    • PartySiteName; string; The name of the party site for the primary address.
    • PartySiteType; string; The type of the party site. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
    • PostalCode; string; The postal code element of the address.
    • PostalPlus4Code; string; The four-digit extension to the United States Postal ZIP code.
    • Province; string; The province element of the address.
    • ShortDescription; string; The short description of the primary address.
    • 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 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.
    • SourceSystemReferenceValue; string; 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.
    • StartDateActive; string; The date on which the resource is associated with a sales account.
    • State; string; The state element of the address.
    • Status; string; Indicates the status of the primary address. Status codes are defined by the lookup HZ_STATUS.
    • TimezoneCode; string; The code of the time zone associated with the primary address.
    • ValidatedFlag; boolean; Indicates whether the location was validated. Y for validated, N for invalidated. The value is internally set by system during address cleansing. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to NULL.
    • 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 : households-PrimaryAddress
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : households-PrimaryAddress-item-response
Type: object
Show Source
  • Title: Addressee
    Maximum Length: 360
    The addressee of the household.
  • Title: Additional Address Element 1
    Maximum Length: 150
    Additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    Additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    Additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    Additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    Additional address element to support flexible address format.
  • Read Only: true
    The unique identifier of the address that is internally generated during create. One of addressId, addressnumber or SourceSystem and sourcesystemreferencevalue keys is used to identify the address record during update.
  • 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.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    Phonetic or Kana representation of the Kanji address lines (used in Japan).
  • Title: Site Number
    Maximum Length: 30
    The alternate key identifier of 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. Prefix is defined as in profile option ZCA_PUID_PREFIX, concatenated with an internally generated unique sequence number.
  • Title: Building
    Maximum Length: 240
    The specific building name or number at a given address.
  • Title: City
    Maximum Length: 60
    The city element of the primary address.
  • Title: Comments
    Maximum Length: 2000
    The user-provided comments for the primary address.
  • Default Value: 0
    The unique identifier of the conflict for the primary address record. This number is used by mobile or portable applications that consume the web service.
  • Maximum Length: 15
    The corporate currency code. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Country
    Maximum Length: 2
    The country code of the primary address. Review the list of country codes using the Manage Geographies task.
  • Title: County
    Maximum Length: 60
    The county element of the primary address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Maximum Length: 30
    The currency conversion rate type associated with the address. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the primary address. The default value is the value specified in the profile option ZCA_COMMON_CORPORATE_CURRENCY.
  • Title: Validated Date
    The date when the address was last validated.
  • Title: Delete Primary Address
    Indicates whether the primary address is to be deleted. If the value is True, then the primary address will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
  • Title: Description
    Maximum Length: 2000
    An extensive description of the location.
  • Title: Don't Validate
    Maximum Length: 1
    Indicator to specify that a particular location isn't eligible for address validation irrespective of the current validation.
  • Title: To Date
    The last date for a primary address record in active status.
  • 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: Address
    Read Only: true
    The formatted multiple line address information.
  • Title: House Type
    Maximum Length: 30
    The type of the building mentioned in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the record.
  • Title: Latitude
    The latitude information for the address. This is used for spatial proximity and containment purposes.
  • Links
  • Title: Comments
    Maximum Length: 2000
    The additional information for the record in free text format.
  • Title: Location Directions
    Maximum Length: 640
    The directions to the location.
  • The unique identifier for the location record for this address.
  • The integration key for the location record.
  • Title: Location ID
    The system identifier for the location record of the primary address.
  • The name of source system for the location record.
  • The unique identifier of the relationship from external source system.
  • Maximum Length: 1
    Default Value: true
    The location record of primary address.
  • Title: Longitude
    The longitude information for the address. This is used for spatial proximity and containment purposes.
  • Title: Mail Stop
    Maximum Length: 60
    The user-defined code that indicates a mail drop point within the organization.
  • The internal version number for the location for the primary address. The number is used to implement 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 determine whether another session has updated the row.
  • The internal version number for the party site for primary address. The number is used to implement 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 determine whether another session has updated the row.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.
  • The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.
  • Title: Site Name
    Maximum Length: 240
    The name of the party site for the primary address.
  • Title: One-Time Address
    Maximum Length: 30
    The type of the party site. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
  • Title: Postal Code
    Maximum Length: 60
    The postal code element of the address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four-digit extension to the United States Postal ZIP code.
  • Title: Province
    Maximum Length: 60
    The province element of the address.
  • Title: Short Description
    Maximum Length: 240
    The short description of the primary 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 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.
  • Title: From Date
    The date on which the resource is associated with a sales account.
  • Title: State
    Maximum Length: 60
    The state element of the address.
  • Maximum Length: 1
    Default Value: A
    Indicates the status of the primary address. Status codes are defined by the lookup HZ_STATUS.
  • Title: Time Zone
    Maximum Length: 64
    The code of the time zone associated with the primary address.
  • Title: Validated
    Maximum Length: 1
    Default Value: false
    Indicates whether the location was validated. Y for validated, N for invalidated. The value is internally set by system during address cleansing. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to NULL.
  • Title: Validation Status
    Maximum Length: 30
    The code indicating the status of the validation. Internally set by system during address cleansing.
Back to Top

Examples

cURL Command

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

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress

Example of Response Body

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

{
    "PartyId": 300100046232383,
    "PartyNumber": "CDRM_336627",
    "AddressId": 300100046232387,
    "AddressNumber": "CDRM_97969",
    "LastUpdatedBy": "SALES_ADMIN",
    "StartDateActive": "2015-01-09",
    "Status": "A",
    "Address1": "600 Oracle Parkway",
    ...
}
Back to Top