Update a district
patch
/fscmRestApi/resources/11.13.18.05/publicSectorDistricts/{DistrictId}
Request
Path Parameters
-
DistrictId(required): string
The unique identifier of the district.
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
-
Description: string
Title:
District Description
Maximum Length:100
The description of the district. -
DistrictType: string
Title:
District Type
Maximum Length:50
The type of district. -
GisDistrictId: string
Title:
District from GIS
Maximum Length:30
Field on the District Details page where the user selects the corresponding GIS district. The valid values are the districts from the GIS district layer that is associated with the appropriate district type.
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 : publicSectorDistricts-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
The date and time the district was created. -
Description: string
Title:
District Description
Maximum Length:100
The description of the district. -
DistrictId: string
Title:
District ID
Maximum Length:30
The unique identifier of the district. -
DistrictType: string
Title:
District Type
Maximum Length:50
The type of district. -
GisDistrictId: string
Title:
District from GIS
Maximum Length:30
Field on the District Details page where the user selects the corresponding GIS district. The valid values are the districts from the GIS district layer that is associated with the appropriate district type. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the district was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.