Get an address

get

/crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/addresses/{AddressNumber}

Request

Path Parameters
  • The alternate key identifier of the address that is internally generated during create. One of AddressId or AddressNumber keys is used to identify the address record during update.
  • The unique identifier for the partner contact party. It Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.
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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : partnerContacts-addresses-item-response
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Read Only: true
    The unique identifier of the address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line for address.
  • Title: Address Line 1
    Maximum Length: 240
    The first line for address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
  • Title: Address Line 3
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line for address.
  • Title: Site Number
    Maximum Length: 30
    The alternate key identifier of the address that is internally generated during create. One of AddressId or AddressNumber keys is used to identify the address record during update.
  • Title: Type
    The lookup code for the type of address, such as billing address, shipping address etc.
  • Title: Building
    Maximum Length: 240
    The building name or number in the address.
  • Title: City
    Maximum Length: 60
    The city in the address.
  • Title: CLLI Code
    Maximum Length: 60
    The Common Language Location Identifier (CLLI) code of the address. The code is used in North America to specify the location of the address.
  • Title: Comments
    Maximum Length: 2000
    The user-provided comments for the address.
  • Maximum Length: 15
    The corporate currency code of the address associated with the contact. 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 of the address. Review the list of countries using the Manage Geographies task.
  • Read Only: true
    The name of the country of the partner company.
  • Title: County
    Maximum Length: 60
    The county of the address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the address record.
  • Title: Created by Application
    Maximum Length: 30
    The module that created the address record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • 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.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the address. 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.
  • Title: Validated Date
    The date when the address was last validated.
  • Title: Description
    Maximum Length: 2000
    The description of the location.
  • Title: Contact Preferences
    Default Value: false
    Indicates whether the address should not be used for mailing.
  • Title: Floor
    Maximum Length: 40
    The floor number of the address.
  • Title: Address
    Read Only: true
    The formatted version of the address.
  • Title: Address
    Read Only: true
    The formatted multiline version of the address.
  • Title: Last Updated Date
    Read Only: true
    The date 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 of the user who last updated the record.
  • Title: Latitude
    The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
  • Links
  • Title: Location Directions
    Maximum Length: 640
    The directions to the address location.
  • Title: Location ID
    The unique identifier for the location.
  • Title: Longitude
    The longitude information for the address. The longitude information for the location 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.
  • Title: Party ID
    The unique identifier of the partner associated with the address.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four-digit extension to the United States Postal ZIP code for the address.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether this is the primary address of the partner. If the value is Y, then this address is the primary address of the partner. The default value is N.
  • Title: Province
    Maximum Length: 60
    The province of the address.
  • The identifier of the record from external source system.
  • The name of the external source system.
  • Title: State
    Maximum Length: 60
    The state of the address.
  • 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.
Back to Top