Country state selects

Learn how to use Suran API on the Suran Help Center.

>>>

GET /api/v2/general/country_state_selects
Get all states for country

Headers

Header name Description
Provision
required 		Web/Mobile/API Provision UUID

Returns

Code: 200

Description:

country_state_selects

Param name Description
data
required

state select

Validations:

  • Must be a Hash
data[id]
required

ID of the state select

Validations:

  • Must be a String
data[type]
required

Type of select

Validations:

  • Must be a String
data[attributes]
required

Attributes of the state select

Validations:

  • Must be a Hash
data[attributes][country]
required

Name of the country

Validations:

  • Must be a String
data[attributes][country_code]
required

Code of the country

Validations:

  • Must be a String
data[attributes][states]
required

States for the crountry

Validations:

  • Must be a Hash
data[attributes][states][statename]
required

Name of the state

Validations:

  • Must be a String
data[attributes][states][statecode]
required

Code of the state

Validations:

  • Must be a String
data[attributes][states][country_code]
required

Code of the country

Validations:

  • Must be a String

Code: 401

Description:

Unauthorized

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 404

Description:

Not Found

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 422

Description:

Unprocessable Entity

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 500

Description:

Internal Server Error

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Errors

Code Description
404 Data source query failed
422 Invalid parameter(s)
422 Provision header missing
422 Invalid provision
422 Under maintenance
422 Incorrect host for provision
422 Establishing session failed
422 Privilege to perform the action was not found
500 No connection to data source