Jump to

• Request
• Response

Get a planning application plan review department due date item

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanningDepartmentDueDatePlanReviews/{publicSectorPlanningDepartmentDueDatePlanReviewsUniqID}

Request

Path Parameters

• publicSectorPlanningDepartmentDueDatePlanReviewsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LnpRecordKey, DepartmentId and ReviewerId ---for the Planning Department Due Date Plan Reviews resource and used to uniquely identify an instance of Planning Department Due Date Plan Reviews. The client should not generate the hash key value. Instead, the client should query on the Planning Department Due Date Plan Reviews collection resource with a filter on the primary key values in order to navigate to a specific instance of Planning Department Due Date Plan Reviews.
  
  For example: publicSectorPlanningDepartmentDueDatePlanReviews?q=LnpRecordKey=<value1>;DepartmentId=<value2>;ReviewerId=<value3>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  The first or main address.
• Address2: string
  Title: Address Line 2

  Read Only: true

  Maximum Length: 240

  The second address, if present.
• AssigneeEmail: string
  Title: Assigned Planner Email

  Read Only: true

  Maximum Length: 240

  The user ID of the planner assigned to the planning application or pre-application.
• AssigneeName: string
  Title: Assigned Planner Name

  Read Only: true

  Maximum Length: 240

  The display name of the planner assigned to the planning application or pre-application.
• AssigneeUserid: string
  Title: Assigned Planner User ID

  Read Only: true

  Maximum Length: 64

  The email of the planner assigned to the planning application or pre-application.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city in the parcel address.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country in the address.
• County: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county in the parcel address.
• CreatedByDisplayName: string
  Title: Plan Check Coordinator Name

  Read Only: true

  The display name of the user who created the plan review cycle.
• CreatedByEmail: string
  Title: Plan Check Coordinator Email

  Read Only: true

  The email address of the user who created the plan review cycle.
• CreatedByUsername: string
  Title: Plan Check Coordinator User ID

  Read Only: true

  Maximum Length: 64

  The user who created the plan review cycle.
• CycleCount: integer (int32)
  Title: Plan Review Cycle

  Read Only: true

  The number specifying each plan review cycle.
• CycleDays: integer (int32)
  Title: Plan Review Cycle Days

  Read Only: true

  The number of days that the plan review cycle was open or in progress.
• CycleDueDate: string (date-time)
  Title: Plan Review Cycle Due Date

  Read Only: true

  The date by which the plan review cycle must be completed.
• CycleStatus: string
  Title: Plan Review Cycle Status

  Read Only: true

  Maximum Length: 30

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

  Maximum Length: 15

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

  Maximum Length: 15

  The decision status code for the plan review cycle.
• DepartmentId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the department associated with the plan review.
• DepartmentName: string
  Title: Plan Reviewer Department

  Read Only: true

  Maximum Length: 25

  The display name of the department associated with the plan review.
• DocumentUploadStatus: string
  Read Only: true

  Maximum Length: 1

  The upload status of the document attachment associated with the plan review.
• 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.
• 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 planning application identifier.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier for a planning application record.
• PermitDescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 1000

  The record description.
• PermitStatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 15

  The record status.
• PersonName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The name of the applicant.
• PlanReviewDecision: string
  Title: Plan Review Cycle Decision

  Read Only: true

  Maximum Length: 35

  The decision status for the plan review cycle.
• PlanReviewerDisplayName: string
  Title: Plan Reviewer Name

  Read Only: true

  The display name of the department-level plan reviewer.
• PlanReviewerEmail: string
  Title: Plan Reviewer Email

  Read Only: true

  The email of the department-level plan reviewer.
• PlanReviewerUsername: string
  Title: Plan Reviewer User ID

  Read Only: true

  The user ID of the department-level plan reviewer.
• PlanReviewKey: integer (int64)
  Title: Plan Review Key

  Read Only: true

  The unique identifier for a plan review cycle.
• PlanReviewLink: string
  Title: Plan Review URL

  Read Only: true

  Maximum Length: 255

  The URL to the plan review page for the given permit.
• PlanReviewName: string
  Title: Plan Review Name

  Read Only: true

  Maximum Length: 100

  The name of the plan review.
• PlanReviewType: string
  Title: Plan Review Type

  Read Only: true

  Maximum Length: 11

  The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the parcel address.
• Province: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province in the parcel address.
• RecordType: string
  Title: Record Type

  Read Only: true

  Maximum Length: 100

  The type of planning application.
• ReviewClosedDttm: string (date-time)
  Title: Plan Review Closed Date

  Read Only: true

  The date when the plan review cycle was closed.
