Jump to

• Request
• Response

Get all planning and zoning workflow communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPzWorkflowCommunications

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 workflow communication data with the specified key.
    Finder Variables:
    • LnpRecordKey; integer; The unique identifier for the record key.
  • findByBRFCriteria: Finds workflow communication data that satisfies the criteria provided.
    Finder Variables:
    • Caller; string; The application making the call. Should always be BRF.
    • Criteria; string; The criteria for the rows. This should be formatted with semicolons before and after the field names.
• 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 license or planning 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.
  • AppAcceptDate; string; Identifies the accepted date of the application.
  • ApplAteDate; string; Identifies the date on which an about-to-expire notification is sent for the application.
  • ApplExpirationDate; string; The date the application expires.
  • Applicant; integer; The party ID of the planning application applicant.
  • ApplicantAddress1; string; The first line of the planning application applicant address.
  • ApplicantAddress2; string; The second line of the planning application applicant address.
  • ApplicantBizProfileId; integer; The business profile used by the applicant.
  • ApplicantCity; string; The city in the planning application applicant address.
  • ApplicantCountry; string; The country in the planning application applicant address.
  • ApplicantCounty; string; The county in the planning application applicant address.
  • ApplicantEmailAddress1; string; The first email address of the planning application applicant.
  • ApplicantEmailAddress2; string; The second email address of the planning application applicant.
  • ApplicantPersonName; string; The planning application applicant name.
  • ApplicantPhoneAreaCode; string; The area code in the phone number of the planning application applicant.
  • ApplicantPhoneCountryCode; string; The country code in the phone number of the planning application applicant.
  • ApplicantPhoneExtension; string; The phone number extension for the planning application applicant.
  • ApplicantPhoneNumber; string; The planning application applicant phone number.
  • ApplicantPostalCode; string; The postal code in the planning application applicant address.
  • ApplicantProfileId; integer; The user profile of the applicant.
  • ApplicantProvince; string; The province in the planning application applicant address.
  • ApplicantState; string; The state in the planning application applicant address.
  • ApplicantUserId; string; User ID of the applicant.
  • AssigneeEmail; string; The email for the workflow task assignee.
  • AssigneeName; string; The name of the workflow task assignee.
  • AssigneePhone; string; The phone for the workflow task assignee.
  • AssigneeUserid; string; The unique user ID of the agency staff assigned to the transaction.
  • BalanceDue; number; The balance due for the planning application.
  • CancellationReason; string; Identifies the cancelation reason of the planning application.
  • CancelledByName; string; Identifies the user name of the person who canceled the application.
  • CancelledByUserID; string; Identifies who canceled the planning application.
  • CancelledDate; string; Identifies the cancelation date of the planning application.
  • Classification; string; The planning application classification.
  • ClassificationMeaning; string; The description for the classification of the planning application type.
  • CreatedBy; string; Identifies the user who created the application by the login ID.
  • CreatedByName; string; Identifies the user name of the person who created the application.
  • CreationDate; string; Identifies the creation date of the planning application.
  • CurrencyCode; string; Identifies the currency code.
  • DelinquentDate; string; The date the license becomes delinquent.
  • DistrictName; string; The name of the district in which the property is located.
  • ExpirationDate; string; The date the license or planning application is no longer valid.
  • ExpirationGraceDate; string; Identifies the expiration grace date for the application.
  • ExpirationStatus; string; Identifies the expiration status of the application.
  • FeeDueUpdateDate; string; Identifier that captures the date when fee item with due status is added or updated.
  • IssueDate; string; The date the license or planning application was issued. Used in the application information component of the planning application Designer.
  • LastUpdateDate; string; Identifies the last update date of the planning application.
  • LastUpdatedBy; string; Identifies the user who last updated the application by the login ID.
  • LastUpdatedByName; string; Identifies the user name of the person who last updated the application.
  • Latitude; number; The geographic location of the permit parcel that is to the North or South of the equator.
  • LnpRecordId; string; The identifier for the building planning application. For example, a planning application number with a value such as Building planning application ID RA-2017-00029.
  • LnpRecordKey; integer; The unique identifier for the planning application.
  • Longitude; number; The geographic location of the permit parcel that is to the East or West of the meridian. It typically points to a specific entrance area within a large permit parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
  • OrganizationName; string; The business name of the applicant. For example, a contractor enters his or her contracting business name.
  • Originator; string; Identifies the originator of the application.
  • Owner; string; The primary or only owner of the parcel or property.
  • OwnerEmailId; string; The parcel owner's email.
  • OwnerId; integer; The owner ID of the parcel owner.
  • OwnerKey; integer; The owner key of the parcel owner.
  • 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.
  • ParcelKey; integer; The key 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 type of the current parcel.
  • PersonFirstName; string; The applicant first name.
  • PersonLastName; string; The applicant last name.
  • PersonMiddleName; string; The applicant middle name.
  • PersonTitle; string; The title of the contact.
  • PlanningDescription; string; The description of the planning application type.
  • PlanningStatus; string; The status of the planning application.
  • PrimaryContactEmail; string; Identifies the email of the primary contact of the application.
  • PrimaryContactName; string; Identifies the primary contact name of the application
  • PrimaryContactPartyId; integer; Identifies the party ID of the primary contact of the application.
  • PrimaryContactPhoneNumber; string; Identifies the phone number of the primary contact of the application.
  • PrimaryContactType; string; Identifies the contact type of the primary contact of the application.
  • PrimaryContactUserId; string; Identifies the user ID of the primary contact.
  • PrimaryContactphoneExtension; string; The extension for the primary contact telephone number.
  • ProjectKey; integer; The project name information for a planning application.
  • PropertyDescription; string; The property description.
  • ReceivedDate; string; Identifies the received date of the application.
  • RecordStatus; string; The status of the application.
  • RecordType; string; The planning application type. Agencies define the types of planning application that they administer, for example, Residential Addition.
  • RecordTypeId; string; The identifier for a record type.
  • RenewalDate; string; The renewal date for the license or planning application.
  • RowType; string; The identifier for a record type.
  • SecondaryOwner; string; The secondary owner of the parcel or property.
  • Subclassification; string; The subclassification of the planning application type.
  • SubclassificationMeaning; string; The description for the subclassification of the planning application type.
  • SubmitDate; string; The date the license and planning application transaction was submitted. Used in the application information component of the planning application Designer.
  • SubmittedBy; string; Identifies the user who submitted the application by the login ID.
  • SubmittedByName; string; Identifies the user name of the person who submitted the application.
  • SystemStatus; string; Identifies the system status of the application.
  • TotalFees; number; The total fees for the application.
  • TotalHold; number; Identifies the total hold fee amount.
  • TotalOutstanding; number; Identifies the total outstanding fee amount.
  • TotalPaid; number; The total fee paid for the application.
  • TotalPayable; number; The total fee payable for the application.
  • TotalPending; number; Identifies the total pending fee amount.
  • TotalWaived; number; Identifies the total fee waived.
  • Url; string; The URL for the planning application.
  • UrlLabel; string; The URL label for the planning application.
  • WithdrawalReason; string; Identifies the reason that a planning application was withdrawn.
  • WithdrawnByName; string; Identifies the user name of the person who withdrew the application.
  • WithdrawnByUserID; string; Identifies who withdrew the planning application.
  • WithdrawnDate; string; Identifies the date that the planning application was withdrawn.
