County

What can you do with County?


Properties

Property Details
id
"id": 173
Type: Number
This is the unique numeric identifier for the County
name
"name": "Hello World"
Type: String
sortOrder
"sortOrder": 70
Type: Number
stateId
"stateId": 294
Type: Number
Unique identifier for the associated State object.
isVisible
"isVisible": true
Type: Boolean


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
  • name
  • sortOrder
  • stateId
  • isVisible

DataFlow PATCH objects:

  • county - create, update, delete

End Points

DELETEapi/v1/County/{id:int}
Delete an instance of the County object.
GETapi/v1/County
Retrieve all of the County objects.
GETapi/v1/County/Metadata
Retrieve all of the meta data details of the County object.
GETapi/v1/County/Metadata/{option}
Retrieve all the meta data details of the County object based on provided options.
{option}Metadata options for the County object.
GETapi/v1/County/Paged
Retreive all of the County objects in a paged fashion.
GETapi/v1/County/{id:int}
Retrieve an instance of the County object by it's ID.
{id:int}Unique identifier for the County object.
POSTapi/v1/County
Create a new instance of the County object.
PUTapi/v1/County/{id:int}
Update an existing instance of the County object.