GET
Retrieve states by conditions

_cnd[countryCode]
string 
Filters states by country code
_cnd[substring]
string 
Filters states by substring
_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\State>[] array
Sample response
[{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}]

GET
Retrieve state by id

id
integer Required
Id value of the State object
default Success <XLite\Model\State>
Sample response
{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}
state_id
integer
State unique id
state
string
State name
code
string
State code
country
region

PUT
Update state by id

id
integer Required
Id value of the State object
<XLite\Model\State>
state_id
integer
State unique id
state
string
State name
code
string
State code
country
region
default Success <XLite\Model\State>
Sample response
{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}
state_id
integer
State unique id
state
string
State name
code
string
State code
country
region

DELETE
Delete state by id

id
integer Required
Id value of the State object
default Success <XLite\Model\State>
Sample response
{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}
state_id
integer
State unique id
state
string
State name
code
string
State code
country
region

POST
Add new state

<XLite\Model\State>
state_id
integer
State unique id
state
string
State name
code
string
State code
country
region
default Success <XLite\Model\State>
Sample response
{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}
state_id
integer
State unique id
state
string
State name
code
string
State code
country
region