Jump to

• Request
• Response
• Examples

Get an address

get

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}

Request

Path Parameters

• AddressNumber(required): string
  The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
• PartyNumber(required): string
  The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.

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: string
  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: string
  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

• 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 : households-Address-item-response

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttribute2: string
  Title: Additional Address Element 2

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttribute3: string
  Title: Additional Address Element 3

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttribute4: string
  Title: Additional Address Element 4

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttribute5: string
  Title: Additional Address Element 5

  Maximum Length: 150

  The additional address element to support flexible address format.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line for address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line for address.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line for address.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line for address.
• AddressId: integer (int64)
  Read Only: true

  Address internal unique identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  Phonetic or Kana representation of the Kanji address lines (used in Japan).
• AddressLocale: array Address Locales
  Title: Address Locales

  The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
• AddressNumber: string
  Title: Site Number

  Maximum Length: 30

  The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
• AddressPurpose: array Address Purposes
  Title: Address Purposes

  The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
• AddressType: string
  Title: Type

  The address type as a string. You can pass either Address Type or Address Type List for Account service.
• Building: string
  Title: Building

  Maximum Length: 240

  Specific building name or number at a given address.
• CalculateFormattedAddress: boolean
  The indicator to process formatted address of the party record.
• City: string
  Title: City

  Maximum Length: 60

  The city element of address.
• ClliCode: string
  Title: CLLI Code

  Maximum Length: 60

  The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the address.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict for the address record. This number is used by mobile or portable applications that consume the web service.
• CorpCurrencyCode: string
  Title: Corporate Currency

  Maximum Length: 15

  The corporate currency code associated with the address. 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.
• Country: string
  Title: Country

  Maximum Length: 2

  The country code of the address. Review the list of country codes using the Manage Geographies task.
• County: string
  Title: County

  Maximum Length: 60

  The county element of address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreatedByModule: string
  Default Value: HZ_WS

  The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
• CreatedByModule1: string
  Title: Created by Application

  Maximum Length: 30

  The module that created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the address. A list of valid values is 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.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code related to the address. A list of valid values is 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.
• DateValidated: string (date)
  Title: Validated Date

  The date when the address was last validated.
• Description: string
  Title: Description

  Maximum Length: 2000

  An extensive description of the location.
• DoNotMailFlag: boolean
  Title: Contact Preferences

  Default Value: false

  Indicates whether the address should not be used for mailing. If the value is Y, then the address should not be used to mail to the contact. The default value is N. If this attribute is not explicitly mentioned in the payload while creating an address, then the value of this attribute is set to null.
• DoNotValidateFlag: boolean
  Title: Don't Validate

  Maximum Length: 1

  Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.
• DunsNumberC: string
  Title: D-U-N-S Number

  Maximum Length: 30

  The D-U-N-S number of the business location.
• EffectiveDate: string (date)
  The date when the address becomes active.
• EndDateActive: string (date)
  Title: End Date

  The date after which this address is rendered inactive.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The specific floor number at a given address or in a particular building when building number is provided.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The formatted address information.
• FormattedAddress1: string
  Title: Formatted Address 1

  Read Only: true

  The formatted version of the address.
• FormattedMultilineAddress: string
  Title: Address

  Read Only: true

  The formatted multiple line address information.
• FormattedMultilineAddress1: string
  Title: Address

  Read Only: true

  The formatted multiline version of the address.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the record.
• Latitude: number
  Title: Latitude

  The latitude information for the address. This is used for spatial proximity and containment purposes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the location.
• LocationId: integer (int64)
  Title: Location ID

  The unique identifier for this location.
• Longitude: number
  Title: Longitude

  The longitude information for the address. This is used for spatial proximity and containment purposes.
• Mailstop: string
  Title: Mail Stop

  Maximum Length: 60

  A user-defined code to indicate a mail drop point within their organization.
• ObjectVersionNumber: integer (int32)
  The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• ObjectVersionNumber1: integer (int32)
  The number used to implement optimistic locking for address record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The name of the party.
• PartyNumber: string
  Title: Party Number

  The unique identifier for the party (account, contact, or household), to which the address is associated. One of PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system-generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  User-defined name for the address.
