Jump to

• Request
• Response
• Examples

Create a primary address

post

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress

Request

Path Parameters

• PartyNumber(required): string
  The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Addressee: string
  Title: Addressee

  Maximum Length: 360

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the primary address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the primary address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the primary address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the primary address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
• AddressNumber: string
  Title: Site Number

  Maximum Length: 30

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

  Maximum Length: 240

  The building name or number in the primary address.
• City: string
  Title: City

  Maximum Length: 60

  The city element of the primary address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

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

  The unique identifier of the conflict.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the account. 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 primary address. Review the list of country codes using the Manage Geographies task.
• County: string
  Title: County

  Maximum Length: 60

  The county of the primary address.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DateValidated: string (date)
  Title: Validated Date

  The date when the primary address was last validated.
• DeleteFlag: boolean
  Title: Delete Primary Address

  Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the location.
• DoNotValidateFlag: boolean
  Title: Don't Validate

  Maximum Length: 1

  Indicates the contact preference to indicate DNC option.
• EndDateActive: string (date)
  Title: To Date

  The last date for a record in active status.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the primary address.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  Indicates the building type for 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.
• Latitude: number
  Title: Latitude

  The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
• LocationComments: string
  Title: Comments

  Maximum Length: 2000

  The additional information for the record in free text format.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the address location.
• LocationId: integer (int64)
  The unique identifier for the location.
• LocationIntegrationKey: string
  The integration key for the location record.
• LocationLocationId: integer (int64)
  Title: Location ID

  The system identifier for the location record.
• LocationSourceSystem: string
  The name of source system for the location record.
• LocationSourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• LocationStatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  The status flag for location record.
• Longitude: number
  Title: Longitude

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

  Maximum Length: 60

  The user-defined code that indicates a mail drop point within the organization.
• ObjectVersionNumberLocation: integer (int32)
  The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• ObjectVersionNumberPartySite: integer (int32)
  The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• OverallPrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.
• PartyId: integer (int64)
  The unique identifier of the account associated with the address.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  The name of the party site.
• PartySiteType: string
  Title: One-Time Address

  Maximum Length: 30

  The type information of the party site.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four-digit extension to the United States Postal ZIP code for the address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• ShortDescription: string
  Title: Short Description

  Maximum Length: 240

  The brief free text that describes the site record.
• SourceSystem: string
  The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
• StartDateActive: string (date)
  Title: From Date

  The date on which the record becomes active.
• State: string
  Title: State

  Maximum Length: 60

  The state of the address.
• Status: string
  Maximum Length: 1

  Default Value: A

  The status of the record.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 64

  The time zone for the location.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
• 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":{
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":"240",
            "type":"string",
            "description":"The brief free text that describes the site record.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the organization.",
            "nullable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the contact preference to indicate DNC option.",
            "nullable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. 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
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "default":"A"
        },
        "OverallPrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.",
            "nullable":false,
            "default":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
        },
        "LocationLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The system identifier for the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "LocationStatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The status flag for location record.",
            "nullable":false,
            "default":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "DeleteFlag":{
            "title":"Delete Primary Address",
            "type":"boolean",
            "description":"Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.",
            "nullable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "LocationComments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The additional information for the record in free text format.",
            "nullable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.",
            "nullable":true,
            "default":false
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The last date for a record in active status.",
            "format":"date",
            "nullable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the address location.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":"30",
            "type":"string",
            "description":"The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "nullable":false
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the primary address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the primary address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the primary address.",
            "nullable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":"64",
            "type":"string",
            "description":"The time zone for the location.",
            "nullable":true
        },
        "LocationIntegrationKey":{
            "type":"string",
            "description":"The integration key for the location record.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date on which the record becomes active.",
            "format":"date",
            "nullable":false
        },
        "PartySiteType":{
            "title":"One-Time Address",
            "maxLength":"30",
            "type":"string",
            "description":"The type information of the party site.",
            "nullable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the building type for 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"
            }
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.",
            "nullable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the primary address was last validated.",
            "format":"date",
            "nullable":true
        },
        "LocationSourceSystem":{
            "type":"string",
            "description":"The name of source system for the location record.",
            "nullable":true
        },
        "Addressee":{
            "title":"Addressee",
            "maxLength":"360",
            "type":"string",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Addressee",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Addressee"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the primary address.",
            "nullable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LocationSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true
        },
        "ObjectVersionNumberPartySite":{
            "type":"integer",
            "description":"The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the account associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true
        }
    }
}

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 : accounts-PrimaryAddress-item-response

Type: object

Show Source

• Addressee: string
  Title: Addressee

  Maximum Length: 360

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• AddressElementAttribute1: string
  Title: Additional Address Element 1

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  An additional address element to support flexible address format.
• AddressId: integer (int64)
  Read Only: true

  The unique identifier of the primary address.
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the primary address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the primary address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  The third line of the primary address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line of the primary address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
• AddressNumber: string
  Title: Site Number

  Maximum Length: 30

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

  Maximum Length: 240

  The building name or number in the primary address.
