Create a locality
post
/fscmRestApi/resources/11.13.18.05/publicSectorLocalities
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CountryCode: string
Maximum Length:
3
The unique identifier for the country associated with the locality. -
CountyCodeIncits: string
Maximum Length:
5
The International Committee for Information Technology Standards code for the county. -
LocalityGnisId: integer
(int64)
The locality ID defined in the Geographic Names Information System of the United States Geological Survey.
-
LocalityIdType: 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: string
Maximum Length:
60
Name of the geographic object, such as city or region. -
StateCodeISO: string
Maximum Length:
6
The code for the state according to the ISO 3166-2 standard.
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 : publicSectorLocalities-item-response
Type:
Show Source
object
-
CountryCode: string
Maximum Length:
3
The unique identifier for the country associated with the locality. -
CountyCodeIncits: string
Maximum Length:
5
The International Committee for Information Technology Standards code for the county. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the locality was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time that the locality was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocalityGnisId: integer
(int64)
The locality ID defined in the Geographic Names Information System of the United States Geological Survey.
-
LocalityIdType: 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: string
Maximum Length:
60
Name of the geographic object, such as city or region. -
StateCodeISO: string
Maximum Length:
6
The code for the state according to the ISO 3166-2 standard.
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.