• PartySourceSystem: string
  Title: Party Source System

  The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
• PartyUniqueName: string
  Title: Unique Party Name

  Read Only: true

  Maximum Length: 900

  The unique party name of the party record.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code as defined by the formal countrywide postal system.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four-digit extension to the United States Postal ZIP code.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the associated object. If the value is True, then this is the primary address. The default value is False. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• Province: string
  Title: Province

  Maximum Length: 60

  The province element of address.
• SalesAccountFlag: boolean
  Title: Sales Account Flag

  Read Only: true

  Maximum Length: 10

  Default Value: false

  Indicates whether the associated customer is a sales account.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• SourceSystem: string
  The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SourceSystemReferenceValue: string
  The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SSROwnerTableName: string
  Read Only: true

  Maximum Length: 255

  The name of the table that holds the address record data and is referenced to manage source system reference.
• SSRPartyOwnerTableName: string
  Read Only: true

  Maximum Length: 255

  Default Value: HZ_PARTIES

  The name of the table that holds the party record data and is referenced to manage source system reference.
• StartDateActive: string (date)
  Title: Start Date

  The date from which this address is active. This value is defaulted to the current system date if not provided during create.
• State: string
  Title: State

  Maximum Length: 60

  The state element of address.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  An internal application-determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates if the location was validated. If the value is True, then the location is validated. The default value is false. The value is internally set by system during address cleansing.
• ValidationStartDate: string (date)
  Read Only: true

  The date on which the validation starts. This attribute is internally set by the system during address cleansing.
• ValidationStatusCode: string
  Title: Validation Status

  Maximum Length: 30

  The code indicating the status of the validation. Internally set by system during address cleansing.

{
    "type":"object",
    "properties":{
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"Address internal unique identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"Phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLocale":{
            "title":"Address Locales",
            "type":"array",
            "description":"The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.",
            "items":{
                "$ref":"#/components/schemas/households-Address-AddressLocale-item-response"
            }
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated.  Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressPurpose":{
            "title":"Address Purposes",
            "type":"array",
            "description":"The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.",
            "items":{
                "$ref":"#/components/schemas/households-Address-AddressPurpose-item-response"
            }
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"The address type as a string. You can pass either Address Type or Address Type List for Account service.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            }
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"Specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculateFormattedAddress":{
            "type":"boolean",
            "description":"The indicator to process formatted address of the party record.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "ClliCode":{
            "title":"CLLI Code",
            "maxLength":60,
            "type":"string",
            "description":"The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict for the address record. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the address. 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.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code of the address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "type":"string",
            "description":"The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES.  Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "CreatedByModule1":{
            "title":"Created by Application",
            "maxLength":30,
            "type":"string",
            "description":"The module that created the record.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the address. A list of valid values is 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.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code related to the address. A list of valid values is 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.",
            "nullable":true,
            "x-queryable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the address was last validated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"An extensive description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotMailFlag":{
            "title":"Contact Preferences",
            "type":"boolean",
            "description":"Indicates whether the address should not be used for mailing. If the value is Y, then the address should not be used to mail to the contact. The default value is N. If this attribute is not explicitly mentioned in the payload while creating an address, then the value of this attribute is set to null.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.",
            "nullable":true,
            "x-queryable":true
        },
        "DunsNumberC":{
            "title":"D-U-N-S Number",
            "maxLength":30,
            "type":"string",
            "description":"The D-U-N-S number of the business location.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "type":"string",
            "description":"The date when the address becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date after which this address is rendered inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedAddress1":{
            "title":"Formatted Address 1",
            "type":"string",
            "description":"The formatted version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiple line address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedMultilineAddress1":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. This is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":640,
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for this location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. This is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":60,
            "type":"string",
            "description":"A user-defined code to indicate a mail drop point within their organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The number used to implement optimistic locking for address record. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the account, contact or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The unique identifier for the party (account, contact, or household), to which the address is associated. One of PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system-generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"User-defined name for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of external source system of the account, contact or household with which the address is associated.  Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyUniqueName":{
            "title":"Unique Party Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name of the party record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is True, then this is the primary address. The default value is False. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the table that holds the address record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SSRPartyOwnerTableName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the table that holds the party record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "SalesAccountFlag":{
            "title":"Sales Account Flag",
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether the associated customer is a sales account.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which this address is active. This value is defaulted to the current system date if not provided during create.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"An internal application-determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the location was validated. If the value is True, then the location is validated. The default value is false. The value is internally set by system during address cleansing.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValidationStartDate":{
            "type":"string",
            "description":"The date on which the validation starts. This attribute is internally set by the system during address cleansing.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the validation. Internally set by system during address cleansing.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/households-Address-smartActions-item-response"
            }
        }
    }
}

Nested Schema : Address Locales

Type: array

Title: Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Show Source

• Array of: object households-Address-AddressLocale-item-response

{
    "title":"Address Locales",
    "type":"array",
    "description":"The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.",
    "items":{
        "$ref":"#/components/schemas/households-Address-AddressLocale-item-response"
    }
}

Nested Schema : Address Purposes

Type: array

Title: Address Purposes

The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.

Show Source

• Array of: object households-Address-AddressPurpose-item-response

{
    "title":"Address Purposes",
    "type":"array",
    "description":"The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.",
    "items":{
        "$ref":"#/components/schemas/households-Address-AddressPurpose-item-response"
    }
}

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 : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object households-Address-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/households-Address-smartActions-item-response"
    }
}

Nested Schema : households-Address-AddressLocale-item-response

Type: object

Show Source

• AddrElementAttribute1: string
  Title: Address Element Attribute 1

  Maximum Length: 150

  The additional address element 1 to support flexible address format in local language.
• AddrElementAttribute2: string
  Title: Address Element Attribute 2

  Maximum Length: 150

  The additional address element 2 to support flexible address format in local language.
• AddrElementAttribute3: string
  Title: Address Element Attribute 3

  Maximum Length: 150

  The additional address element 3 to support flexible address format in local language.
• AddrElementAttribute4: string
  Title: Address Element Attribute 4

  Maximum Length: 150

  The additional address element 4 to support flexible address format in local language.
• AddrElementAttribute5: string
  Title: Address Element Attribute 5

  Maximum Length: 150

  The additional address element 5 to support flexible address format in local language.
• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the address in the local language.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the address in the local language.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the address in the local language.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the address in the local language.
• AddressNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  The unique address identifier that's internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue.
• Building: string
  Title: Building

  Maximum Length: 240

  The specific building name or number at a given address in local language.
• City: string
  Title: City

  Maximum Length: 60

  The specific name of the city in local language.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  The specific name of the country in local language.
• County: string
  Title: County

  Maximum Length: 60

  The specific name of the county in local language.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the address locale record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the address locale record was created.
• FloorNumber: string
  Title: Floor

  Maximum Length: 240

  The specific floor number at a given address or a particular building when building number is provided in local language.
• FormattedAddress: string
  Read Only: true

  The formatted read only version of the locale address.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the address locale was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the address locale record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the address locale record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  The unique identifier of the location record.
• LocationLocaleId: integer (int64)
  Read Only: true

  The unique identifier of the location locale record.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.
• PostalPlus4code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four digit extension to the United States Postal ZIP code in local language.
• Province: string
  Title: Province

  Maximum Length: 60

  The name of the province in local language.
• SiteSourceSystem: string
  The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• State: string
  Title: State

  Maximum Length: 60

  The name of the State in the local language.
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.

