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

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.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • 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.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partnerContacts-addresses-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if the actions can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partnerContacts-addresses-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : partnerContacts-addresses-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from the system action flag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : partnerContacts-addresses-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
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
smartActions
Parameters:
  • AddressNumber: $request.path.AddressNumber
  • PartyNumber: $request.path.PartyNumber
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Back to Top

Examples

The following example shows how to get an address of partner contacts by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerContacts/100000016934085/child/addresses/CDRM_27853' -X GET

Example of Response Body

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

{
    "PartyId": 100000016934086,
    "AddressId": 300100026717351,
    "AddressNumber": "CDRM_27853",
    "Comments": null,
    "DoNotMailFlag": false,
    "CorpCurrencyCode": "USD",
    "CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
    "CreationDate": "2013-08-23T04:23:49.874+00:00",
    "CurcyConvRateType": "Corporate",
    "CurrencyCode": "USD",
    "LastUpdateDate": "2014-08-04T05:09:04.740+00:00",
    "LastUpdateLogin": "FF5E346BE9104D4CE0435060F00A3D53",
    "LastUpdatedBy": "CHANNEL_OPERATIONS_MANAGER",
    "LocationId": 300100026717352,
    "Mailstop": "BOSTON COMMON",
    "PrimaryFlag": true,
    "AddressLinesPhonetic": null,
    "Building": null,
    "City": "SAN JOSE",
    "ClliCode": null,
    "Country": "US",
    "County": null,
    "DateValidated": null,
    "Description": null,
    "FloorNumber": null,
    "Latitude": null,
    "LocationDirections": null,
    "Longitude": null,
    "PostalCode": "95112",
    "PostalPlus4Code": null,
    "Province": null,
    "State": "California",
    "ValidatedFlag": false,
    "CountryName": "United States",
    "AddressType": null,
    "AddressLineOne": "Wall Street",
    "AddressLineTwo": "Quimby Road",
    "AddressLineThree": "DOWN TOWN",
    "AddressLineFour": null,
    "CreatedByModule": "HZ_CPUI",
    "FormattedAddress": "Wall Street,Quimby Road,SAN JOSE, CALIFORNIA 95112",
    "FormattedMultilineAddress": "Wall Street Quimby Road  SAN JOSE, CALIFORNIA 95112",
    "AddrElementAttribute1": null,
    "AddrElementAttribute2": null,
    "AddrElementAttribute3": null,
    "AddrElementAttribute4": null,
    "AddrElementAttribute5": null,
    "SourceSystem": null,
    "SourceSystemReferenceValue": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerContacts/100000016934085/child/addresses/CDRM_27853",
            "name": "addresses",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E00020000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerContacts/100000016934085/child/addresses/CDRM_27853",
            "name": "addresses",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerContacts/100000016934085",
            "name": "partnerContacts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerContacts/100000016934085/child/addresses/CDRM_27853/lov/CountriesLOV",
            "name": "CountriesLOV",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerContacts/100000016934085/child/addresses/CDRM_27853/child/smartActions",
            "name": "smartActions",
            "kind": "collection"
        }
    ]
}
Back to Top