Jump to

• Request
• Response

Get all plan review unassigned reviewers

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewUnassignedReviewers

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the plan review unassigned reviewers that match the primary key criteria specified.
    Finder Variables:
    • LnpRecordKey; integer; The unique identifier of the plan review unassigned reviewer.
  • simpleSearchFinder: Finds the plan review unassigned reviewers that match the search criteria specified.
    Finder Variables:
    • value; string; The search value used to find a specific plan review unassigned reviewer.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Address1; string; The first line of the primary parcel address.
  • Address2; string; The second line of the primary parcel address.
  • Address3; string; The third line of the primary parcel address.
  • Address4; string; The fourth line of the primary parcel address.
  • ApplicationDescription; string; The description of the application that the plan review is associated with.
  • City; string; The city of the primary parcel address.
  • Classification; string; The classification of the permit or planning and zoning type.
  • CycleCount; integer; The numbering for each plan review cycle.
  • CycleCountString; string; The numbering for each plan review cycle in a string format.
  • Department; string; The value that will be displayed for a plan reviewer department. This value is user-defined.
  • DepartmentId; string; The unique identifier for a plan reviewer department. This is a user-defined value.
  • DocGroupId; string; The unique identifier for a document group.
  • ElectronicPlanReview; string; Indicates whether the plan review has been performed for a document attachment. The default value is N for no.
  • ExistingRow; string; Indicates whether the unassigned rows exist. This value is Y for yes if there is a reviewer row for a department, but no reviewer is assigned. This value is N for no if there is no row for a required department.
  • FinalizeStatus; string; Indicates the status of finalizing the electronic plan review markup session. Possible values are R, F, and S for Ready, Finalizing, and Success.
  • LnpRecordId; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
  • LnpRecordKey; integer; The unique identifier for a record. The record is for a permit or planning and zoning, and is determined by the classification.
  • ParcelAddressStreetNameConcat; string; The street number and name of the primary parcel address.
  • ParcelAddressStreetNumber; string; The street number of the primary parcel address.
  • ParcelAddressStreetNumberAlpha; string; The street number of the primary parcel address in alphabetical format.
  • ParcelAddressStreetNumberNumeric; integer; The street number of the primary parcel address in numeric format.
  • PlanReviewKey; integer; The unique identifier for a plan review cycle.
  • PlanReviewName; string; The name of the plan review.
  • PostalCode; string; The postal code of the primary parcel address.
  • RecordType; string; The user-friendly name for a permit or planning and zoning type.
  • RecordTypeCode; string; The unique alphanumeric code or short name for a permit or planning and zoning type.
  • RecordTypeId; string; The unique identifier for a permit or planning and zoning type.
  • ReviewDueDate; string; The date by which the assigned plan reviewer must complete the department-level plan review.
  • ReviewOpenDttm; string; The date when the plan review cycle was opened.
  • ReviewStatus; string; The review status for the plan review cycle.
  • RevisedDocUploadedFlag; string; Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. The default value is N for no.
  • SessionId; string; The unique identifier for an electronic plan review markup session.
  • State; string; The state of the primary parcel address.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : publicSectorPlanReviewUnassignedReviewers

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPlanReviewUnassignedReviewers-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPlanReviewUnassignedReviewers-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPlanReviewUnassignedReviewers-item-response"
    }
}

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

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the primary parcel address.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second line of the primary parcel address.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third line of the primary parcel address.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth line of the primary parcel address.
• ApplicationDescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 1000

  The description of the application that the plan review is associated with.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the primary parcel address.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the permit or planning and zoning type.
• CycleCount: integer (int32)
  Title: Cycle

  Read Only: true

  The numbering for each plan review cycle.
• CycleCountString: string
  Read Only: true

  Maximum Length: 40

  The numbering for each plan review cycle in a string format.
• Department: string
  Title: Department

  Read Only: true

  Maximum Length: 300

  The value that will be displayed for a plan reviewer department. This value is user-defined.
• DepartmentId: string
  Title: Department

  Read Only: true

  Maximum Length: 300

  The unique identifier for a plan reviewer department. This is a user-defined value.
• DocGroupId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for a document group.
• ElectronicPlanReview: string
  Title: Electronic Review

  Read Only: true

  Maximum Length: 1

  Indicates whether the plan review has been performed for a document attachment. The default value is N for no.
• ExistingRow: string
  Read Only: true

  Maximum Length: 50

  Indicates whether the unassigned rows exist. This value is Y for yes if there is a reviewer row for a department, but no reviewer is assigned. This value is N for no if there is no row for a required department.
