Get an address
get
/fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/addresses/{addressesUniqID}
Request
Path Parameters
-
PartyId(required): integer(int64)
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=
-
addressesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Addresses resource and used to uniquely identify an instance of Addresses. The client should not generate the hash key value. Instead, the client should query on the Addresses collection resource in order to navigate to a specific instance of Addresses to get the hash key.
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 : externalOrganizations-addresses-item-response
Type:
Show Source
object
-
AddrElementAttributeFive: string
Title:
Additional Address Element 5
Maximum Length:150
The fifth additional address element. -
AddrElementAttributeFour: string
Title:
Additional Address Element 4
Maximum Length:150
The fourth additional address element. -
AddrElementAttributeOne: string
Title:
Additional Address Element 1
Maximum Length:150
The first additional address element. -
AddrElementAttributeThree: string
Title:
Additional Address Element 3
Maximum Length:150
The third additional address element. -
AddrElementAttributeTwo: string
Title:
Additional Address Element 2
Maximum Length:150
The second additional address element. -
AddressFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier for the address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The Phonetic or Kana representation of the Kanji address lines, used in Japan. -
AddressOne: string
Title:
Address Line 1
Maximum Length:240
The first line of the address. -
AddressThree: string
Title:
Address Line 3
Maximum Length:240
The third line of the address. -
AddressTwo: string
Title:
Address Line 2
Maximum Length:240
The second line of the address. -
AddressUseTypeCode: string
Title:
Purpose
Maximum Length:30
The use type code of the address. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE. -
AddressUseTypeMeaning: string
Read Only:
true
Maximum Length:80
The use type meaning of the address, for example, home or business. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The name of the city mentioned in the address. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
EndDate: string
(date)
Title:
To Date
The end date of the address. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the building in the address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiline address. -
HouseTypeCode: string
Title:
House Type
Maximum Length:30
The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
HouseTypeMeaning: string
Read Only:
true
Maximum Length:80
The house type meaning of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The location directions of the address. -
LocationId: integer
(int64)
Title:
Location ID
Read Only:true
The unique identifier for the location in the address. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name for the location in the address. -
Position: string
Title:
Position
Maximum Length:50
The position of the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlusFourCode: string
Title:
Postal Code Extension
Maximum Length:20
The postal plus four code of the address. -
PreferredFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if this is a preferred address or not. -
Province: string
Title:
Province
Maximum Length:60
The province code of the address. -
StartDate: string
(date)
Title:
From Date
The start date of the address. -
State: string
Title:
State
Maximum Length:60
The state code of the address.
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
- HeyLookupVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_PARTY_SITE_USE
The following properties are defined on the LOV link relation:- Source Attribute: AddressUseTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PersonProfileLookupVO
-
Parameters:
- finder:
LookupTypeIsActiveFinder%3BLookupType%3DHZ_HOUSE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: HouseTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: