TAG LINE
SMALL TITLE

State

(API Version v3)


What can you do with State?


Properties

Property Details
id
"id": 15
Type: Number
This is the unique numeric identifier for the State
countryId
"countryId": 17
Type: Number
Unique identifier for the associated Country object.
name
"name": "Hello World"
Type: String
sortOrder
"sortOrder": 15
Type: Number
code
"code": "Hello World"
Type: String
isVisible
"isVisible": true
Type: Boolean
ownerId
"ownerId": 8
Type: Number
Unique identifier for the associated Owner object.


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:

  • countryId
  • name
  • sortOrder
  • code
  • isVisible
  • countryCode

DataFlow PATCH objects:

  • state - create, update, delete

End Points

GETapi/v3/State
Retrieve all of the State objects.
GETapi/v3/State/Paged
Retreive all of the State objects in a paged fashion.
GETapi/v3/State/{id:int}
Retrieve an instance of the State object by it's ID.
{id:int}Unique identifier for the State object.