Cities endpoint RFC

From Koha Wiki

Jump to: navigation, search

This RFC should be the basis for making the cities endpoint follow the guidelines. Bug reports still need to be filed.

Actions and routes

The following table presents the current implementation, and the proposed changes.

Description Action Current Proposed
List cities
 GET
 /cities
 /cities
Add a city
 POST
 /cities
 /cities
Get a city
 GET
 /cities/{cityid}
 /cities/{city_id}
Overwrite a city
 PUT
 /cities/{cityid}
 /cities/{city_id}
Delete a city
 DELETE
 /cities/{cityid}
 /cities/{city_id}
Partially update a city
 PATCH
 NOT IMPLEMENTED
 /cities/{city_id}

City object definition

DB schema Current API tcohen
cityid cityid city_id
city_name city_name name
city_state city_state state
city_country city_country country
city_zipcode city_zipcode zip