• 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 Top

Response

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.

Body ()

Root Schema : publicSectorPzWorkflowCommunications

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPzWorkflowCommunications-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Communications",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPzWorkflowCommunications-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPzWorkflowCommunications-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorPzWorkflowCommunications-item-response

Type: object

Show Source

• AboutToExpireDate: string (date-time)
  Title: About to Expire Date

  Read Only: true

  The date when the notification about an expiring license or planning 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.
• AppAcceptDate: string (date-time)
  Title: Acceptance Date

  Read Only: true

  Identifies the accepted date of the application.
• ApplAteDate: string (date-time)
  Title: Application About to Expire Date

  Read Only: true

  Identifies the date on which an about-to-expire notification is sent for the application.
• ApplExpirationDate: string (date-time)
  Title: Application Expiration Date

  Read Only: true

  The date the application expires.
• Applicant: integer (int64)
  Read Only: true

  The party ID of the planning application applicant.
• ApplicantAddress1: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the planning application applicant address.
• ApplicantAddress2: string
  Title: Applicant Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the planning application applicant address.
• ApplicantBizProfileId: integer (int64)
  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 application applicant address.
• ApplicantCountry: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

  The country in the planning application applicant address.
• ApplicantCounty: string
  Title: Applicant County

  Read Only: true

  Maximum Length: 60

  The county in the planning application applicant address.
