City

What can you do with City?


Properties

Property Details
id
"id": 645
Type: Number
This is the unique numeric identifier for the City
name
"name": "Hello World"
Type: String
countyId
"countyId": 746
Type: Number
Unique identifier for the associated County object.
sortOrder
"sortOrder": 51
Type: Number
stateId
"stateId": 899
Type: Number
Unique identifier for the associated State object.
isVisible
"isVisible": true
Type: Boolean
ownerId
"ownerId": 448
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
  • name
  • countyId
  • sortOrder
  • stateId
  • isVisible

DataFlow PATCH objects:

  • city - create, update, delete

End Points

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