Update a city
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCities/{publicSectorCitiesUniqID}
Request
Path Parameters
-
publicSectorCitiesUniqID(required): string
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>
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CityName: string
Title:
City Name
Maximum Length:60
The name of the city. -
CountryCode: string
Maximum Length:
3
The unique identifier for the country associated with the city. -
CountyCodeIncits: string
Maximum Length:
5
The unique identifier for the county associated with the city. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
LocalityGnisId: integer
(int64)
The Geographic Names Information System ID of the city.
-
SeedDataLock: integer
(int32)
Default Value:
0
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: string
Maximum Length:
6
The unique ISO code for the state associated with the city.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorCities-item-response
Type:
Show Source
object
-
CityCodeFIPS: string
Maximum Length:
8
The unique identifier for the city. -
CityName: string
Title:
City Name
Maximum Length:60
The name of the city. -
CountryCode: string
Maximum Length:
3
The unique identifier for the country associated with the city. -
CountyCodeIncits: string
Maximum Length:
5
The unique identifier for the county associated with the city. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the city was created. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
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: string
(date-time)
Read Only:
true
The last date and time that the city was updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocalityGnisId: integer
(int64)
The Geographic Names Information System ID of the city.
-
SeedDataLock: integer
(int32)
Default Value:
0
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: string
Maximum Length:
6
The unique ISO code for the state associated with the city.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.