Get a pending plan review cycle
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewPendingReviews/{LnpRecordKey}
Request
Path Parameters
-
LnpRecordKey: integer
The unique identifier for a record. The record is for a permit or planning and zoning, and is determined by the classification.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPlanReviewPendingReviews-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240The first line of the primary parcel address. -
Address2(optional):
string
Maximum Length:
240The second line of the primary parcel address. -
Address3(optional):
string
Maximum Length:
240The third line of the primary parcel address. -
Address4(optional):
string
Maximum Length:
240The fourth line of the primary parcel address. -
City(optional):
string
Maximum Length:
60The city of the primary parcel address. -
Classification(optional):
string
Maximum Length:
3The classification of the permit or planning and zoning type. -
CycleCount(optional):
integer(int32)
The numbering for each plan review cycle.
-
CycleCountString(optional):
string
Maximum Length:
40The numbering for each plan review cycle converted to a string. -
CycleDecision(optional):
string
Maximum Length:
15The decision status code for the plan review cycle. -
CycleDecisionStatus(optional):
string
Maximum Length:
35The description of the cycle decision status. -
CycleReviewStatus(optional):
string
Maximum Length:
30The review status description for the plan review cycle. -
DocGroupId(optional):
string
Maximum Length:
30The unique identifier for a document group. -
ElectronicPlanReview(optional):
string
Maximum Length:
1Indicates whether the plan review has been performed for a document attachment. The default value is N for no. -
FinalizeStatus(optional):
string
Maximum Length:
1Indicates the status of finalizing the markup session. Possible values are R, F, and S for Ready, Finalizing, and Success. -
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordId(optional):
string
Maximum Length:
50The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for a record. The record is for a permit or planning and zoning, and is determined by the classification.
-
PermitDescription(optional):
string
Maximum Length:
1000The application record description. -
PermitStatus(optional):
string
Maximum Length:
15The application record status. -
PermitSubmittedDate(optional):
string(date-time)
The date when the application record was submitted.
-
PermitSystemStatus(optional):
string
Maximum Length:
15The application record's predefined system status to which the record status maps. -
PlanReviewId(optional):
string
Maximum Length:
12The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1. -
PlanReviewKey(optional):
integer(int64)
The unique identifier for a plan review cycle.
-
PlanReviewName(optional):
string
Maximum Length:
100The name of the plan review. -
PlanReviewType(optional):
string
Maximum Length:
11The type of plan review. For example, a plan review type for the first cycle is O for original or R for resubmittal. -
PostalCode(optional):
string
Maximum Length:
60The postal code of the primary parcel address. -
RecordType(optional):
string
Maximum Length:
100The user-friendly name for a permit or planning and zoning type. -
RecordTypeCode(optional):
string
Maximum Length:
20The unique alphanumeric code or short name for a permit or planning and zoning type. -
RecordTypeId(optional):
string
Maximum Length:
30The unique identifier for an application record type. -
ReviewClosedDttm(optional):
string(date-time)
The date when the plan review cycle was closed.
-
ReviewDueDate(optional):
string(date-time)
The date by which the plan review must be completed.
-
ReviewOpenDttm(optional):
string(date-time)
The date when the plan review cycle was opened.
-
ReviewStatus(optional):
string
Maximum Length:
15The review status code for the plan review cycle. -
RevisedDocUploadedFlag(optional):
string
Maximum Length:
1Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. Default value is N for no. -
SessionId(optional):
string
Maximum Length:
1000The unique identifier for a markup session. -
State(optional):
string
Maximum Length:
60The state of the primary parcel address. -
StreetNameConcat(optional):
string
Maximum Length:
350The 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(optional):
string
Maximum Length:
20The street number in the address of the record's primary parcel. -
StreetNumberAlpha(optional):
string
Maximum Length:
20The alphabetic portion of the street number in the address of the record's primary parcel. -
StreetNumberNumeric(optional):
number
The numerical portion of the street number in the address of the record's primary parcel.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.