• ApplicantEmailAddress1: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The first email address of the planning application applicant.
• ApplicantEmailAddress2: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The second email address of the planning application applicant.
• ApplicantPersonName: string
  Title: Applicant Full Name

  Read Only: true

  Maximum Length: 450

  The planning application applicant name.
• ApplicantPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The area code in the phone number of the planning application applicant.
• ApplicantPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The country code in the phone number of the planning application applicant.
• ApplicantPhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The phone number extension for the planning application applicant.
• ApplicantPhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 60

  The planning application applicant phone number.
• ApplicantPostalCode: string
  Title: Applicant Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the planning application applicant address.
• ApplicantProfileId: integer (int64)
  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 application applicant address.
• ApplicantState: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The state in the planning application applicant address.
• ApplicantUserId: string
  Title: Applicant User ID

  Read Only: true

  Maximum Length: 20

  User ID of the applicant.
• AssigneeEmail: string
  Title: Assigned Planner Email

  Read Only: true

  The email for the workflow task assignee.
• AssigneeName: string
  Title: Assigned Planner Name

  Read Only: true

  The name of the workflow task assignee.
• AssigneePhone: string
  Title: Assigned Planner Phone

  Read Only: true

  The phone for the workflow task assignee.
• AssigneeUserid: string
  Title: Assigned Planner

  Read Only: true

  Maximum Length: 64

  The unique user ID of the agency staff assigned to the transaction.
• BalanceDue: number
  Title: Fees Balance Due

  Read Only: true

  The balance due for the planning application.
• CancellationReason: string
  Title: Cancellation Reason

  Read Only: true

  Maximum Length: 1000

  Identifies the cancelation reason of the planning application.
• CancelledByName: string
  Title: Canceled by Name

  Read Only: true

  Identifies the user name of the person who canceled the application.
• CancelledByUserID: string
  Title: Canceled by User ID

  Read Only: true

  Maximum Length: 64

  Identifies who canceled the planning application.
• CancelledDate: string (date-time)
  Title: Cancellation Date

  Read Only: true

  Identifies the cancelation date of the planning application.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The planning application classification.
• ClassificationMeaning: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  The description for the classification of the planning application type.
• CreatedBy: string
  Title: Created by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user who created the application by the login ID.
• CreatedByName: string
  Title: Created by Name

  Read Only: true

  Identifies the user name of the person who created the application.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Identifies the creation date of the planning application.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 3

  Identifies the currency code.
• DelinquentDate: string (date-time)
  Read Only: true

  The date the license becomes delinquent.
• DistrictName: string
  Read Only: true

  Maximum Length: 50

  The name of the district in which the property is located.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Read Only: true

  The date the license or planning application is no longer valid.
• ExpirationGraceDate: string (date-time)
  Title: Grace Period Date

  Read Only: true

  Identifies the expiration grace date for the application.
• ExpirationStatus: string
  Title: Expiration Status

  Read Only: true

  Maximum Length: 15

  Identifies the expiration status of the application.
• FeeDueUpdateDate: string (date-time)
  Title: Fees Due Updated Date

  Read Only: true

  Identifier that captures the date when fee item with due status is added or updated.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date the license or planning application was issued. Used in the application information component of the planning application Designer.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Identifies the last update date of the planning application.
• LastUpdatedBy: string
  Title: Last Updated by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user who last updated the application by the login ID.
• LastUpdatedByName: string
  Title: Last Updated by Name

  Read Only: true

  Identifies the user name of the person who last updated the application.
• Latitude: number
  Read Only: true

  The geographic location of the permit parcel that is to the North or South of the equator.
• 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 building planning application. For example, a planning application number with a value such as Building planning application ID RA-2017-00029.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for the planning application.
• Longitude: number
  Read Only: true

  The geographic location of the permit parcel that is to the East or West of the meridian. It typically points to a specific entrance area within a large permit parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
• 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.
• Originator: string
  Title: Originator

  Read Only: true

  Maximum Length: 3

  Identifies the originator of the application.
• Owner: string
  Title: Property Owner Name

  Read Only: true

  Maximum Length: 150

  The primary or only owner of the parcel or property.
• OwnerEmailId: string
  Title: Property Owner Email

  Read Only: true

  Maximum Length: 50

  The parcel owner's email.
