Get all planning applications
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlannerAssignmentCommunications
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 the planning application that matches the specified search criteria.
Finder Variables:- LnpRecordKey; integer; Finds the planning application that matches the specified record key.
- PrimaryKey: Finds the planning application that matches the specified search criteria.
-
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:- AboutToExpireDate; string; The about to expire date of the planning application.
- AddressKey; integer; The address identifier of the property.
- AgencyId; integer; The agency identifier of the transaction.
- Applicant; integer; The applicant identifier of the application.
- ApplicantAddress1; string; The first line of the applicant's address in the application.
- ApplicantAddress2; string; The second line of the applicant's address in the application.
- ApplicantBizProfileId; integer; The business profile ID of the applicant submitting the planning application.
- ApplicantCity; string; The applicant's city in the application.
- ApplicantCountry; string; The applicant's country in the application.
- ApplicantCounty; string; The applicant's county in the application.
- ApplicantEmailAddress1; string; The applicant's primary email ID in the application.
- ApplicantEmailAddress2; string; The applicant's secondary email ID in the application.
- ApplicantFirstName; string; The first name of the person filling the application form for submission.
- ApplicantLastName; string; The last name of the person filling the application form for submission.
- ApplicantMiddleName; string; The middle name of the person filling the application form for submission.
- ApplicantName; string; The name of the person filling the application form for submission.
- ApplicantPhoneExtension; string; The applicant's phone number extension in the application.
- ApplicantPhoneNumber; string; The applicant's phone number in the application.
- ApplicantPostalCode; string; The applicant's postal code in the application.
- ApplicantProfileId; integer; The profile ID of the applicant submitting the planning application.
- ApplicantProvince; string; The applicant's province in the application.
- ApplicantState; string; The applicant's state in the application.
- ApplicantTitle; string; The title of the person filling the application form for submission.
- AssigneeEmail; string; The email of the planner assigned to the transaction.
- AssigneeName; string; The name of the planner assigned to the transaction.
- AssigneePhone; string; The phone number of the planner assigned to the transaction.
- AssigneeUserid; string; The identifier of the planner assigned to the transaction.
- AssignmentStatus; string; The planner assignment status of the transaction.
- BalanceDue; number; The balance amount due for the transaction.
- CancelledByEmail; string; Identifies the user who canceled the application by the phone number.
- CancelledById; string; Identifies the user who canceled the application by the user ID.
- CancelledByName; string; Identifies the user who canceled the application by the name.
- CancelledByPhone; string; Identifies the user who canceled the application by the email address.
- Classification; string; The classification of the transaction.
- CreatedBy; string; Identifies the user ID of the person who created the application.
- CreatedByEmail; string; Identifies the user who created the application by the email address.
- CreatedByName; string; Identifies the person who created the application.
- CreatedByPhone; string; Identifies the user who created the application by the phone number.
- CreationDate; string; The date on which the transaction was created.
- DelinquentDate; string; The date on which the planning application becomes delinquent.
- DistrictName; string; The district in which the property exists.
- ExpirationDate; string; The planning application expiration date.
- ExpirationGraceDate; string; The date of expiration of the grace period for the planning application.
- ExpirationGracePeriod; string; The expiration grace period of the planning application.
- ExtensionsCount; integer; The number of extensions given for the planning application.
- IssueDate; string; The planning application issue date.
- LastUpdateDate; string; The date on which the transaction was last updated.
- LastUpdatedBy; string; Identifies the user ID of the person who last updated the application.
- LastUpdatedByEmail; string; Identifies the user who last updated the application by the email address.
- LastUpdatedByName; string; Identifies the person who last updated the application.
- LastUpdatedByPhone; string; Identifies the user who last updated the application by the phone number.
- LnpRecordKey; integer; Key identifier for the main record.
- OrganizationName; string; The applicant's organization name in the application.
- Owner; string; The name of the property owner in the application.
- OwnerEmailId; string; The email address of the property owner in the application.
- ParcelAddress1; string; The first line in the parcel address of the property in the application.
- ParcelAddress2; string; The second line in the parcel address of the property in the application.
- ParcelCity; string; The parcel city of the property in the application.
- ParcelCountry; string; The parcel country of the property in the application.
- ParcelCounty; string; The parcel county of the property in the application.
- ParcelId; integer; The parcel ID of the planning application.
- ParcelIdEntered; string; The parcel name of the planning application as entered by the user.
- ParcelKey; integer; The parcel key for the planning application.
- ParcelPostalCode; string; The parcel postal code of the property in the application.
- ParcelProvince; string; The parcel province of the property in the application.
- ParcelState; string; The parcel state of the property in the application.
- ParcelType; string; The parcel type for the planning application.
- PersonName; string; The primary contact name in the application.
- PrimaryContactEmail; string; The email of the primary contact in the application.
- PrimaryContactPhone; string; The phone number of the primary contact in the application.
- ProcessId; number; The identifier of the workflow process of the transaction.
- ProjectId; integer; The transaction's project ID in the application.
- PropertyDescription; string; The description of the property in the planning application.
- ReceivedDate; string; The received date of the transaction application.
- RenewalDate; string; The transaction renewal date of the application.
- RowType; string; The category of the transaction.
- SecondaryOwner; string; The name of the secondary owner of the property in the application.
- Subclassification; string; The subclassification of the transaction.
- SubmitDate; string; The submission date of the transaction application.
- SubmittedBy; string; Identifies the user who submitted the application by the user ID.
- SubmittedByEmail; string; Identifies the user who submitted the application by the email address.
- SubmittedByName; string; Identifies the user who submitted the application by the name.
- SubmittedByPhone; string; Identifies the user who submitted the application by the phone number.
- TransactionDescription; string; The description of the transaction.
- TransactionId; string; Unique identifier for the main transaction record.
- TransactionKey; integer; Identifier for the main transaction record.
- TransactionStatus; string; The status of the transaction.
- TransactionType; string; The type of the transaction.
- TransactionTypeId; string; The identifier for the transaction type.
- WithdrawnByEmail; string; Identifies the user who withdrew the application by the phone number.
- WithdrawnById; string; Identifies the user who withdrew the application by the user ID.
- WithdrawnByName; string; Identifies the user who withdrew the application by the name.
- WithdrawnByPhone; string; Identifies the user who withdrew the application by the email 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 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 : publicSectorPlannerAssignmentCommunications
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 : publicSectorPlannerAssignmentCommunications-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Title:
About to Expire Date
Read Only:true
The about to expire date of the planning application. -
AddressKey: integer
(int64)
Title:
Address Key
Read Only:true
The address identifier of the property. -
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
The agency identifier of the transaction. -
Applicant: integer
(int64)
Title:
Applicant ID
Read Only:true
The applicant identifier of the application. -
ApplicantAddress1: string
Title:
Applicant Address Line 1
Read Only:true
Maximum Length:240
The first line of the applicant's address in the application. -
ApplicantAddress2: string
Title:
Applicant Address Line 2
Read Only:true
Maximum Length:240
The second line of the applicant's address in the application. -
ApplicantBizProfileId: integer
(int64)
Title:
Business Profile
Read Only:true
The business profile ID of the applicant submitting the planning application. -
ApplicantCity: string
Title:
Applicant City
Read Only:true
Maximum Length:60
The applicant's city in the application. -
ApplicantCountry: string
Title:
Applicant Country
Read Only:true
Maximum Length:3
The applicant's country in the application. -
ApplicantCounty: string
Title:
Applicant County
Read Only:true
Maximum Length:60
The applicant's county in the application. -
ApplicantEmailAddress1: string
Title:
Applicant Email 1
Read Only:true
Maximum Length:320
The applicant's primary email ID in the application. -
ApplicantEmailAddress2: string
Title:
Applicant Email 2
Read Only:true
Maximum Length:320
The applicant's secondary email ID in the application. -
ApplicantFirstName: string
Read Only:
true
Maximum Length:150
The first name of the person filling the application form for submission. -
ApplicantLastName: string
Read Only:
true
Maximum Length:150
The last name of the person filling the application form for submission. -
ApplicantMiddleName: string
Read Only:
true
Maximum Length:60
The middle name of the person filling the application form for submission. -
ApplicantName: string
Title:
Applicant Name
Read Only:true
Maximum Length:450
The name of the person filling the application form for submission. -
ApplicantPhoneExtension: string
Title:
Applicant Phone Extension
Read Only:true
Maximum Length:20
The applicant's phone number extension in the application. -
ApplicantPhoneNumber: string
Title:
Applicant Phone Number
Read Only:true
Maximum Length:65
The applicant's phone number in the application. -
ApplicantPostalCode: string
Title:
Applicant Postal Code
Read Only:true
Maximum Length:60
The applicant's postal code in the application. -
ApplicantProfileId: integer
(int64)
Title:
Applicant Profile
Read Only:true
The profile ID of the applicant submitting the planning application. -
ApplicantProvince: string
Title:
Applicant Province
Read Only:true
Maximum Length:60
The applicant's province in the application. -
ApplicantState: string
Title:
Applicant State
Read Only:true
Maximum Length:60
The applicant's state in the application. -
ApplicantTitle: string
Read Only:
true
Maximum Length:60
The title of the person filling the application form for submission. -
AssigneeEmail: string
Title:
Assigned Planner Email
Read Only:true
Maximum Length:240
The email of the planner assigned to the transaction. -
AssigneeName: string
Title:
Assigned Planner Name
Read Only:true
Maximum Length:240
The name of the planner assigned to the transaction. -
AssigneePhone: string
Title:
Assigned Planner Phone
Read Only:true
Maximum Length:60
The phone number of the planner assigned to the transaction. -
AssigneeUserid: string
Title:
Assigned Planner User ID
Read Only:true
Maximum Length:64
The identifier of the planner assigned to the transaction. -
AssignmentStatus: string
Read Only:
true
Maximum Length:8
The planner assignment status of the transaction. -
BalanceDue: number
Title:
Balance Due
Read Only:true
The balance amount due for the transaction. -
CancelledByEmail: string
Title:
Canceled by Email
Read Only:true
Maximum Length:240
Identifies the user who canceled the application by the phone number. -
CancelledById: string
Title:
Canceled by User ID
Read Only:true
Maximum Length:64
Identifies the user who canceled the application by the user ID. -
CancelledByName: string
Title:
Canceled by Name
Read Only:true
Maximum Length:240
Identifies the user who canceled the application by the name. -
CancelledByPhone: string
Title:
Canceled by Phone
Read Only:true
Maximum Length:60
Identifies the user who canceled the application by the email address. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The classification of the transaction. -
CreatedBy: string
Title:
Created by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who created the application. -
CreatedByEmail: string
Title:
Created by Email
Read Only:true
Maximum Length:240
Identifies the user who created the application by the email address. -
CreatedByName: string
Title:
Created by Name
Read Only:true
Maximum Length:240
Identifies the person who created the application. -
CreatedByPhone: string
Title:
Created by Phone
Read Only:true
Maximum Length:60
Identifies the user who created the application by the phone number. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the transaction was created. -
DelinquentDate: string
(date-time)
Title:
Delinquent Date
Read Only:true
The date on which the planning application becomes delinquent. -
DistrictName: string
Title:
District
Read Only:true
Maximum Length:50
The district in which the property exists. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Read Only:true
The planning application expiration date. -
ExpirationGraceDate: string
(date-time)
Title:
Expiration Grace Date
Read Only:true
The date of expiration of the grace period for the planning application. -
ExpirationGracePeriod: string
Title:
Expiration Grace Period
Read Only:true
Maximum Length:121
The expiration grace period of the planning application. -
ExtensionsCount: integer
(int32)
Title:
Extensions Count
Read Only:true
The number of extensions given for the planning application. -
IssueDate: string
(date-time)
Title:
Issue Date
Read Only:true
The planning application issue date. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the transaction was last updated. -
LastUpdatedBy: string
Title:
Last Updated by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who last updated the application. -
LastUpdatedByEmail: string
Title:
Last Updated by Email
Read Only:true
Maximum Length:240
Identifies the user who last updated the application by the email address. -
LastUpdatedByName: string
Title:
Last Updated by Name
Read Only:true
Maximum Length:240
Identifies the person who last updated the application. -
LastUpdatedByPhone: string
Title:
Last Updated by Phone
Read Only:true
Maximum Length:60
Identifies the user who last updated the application by the phone number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordKey: integer
(int64)
Read Only:
true
Key identifier for the main record. -
OrganizationName: string
Title:
Business Name
Read Only:true
Maximum Length:360
The applicant's organization name in the application. -
Owner: string
Title:
Owner Name
Read Only:true
Maximum Length:150
The name of the property owner in the application. -
OwnerEmailId: string
Title:
Owner Email
Read Only:true
Maximum Length:50
The email address of the property owner in the application. -
ParcelAddress1: string
Title:
Parcel Address Line 1
Read Only:true
Maximum Length:240
The first line in the parcel address of the property in the application. -
ParcelAddress2: string
Title:
Parcel Address Line 2
Read Only:true
Maximum Length:240
The second line in the parcel address of the property in the application. -
ParcelCity: string
Title:
Parcel City
Read Only:true
Maximum Length:60
The parcel city of the property in the application. -
ParcelCountry: string
Title:
Parcel Country
Read Only:true
Maximum Length:60
The parcel country of the property in the application. -
ParcelCounty: string
Title:
Parcel County
Read Only:true
Maximum Length:60
The parcel county of the property in the application. -
ParcelId: integer
(int64)
Title:
Parcel ID
Read Only:true
The parcel ID of the planning application. -
ParcelIdEntered: string
Title:
Parcel
Read Only:true
Maximum Length:30
The parcel name of the planning application as entered by the user. -
ParcelKey: integer
(int64)
Title:
Parcel Key
Read Only:true
The parcel key for the planning application. -
ParcelPostalCode: string
Title:
Parcel Postal Code
Read Only:true
Maximum Length:60
The parcel postal code of the property in the application. -
ParcelProvince: string
Title:
Parcel Province
Read Only:true
Maximum Length:60
The parcel province of the property in the application. -
ParcelState: string
Title:
Parcel State
Read Only:true
Maximum Length:60
The parcel state of the property in the application. -
ParcelType: string
Title:
Parcel Type
Read Only:true
Maximum Length:30
The parcel type for the planning application. -
PersonName: string
Title:
Primary Contact Name
Read Only:true
Maximum Length:450
The primary contact name in the application. -
PrimaryContactEmail: string
Title:
Primary Contact Email
Read Only:true
Maximum Length:320
The email of the primary contact in the application. -
PrimaryContactPhone: string
Title:
Primary Contact Phone
Read Only:true
Maximum Length:65
The phone number of the primary contact in the application. -
ProcessId: number
Title:
Process ID
Read Only:true
The identifier of the workflow process of the transaction. -
ProjectId: integer
(int64)
Title:
Project ID
Read Only:true
The transaction's project ID in the application. -
PropertyDescription: string
Title:
Property Description
Read Only:true
Maximum Length:240
The description of the property in the planning application. -
ReceivedDate: string
(date-time)
Title:
Received Date
Read Only:true
The received date of the transaction application. -
RenewalDate: string
(date-time)
Title:
Renewal Date
Read Only:true
The transaction renewal date of the application. -
RowType: string
Title:
Row Type
Read Only:true
Maximum Length:30
The category of the transaction. -
SecondaryOwner: string
Title:
Secondary Owner
Read Only:true
Maximum Length:150
The name of the secondary owner of the property in the application. -
Subclassification: string
Title:
Subclassification
Read Only:true
Maximum Length:10
The subclassification of the transaction. -
SubmitDate: string
(date-time)
Title:
Submission Date
Read Only:true
The submission date of the transaction application. -
SubmittedBy: string
Title:
Submitted by User ID
Read Only:true
Maximum Length:64
Identifies the user who submitted the application by the user ID. -
SubmittedByEmail: string
Title:
Submitted by Email
Read Only:true
Maximum Length:240
Identifies the user who submitted the application by the email address. -
SubmittedByName: string
Title:
Submitted by Name
Read Only:true
Maximum Length:240
Identifies the user who submitted the application by the name. -
SubmittedByPhone: string
Title:
Submitted by Phone
Read Only:true
Maximum Length:60
Identifies the user who submitted the application by the phone number. -
TransactionDescription: string
Title:
Application Description
Read Only:true
Maximum Length:1000
The description of the transaction. -
TransactionId: string
Title:
Transaction ID
Read Only:true
Maximum Length:50
Unique identifier for the main transaction record. -
TransactionKey: integer
Title:
Transaction Key
Read Only:true
Identifier for the main transaction record. -
TransactionStatus: string
Title:
Application Status
Read Only:true
Maximum Length:15
The status of the transaction. -
TransactionType: string
Title:
Transaction Type
Read Only:true
Maximum Length:100
The type of the transaction. -
TransactionTypeId: string
Title:
Transaction Type ID
Read Only:true
Maximum Length:30
The identifier for the transaction type. -
WithdrawnByEmail: string
Title:
Withdrawn by Email
Read Only:true
Maximum Length:240
Identifies the user who withdrew the application by the phone number. -
WithdrawnById: string
Title:
Withdrawn by User ID
Read Only:true
Maximum Length:64
Identifies the user who withdrew the application by the user ID. -
WithdrawnByName: string
Title:
Withdrawn by Name
Read Only:true
Maximum Length:240
Identifies the user who withdrew the application by the name. -
WithdrawnByPhone: string
Title:
Withdrawn by Phone
Read Only:true
Maximum Length:60
Identifies the user who withdrew the application by the email address.
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.