System / State

What can you do with SystemState?


Properties

Property Details
id
"id": 988
Type: Number
This is the unique numeric identifier for the SystemState
name
"name": "Hello World"
Type: String
systemCountryId
"systemCountryId": 841
Type: Number
Unique identifier for the associated SystemCountry object.
sortOrder
"sortOrder": 892
Type: Number
code
"code": "Hello World"
Type: String


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:

  • name
  • systemCountryId
  • sortOrder
  • code

DataFlow PATCH objects:


End Points

GETapi/v1/System/State
Retrieve all of the SystemState objects.
GETapi/v1/System/State/Metadata
Retrieve all of the meta data details of the SystemState object.
GETapi/v1/System/State/Metadata/{option}
Retrieve all the meta data details of the SystemState object based on provided options.
{option}Metadata options for the SystemState object.
GETapi/v1/System/State/Paged
Retreive all of the SystemState objects in a paged fashion.
GETapi/v1/System/State/{id:int}
Retrieve an instance of the SystemState object by it's ID.
{id:int}Unique identifier for the SystemState object.