• City: string
  Title: City

  Maximum Length: 60

  The city element of the primary address.
• Comments: string
  Title: Comments

  Maximum Length: 2000

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

  The unique identifier of the conflict.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency code associated with the account. 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 primary address. Review the list of country codes using the Manage Geographies task.
• County: string
  Title: County

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 64

  The user who created the primary address record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurcyConvRateType: string
  Maximum Length: 30

  The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DateValidated: string (date)
  Title: Validated Date

  The date when the primary address was last validated.
• DeleteFlag: boolean
  Title: Delete Primary Address

  Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the location.
• DoNotValidateFlag: boolean
  Title: Don't Validate

  Maximum Length: 1

  Indicates the contact preference to indicate DNC option.
• EndDateActive: string (date)
  Title: To Date

  The last date for a record in active status.
• FloorNumber: string
  Title: Floor

  Maximum Length: 40

  The floor number of the primary address.
• FormattedAddress: string
  Title: Address

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Indicates the building type for 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 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 of the user who last updated the record.
• Latitude: number
  Title: Latitude

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

  The link relations associated with the resource instance.
• LocationComments: string
  Title: Comments

  Maximum Length: 2000

  The additional information for the record in free text format.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the address location.
• LocationId: integer (int64)
  The unique identifier for the location.
• LocationIntegrationKey: string
  The integration key for the location record.
• LocationLocationId: integer (int64)
  Title: Location ID

  The system identifier for the location record.
• LocationSourceSystem: string
  The name of source system for the location record.
• LocationSourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• LocationStatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  The status flag for location record.
• Longitude: number
  Title: Longitude

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

  Maximum Length: 60

  The user-defined code that indicates a mail drop point within the organization.
• ObjectVersionNumberLocation: integer (int32)
  The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• ObjectVersionNumberPartySite: integer (int32)
  The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
• OverallPrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.
• PartyId: integer (int64)
  The unique identifier of the account associated with the address.
• PartySiteName: string
  Title: Site Name

  Maximum Length: 240

  The name of the party site.
• PartySiteType: string
  Title: One-Time Address

  Maximum Length: 30

  The type information of the party site.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• PostalPlus4Code: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four-digit extension to the United States Postal ZIP code for the address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• ShortDescription: string
  Title: Short Description

  Maximum Length: 240

  The brief free text that describes the site record.
• SourceSystem: string
  The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
• StartDateActive: string (date)
  Title: From Date

  The date on which the record becomes active.
• State: string
  Title: State

  Maximum Length: 60

  The state of the address.
• Status: string
  Maximum Length: 1

  Default Value: A

  The status of the record.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 64

  The time zone for the location.
• ValidatedFlag: boolean
  Title: Validated

  Maximum Length: 1

  Default Value: false

  Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
• 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":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":"240",
            "type":"string",
            "description":"The brief free text that describes the site record.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the contact preference to indicate DNC option.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the primary address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code associated with the account. 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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the primary address record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverallPrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "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
        },
        "LocationLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The system identifier for the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted version of the primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city element of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationStatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The status flag for location record.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Primary Address",
            "type":"boolean",
            "description":"Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "LocationComments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The additional information for the record in free text format.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The last date for a record in active status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the address location.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the primary address.",
            "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 primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the primary address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number in the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number of the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":"64",
            "type":"string",
            "description":"The time zone for the location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationIntegrationKey":{
            "type":"string",
            "description":"The integration key for the location record.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date on which the record becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartySiteType":{
            "title":"One-Time Address",
            "maxLength":"30",
            "type":"string",
            "description":"The type information of the party site.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the building type for 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
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.",
            "nullable":true,
            "x-queryable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the primary address was last validated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LocationSourceSystem":{
            "type":"string",
            "description":"The name of source system for the location record.",
            "nullable":true,
            "x-queryable":true
        },
        "Addressee":{
            "title":"Addressee",
            "maxLength":"360",
            "type":"string",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Addressee",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Addressee"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberPartySite":{
            "type":"integer",
            "description":"The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultiLineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline version of the primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the account associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

CountriesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndTerritories

Parameters:

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

The list of values indicating the country code of the address, such as US or UK.

The following properties are defined on the LOV link relation:

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

HouseTypeLookupLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE

The list of values indicating the house type of the primary address, such as House Boat and Trailer.

The following properties are defined on the LOV link relation:

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

Back to Top

Examples

The following example shows how to create a primary address by submitting a post request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_ 336942/child/PrimaryAddress

Example of Request Body

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

{
    "Address1": "500 New Oracle Parkway",
    "City": "Redwood Shores",
    "Country": "US",
    "CreatedByModule": "HZ_WS"
}

Example of Response Body

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

{
    "AddressId": 300100094767111,
    "AddressNumber": "CDRM_200965",
    "City": "Redwood Shores",
    "Country": "US",
    "FormattedAddress": "REDWOOD SHORES,",
    "FormattedMultiLineAddress": "REDWOOD SHORES,",
    ...
}

Back to Top