• FinalizeStatus: string
  Read Only: true

  Maximum Length: 1

  Indicates the status of finalizing the electronic plan review markup session. Possible values are R, F, and S for Ready, Finalizing, and Success.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 50

  The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier for a record. The record is for a permit or planning and zoning, and is determined by the classification.
• ParcelAddressStreetNameConcat: string
  Read Only: true

  Maximum Length: 350

  The street number and name of the primary parcel address.
• ParcelAddressStreetNumber: string
  Read Only: true

  Maximum Length: 20

  The street number of the primary parcel address.
• ParcelAddressStreetNumberAlpha: string
  Read Only: true

  Maximum Length: 20

  The street number of the primary parcel address in alphabetical format.
• ParcelAddressStreetNumberNumeric: integer (int64)
  Read Only: true

  The street number of the primary parcel address in numeric format.
• PlanReviewKey: integer (int64)
  Read Only: true

  The unique identifier for a plan review cycle.
• PlanReviewName: string
  Title: Plan Review Name

  Read Only: true

  Maximum Length: 100

  The name of the plan review.
• PostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code of the primary parcel address.
• RecordType: string
  Title: Record Type

  Read Only: true

  Maximum Length: 100

  The user-friendly name for a permit or planning and zoning type.
• RecordTypeCode: string
  Title: Record Type Code

  Read Only: true

  Maximum Length: 20

  The unique alphanumeric code or short name for a permit or planning and zoning type.
• RecordTypeId: string
  Title: Record Type

  Read Only: true

  Maximum Length: 30

  The unique identifier for a permit or planning and zoning type.
• ReviewDueDate: string (date-time)
  Title: Cycle Due

  Read Only: true

  The date by which the assigned plan reviewer must complete the department-level plan review.
• ReviewOpenDttm: string (date-time)
  Read Only: true

  The date when the plan review cycle was opened.
• ReviewStatus: string
  Read Only: true

  Maximum Length: 15

  The review status for the plan review cycle.
• RevisedDocUploadedFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. The default value is N for no.
• SessionId: string
  Read Only: true

  Maximum Length: 255

  The unique identifier for an electronic plan review markup session.
• State: string
  Read Only: true

  Maximum Length: 60

  The state of the primary parcel address.

{
    "type":"object",
    "properties":{
        "ParcelAddressStreetNameConcat":{
            "maxLength":"350",
            "type":"string",
            "description":"The street number and name of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElectronicPlanReview":{
            "title":"Electronic Review",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the plan review has been performed for a document attachment. The default value is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Department":{
            "title":"Department",
            "maxLength":"300",
            "type":"string",
            "description":"The value that will be displayed for a plan reviewer department. This value is user-defined.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "title":"Record Type Code",
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for a permit or planning and zoning type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Record Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for a permit or planning and zoning type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FinalizeStatus":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the status of finalizing the electronic plan review markup session. Possible values are R, F, and S for Ready, Finalizing, and Success.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleCountString":{
            "maxLength":"40",
            "type":"string",
            "description":"The numbering for each plan review cycle in a string format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The review status for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the permit or planning and zoning type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record Type",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a permit or planning and zoning type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewName":{
            "title":"Plan Review Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the plan review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddressStreetNumberAlpha":{
            "maxLength":"20",
            "type":"string",
            "description":"The street number of the primary parcel address in alphabetical format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddressStreetNumber":{
            "maxLength":"20",
            "type":"string",
            "description":"The street number of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SessionId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier for an electronic plan review markup session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RevisedDocUploadedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. The default value is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewDueDate":{
            "title":"Cycle Due",
            "type":"string",
            "description":"The date by which the assigned plan reviewer must complete the department-level plan review.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExistingRow":{
            "maxLength":"50",
            "type":"string",
            "description":"Indicates whether the unassigned rows exist. This value is Y for yes if there is a reviewer row for a department, but no reviewer is assigned. This value is N for no if there is no row for a required department.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddressStreetNumberNumeric":{
            "type":"integer",
            "description":"The street number of the primary parcel address in numeric format.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"20"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a record. The record is for a permit or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CycleCount":{
            "title":"Cycle",
            "type":"integer",
            "description":"The numbering for each plan review cycle.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "ApplicationDescription":{
            "title":"Application Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the application that the plan review is associated with.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The state of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewOpenDttm":{
            "type":"string",
            "description":"The date when the plan review cycle was opened.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocGroupId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a document group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":"300",
            "type":"string",
            "description":"The unique identifier for a plan reviewer department. This is a user-defined value.",
            "nullable":true,
            "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