Jump to

• Request
• Response

Get all permit plan review cycle due date items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPermitCycleDueDatePlanReviews

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 a permit plan review using the specified identifiers.
    Finder Variables:
    • LnpRecordKey; integer; The unique identifier of the permit to which the plan review belongs.
  • findByBRFCriteria: Finds permit application plan review data that satisfies the criteria provided.
    Finder Variables:
    • Caller; string; The application making the call. It should always be BRF.
    • Criteria; string; The criteria for the rows. This should be formatted with semicolons before and after the field names. For example, (;ApplicantCountry; = 'US') AND (;RecordType; = 'Permit1001').
• 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 or main address.
  • Address2; string; The second address, if present.
  • City; string; The city in the parcel address.
  • Country; string; The country in the address.
  • County; string; The county in the parcel address.
  • CreatedByDisplayName; string; The display name of the user who created the plan review cycle.
  • CreatedByEmail; string; The email address of the user who created the plan review cycle.
  • CreatedByUsername; string; The user who created the plan review cycle.
  • CycleCount; integer; The number specifying each plan review cycle.
  • CycleDays; integer; The number of days that the plan review cycle was open or in progress.
  • CycleDueDate; string; The date by which the plan review cycle must be completed.
  • CycleStatus; string; The review status for the plan review cycle.
  • CycleStatusCode; string; The review status code for the plan review cycle.
  • DecisionStatusCode; string; The decision status code for the plan review cycle.
  • ElectronicPlanReview; string; Indicates whether the plan review has been performed for a document attachment. The default value is N for no.
  • LnpRecordId; string; The permit record identifier.
  • LnpRecordKey; integer; The unique identifier for a permit record.
  • PermitDescription; string; The permit description.
  • PermitStatus; string; The permit status.
  • PermitStatusDescr; string; The status description of the permit record.
  • PersonName; string; The name of the applicant.
  • PlanReviewDecision; string; The decision status for the plan review cycle.
  • PlanReviewKey; integer; The unique identifier for a plan review cycle.
  • PlanReviewLink; string; The URL to the plan review page for the given permit.
  • PlanReviewName; string; The name of the plan review.
  • PlanReviewStatusDescr; string; The status description of the plan review record.
  • PlanReviewType; string; The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal.
  • PlanReviewerEmailList; string; The list of plan reviewer email addresses for which an email communication can be sent.
  • PlanReviewerUserIdList; string; The list of plan reviewer user IDs for which an in-product notification communication can be sent.
  • PostalCode; string; The postal code in the parcel address.
  • Province; string; The province in the parcel address.
  • RecordType; string; The type of permit. For example, a residential addition.
  • ReviewClosedDttm; string; The date when the plan review cycle was closed.
  • ReviewOpenDttm; string; The date when the plan review cycle was opened.
  • State; string; The state in the 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 : publicSectorPermitCycleDueDatePlanReviews

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/publicSectorPermitCycleDueDatePlanReviews-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Communications",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPermitCycleDueDatePlanReviews-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPermitCycleDueDatePlanReviews-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 : publicSectorPermitCycleDueDatePlanReviews-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.
• 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.
• 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: Application ID

  Read Only: true

  Maximum Length: 50

  The permit record identifier.
• LnpRecordKey: integer
  Read Only: true

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

  Read Only: true

  Maximum Length: 1000

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

  Read Only: true

  Maximum Length: 15

  The permit status.
• PermitStatusDescr: string
  Title: Application Status Description

  Read Only: true

  Maximum Length: 1000

  The status description of the permit record.
• 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.
• PlanReviewerEmailList: string
  Title: Plan Reviewer Email List

  The list of plan reviewer email addresses for which an email communication can be sent.
• PlanReviewerUserIdList: string
  Title: Plan Reviewer User ID List

  The list of plan reviewer user IDs for which an in-product notification communication can be sent.
• 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.
• PlanReviewStatusDescr: string
  Title: Plan Review Cycle Status Description

  Read Only: true

  Maximum Length: 100

  The status description of the plan review record.
• 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: Application Type

  Read Only: true

  Maximum Length: 100

  The type of permit. For example, a residential addition.
• ReviewClosedDttm: string (date-time)
  Title: Plan Review Closed Date

  Read Only: true

  The date when the plan review cycle was closed.
• 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.

{
    "type":"object",
    "properties":{
        "PlanReviewStatusDescr":{
            "title":"Plan Review Cycle Status Description",
            "maxLength":"100",
            "type":"string",
            "description":"The status description of the plan review record.",
            "nullable":true,
            "readOnly":true,
            "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":false,
            "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
        },
        "PlanReviewerUserIdList":{
            "title":"Plan Reviewer User ID List",
            "type":"string",
            "description":"The list of plan reviewer user IDs for which an in-product notification communication can be sent.",
            "nullable":true,
            "x-hints":{
                "Sender":"Y",
                "UserID":"Y",
                "Recipient":"Y"
            },
            "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
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":"100",
            "type":"string",
            "description":"The type of permit. For example, a residential addition.",
            "nullable":false,
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewName":{
            "title":"Plan Review Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the plan review.",
            "nullable":false,
            "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 permit description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":"50",
            "type":"string",
            "description":"The permit record identifier.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "PlanReviewerEmailList":{
            "title":"Plan Reviewer Email List",
            "type":"string",
            "description":"The list of plan reviewer email addresses for which an email communication can be sent.",
            "nullable":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a permit record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1"
            },
            "x-queryable":true
        },
        "CycleCount":{
            "title":"Plan Review Cycle",
            "type":"integer",
            "description":"The number specifying each plan review cycle.",
            "format":"int32",
            "nullable":false,
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReviewKey":{
            "title":"Plan Review Key",
            "type":"integer",
            "description":"The unique identifier for a plan review cycle.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "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
        },
        "PermitStatus":{
            "title":"Application Status",
            "maxLength":"15",
            "type":"string",
            "description":"The permit status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatusDescr":{
            "title":"Application Status Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The status description of the permit record.",
            "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