State

What can you do with State?


Properties

Property Details
id
"id": 145
Type: Number
This is the unique numeric identifier for the State
countryId
"countryId": 13
Type: Number
Unique identifier for the associated Country object.
name
"name": "Hello World"
Type: String
sortOrder
"sortOrder": 820
Type: Number
code
"code": "Hello World"
Type: String
isVisible
"isVisible": true
Type: Boolean
ownerId
"ownerId": 281
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:

  • identity
  • countryId
  • name
  • sortOrder
  • code
  • isVisible

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the State object.

Standard PATCH objects:

  • city - create, update, delete

DataFlow PATCH objects:

  • state - create, update, delete
  • city - create, update, delete

End Points

DELETEapi/v1/State/{id:int}
Delete an instance of the State object.
GETapi/v1/State
Retrieve all of the State objects.
GETapi/v1/State/Default
Retrieve all of the State objects.
GETapi/v1/State/Default/Paged
Retreive all of the State objects in a paged fashion.
GETapi/v1/State/Default/Paged/Detail
Retreive all of the State objects in a paged fashion with all object details.
GETapi/v1/State/Default/{id:int}
Retrieve an instance of the State object by it's ID.
{id:int}Unique identifier for the State object.
GETapi/v1/State/Default/{id:int}/Detail
Retrieve a specified /{id:int}/ object by it's ID for a specified State.
{id:int}Unique identifier for the State object.
GETapi/v1/State/Metadata
Retrieve all of the meta data details of the State object.
GETapi/v1/State/Metadata/{option}
Retrieve all the meta data details of the State object based on provided options.
{option}Metadata options for the State object.
GETapi/v1/State/Paged
Retreive all of the State objects in a paged fashion.
GETapi/v1/State/Paged/Detail
Retreive all of the State objects in a paged fashion with all object details.
GETapi/v1/State/{id:int}
Retrieve an instance of the State object by it's ID.
{id:int}Unique identifier for the State object.
GETapi/v1/State/{id:int}/Detail
Retreive all of the Detail objects for the specified State.
{id:int}Unique identifier for the State object.
PATCHapi/v1/State/{id:int}
Update the State object and optionally make changes to any child objects.
POSTapi/v1/State
Create a new instance of the State object.
PUTapi/v1/State/{id:int}
Update an existing instance of the State object.