Update a city
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCities/{publicSectorCitiesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorCitiesUniqID: integer
This is the hash key of the attributes which make up the composite key--- CountryCode, StateCodeISO, CountyCodeIncits and CityCodeFIPS ---for the Cities resource and used to uniquely identify an instance of Cities. The client should not generate the hash key value. Instead, the client should query on the Cities collection resource with a filter on the primary key values in order to navigate to a specific instance of Cities.
For example: publicSectorCities?q=CountryCode=<value1>;StateCodeISO=<value2>;CountyCodeIncits=<value3>;CityCodeFIPS=<value4>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCities-item
Type:
Show Source
object
-
CityCodeFIPS(optional):
string
Maximum Length:
8
The unique identifier for the city. -
CityName(optional):
string
Title:
City Name
Maximum Length:60
The name of the city. -
CountryCode(optional):
string
Maximum Length:
3
The unique identifier for the country associated with the city. -
CountyCodeIncits(optional):
string
Maximum Length:
5
The unique identifier for the county associated with the city. -
CreationDate(optional):
string(date-time)
The date and time that the city was created.
-
DeletedFlag(optional):
boolean
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
-
LastUpdateDate(optional):
string(date-time)
The last date and time that the city was updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
LocalityGnisId(optional):
integer(int64)
The Geographic Names Information System ID of the city.
-
SeedDataLock(optional):
integer(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
StateCodeISO(optional):
string
Maximum Length:
6
The unique ISO code for the state associated with the city.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCities-item
Type:
Show Source
object
-
CityCodeFIPS(optional):
string
Maximum Length:
8
The unique identifier for the city. -
CityName(optional):
string
Title:
City Name
Maximum Length:60
The name of the city. -
CountryCode(optional):
string
Maximum Length:
3
The unique identifier for the country associated with the city. -
CountyCodeIncits(optional):
string
Maximum Length:
5
The unique identifier for the county associated with the city. -
CreationDate(optional):
string(date-time)
The date and time that the city was created.
-
DeletedFlag(optional):
boolean
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
-
LastUpdateDate(optional):
string(date-time)
The last date and time that the city was updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
LocalityGnisId(optional):
integer(int64)
The Geographic Names Information System ID of the city.
-
SeedDataLock(optional):
integer(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
StateCodeISO(optional):
string
Maximum Length:
6
The unique ISO code for the state associated with the city.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.