Create a district type
post
/fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes
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
-
Description: string
Title:
Description
Maximum Length:100
The description of the district type. -
DistrictCategory: string
Title:
District Type Category
Maximum Length:10
The category of the district type. -
DistrictType: string
Title:
District Type
Maximum Length:50
The unique identifier of the district type. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the district type is available to be used. The default value is N. -
GisDistrictIdAttr: string
Title:
District in GIS
Maximum Length:30
Field for selecting the map service attribute that provides a district identifier. -
GisDistrictRestURL: string
Title:
District Layer Service URL
Field for the URL of the GIS map service that plots district information for the specified district type. -
ParcelImportUpdateFlag: boolean
Maximum Length:
1
Indicates whether parcel district or address district is allowed to be updated by the APO import process. -
UseGisFlag: boolean
Title:
GIS Layer Enabled
Maximum Length:1
Default Value:false
Switch indicating whether to use GIS to identify districts based on a provided location.
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 : publicSectorDistrictTypes-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
The date and time the district type was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the district type. -
DistrictCategory: string
Title:
District Type Category
Maximum Length:10
The category of the district type. -
DistrictType: string
Title:
District Type
Maximum Length:50
The unique identifier of the district type. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the district type is available to be used. The default value is N. -
GisDistrictIdAttr: string
Title:
District in GIS
Maximum Length:30
Field for selecting the map service attribute that provides a district identifier. -
GisDistrictRestURL: string
Title:
District Layer Service URL
Field for the URL of the GIS map service that plots district information for the specified district type. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the district type was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Read Only:
true
Maximum Length:80
Indicates the category of the district type. -
ParcelImportUpdateFlag: boolean
Maximum Length:
1
Indicates whether parcel district or address district is allowed to be updated by the APO import process. -
UseGisFlag: boolean
Title:
GIS Layer Enabled
Maximum Length:1
Default Value:false
Switch indicating whether to use GIS to identify districts based on a provided location.
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.