Get all address locales

get

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale

Request

Path Parameters
  • The alternate unique 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. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
  • 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:

    • PrimaryKey :Finds an address locale with the specified primary key.
      Finder Variables:
      • LocationLocaleId :The unique identifier of the location locale.
  • 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 1 to support flexible address format in local language.
    • AddrElementAttribute2; string; The additional address element 2 to support flexible address format in local language.
    • AddrElementAttribute3; string; The additional address element 3 to support flexible address format in local language.
    • AddrElementAttribute4; string; The additional address element 4 to support flexible address format in local language.
    • AddrElementAttribute5; string; The additional address element 5 to support flexible address format in local language.
    • Address1; string; The first line of the address in the local language.
    • Address2; string; The second line of the address in the local language.
    • Address3; string; The third line of the address in the local language.
    • Address4; string; The fourth line of the address in the local language.
    • AddressNumber; string; 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.
    • Building; string; The specific building name or number at a given address in local language.
    • City; string; The specific name of the city in local language.
    • Country; string; The specific name of the country in local language.
    • County; string; The specific name of the county in local language.
    • CreatedBy; string; The user who created the address locale record.
    • CreationDate; string; The date and time when the address locale record was created.
    • FloorNumber; string; The specific floor number at a given address or a particular building when building number is provided in local language.
    • LastUpdateDate; string; The date and time when the address locale was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the address locale record.
    • LastUpdatedBy; string; The user who last updated the address locale record.
    • LocationId; integer; The unique identifier of the location record.
    • PostalCode; string; 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.
    • PostalPlus4code; string; The four digit extension to the United States Postal ZIP code in local language.
    • Province; string; The name of the province in local language.
    • State; string; The name of the State in the local language.
    • TransliterationLanguage; string; 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.
  • 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-Address-AddressLocale
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : households-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.
Back to Top