Get all planning application plan review attachment communications items
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlanningPlanReviewAttachmentCommunications
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 planning application plan review attachment communication item using the specified planning application plan review attachment identifiers.
Finder Variables:- AttachmentId; integer; The unique identifier of the planning application plan review attachment.
- LnpRecordKey; integer; The unique identifier of the planning application to which the attachment belongs.
- PrimaryKey: Finds a planning application plan review attachment communication item using the specified planning application plan review attachment identifiers.
-
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.
- ApplicantId; integer; The party ID of the person applying for a planning application.
- ApplicantName; string; The name of the applicant.
- AssignedPlannerEmail; string; The email address of the assigned planner.
- AssignedPlannerName; string; The name of the assigned planner.
- AssignedPlannerUserId; string; The user ID of the assigned planner.
- AttachmentId; integer; The unique identifier for a planning application plan review attachment.
- City; string; The city in the parcel address.
- Country; string; The country in the address.
- County; string; The county in the parcel address.
- CreationDate; string; The date and time when the attachment was created.
- CycleCount; integer; The numbering for each plan review cycle.
- CycleDays; integer; The number of days the plan review cycle was open or in progress.
- DocCategory; string; The value that will be displayed for the document category related to an attachment.
- DocCategoryCode; string; The unique identifier for the document category.
- DocSubcategory; string; The value that will be displayed for document subcategory related to an attachment.
- DocSubcategoryCode; string; The unique identifier for the document subcategory.
- ElectronicPlanReview; string; Indicates whether the plan review has been performed for a document attachment.
- FileDescription; string; The description of the attachment.
- FileName; string; The name of the attached file.
- FileSize; integer; The size of the attached file.
- FileType; string; The file type of attachment, such as PDF or text.
- LnpRecordId; string; The planning application record identifier.
- LnpRecordKey; integer; The unique identifier for a planning application.
- PermitDescription; string; The planning application description.
- PermitStatus; string; The planning application status.
- PermitStatusCode; string; The planning application status code.
- PlanCoordinatorDisplayName; string; The display name of the plan coordinator as seen within the application.
- PlanCoordinatorEmailAddress; string; The plan coordinator email addresses to which an email communication can be sent.
- PlanCoordinatorUsername; string; The plan coordinator user ID for which an in-product notification communication can be sent.
- PlanReviewDecision; string; The decision status for the plan review cycle.
- PlanReviewDecisionCode; string; The decision status code for the plan review cycle.
- PlanReviewId; string; The plan review cycle record identifier. For example, a plan review ID with a value such as PLNR-1.
- PlanReviewName; string; The name of the plan review.
- PlanReviewStatus; string; The review status for the plan review cycle.
- PlanReviewStatusCode; string; The review status code for the plan review cycle.
- 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 to 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 user-friendly name for the planning application type.
- ReviewClosedBy; integer; The user who closed the plan review cycle.
- ReviewClosedDttm; string; The date when the plan review cycle was closed.
- ReviewDueDate; string; The date by which the plan review must be completed.
- ReviewOpenBy; integer; The user who opened the plan review cycle.
- ReviewOpenDttm; string; The date when the plan review cycle was opened.
- State; string; The state in the parcel address.
- Subclassification; string; The subclassification of the planning application. For example, Pre-Application or Not Applicable.
-
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 TopResponse
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.
Root Schema : publicSectorPlanningPlanReviewAttachmentCommunications
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPlanningPlanReviewAttachmentCommunications-item-response
Type:
Show Source
object
-
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. -
ApplicantId: integer
(int64)
Read Only:
true
The party ID of the person applying for a planning application. -
ApplicantName: string
Title:
Applicant Name
Read Only:true
Maximum Length:450
The name of the applicant. -
AssignedPlannerEmail: string
Title:
Assigned Planner Email
Read Only:true
Maximum Length:255
The email address of the assigned planner. -
AssignedPlannerName: string
Title:
Assigned Planner Name
Read Only:true
Maximum Length:255
The name of the assigned planner. -
AssignedPlannerUserId: string
Title:
Assigned Planner User ID
Read Only:true
Maximum Length:255
The user ID of the assigned planner. -
AttachmentId: integer
(int64)
Read Only:
true
The unique identifier for a planning application plan review attachment. -
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. -
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
The date and time when the attachment was created. -
CycleCount: integer
(int32)
Title:
Plan Review Cycle
Read Only:true
The numbering for each plan review cycle. -
CycleDays: integer
(int32)
Title:
Plan Review Cycle Days
Read Only:true
The number of days the plan review cycle was open or in progress. -
DocCategory: string
Title:
Document Category
Read Only:true
Maximum Length:30
The value that will be displayed for the document category related to an attachment. -
DocCategoryCode: string
Read Only:
true
Maximum Length:30
The unique identifier for the document category. -
DocSubcategory: string
Title:
Document Subcategory
Read Only:true
Maximum Length:30
The value that will be displayed for document subcategory related to an attachment. -
DocSubcategoryCode: string
Read Only:
true
Maximum Length:30
The unique identifier for the document subcategory. -
ElectronicPlanReview: string
Title:
Electronic Review
Read Only:true
Maximum Length:1
Indicates whether the plan review has been performed for a document attachment. -
FileDescription: string
Title:
File Description
Read Only:true
Maximum Length:100
The description of the attachment. -
FileName: string
Title:
File Name
Read Only:true
Maximum Length:255
The name of the attached file. -
FileSize: integer
(int64)
Title:
File Size
Read Only:true
The size of the attached file. -
FileType: string
Title:
File Type
Read Only:true
Maximum Length:100
The file type of attachment, such as PDF or text. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Application
Read Only:true
Maximum Length:50
The planning application record identifier. -
LnpRecordKey: integer
Read Only:
true
The unique identifier for a planning application. -
PermitDescription: string
Title:
Application Description
Read Only:true
Maximum Length:1000
The planning application description. -
PermitStatus: string
Title:
Application Status
Read Only:true
Maximum Length:15
The planning application status. -
PermitStatusCode: string
Read Only:
true
Maximum Length:15
The planning application status code. -
PlanCoordinatorDisplayName: string
Title:
Plan Check Coordinator Name
Read Only:true
The display name of the plan coordinator as seen within the application. -
PlanCoordinatorEmailAddress: string
Title:
Plan Check Coordinator Email
Read Only:true
The plan coordinator email addresses to which an email communication can be sent. -
PlanCoordinatorUsername: string
Title:
Plan Check Coordinator User ID
Read Only:true
The plan coordinator user ID for which an in-product notification communication can be sent. -
PlanReviewDecision: string
Title:
Plan Review Cycle Decision
Read Only:true
Maximum Length:35
The decision status for the plan review cycle. -
PlanReviewDecisionCode: string
Read Only:
true
Maximum Length:15
The decision status code for the plan review cycle. -
PlanReviewerEmailList: string
Title:
Plan Reviewer Email List
The list of plan reviewer email addresses to 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. -
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. -
PlanReviewName: string
Title:
Plan Review Name
Read Only:true
Maximum Length:100
The name of the plan review. -
PlanReviewStatus: string
Title:
Plan Review Cycle Status
Read Only:true
Maximum Length:30
The review status for the plan review cycle. -
PlanReviewStatusCode: string
Read Only:
true
Maximum Length:15
The review status code for the plan review cycle. -
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 user-friendly name for the planning application type. -
ReviewClosedBy: integer
(int64)
Read Only:
true
The user who closed the plan review cycle. -
ReviewClosedDttm: string
(date-time)
Title:
Plan Review Closed Date
Read Only:true
The date when the plan review cycle was closed. -
ReviewDueDate: string
(date-time)
Title:
Plan Review Cycle Due Date
Read Only:true
The date by which the plan review must be completed. -
ReviewOpenBy: integer
(int64)
Read Only:
true
The user who opened the plan review cycle. -
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:255
The subclassification of the planning application. For example, Pre-Application or Not Applicable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.