• ReviewerDueDate: string (date-time)
  Title: Plan Reviewer Due Date

  Read Only: true

  The date by which the assigned plan reviewer must complete the department-level plan review.
• ReviewerId: integer (int64)
  Read Only: true

  The unique identifier for the plan reviewer associated with the plan review department.
• ReviewerReviewStatus: string
  Title: Plan Reviewer Review Status

  Read Only: true

  Maximum Length: 30

  The review status of a department-level plan review.
• ReviewerReviewStatusCode: string
  Read Only: true

  Maximum Length: 15

  The review status code of a department-level plan review.
• ReviewOpenDttm: string (date-time)
  Title: Plan Review Open Date

  Read Only: true

  The date when the plan review cycle was opened.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state in the parcel address.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 10

  The subclassification of a planning record.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification of a planning record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeUserid":{
            "title":"Assigned Planner User ID",
            "maxLength":"64",
            "type":"string",
            "description":"The email of the planner assigned to the planning application or pre-application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "DocumentUploadStatus":{
            "maxLength":"1",
            "type":"string",
            "description":"The upload status of the document attachment associated with the plan review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeEmail":{
            "title":"Assigned Planner Email",
            "maxLength":"240",
            "type":"string",
            "description":"The user ID of the planner assigned to the planning application or pre-application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the 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
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleStatusCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The review status code for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerReviewStatusCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The review status code of a department-level plan review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Record Type",
            "maxLength":"100",
            "type":"string",
            "description":"The type of planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerReviewStatus":{
            "title":"Plan Reviewer Review Status",
            "maxLength":"30",
            "type":"string",
            "description":"The review status of a department-level plan review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleStatus":{
            "title":"Plan Review Cycle Status",
            "maxLength":"30",
            "type":"string",
            "description":"The review status for the plan review cycle.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PermitDescription":{
            "title":"Application Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The record description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeName":{
            "title":"Assigned Planner Name",
            "maxLength":"240",
            "type":"string",
            "description":"The display name of the planner assigned to the planning application or pre-application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"The planning application identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewerEmail":{
            "title":"Plan Reviewer Email",
            "type":"string",
            "description":"The email of the department-level plan reviewer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Applicant Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewClosedDttm":{
            "title":"Plan Review Closed Date",
            "type":"string",
            "description":"The date when the plan review cycle was closed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleDays":{
            "title":"Plan Review Cycle Days",
            "type":"integer",
            "description":"The number of days that the plan review cycle was open or in progress.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByDisplayName":{
            "title":"Plan Check Coordinator Name",
            "type":"string",
            "description":"The display name of the user who created the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewerDisplayName":{
            "title":"Plan Reviewer Name",
            "type":"string",
            "description":"The display name of the department-level plan reviewer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewLink":{
            "title":"Plan Review URL",
            "maxLength":"255",
            "type":"string",
            "description":"The URL to the plan review page for the given permit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "x-queryable":true
        },
        "PlanReviewDecision":{
            "title":"Plan Review Cycle Decision",
            "maxLength":"35",
            "type":"string",
            "description":"The decision status for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByEmail":{
            "title":"Plan Check Coordinator Email",
            "type":"string",
            "description":"The email address of the user who created the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewType":{
            "title":"Plan Review Type",
            "maxLength":"11",
            "type":"string",
            "description":"The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a planning application record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CycleCount":{
            "title":"Plan Review Cycle",
            "type":"integer",
            "description":"The number specifying each plan review cycle.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "CycleDueDate":{
            "title":"Plan Review Cycle Due Date",
            "type":"string",
            "description":"The date by which the plan review cycle must be completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByUsername":{
            "title":"Plan Check Coordinator User ID",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewKey":{
            "title":"Plan Review Key",
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReviewerDueDate":{
            "title":"Plan Reviewer Due Date",
            "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
        },
        "DecisionStatusCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The decision status code for the plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewerUsername":{
            "title":"Plan Reviewer User ID",
            "type":"string",
            "description":"The user ID of the department-level plan reviewer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ReviewerId":{
            "type":"integer",
            "description":"The unique identifier for the plan reviewer associated with the plan review department.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"3",
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewOpenDttm":{
            "title":"Plan Review Open Date",
            "type":"string",
            "description":"The date when the plan review cycle was opened.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country in the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Plan Reviewer Department",
            "maxLength":"25",
            "type":"string",
            "description":"The display name of the department associated with the plan review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatus":{
            "title":"Application Status",
            "maxLength":"15",
            "type":"string",
            "description":"The record status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the department associated with the plan review.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"2"
            },
            "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