Jump to

• Request
• Response

Update an address

patch

/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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• State: string
  Title: State

  Maximum Length: 60

  The state code of the address.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the address.",
            "nullable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "HouseTypeCode":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the building in the address.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The fifth additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddrElementAttributeThree":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The third additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name for the location in the address.",
            "nullable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The Phonetic or Kana representation of the Kanji address lines, used in Japan.",
            "nullable":true
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The first additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "Position":{
            "title":"Position",
            "maxLength":"50",
            "type":"string",
            "description":"The position of the address.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city mentioned in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The end date of the address.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The location directions of the address.",
            "nullable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The second additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The fourth additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address.",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The postal plus four code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "PreferredFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if this is a preferred address or not.",
            "nullable":false,
            "default":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : externalOrganizations-addresses-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "HouseTypeCode":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"The house type code of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the building in the address.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The fifth additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The start date of the address.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeThree":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The third additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressUseTypeCode":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The use type code of the address. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name for the location in the address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The Phonetic or Kana representation of the Kanji address lines, used in Japan.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The first additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier for the address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AddressUseTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Position":{
            "title":"Position",
            "maxLength":"50",
            "type":"string",
            "description":"The position of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The house type meaning of the address. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location in the address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city mentioned in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The end date of the address.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The location directions of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The second additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The fourth additional address element.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the address.",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The postal plus four code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if this is a preferred address or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

HeyLookupVO

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

PersonProfileLookupVO

Operation: /fscmRestApi/resources/11.13.18.05/personProfileLookups

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

Back to Top