Country / Address Format

What can you do with CountryAddressFormat?


Properties

Property Details
id
"id": 666
Type: Number
This is the unique numeric identifier for the CountryAddressFormat
ownerId
"ownerId": 252
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
isAddressTwoRequired
"isAddressTwoRequired": true
Type: Boolean
isStateUsed
"isStateUsed": true
Type: Boolean
validateAddress
"validateAddress": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • identity
  • name
  • isAddressTwoRequired
  • isStateUsed
  • validateAddress

DataFlow PATCH objects:


End Points

DELETEapi/v1/Country/AddressFormat/{id:int}
Delete an instance of the CountryAddressFormat object.
GETapi/v1/Country/AddressFormat
Retrieve all of the CountryAddressFormat objects.
GETapi/v1/Country/AddressFormat/Metadata
Retrieve all of the meta data details of the CountryAddressFormat object.
GETapi/v1/Country/AddressFormat/Metadata/{option}
Retrieve all the meta data details of the CountryAddressFormat object based on provided options.
{option}Metadata options for the CountryAddressFormat object.
GETapi/v1/Country/AddressFormat/Paged
Retreive all of the CountryAddressFormat objects in a paged fashion.
GETapi/v1/Country/AddressFormat/{id:int}
Retrieve an instance of the CountryAddressFormat object by it's ID.
{id:int}Unique identifier for the CountryAddressFormat object.
POSTapi/v1/Country/AddressFormat
Create a new instance of the CountryAddressFormat object.
PUTapi/v1/Country/AddressFormat/{id:int}
Update an existing instance of the CountryAddressFormat object.