Create an address locale
post
/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Request
Path Parameters
-
AddressNumber(required): string
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.
-
PartyNumber(required): string
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.
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:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
FloorNumber: string
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. -
LocationId: integer
(int64)
The unique identifier of the location record.
-
PostalCode: string
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. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
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.
-
SiteSourceSystemReferenceValue: string
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.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : households-Address-AddressLocale-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is 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
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
The specific name of the country in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address locale record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address locale record was created. -
FloorNumber: string
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. -
FormattedAddress: string
Read Only:
true
The formatted read only version of the locale address. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the address locale was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the address locale record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the address locale record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
The unique identifier of the location record.
-
LocationLocaleId: integer
(int64)
Read Only:
true
The unique identifier of the location locale record. -
PostalCode: string
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. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
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.
-
SiteSourceSystemReferenceValue: string
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.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- TransliterationLanguageLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: TransliterationLanguage; Target Attribute: LanguageCode
- Display Attribute: Description