Jump to

• Request
• Response

Get all planning and zoning workflow communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPzWorkflowCommunications

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:
  
  

  • findByBRFCriteria: Finds workflow communication data that satisfies the criteria provided.
  • PrimaryKey: Finds workflow communication data with the specified key. Finder Variables:
    • LnpRecordKey; integer; The unique identifier for the 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPzWorkflowCommunications

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "type":"object",
    "properties":{
        "count":{
            "title":"Count",
            "description":"The number of resource instances returned in the current range.",
            "type":"integer"
        },
        "hasMore":{
            "title":"HasMore",
            "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.",
            "type":"boolean"
        },
        "items":{
            "title":"Items",
            "description":"The items in the collection.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/publicSectorPzWorkflowCommunications-item"
            }
        },
        "limit":{
            "title":"Limit",
            "description":"The actual paging size used by the server.",
            "type":"integer"
        },
        "links":{
            "title":"Items",
            "description":"The link relations associated with the resource instance.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "offset":{
            "title":"Offset",
            "description":"The offset value used in the current page.",
            "type":"integer"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPzWorkflowCommunications-item

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

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorPzWorkflowCommunications-item

Type: object

Show Source

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

  The date when the notification about an expiring license or planning application is sent.
• AddressKey(optional): integer(int64)
  The parcel address key.
• AgencyId(optional): integer(int32)
  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(optional): string(date-time)
  Title: Acceptance Date

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

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

  The date the application expires.
• Applicant(optional): integer(int64)
  The party ID of the planning application applicant.
• ApplicantAddress1(optional): string
  Title: Applicant Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

  The second line of the planning application applicant address.
• ApplicantBizProfileId(optional): integer(int64)
  The business profile used by the applicant.
• ApplicantCity(optional): string
  Title: Applicant City

  Maximum Length: 60

  The city in the planning application applicant address.
• ApplicantCountry(optional): string
  Title: Applicant Country

  Maximum Length: 3

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

  Maximum Length: 60

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

  Maximum Length: 320

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

  Maximum Length: 320

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

  Maximum Length: 450

  The planning application applicant name.
• ApplicantPhoneAreaCode(optional): string
  Maximum Length: 10

  The area code in the phone number of the planning application applicant.
• ApplicantPhoneCountryCode(optional): string
  Maximum Length: 10

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

  Maximum Length: 20

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

  Maximum Length: 60

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

  Maximum Length: 60

  The postal code in the planning application applicant address.
• ApplicantProfileId(optional): integer(int64)
  The user profile of the applicant.
• ApplicantProvince(optional): string
  Title: Applicant Province

  Maximum Length: 60

  The province in the planning application applicant address.
• ApplicantState(optional): string
  Title: Applicant State

  Maximum Length: 60

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

  Maximum Length: 20

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

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

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

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

  Maximum Length: 64

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

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

  Maximum Length: 1000

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

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

  Maximum Length: 64

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

  Identifies the cancelation date of the planning application.
• Classification(optional): string
  Maximum Length: 3

  The planning application classification.
• ClassificationMeaning(optional): string
  Title: Classification

  Maximum Length: 80

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

  Maximum Length: 64

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

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

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

  Maximum Length: 3

  Identifies the currency code.
• DelinquentDate(optional): string(date-time)
  The date the license becomes delinquent.
• DistrictName(optional): string
  Maximum Length: 50

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

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

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

  Maximum Length: 15

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

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

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

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

  Maximum Length: 64

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

  Identifies the user name of the person who last updated the application.
• Latitude(optional): number
  The geographic location of the permit parcel that is to the North or South of the equator.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Application ID

  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(optional): integer(int64)
  The unique identifier for the planning application.
• Longitude(optional): 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(optional): string
  Title: Business Name

  Maximum Length: 360

  The business name of the applicant. For example, a contractor enters his or her contracting business name.
• Originator(optional): string
  Title: Originator

  Maximum Length: 3

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

  Maximum Length: 150

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

  Maximum Length: 50

  The parcel owner's email.
• OwnerId(optional): integer(int64)
  The owner ID of the parcel owner.
• OwnerKey(optional): integer(int64)
  The owner key of the parcel owner.
• ParcelAddress1(optional): string
  Title: Property Address Line 1

  Maximum Length: 240

  The first line of the parcel or property address.
• ParcelAddress2(optional): string
  Title: Property Address Line 2

  Maximum Length: 240

  The second line of the parcel or property address.
• ParcelCity(optional): string
  Title: Property City

  Maximum Length: 60

  The city in the parcel or property address.
• ParcelCountry(optional): string
  Title: Property Country

  Maximum Length: 60

  The country in the parcel or property address.
• ParcelCounty(optional): string
  Title: Property County

  Maximum Length: 60

  The county in the parcel or property address.
• ParcelId(optional): integer(int64)
  Title: Parcel

  The identifier of the record parcel.
• ParcelKey(optional): integer(int64)
  The key of the record parcel.
• ParcelPostalCode(optional): string
  Title: Property Postal Code

  Maximum Length: 60

  The postal code in the parcel or property address.
• ParcelProvince(optional): string
  Title: Property Province

  Maximum Length: 60

  The province in the parcel or property address.
• ParcelState(optional): string
  Title: Property State

  Maximum Length: 60

  The state in the parcel or property address.
• ParcelType(optional): string
  Title: Parcel Type

  Maximum Length: 30

  The type of the current parcel.
• PersonFirstName(optional): string
  Title: Applicant First Name

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 60

  The applicant middle name.
• PersonTitle(optional): string
  Title: Applicant Title

  Maximum Length: 60

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

  Maximum Length: 300

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

  Maximum Length: 100

  The status of the planning application.
• PrimaryContactEmail(optional): string
  Maximum Length: 320

  Identifies the email of the primary contact of the application.
• PrimaryContactName(optional): string
  Maximum Length: 450

  Identifies the primary contact name of the application
• PrimaryContactPartyId(optional): integer(int64)
  Identifies the party ID of the primary contact of the application.
• PrimaryContactphoneExtension(optional): string
  Maximum Length: 20

  The extension for the primary contact telephone number.
• PrimaryContactPhoneNumber(optional): string
  Maximum Length: 80

  Identifies the phone number of the primary contact of the application.
• PrimaryContactType(optional): string
  Maximum Length: 30

  Identifies the contact type of the primary contact of the application.
• PrimaryContactUserId(optional): string
  Identifies the user ID of the primary contact.
• ProjectKey(optional): integer(int64)
  The project name information for a planning application.
• PropertyDescription(optional): string
  Title: Property Description

  Maximum Length: 240

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

  Identifies the received date of the application.
• RecordStatus(optional): string
  Maximum Length: 15

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

  Maximum Length: 100

  The planning application type. Agencies define the types of planning application that they administer, for example, Residential Addition.
• RecordTypeId(optional): string
  Maximum Length: 30

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

  The renewal date for the license or planning application.
• RowType(optional): string
  Maximum Length: 30

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

  Maximum Length: 150

  The secondary owner of the parcel or property.
• Subclassification(optional): string
  Maximum Length: 10

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

  Maximum Length: 80

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

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

  Maximum Length: 64

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

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

  Maximum Length: 15

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

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

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

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

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

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

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

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

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

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

  Maximum Length: 1000

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

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

  Maximum Length: 64

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

  Identifies the date that the planning application was withdrawn.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top