• OwnerId: integer (int64)
  Read Only: true

  The owner ID of the parcel owner.
• OwnerKey: integer (int64)
  Read Only: true

  The owner key of the parcel owner.
• 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.
• ParcelKey: integer (int64)
  Read Only: true

  The key 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 type of the current parcel.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

  The applicant first name.
• PersonLastName: string
  Title: Applicant Last Name

  Read Only: true

  Maximum Length: 150

  The applicant last name.
• PersonMiddleName: string
  Title: Applicant Middle Name

  Read Only: true

  Maximum Length: 60

  The applicant middle name.
• PersonTitle: string
  Title: Applicant Title

  Read Only: true

  Maximum Length: 60

  The title of the contact.
• PlanningDescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 300

  The description of the planning application type.
• PlanningStatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 100

  The status of the planning application.
• PrimaryContactEmail: string
  Read Only: true

  Maximum Length: 320

  Identifies the email of the primary contact of the application.
• PrimaryContactName: string
  Read Only: true

  Maximum Length: 450

  Identifies the primary contact name of the application
• PrimaryContactPartyId: integer (int64)
  Read Only: true

  Identifies the party ID of the primary contact of the application.
• PrimaryContactphoneExtension: string
  Read Only: true

  Maximum Length: 20

  The extension for the primary contact telephone number.
• PrimaryContactPhoneNumber: string
  Read Only: true

  Maximum Length: 80

  Identifies the phone number of the primary contact of the application.
• PrimaryContactType: string
  Read Only: true

  Maximum Length: 30

  Identifies the contact type of the primary contact of the application.
• PrimaryContactUserId: string
  Read Only: true

  Identifies the user ID of the primary contact.
• ProjectKey: integer (int64)
  Read Only: true

  The project name information for a planning application.
• PropertyDescription: string
  Title: Property Description

  Read Only: true

  Maximum Length: 240

  The property description.
• ReceivedDate: string (date-time)
  Title: Received Date

  Read Only: true

  Identifies the received date of the application.
• RecordStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the application.
• RecordType: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The planning application type. Agencies define the types of planning application that they administer, for example, Residential Addition.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The identifier for a record type.
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

  The renewal date for the license or planning application.
• RowType: string
  Read Only: true

  Maximum Length: 30

  The identifier for a record type.
• SecondaryOwner: string
  Title: Property Secondary Owner

  Read Only: true

  Maximum Length: 150

  The secondary owner of the parcel or property.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The subclassification of the planning application type.
• SubclassificationMeaning: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 80

  The description for the subclassification of the planning application type.
• SubmitDate: string (date-time)
  Title: Submission Date

  Read Only: true

  The date the license and planning application transaction was submitted. Used in the application information component of the planning application Designer.
• SubmittedBy: string
  Title: Submitted by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user who submitted the application by the login ID.
• SubmittedByName: string
  Title: Submitted by Name

  Read Only: true

  Identifies the user name of the person who submitted the application.
• SystemStatus: string
  Title: Application System Status

  Read Only: true

  Maximum Length: 15

  Identifies the system status of the application.
• TotalFees: number
  Title: Fees Total Amount

  Read Only: true

  The total fees for the application.
• TotalHold: number
  Title: Fees on Hold

  Read Only: true

  Identifies the total hold fee amount.
• TotalOutstanding: number
  Title: Fees Outstanding Balance

  Read Only: true

  Identifies the total outstanding fee amount.
• TotalPaid: number
  Title: Fees Total Paid

  Read Only: true

  The total fee paid for the application.
• TotalPayable: number
  Title: Fees Total Payable

  Read Only: true

  The total fee payable for the application.
• TotalPending: number
  Title: Fees in Pending Status

  Read Only: true

  Identifies the total pending fee amount.
• TotalWaived: number
  Title: Fees Waived

  Read Only: true

  Identifies the total fee waived.
• Url: string
  Title: URL

  Read Only: true

  The URL for the planning application.
• UrlLabel: string
  Title: Link to Planning Application

  Read Only: true

  The URL label for the planning application.
• WithdrawalReason: string
  Title: Withdrawal Reason

  Read Only: true

  Maximum Length: 1000

  Identifies the reason that a planning application was withdrawn.
• WithdrawnByName: string
  Title: Withdrawn by Name

  Read Only: true

  Identifies the user name of the person who withdrew the application.
