Jump to

• Request
• Response

Update a parcel district fee

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCalculateDistrictFees/{publicSectorCalculateDistrictFeesUniqID}

Request

Path Parameters

• publicSectorCalculateDistrictFeesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LnpRecordKey, LnpRecordId and Districtid ---for the Calculate District Fees Mapping resource and used to uniquely identify an instance of Calculate District Fees Mapping. The client should not generate the hash key value. Instead, the client should query on the Calculate District Fees Mapping collection resource with a filter on the primary key values in order to navigate to a specific instance of Calculate District Fees Mapping.
  
  For example: publicSectorCalculateDistrictFees?q=LnpRecordKey=<value1>;LnpRecordId=<value2>;Districtid=<value3>

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

{
    "type":"object",
    "properties":{
    }
}

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 : publicSectorCalculateDistrictFees-item-response

Type: object

Show Source

• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  Indicates the type of transaction. The classification can be for permits, planning and zoning.
• DistrictCategory: string
  Title: District Category

  Read Only: true

  Maximum Length: 10

  The category of the district type where the parcel of the real estate is located. Possible values include urban, suburban, or rural.
• Districtid: string
  Title: District ID

  Read Only: true

  Maximum Length: 30

  The identifier for district for the location. The district can be configured by the agency.
• DistrictType: string
  Title: District Type

  Read Only: true

  Maximum Length: 50

  Indicates the type of district for the inspection such as Building, Electrical, and Plumbing inspection district.
• GisDistrictId: string
  Title: GIS District ID

  Read Only: true

  Maximum Length: 30

  Identifier for the district provided by a geographic information system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Read Only: true

  Maximum Length: 50

  Unique identifier for the transaction. It is generated using the autonumber rule configured by the agency.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for a record. The record is for a permit, planning and zoning.
• VersionType: string
  Title: Version Type

  Read Only: true

  Maximum Length: 1

  Identifies whether the transaction is for an origination, renewal, or amendment.

{
    "type":"object",
    "properties":{
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier for the transaction.  It is generated using the autonumber rule configured by the agency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictCategory":{
            "title":"District Category",
            "maxLength":10,
            "type":"string",
            "description":"The category of the district type where the parcel of the real estate is located. Possible values include urban, suburban, or rural.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictType":{
            "title":"District Type",
            "maxLength":50,
            "type":"string",
            "description":"Indicates the type of district for the inspection such as Building, Electrical, and Plumbing inspection district.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Districtid":{
            "title":"District ID",
            "maxLength":30,
            "type":"string",
            "description":"The identifier for district for the location.  The district can be configured by the agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GisDistrictId":{
            "title":"GIS District ID",
            "maxLength":30,
            "type":"string",
            "description":"Identifier for the district provided by a geographic information system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"Indicates the type of transaction.  The classification can be for permits, planning and zoning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a record. The record is for a permit, planning and zoning.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "VersionType":{
            "title":"Version Type",
            "maxLength":1,
            "type":"string",
            "description":"Identifies whether the transaction is for an origination, renewal, or amendment.",
            "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