Update a plan reviewer department
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments/{publicSectorPlanReviewerDepartmentsUniqID}
Request
Path Parameters
-
publicSectorPlanReviewerDepartmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and DepartmentId ---for the Plan Reviewer Departments resource and used to uniquely identify an instance of Plan Reviewer Departments. The client should not generate the hash key value. Instead, the client should query on the Plan Reviewer Departments collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Reviewer Departments.
For example: publicSectorPlanReviewerDepartments?q=AgencyId=<value1>;DepartmentId=<value2>
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
-
Department: string
Title:
Department
Maximum Length:25
The value that will be displayed for a plan reviewer department. This value is user-defined. -
DepartmentLeadId: integer
(int64)
Title:
Department Lead
The unique identifier for the plan reviewer department lead. -
Description: string
Title:
Description
Maximum Length:500
The long description value for a plan reviewer department. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true. -
UsePermitting: boolean
Title:
Permits
Maximum Length:1
Indicates whether the plan reviewer department is applicable to the Permit classification. -
UsePlanning: boolean
Title:
Planning and Zoning
Maximum Length:1
Indicates whether the plan reviewer department is applicable to the Planning and Zoning classification.
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 : publicSectorPlanReviewerDepartments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this plan reviewer department applies. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the plan reviewer department. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the plan reviewer department was created. -
Department: string
Title:
Department
Maximum Length:25
The value that will be displayed for a plan reviewer department. This value is user-defined. -
DepartmentId: string
Title:
Department ID
Maximum Length:30
The unique identifier for a plan reviewer department. -
DepartmentLeadId: integer
(int64)
Title:
Department Lead
The unique identifier for the plan reviewer department lead. -
Description: string
Title:
Description
Maximum Length:500
The long description value for a plan reviewer department. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the plan reviewer department was last modified. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last modified the plan reviewer department. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UsePermitting: boolean
Title:
Permits
Maximum Length:1
Indicates whether the plan reviewer department is applicable to the Permit classification. -
UsePlanning: boolean
Title:
Planning and Zoning
Maximum Length:1
Indicates whether the plan reviewer department is applicable to the Planning and Zoning classification.
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.