Get all planning and zoning application expiry communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorPzExpiryCommunications
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 and zoning application expiry communication data that matches the specified record key.
Finder Variables:- LnpRecordKey; integer; The unique identifier for the record key.
- PrimaryKey: Finds the planning and zoning application expiry communication data that matches the specified record key.
-
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 date when the notification about an expiring planning and zoning application is sent.
- AddressKey; integer; The parcel address key.
- AgencyId; integer; The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
- ApplAteDate; string; The date to indicate when the application is about to expire.
- ApplExpirationDate; string; The date when the application expires.
- Applicant; integer; The party identifier of the planning and zoning applicant.
- ApplicantAddress1; string; The first line of the planning and zoning applicant address.
- ApplicantAddress2; string; The second line of the planning and zoning applicant address.
- ApplicantBizProfileId; integer; The business profile used by the applicant.
- ApplicantCity; string; The city in the planning and zoning applicant address.
- ApplicantCountry; string; The country in the planning and zoning applicant address.
- ApplicantCounty; string; The county in the planning and zoning applicant address.
- ApplicantEmailAddress1; string; The first email address of the planning and zoning applicant.
- ApplicantEmailAddress2; string; The second email address of the planning and zoning applicant.
- ApplicantPersonName; string; The planning and zoning applicant name.
- ApplicantPhoneAreaCode; string; The area code in the phone number of the planning and zoning applicant.
- ApplicantPhoneCountryCode; string; The country code in the phone number of the planning and zoning applicant.
- ApplicantPhoneExtension; string; The phone number extension for the planning and zoning applicant.
- ApplicantPhoneNumber; string; The planning and zoning applicant phone number.
- ApplicantPostalCode; string; The postal code in the planning and zoning applicant address.
- ApplicantProfileId; integer; The user profile of the applicant.
- ApplicantProvince; string; The province in the planning and zoning applicant address.
- ApplicantState; string; The state in the planning and zoning applicant address.
- AssignedPlannerEmail; string; The email address of the assigned planner.
- AssignedPlannerName; string; The name of an assigned planner.
- AssignedPlannerPhone; string; The phone number of the assigned planner.
- AssignedPlannerUserid; string; The user ID of the assigned planner.
- BalanceDue; number; The application balance due amount.
- Classification; string; The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The user who last updated the record.
- DelinquentDate; string; The date the license becomes delinquent.
- DistrictName; string; The type of the current parcel.
- ExpirationDate; string; The date the planning and zoning is no longer valid.
- ExpirationGraceDate; string; The application expiry grace date.
- ExtensionsCount; integer; The application expiry extension count.
- GracePeriod; integer; The grace period for the application expiry.
- GracePeriodUom; string; The application expiry grace period unit.
- IssueDate; string; The date on which the planning and zoning was issued.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The date when the record was created.
- LnpRecordId; string; The identifier for the planning and zoning application record.
- LnpRecordKey; integer; The unique identifier for the record.
- OrganizationName; string; The business name of the applicant. For example, a contractor enters his or her contracting business name.
- Owner; string; The primary or only owner of the parcel or property.
- OwnerEmailId; string; The parcel owner email address.
- ParcelAddress1; string; The first line of the parcel or property address.
- ParcelAddress2; string; The second line of the parcel or property address.
- ParcelCity; string; The city in the parcel or property address.
- ParcelCountry; string; The country in the parcel or property address.
- ParcelCounty; string; The county in the parcel or property address.
- ParcelId; integer; The identifier of the record parcel.
- ParcelPostalCode; string; The postal code in the parcel or property address.
- ParcelProvince; string; The province in the parcel or property address.
- ParcelState; string; The state in the parcel or property address.
- ParcelType; string; The key of the record parcel.
- PlanningDescription; string; The description of the planning and zoning type.
- PlanningStatus; string; The status of the planning and zoning record.
- PrimaryContactEmail; string; The application primary contact email.
- PrimaryContactName; string; The application primary contact name.
- PrimaryContactPhone; string; The application primary contact phone.
- ProjectKey; integer; The project name information for a planning and zoning application.
- PropertyDescription; string; The property description.
- RecordStatus; string; The status of the record.
- RecordType; string; The planning and zoning application type. Agencies define the types of planning applications that they administer.
- RenewalDate; string; The renewal date for the planning and zoning application.
- SecondaryOwner; string; The secondary owner of the parcel or property.
- Subclassification; string; The record subclassification.
- SubmitDate; string; The date the planning and zoning transaction was submitted. Used in the application information component of the Permit Designer.
- SubmittedBy; string; The user who submitted the application.
- Url; string; The browser link for the business license application.
- UrlLabel; string; The label for the URL.
- Username; string; The user ID of the planning and zoning applicant.
-
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 : publicSectorPzExpiryCommunications
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 : publicSectorPzExpiryCommunications-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Title:
About to Expire Date
Read Only:true
The date when the notification about an expiring planning and zoning application is sent. -
AddressKey: integer
(int64)
Read Only:
true
The parcel address key. -
AgencyId: integer
(int32)
Read Only:
true
The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
ApplAteDate: string
(date-time)
Read Only:
true
The date to indicate when the application is about to expire. -
ApplExpirationDate: string
(date-time)
Title:
Application Expiration Date
Read Only:true
The date when the application expires. -
Applicant: integer
(int64)
Title:
Applicant
Read Only:true
The party identifier of the planning and zoning applicant. -
ApplicantAddress1: string
Title:
Applicant Address Line 1
Read Only:true
Maximum Length:240
The first line of the planning and zoning applicant address. -
ApplicantAddress2: string
Title:
Applicant Address Line 2
Read Only:true
Maximum Length:240
The second line of the planning and zoning applicant address. -
ApplicantBizProfileId: integer
(int64)
Title:
Business Profile
Read Only:true
The business profile used by the applicant. -
ApplicantCity: string
Title:
Applicant City
Read Only:true
Maximum Length:60
The city in the planning and zoning applicant address. -
ApplicantCountry: string
Title:
Applicant Country
Read Only:true
Maximum Length:3
The country in the planning and zoning applicant address. -
ApplicantCounty: string
Title:
Applicant County
Read Only:true
Maximum Length:60
The county in the planning and zoning applicant address. -
ApplicantEmailAddress1: string
Title:
Applicant Email 1
Read Only:true
Maximum Length:320
The first email address of the planning and zoning applicant. -
ApplicantEmailAddress2: string
Title:
Applicant Email 2
Read Only:true
Maximum Length:320
The second email address of the planning and zoning applicant. -
ApplicantPersonName: string
Title:
Applicant Name
Read Only:true
Maximum Length:450
The planning and zoning applicant name. -
ApplicantPhoneAreaCode: string
Read Only:
true
Maximum Length:10
The area code in the phone number of the planning and zoning applicant. -
ApplicantPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The country code in the phone number of the planning and zoning applicant. -
ApplicantPhoneExtension: string
Title:
Applicant Phone Extension
Read Only:true
Maximum Length:20
The phone number extension for the planning and zoning applicant. -
ApplicantPhoneNumber: string
Title:
Applicant Phone Number
Read Only:true
Maximum Length:40
The planning and zoning applicant phone number. -
ApplicantPostalCode: string
Title:
Applicant Postal Code
Read Only:true
Maximum Length:60
The postal code in the planning and zoning applicant address. -
ApplicantProfileId: integer
(int64)
Title:
Applicant Profile
Read Only:true
The user profile of the applicant. -
ApplicantProvince: string
Title:
Applicant Province
Read Only:true
Maximum Length:60
The province in the planning and zoning applicant address. -
ApplicantState: string
Title:
Applicant State
Read Only:true
Maximum Length:60
The state in the planning and zoning applicant address. -
AssignedPlannerEmail: string
Title:
Assigned Planner Email
Read Only:true
The email address of the assigned planner. -
AssignedPlannerName: string
Title:
Assigned Planner Name
Read Only:true
The name of an assigned planner. -
AssignedPlannerPhone: string
Title:
Assigned Planner Phone
Read Only:true
The phone number of the assigned planner. -
AssignedPlannerUserid: string
Title:
Assigned Planner
Read Only:true
Maximum Length:64
The user ID of the assigned planner. -
BalanceDue: number
Title:
Fees Balance Due
Read Only:true
The application balance due amount. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The user who last updated the record. -
DelinquentDate: string
(date-time)
Title:
Delinquent Date
Read Only:true
The date the license becomes delinquent. -
DistrictName: string
Title:
District
Read Only:true
Maximum Length:50
The type of the current parcel. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Read Only:true
The date the planning and zoning is no longer valid. -
ExpirationGraceDate: string
(date-time)
Title:
Grace Period Date
Read Only:true
The application expiry grace date. -
ExtensionsCount: integer
(int32)
Title:
Number of Extensions
Read Only:true
The application expiry extension count. -
GracePeriod: integer
(int64)
Title:
Grace Period
Read Only:true
The grace period for the application expiry. -
GracePeriodUom: string
Title:
Grace Period UOM
Read Only:true
Maximum Length:5
The application expiry grace period unit. -
IssueDate: string
(date-time)
Title:
Issue Date
Read Only:true
The date on which the planning and zoning was issued. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the record was created. -
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 identifier for the planning and zoning application record. -
LnpRecordKey: integer
Read Only:
true
The unique identifier for the record. -
OrganizationName: string
Title:
Business Name
Read Only:true
Maximum Length:360
The business name of the applicant. For example, a contractor enters his or her contracting business name. -
Owner: string
Title:
Owner
Read Only:true
Maximum Length:150
The primary or only owner of the parcel or property. -
OwnerEmailId: string
Title:
Owner Email
Read Only:true
Maximum Length:50
The parcel owner email address. -
ParcelAddress1: string
Title:
Property Address Line 1
Read Only:true
Maximum Length:240
The first line of the parcel or property address. -
ParcelAddress2: string
Title:
Property Address Line 2
Read Only:true
Maximum Length:240
The second line of the parcel or property address. -
ParcelCity: string
Title:
Property City
Read Only:true
Maximum Length:60
The city in the parcel or property address. -
ParcelCountry: string
Title:
Property Country
Read Only:true
Maximum Length:60
The country in the parcel or property address. -
ParcelCounty: string
Title:
Property County
Read Only:true
Maximum Length:60
The county in the parcel or property address. -
ParcelId: integer
(int64)
Title:
Parcel
Read Only:true
The identifier of the record parcel. -
ParcelPostalCode: string
Title:
Property Postal Code
Read Only:true
Maximum Length:60
The postal code in the parcel or property address. -
ParcelProvince: string
Title:
Property Province
Read Only:true
Maximum Length:60
The province in the parcel or property address. -
ParcelState: string
Title:
Property State
Read Only:true
Maximum Length:60
The state in the parcel or property address. -
ParcelType: string
Title:
Parcel Type
Read Only:true
Maximum Length:30
The key of the record parcel. -
PlanningDescription: string
Title:
Application Description
Read Only:true
Maximum Length:1000
The description of the planning and zoning type. -
PlanningStatus: string
Title:
Application Status
Read Only:true
Maximum Length:100
The status of the planning and zoning record. -
PrimaryContactEmail: string
Title:
Contact Email
Read Only:true
Maximum Length:320
The application primary contact email. -
PrimaryContactName: string
Title:
Primary Contact
Read Only:true
Maximum Length:450
The application primary contact name. -
PrimaryContactPhone: string
Title:
Contact Phone Number
Read Only:true
Maximum Length:60
The application primary contact phone. -
ProjectKey: integer
(int64)
Read Only:
true
The project name information for a planning and zoning application. -
PropertyDescription: string
Title:
Property Description
Read Only:true
Maximum Length:240
The property description. -
RecordStatus: string
Read Only:
true
Maximum Length:15
The status of the record. -
RecordType: string
Title:
Application Type
Read Only:true
Maximum Length:100
The planning and zoning application type. Agencies define the types of planning applications that they administer. -
RenewalDate: string
(date-time)
Title:
Renewal Date
Read Only:true
The renewal date for the planning and zoning application. -
SecondaryOwner: string
Title:
Secondary Owner
Read Only:true
Maximum Length:150
The secondary owner of the parcel or property. -
Subclassification: string
Title:
Subclassification
Read Only:true
Maximum Length:80
The record subclassification. -
SubmitDate: string
(date-time)
Title:
Submission Date
Read Only:true
The date the planning and zoning transaction was submitted. Used in the application information component of the Permit Designer. -
SubmittedBy: string
Title:
Submitted By
Read Only:true
Maximum Length:64
The user who submitted the application. -
Url: string
Title:
URL
Read Only:true
Maximum Length:255
The browser link for the business license application. -
UrlLabel: string
Title:
Link to Planning Application
Read Only:true
Maximum Length:255
The label for the URL. -
Username: string
Title:
Applicant User ID
Read Only:true
Maximum Length:100
The user ID of the planning and zoning applicant.
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.