Create an address
post
/fscmRestApi/resources/11.13.18.05/externalOrganizations/{PartyId}/child/addresses
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=
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:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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. -
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. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The location directions of 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.
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 : 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: