1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Communications
  4. Plan Review Planning Communications

Get all planning plan review workflow communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewPlanningCommunications

Request

Query Parameters
  • 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).
  • 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
  • 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 planning plan review communication item using the specified planning plan review identifiers.
      Finder Variables:
      • LnpRecordKey; integer; The unique identifier of the application to which the planning plan review belongs.
      • PlanReviewKey; integer; The unique identifier of the planning plan review cycle.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AgencyName; string; The agency name of the public sector entity to which this planning plan review communication applies.
    • Applicant; integer; The unique identifer for an applicant.
    • ApplicantUsername; string; The user ID for an applicant.
    • CreatedBy; string; The user who created the planning plan review cycle.
    • CycleCount; integer; The number specifying each planning plan review cycle.
    • Decision; string; The decision status for the planning plan review cycle.
    • EmailAddress1; string; The email address for the applicant.
    • LnpRecordId; string; The planning record identifier.
    • LnpRecordKey; integer; The unique identifer for a planning plan review cycle.
    • Meaning; string; The public unique identifier of the subclassification code. This is the readable value displayed to the user.
    • PccEmail; string; The email address for the plan coordinator.
    • PccName; string; The name of the plan coordinator.
    • PersonName; string; The name of the applicant.
    • PlanReviewKey; integer; The unique identifer for a planning record.
    • PlanReviewLink; string; The URL to the plan review page for the given planning application.
    • PlanReviewName; string; The name of the planning plan review.
    • RecordType; string; The type of planning application. For example, a residential addition.
    • ReviewClosedDttm; string; The date when the planning plan review cycle was closed.
    • ReviewOpenBy; integer; The user who opened the planning plan review cycle.
    • ReviewStatus; string; The review status for the planning plan review cycle.
    • Subclassification; string; The subclassification code for the transaction type, which indicates that the preapplication process is included in addition to the hearing process.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorPlanReviewPlanningCommunications
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorPlanReviewPlanningCommunications-item-response
Type: object
Show Source
  • Title: Agency Name
    Read Only: true
    Maximum Length: 100
    The agency name of the public sector entity to which this planning plan review communication applies.
  • Read Only: true
    The unique identifer for an applicant.
  • Title: Applicant User ID
    The user ID for an applicant.
  • Title: Plan Check Coordinator User ID
    Read Only: true
    Maximum Length: 64
    The user who created the planning plan review cycle.
  • Title: Plan Review Cycle
    Read Only: true
    The number specifying each planning plan review cycle.
  • Title: Decision
    Read Only: true
    Maximum Length: 32
    The decision status for the planning plan review cycle.
  • Title: Applicant Email
    Read Only: true
    Maximum Length: 320
    The email address for the applicant.
  • Links
  • Title: Application
    Read Only: true
    Maximum Length: 50
    The planning record identifier.
  • Read Only: true
    The unique identifer for a planning plan review cycle.
  • Title: Subclassification
    Maximum Length: 80
    The public unique identifier of the subclassification code. This is the readable value displayed to the user.
  • Title: Plan Check Coordinator Email
    The email address for the plan coordinator.
  • Title: Plan Check Coordinator Name
    The name of the plan coordinator.
  • Title: Applicant Name
    Read Only: true
    Maximum Length: 450
    The name of the applicant.
  • Read Only: true
    The unique identifer for a planning record.
  • Title: Plan Review Name
    Read Only: true
    Maximum Length: 100
    The name of the planning plan review.
  • Title: Application Type
    Read Only: true
    Maximum Length: 100
    The type of planning application. For example, a residential addition.
  • Title: Decision Date
    Read Only: true
    The date when the planning plan review cycle was closed.
  • Read Only: true
    The user who opened the planning plan review cycle.
  • Title: Plan Review Cycle Status
    Read Only: true
    Maximum Length: 30
    The review status for the planning plan review cycle.
  • Read Only: true
    Maximum Length: 10
    The subclassification code for the transaction type, which indicates that the preapplication process is included in addition to the hearing process.
Back to Top