Update a locality
patch
/fscmRestApi/resources/11.13.18.05/publicSectorLocalities/{publicSectorLocalitiesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorLocalitiesUniqID: integer
This is the hash key of the attributes which make up the composite key--- CountryCode, StateCodeISO, CountyCodeIncits and LocalityGnisId ---for the Localities resource and used to uniquely identify an instance of Localities. The client should not generate the hash key value. Instead, the client should query on the Localities collection resource with a filter on the primary key values in order to navigate to a specific instance of Localities.
For example: publicSectorLocalities?q=CountryCode=<value1>;StateCodeISO=<value2>;CountyCodeIncits=<value3>;LocalityGnisId=<value4>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorLocalities-item
Type:
Show Source
object
-
CountryCode(optional):
string
Maximum Length:
3
The unique identifier for the country associated with the locality. -
CountyCodeIncits(optional):
string
Maximum Length:
5
The International Committee for Information Technology Standards code for the county. -
CreationDate(optional):
string(date-time)
The date and time that the locality was created.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the locality was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
LocalityGnisId(optional):
integer(int64)
The locality ID defined in the Geographic Names Information System of the United States Geological Survey.
-
LocalityIdType(optional):
string
Maximum Length:
10
An identifier that explains how the locality can be identified. For example, a locality can be identified through an address (LocalityIdType ADDRESS), or it can be identified through coordinates on a map (LocalityIdType GIS). -
LocalityName(optional):
string
Maximum Length:
60
Name of the geographic object, such as city or region. -
StateCodeISO(optional):
string
Maximum Length:
6
The code for the state according to the ISO 3166-2 standard.
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 : publicSectorLocalities-item
Type:
Show Source
object
-
CountryCode(optional):
string
Maximum Length:
3
The unique identifier for the country associated with the locality. -
CountyCodeIncits(optional):
string
Maximum Length:
5
The International Committee for Information Technology Standards code for the county. -
CreationDate(optional):
string(date-time)
The date and time that the locality was created.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the locality was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
LocalityGnisId(optional):
integer(int64)
The locality ID defined in the Geographic Names Information System of the United States Geological Survey.
-
LocalityIdType(optional):
string
Maximum Length:
10
An identifier that explains how the locality can be identified. For example, a locality can be identified through an address (LocalityIdType ADDRESS), or it can be identified through coordinates on a map (LocalityIdType GIS). -
LocalityName(optional):
string
Maximum Length:
60
Name of the geographic object, such as city or region. -
StateCodeISO(optional):
string
Maximum Length:
6
The code for the state according to the ISO 3166-2 standard.
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.