{
    "type":"object",
    "properties":{
        "AddrElementAttribute1":{
            "title":"Address Element Attribute 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element 1 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Address Element Attribute 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element 2 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute3":{
            "title":"Address Element Attribute 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element 3 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Address Element Attribute 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element 4 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Address Element Attribute 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element 5 to support flexible address format in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique address identifier that's internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The specific building name or number at a given address in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The specific name of the city in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The specific name of the country in local language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The specific name of the county in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the address locale record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the address locale record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":240,
            "type":"string",
            "description":"The specific floor number at a given address or a particular building when building number is provided in local language.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"The formatted read only version of the locale address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the address locale was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the address locale record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the address locale record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier of the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationLocaleId":{
            "type":"integer",
            "description":"The unique identifier of the location locale record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "PostalPlus4code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The name of the province in local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "SiteSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "SiteSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The name of the State in the local language.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":4,
            "type":"string",
            "description":"Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : households-Address-AddressPurpose-item-response

Type: object

Show Source

• AddressId: integer (int64)
  The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
• AddressNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
• AddressPurposeId: integer (int64)
  Read Only: true

  The unique identifier of the address purpose.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user comments for the address purpose.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the address purpose record.
• CreatedByModule: string
  Maximum Length: 30

  Default Value: HZ_WS

  The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the address purpose record was created.
• DeleteFlag: boolean
  Indicates whether the address purpose is to be deleted. If the value is True, then the address purpose will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.
• EndDate: string (date)
  Title: To Date

  The date on which the address purpose is no longer valid.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the address purpose was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the address purpose record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the address purpose record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryPerType: string
  Title: Primary

  Maximum Length: 1

  Default Value: N

  Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.
• Purpose: string
  Title: Purpose

  Maximum Length: 30

  The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SiteSourceSystem: string
  The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SiteSourceSystemReferenceValue: string
  The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• SourceSystem: string
  The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
• SourceSystemReferenceValue: string
  The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
• StartDate: string (date)
  Title: From Date

  The date from which the address purpose is valid.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.

{
    "type":"object",
    "properties":{
        "AddressId":{
            "type":"integer",
            "description":"The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressPurposeId":{
            "type":"integer",
            "description":"The unique identifier of the address purpose.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user comments for the address purpose.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the address purpose record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "maxLength":30,
            "type":"string",
            "description":"The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the address purpose record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the address purpose is to be deleted. If the value is True, then the address purpose will be deleted. The default value is NULL. If this attribute is not explicitly mentioned in the payload, then the value of this attribute is set to null.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date on which the address purpose is no longer valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the address purpose was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the address purpose record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the address purpose record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPerType":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Purpose":{
            "title":"Purpose",
            "maxLength":30,
            "type":"string",
            "description":"The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "SiteSourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "SiteSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date from which the address purpose is valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : households-Address-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/households-Address-smartActions-UserActionNavigation-item-response"
            }
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/households-Address-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/households-Address-smartActions-UserActionURLBinding-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object households-Address-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/households-Address-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object households-Address-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/households-Address-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object households-Address-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/households-Address-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : households-Address-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : households-Address-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : households-Address-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

AddressLocale

Operation: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale

Parameters:

• AddressNumber: $request.path.AddressNumber
• PartyNumber: $request.path.PartyNumber

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

AddressPurpose

Operation: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose

Parameters:

• AddressNumber: $request.path.AddressNumber
• PartyNumber: $request.path.PartyNumber

The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.

CountriesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndTerritories

Parameters:

• finder: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN

The list of values for the country code of the address, such as US and UK.

The following properties are defined on the LOV link relation:

• Source Attribute: Country; Target Attribute: TerritoryCode
• Display Attribute: TerritoryShortName

FuseTypeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeTagFinder%3BBindLookupType%3DPARTY_SITE_USE_CODE%2CBindTag%3DSALES_CLOUD

The following properties are defined on the LOV link relation:

• Source Attribute: AddressType; Target Attribute: LookupCode
• Display Attribute: Meaning

HouseTypeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE

The list of values for the building type, such as houseboat or trailer.

The following properties are defined on the LOV link relation:

• Source Attribute: HouseType; Target Attribute: LookupCode
• Display Attribute: Meaning

smartActions

Operation: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/smartActions

Parameters:

• AddressNumber: $request.path.AddressNumber
• PartyNumber: $request.path.PartyNumber

This VO stores the endpoint and security details for every user action.

Back to Top

Examples

cURL Command

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

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_336627/child/Address/CDRM_97969

Example of Response Body

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

{
    "PartyId": 300100046232383,
    "PartyNumber": "CDRM_336627",
    "AddressId": 300100046232387,
    "AddressNumber": "CDRM_97969",
    "LastUpdatedBy": "SALES_ADMIN",
    "StartDateActive": "2015-01-09",
    "Status": "A",
    "Address1": "600 Oracle Parkway",
    ...
	}

Back to Top