• WithdrawnByUserID: string
  Title: Withdrawn by User ID

  Read Only: true

  Maximum Length: 64

  Identifies who withdrew the planning application.
• WithdrawnDate: string (date-time)
  Title: Withdrawal Date

  Read Only: true

  Identifies the date that the planning application was withdrawn.

{
    "type":"object",
    "properties":{
        "WithdrawnByUserID":{
            "title":"Withdrawn by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies who withdrew the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"The date when the notification about an expiring license or planning application is sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Identifies the creation date of the planning application.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantUserId":{
            "title":"Applicant User ID",
            "maxLength":20,
            "type":"string",
            "description":"User ID of the applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Owner":{
            "title":"Property Owner Name",
            "maxLength":150,
            "type":"string",
            "description":"The primary or only owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeUserid":{
            "title":"Assigned Planner",
            "maxLength":64,
            "type":"string",
            "description":"The unique user ID of the agency staff assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AppAcceptDate":{
            "title":"Acceptance Date",
            "type":"string",
            "description":"Identifies the accepted date of the application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnDate":{
            "title":"Withdrawal Date",
            "type":"string",
            "description":"Identifies the date that the planning application was withdrawn.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the license and planning application transaction was submitted. Used in the application information component of the planning application Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalHold":{
            "title":"Fees on Hold",
            "type":"number",
            "description":"Identifies the total hold fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactEmail":{
            "maxLength":320,
            "type":"string",
            "description":"Identifies the email of the primary contact of the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelPostalCode":{
            "title":"Property Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Applicant Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The applicant middle name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Originator":{
            "title":"Originator",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the originator of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The planning application classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Fees Total Paid",
            "type":"number",
            "description":"The total fee paid for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"Link to Planning Application",
            "type":"string",
            "description":"The URL label for the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URLLabel":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantProvince":{
            "title":"Applicant Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the planning application applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SecondaryOwner":{
            "title":"Property Secondary Owner",
            "maxLength":150,
            "type":"string",
            "description":"The secondary owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPartyId":{
            "type":"integer",
            "description":"Identifies the party ID of the primary contact of the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CancelledDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"Identifies the cancelation date of the planning application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who last updated the application by the login ID.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelProvince":{
            "title":"Property Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactName":{
            "maxLength":450,
            "type":"string",
            "description":"Identifies the primary contact name of the application",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The user profile of the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the application by the login ID.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant last name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelCounty":{
            "title":"Property County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who submitted the application by the login ID.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelState":{
            "title":"Property State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"Applicant First Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant first name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AddressKey":{
            "type":"integer",
            "description":"The parcel address key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantCounty":{
            "title":"Applicant County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the planning application applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the planning application.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1"
            },
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The geographic location of the permit parcel that is to the East or West of the meridian. It typically points to a specific entrance area within a large permit parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationMeaning":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"The description for the classification of the planning application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":240,
            "type":"string",
            "description":"The property description.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"The renewal date for the license or planning application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "WithdrawalReason":{
            "title":"Withdrawal Reason",
            "maxLength":1000,
            "type":"string",
            "description":"Identifies the reason that a planning application was withdrawn.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "WithdrawnByName":{
            "title":"Withdrawn by Name",
            "type":"string",
            "description":"Identifies the user name of the person who withdrew the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Grace Period Date",
            "type":"string",
            "description":"Identifies the expiration grace date for the application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeDueUpdateDate":{
            "title":"Fees Due Updated Date",
            "type":"string",
            "description":"Identifier that captures the date when fee item with due status is added or updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerKey":{
            "type":"integer",
            "description":"The owner key of the parcel owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the planning application applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The phone number extension for the planning application applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CancellationReason":{
            "title":"Cancellation Reason",
            "maxLength":1000,
            "type":"string",
            "description":"Identifies the cancelation reason of the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssigneePhone":{
            "title":"Assigned Planner Phone",
            "type":"string",
            "description":"The phone for the workflow task assignee.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":320,
            "type":"string",
            "description":"The first email address of the planning application applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PlanningDescription":{
            "title":"Application Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of the planning application type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress2":{
            "title":"Applicant Email 2",
            "maxLength":320,
            "type":"string",
            "description":"The second email address of the planning application applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplExpirationDate":{
            "title":"Application Expiration Date",
            "type":"string",
            "description":"The date the application expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The URL for the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true",
                "URL":"Y"
            },
            "x-queryable":true
        },
        "OwnerEmailId":{
            "title":"Property Owner Email",
            "maxLength":50,
            "type":"string",
            "description":"The parcel owner's email.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "DelinquentDate":{
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"The owner ID of the parcel owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated by Name",
            "type":"string",
            "description":"Identifies the user name of the person who last updated the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeName":{
            "title":"Assigned Planner Name",
            "type":"string",
            "description":"The name of the workflow task assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code in the phone number of the planning application applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date the license or planning application was issued. Used in the application information component of the planning application Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantCountry":{
            "title":"Applicant Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the planning application applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplAteDate":{
            "title":"Application About to Expire Date",
            "type":"string",
            "description":"Identifies the date on which an about-to-expire notification is sent for the application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationStatus":{
            "title":"Expiration Status",
            "maxLength":15,
            "type":"string",
            "description":"Identifies the expiration status of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "type":"integer",
            "description":"The business profile used by the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DistrictName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the district in which the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date the license or planning application is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Identifies the last update date of the planning application.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subclassification":{
            "maxLength":10,
            "type":"string",
            "description":"The subclassification of the planning application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddress2":{
            "title":"Property Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPhoneNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies the phone number of the primary contact of the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssigneeEmail":{
            "title":"Assigned Planner Email",
            "type":"string",
            "description":"The email for the workflow task assignee.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelAddress1":{
            "title":"Property Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The geographic location of the permit parcel that is to the North or South of the equator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Applicant Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPersonName":{
            "title":"Applicant Full Name",
            "maxLength":450,
            "type":"string",
            "description":"The planning application applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the contact type of the primary contact of the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "type":"integer",
            "description":"The key of the record parcel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code in the phone number of the planning application applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelType":{
            "title":"Parcel Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the current parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantAddress2":{
            "title":"Applicant Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the planning application applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubclassificationMeaning":{
            "title":"Subclassification",
            "maxLength":80,
            "type":"string",
            "description":"The description for the subclassification of the planning application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledByUserID":{
            "title":"Canceled by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies who canceled the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantState":{
            "title":"Applicant State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the planning application applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubmittedByName":{
            "title":"Submitted by Name",
            "type":"string",
            "description":"Identifies the user name of the person who submitted the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledByName":{
            "title":"Canceled by Name",
            "type":"string",
            "description":"Identifies the user name of the person who canceled the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PlanningStatus":{
            "title":"Application Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the planning application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCity":{
            "title":"Property City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalOutstanding":{
            "title":"Fees Outstanding Balance",
            "type":"number",
            "description":"Identifies the total outstanding fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"Identifies the received date of the application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Business Name",
            "maxLength":360,
            "type":"string",
            "description":"The business name of the applicant. For example, a contractor enters his or her contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectKey":{
            "type":"integer",
            "description":"The project name information for a planning application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedByName":{
            "title":"Created by Name",
            "type":"string",
            "description":"Identifies the user name of the person who created the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RowType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPayable":{
            "title":"Fees Total Payable",
            "type":"number",
            "description":"The total fee payable for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantCity":{
            "title":"Applicant City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the planning application applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalWaived":{
            "title":"Fees Waived",
            "type":"number",
            "description":"Identifies the total fee waived.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":100,
            "type":"string",
            "description":"The planning application type. Agencies define the types of planning application that they administer, for example, Residential Addition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the planning application applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantAddress1":{
            "title":"Applicant Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the planning application applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"Application System Status",
            "maxLength":15,
            "type":"string",
            "description":"Identifies the system status of the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":50,
            "type":"string",
            "description":"The identifier for the building planning application. For example, a planning application number with a value such as Building planning application ID RA-2017-00029.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:Condition:ObjectType":"LNP",
                "brf:Condition:ObjectSubType":"PZ"
            },
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalPending":{
            "title":"Fees in Pending Status",
            "type":"number",
            "description":"Identifies the total pending fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCountry":{
            "title":"Property Country",
            "maxLength":60,
            "type":"string",
            "description":"The country in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The planning application applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactUserId":{
            "type":"string",
            "description":"Identifies the user ID of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Fees Total Amount",
            "type":"number",
            "description":"The total fees for the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The balance due for the planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactphoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The extension for the primary contact telephone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top