Create a plan reviewer for a permit plan review
post
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewers
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
-
AgencyId: integer
Default Value:
1
The agency identifier of the public sector entity to which this plan reviewer applies. -
AssignedBy: string
Maximum Length:
18
The user who assigned the plan reviewer to the plan review cycle. Usually this is the plan coordinator. -
AssignedByPuid: string
The public unique identifier for the person that assigned the reviewer to the plan review.
-
AssignedDttm: string
(date-time)
The date when the plan reviewer was assigned to the plan review cycle.
-
Decision: string
Title:
Decision
Maximum Length:15
The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED. -
DecisionDttm: string
(date-time)
Title:
Decision Date
The date when the decision was updated by the user. The user could be a plan reviewer or plan coordinator. -
DepartmentId: string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
DepartmentLeadReviewer: string
Default Value:
N
The indicator used when creating a new plan reviewer. Used to determine whether the plan reviewers are being added from plan review automatic cycle creation. -
EmailAddress: string
Maximum Length:
320
The email address for the plan review file reviewer. -
OverrideBy: string
Maximum Length:
18
The user who the entered the override decision. Usually this is the plan coordinator. -
OverrideByPuid: string
The public unique identifier for the person that provided an override decision for the reviewer.
-
OverrideDecision: string
Title:
Override
Maximum Length:15
The decision code when the plan reviewer decision was overridden by the plan coordinator. -
OverrideDttm: string
(date-time)
The date and time when the plan reviewer decision was overridden.
-
PlanReviewKey: integer
(int64)
The unique identifier for a plan review cycle.
-
PlanReviewPuid: string
Maximum Length:
480
The public unique identifier for a plan review record. -
PlanReviewUserKey: integer
(int64)
The unique identifier for a plan reviewer.
-
PlanReviewUserPuid: string
Maximum Length:
480
The public unique identifier for a plan reviewer record. -
ReviewerDueDate: string
(date-time)
Title:
Due Date
The date by which the plan review must be completed by the reviewer. -
ReviewerId: integer
(int64)
Title:
Reviewer
The unique identifier for a plan reviewer. -
ReviewerPuid: string
The public unique identifier for a plan reviewer.
-
ReviewStatus: string
Title:
Status
Maximum Length:15
Default Value:INPROGRESS
The review status code for the plan reviewer of a plan review cycle. For example, the initial review status is IN PROGRESS. -
UploadStatus: string
Maximum Length:
1
Default Value:N
The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error.
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 : publicSectorPlanReviewers-item-response
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The agency identifier of the public sector entity to which this plan reviewer applies. -
AssignedBy: string
Maximum Length:
18
The user who assigned the plan reviewer to the plan review cycle. Usually this is the plan coordinator. -
AssignedByPuid: string
The public unique identifier for the person that assigned the reviewer to the plan review.
-
AssignedDttm: string
(date-time)
The date when the plan reviewer was assigned to the plan review cycle.
-
Decision: string
Title:
Decision
Maximum Length:15
The decision code for the plan reviewer of a plan review cycle. For example, the decision code could be APPROVED. -
DecisionDttm: string
(date-time)
Title:
Decision Date
The date when the decision was updated by the user. The user could be a plan reviewer or plan coordinator. -
DepartmentId: string
Title:
Department
Maximum Length:30
The unique identifier for a plan reviewer department. This is a user-defined value. -
DepartmentLeadReviewer: string
Default Value:
N
The indicator used when creating a new plan reviewer. Used to determine whether the plan reviewers are being added from plan review automatic cycle creation. -
EmailAddress: string
Maximum Length:
320
The email address for the plan review file reviewer. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the plan reviewer decision was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last modified the plan reviewer decision. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Override: string
Title:
Override
Read Only:true
Maximum Length:1
Default Value:N
Indicates whether the plan reviewer decision was overridden by the plan coordinator user or not. The default value is no. -
OverrideBy: string
Maximum Length:
18
The user who the entered the override decision. Usually this is the plan coordinator. -
OverrideByPuid: string
The public unique identifier for the person that provided an override decision for the reviewer.
-
OverrideDecision: string
Title:
Override
Maximum Length:15
The decision code when the plan reviewer decision was overridden by the plan coordinator. -
OverrideDttm: string
(date-time)
The date and time when the plan reviewer decision was overridden.
-
PartyId: integer
(int64)
Read Only:
true
Default Value:0
The person party ID for the plan reviewer. -
PlanReviewKey: integer
(int64)
The unique identifier for a plan review cycle.
-
PlanReviewPuid: string
Maximum Length:
480
The public unique identifier for a plan review record. -
PlanReviewUserKey: integer
(int64)
The unique identifier for a plan reviewer.
-
PlanReviewUserPuid: string
Maximum Length:
480
The public unique identifier for a plan reviewer record. -
ReviewerDueDate: string
(date-time)
Title:
Due Date
The date by which the plan review must be completed by the reviewer. -
ReviewerEmailId: integer
(int64)
Read Only:
true
The email address for the plan reviewer. -
ReviewerId: integer
(int64)
Title:
Reviewer
The unique identifier for a plan reviewer. -
ReviewerPuid: string
The public unique identifier for a plan reviewer.
-
ReviewStatus: string
Title:
Status
Maximum Length:15
Default Value:INPROGRESS
The review status code for the plan reviewer of a plan review cycle. For example, the initial review status is IN PROGRESS. -
UploadStatus: string
Maximum Length:
1
Default Value:N
The status of uploading a plan review file reviewer to the electronic document review application. Example values are Not Attempted, Success, and Error. -
UserType: string
Read Only:
true
Maximum Length:8
Default Value:I
The user type for a plan reviewer. For example, I for an internal user, and E for an external user. An example of an external user could be a contractor.
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.