Jump to

• Request
• Response

Get an open plan review cycle

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewOpenReviews/{PlanReviewKey}

Request

Path Parameters

• PlanReviewKey(required): integer(int64)
  The unique identifier for a plan review cycle.

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(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.

Body ()

Root Schema : publicSectorPlanReviewOpenReviews-item-response

Type: object

Show Source

• Address1: string
  Title: Address

  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.
• 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
  Title: Cycle

  Read Only: true

  Maximum Length: 40

  The numbering for each plan review cycle converted to a string.
• DocGroupId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for a document group.
• ElectronicPlanReview: string
  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.
• FinalizeStatus: string
  Read Only: true

  Maximum Length: 1

  Indicates the status of finalizing the 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
  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
  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.
• PermitDescription: string
  Read Only: true

  Maximum Length: 1000

  The application record description.
• PermitStatus: string
  Read Only: true

  Maximum Length: 15

  The application record status.
• PermitSubmittedDate: string (date-time)
  Title: Submitted

  Read Only: true

  The date when the application record was submitted.
• PermitSystemStatus: string
  Read Only: true

  Maximum Length: 15

  The application record's predefined system status to which the record status maps.
• PlanReviewId: string
  Read Only: true

  Maximum Length: 12

  The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1.
• PlanReviewKey: integer (int64)
  Read Only: true

  The unique identifier for a plan review cycle.
• PlanReviewName: string
  Read Only: true

  Maximum Length: 100

  The name of the plan review.
• PlanReviewType: string
  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
  Read Only: true

  Maximum Length: 60

  The postal code of the primary parcel address.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The user-friendly name for the application record type.
• RecordTypeCode: string
  Read Only: true

  Maximum Length: 20

  The unique alphanumeric code or short name for the application record type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for an application record type.
• ReviewDueDate: string (date-time)
  Title: Cycle Due

  Read Only: true

  The date by which the plan review must be completed.
• ReviewerCount: integer (int32)
  Read Only: true

  The number of the plan reviewers assigned to this plan review cycle.
• 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. Default value is N for no.
• SessionId: string
  Read Only: true

  Maximum Length: 1000

  The unique identifier for a markup session.
• State: string
  Read Only: true

  Maximum Length: 60

  The state of the primary parcel address.
• StreetNameConcat: string
  Read Only: true

  Maximum Length: 350

  The concatenated value of the street name corresponding to the address of the record's primary parcel. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix, and direction suffix.
• StreetNumber: string
  Read Only: true

  Maximum Length: 20

  The street number in the address of the record's primary parcel.
• StreetNumberAlpha: string
  Read Only: true

  Maximum Length: 20

  The alphabetic portion of the street number in the address of the record's primary parcel.
• StreetNumberNumeric: number
  Read Only: true

  The numerical portion of the street number in the address of the record's primary parcel.

{
    "type":"object",
    "properties":{
        "PermitSystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The application record's predefined system status to which the record status maps.",
            "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":{
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNameConcat":{
            "maxLength":350,
            "type":"string",
            "description":"The concatenated value of the street name corresponding to the address of the record's primary parcel. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix, and direction suffix.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The unique alphanumeric code or short name for the application record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The user-friendly name for the application record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FinalizeStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the status of finalizing the markup session. Possible values are R, F, and S for Ready, Finalizing, and Success.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleCountString":{
            "title":"Cycle",
            "maxLength":40,
            "type":"string",
            "description":"The numbering for each plan review cycle converted to a string.",
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumberNumeric":{
            "type":"number",
            "description":"The numerical portion of the street number in the address of the record's primary parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for an application record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the plan review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "maxLength":20,
            "type":"string",
            "description":"The street number in the address of the record's primary parcel.",
            "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":1000,
            "type":"string",
            "description":"The unique identifier for a markup session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The application record description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "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":false,
            "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. 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 plan review must be completed.",
            "format":"date-time",
            "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
        },
        "Address1":{
            "title":"Address",
            "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
        },
        "PlanReviewType":{
            "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":false,
            "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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleCount":{
            "title":"Cycle",
            "type":"integer",
            "description":"The numbering for each plan review cycle.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "ReviewerCount":{
            "type":"integer",
            "description":"The number of the plan reviewers assigned to this plan review cycle.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "PlanReviewKey":{
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "PermitStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The application record status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitSubmittedDate":{
            "title":"Submitted",
            "type":"string",
            "description":"The date when the application record was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumberAlpha":{
            "maxLength":20,
            "type":"string",
            "description":"The alphabetic portion of the street number in the address of the record's primary parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewId":{
            "maxLength":12,
            "type":"string",
            "description":"The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1.",
            "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