Get a primary address
get
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Request
Path Parameters
-
AddressNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
PartyNumber(required): string
The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : accounts-PrimaryAddress-item-response
Type:
Show Source
object
-
Addressee: string
Title:
Addressee
Maximum Length:360
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier of the primary address. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line of the primary address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line of the primary address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line of the primary address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the primary address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the primary address. -
City: string
Title:
City
Maximum Length:60
The city element of the primary address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the primary address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the account. 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
Title:
Country
Maximum Length:2
The country code of the primary address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the primary address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the primary address record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are 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
Title:
Currency
Maximum Length:15
The currency code. A list of valid values are 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. -
DateValidated: string
(date)
Title:
Validated Date
The date when the primary address was last validated. -
DeleteFlag: boolean
Title:
Delete Primary Address
Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates the contact preference to indicate DNC option. -
EndDateActive: string
(date)
Title:
To Date
The last date for a record in active status. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the primary address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the primary address. -
FormattedMultiLineAddress: string
Title:
Address
Read Only:true
The formatted multiline version of the primary address. -
HouseType: string
Title:
House Type
Maximum Length:30
Indicates the building type for the building 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
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationComments: string
Title:
Comments
Maximum Length:2000
The additional information for the record in free text format. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
The unique identifier for the location.
-
LocationIntegrationKey: string
The integration key for the location record.
-
LocationLocationId: integer
(int64)
Title:
Location ID
The system identifier for the location record. -
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
Maximum Length:
1
Default Value:true
The status flag for location record. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ObjectVersionNumberLocation: integer
(int32)
The internal version number for the location object. The number 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
(int32)
The internal version number for the party site object. The number 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
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. -
PartyId: integer
(int64)
The unique identifier of the account associated with the address.
-
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name of the party site. -
PartySiteType: string
Title:
One-Time Address
Maximum Length:30
The type information of the party site. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
ShortDescription: string
Title:
Short Description
Maximum Length:240
The brief free text that describes the site record. -
SourceSystem: string
The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
-
SourceSystemReferenceValue: string
The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
-
StartDateActive: string
(date)
Title:
From Date
The date on which the record becomes active. -
State: string
Title:
State
Maximum Length:60
The state of the address. -
Status: string
Maximum Length:
1
Default Value:A
The status of the record. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone for the location. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
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
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The list of values indicating the country code of the address, such as US or UK.
The following properties are defined on the LOV link relation:- Source Attribute: Country; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- finder:
- HouseTypeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE
The list of values indicating the house type of the primary address, such as House Boat and Trailer.
The following properties are defined on the LOV link relation:- Source Attribute: HouseType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: