Jump to

• Request
• Response

Update a district type

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDistrictTypes/{DistrictType}

Request

Path Parameters

• DistrictType(required): string
  The unique identifier of the district type.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "GisDistrictRestURL":{
            "title":"District Layer Service URL",
            "type":"string",
            "description":"Field for the URL of the GIS map service that plots district information for the specified district type.",
            "nullable":true,
            "x-queryable":false
        },
        "DistrictCategory":{
            "title":"District Type Category",
            "maxLength":"10",
            "type":"string",
            "description":"The category of the district type.",
            "nullable":false
        },
        "UseGisFlag":{
            "title":"GIS Layer Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Switch indicating whether to use GIS to identify districts based on a provided location.",
            "nullable":false,
            "default":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the district type.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the district type is available to be used. The default value is N.",
            "nullable":false
        },
        "GisDistrictIdAttr":{
            "title":"District in GIS",
            "maxLength":"30",
            "type":"string",
            "description":"Field for selecting the map service attribute that provides a district identifier.",
            "nullable":true
        },
        "ParcelImportUpdateFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether parcel district or address district is allowed to be updated by the APO import process.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorDistrictTypes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "GisDistrictRestURL":{
            "title":"District Layer Service URL",
            "type":"string",
            "description":"Field for the URL of the GIS map service that plots district information for the specified district type.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the district type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictCategory":{
            "title":"District Type Category",
            "maxLength":"10",
            "type":"string",
            "description":"The category of the district type.",
            "nullable":false,
            "x-queryable":true
        },
        "UseGisFlag":{
            "title":"GIS Layer Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Switch indicating whether to use GIS to identify districts based on a provided location.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the district type.",
            "nullable":false,
            "x-queryable":true
        },
        "DistrictType":{
            "title":"District Type",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the district type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the district type is available to be used. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "GisDistrictIdAttr":{
            "title":"District in GIS",
            "maxLength":"30",
            "type":"string",
            "description":"Field for selecting the map service attribute that provides a district identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the category of the district type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelImportUpdateFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether parcel district or address district is allowed to be updated by the APO import process.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the district type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top