Country / Address Format

(API Version v2)

What can you do with CountryAddressFormat?

DELETE api/v2/Country/AddressFormat/{id:int}
GET api/v2/Country/AddressFormat
GET api/v2/Country/AddressFormat/Paged
GET api/v2/Country/AddressFormat/{id:int}
POST api/v2/Country/AddressFormat
PUT api/v2/Country/AddressFormat/{id:int}

Properties

Property Details

id	"id": 20 Type: Number This is the unique numeric identifier for the CountryAddressFormat
ownerId	"ownerId": 23 Type: Number Unique identifier for the associated Owner object.
name	"name": "Hello World" Type: String
isStateRequired	"isStateRequired": true Type: Boolean
isStateVisible	"isStateVisible": true Type: Boolean
isCityRequired	"isCityRequired": true Type: Boolean
isCityVisible	"isCityVisible": true Type: Boolean
isAddress2Visible	"isAddress2Visible": true Type: Boolean
isZipCodeRequired	"isZipCodeRequired": true Type: Boolean
isZipCodeVisible	"isZipCodeVisible": 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
isStateRequired
isStateVisible
isCityRequired
isCityVisible
isAddress2Visible
isZipCodeRequired
isZipCodeVisible

DataFlow PATCH objects:

countryAddressFormat - create, update, delete

End Points

DELETE	api/v2/Country/AddressFormat/{id:int}
Delete an instance of the CountryAddressFormat object.

GET	api/v2/Country/AddressFormat
Retrieve all of the CountryAddressFormat objects.

GET	api/v2/Country/AddressFormat/Paged
Retreive all of the CountryAddressFormat objects in a paged fashion.

GET	api/v2/Country/AddressFormat/{id:int}
Retrieve an instance of the CountryAddressFormat object by it's ID.
{id:int}	Unique identifier for the CountryAddressFormat object.

POST	api/v2/Country/AddressFormat
Create a new instance of the CountryAddressFormat object.

PUT	api/v2/Country/AddressFormat/{id:int}
Update an existing instance of the CountryAddressFormat object.