Jump to

• Request
• Response

Get all workflow communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowCommunicationsWithoutTransients

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 record key.
    Finder Variables:
    • LnpRecordKey; integer; The unique identifier for the record key.
  • findByBRFCriteria: Finds workflow communication data that meets the specified criteria.
    Finder Variables:
    • Caller; string.
    • Criteria; string.
• 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 an expiring license/permit notification is sent.
  • AddressKey; integer; The parcel address key.
  • AgencyId; integer; The identifier of a public-sector agency (typically an alphanumeric ID for a city, county, or state, but it may also be the agency name).
  • AppAcceptDate; string; The accepted date for the permit application.
  • ApplAteDate; string; The date an about-to-expire notification is sent for the permit application.
  • ApplExpirationDate; string; The application expiration date.
  • Applicant; integer; The party ID of the permit applicant.
  • ApplicantAddress1; string; Address line 1 for the permit applicant.
  • ApplicantAddress2; string; Address line 2 for the permit applicant.
  • ApplicantBizProfileId; integer; The business profile used by the applicant.
  • ApplicantCity; string; The city in the permit applicant address.
  • ApplicantCountry; string; The country in the permit applicant address.
  • ApplicantCounty; string; The county in the permit applicant address.
  • ApplicantEmailAddress1; string; The permit applicant???s primary email address.
  • ApplicantEmailAddress2; string; The permit applicant???s secondary email address.
  • ApplicantPersonName; string; The permit applicant name.
  • ApplicantPhoneAreaCode; string; The area code for the permit applicant???s phone number.
  • ApplicantPhoneCountryCode; string; The country code for the permit applicant???s phone number.
  • ApplicantPhoneExtension; string; The phone extension for the permit applicant.
  • ApplicantPhoneNumber; string; The permit applicant phone number.
  • ApplicantPostalCode; string; The postal code in the permit applicant address.
  • ApplicantProfileId; integer; The applicant???s user profile.
  • ApplicantProvince; string; The province in the permit applicant address.
  • ApplicantState; string; The state in the permit applicant address.
  • BalanceDue; number; The total fee balance due for the permit application.
  • CancelledCreatedBy; string; The user ID of the person who canceled the permit application.
  • CancelledCreationDate; string; The cancellation date of the permit application.
  • CancelledReason; string; The reason for canceling the permit application.
  • Classification; string; The record classification (permit, business license, professional license, or planning and zoning).
  • ClassificationMeaning; string; The classification of the permit application type.
  • CreatedBy; string; The user ID of the person who created the permit application.
  • CreationDate; string; The date the permit application was created.
  • CurrencyCode; string; The currency code.
  • DelinquentDate; string; The date the license becomes delinquent.
  • DistrictName; string; The district name where the property is located.
  • ExpirationDate; string; The date the license or permit is no longer valid.
  • ExpirationGraceDate; string; The expiration grace date for the permit application.
  • ExpirationStatus; string; The expiration status of the permit application.
  • FeeDueUpdateDate; string; The identifier that records the date when a due-status fee item is added or updated.
  • GenFloorAreaAddl; number; The additional floor area for construction (square footage of the construction area; used in the Construction Information component of the Permit Designer).
  • GenFloorAreaExist; number; The area of existing floor space in the building (used in the Construction Information component of the Permit Designer).
  • GenFloorAreaTotal; number; The total floor area under construction (used in the Construction Information component of the Permit Designer).
  • GenJobCost; number; The construction job cost (used in the Construction Information component of the Permit Designer).
  • GenNewFloorAreaClass; string; The classification of the new floor area (used in the Construction Information component of the Permit Designer).
  • GenTotalNumStories; number; The total number of stories in the structure under construction (used in the Construction Information component of the Permit Designer).
  • GenTypeConstruction; string; The construction type (used in the Construction Information component of the Permit Designer).
  • GenTypeOfUse; string; The intended use of the construction (used in the Construction Information component of the Permit Designer).
  • GenTypeOfWork; string; The type of construction work (used in the Construction Information component of the Permit Designer).
  • IssueDate; string; The date the license or permit was issued (used in the Application Information component of the Permit Designer).
  • LastAction; string; Indicates the last action performed on the transaction.
  • LastGISSyncDatetime; string; The date and time transaction information was last synchronized to GIS.
  • LastUpdateDate; string; The last updated date of the permit application.
  • LastUpdatedBy; string; The user ID of the person who last updated the permit application.
  • Latitude; number; The property latitude (north/south of the equator).
  • LicenseStatus; string; The overall status of the business license.
  • LnpRecordId; string; The building permit record identifier (for example, Building Permit ID RA-2017-00029).
  • LnpRecordKey; integer; The unique identifier of the record.
  • Longitude; number; The property longitude (east/west of the meridian).
  • OrganizationName; string; The applicant???s business name (for example, a contractor???s business name).
  • Originator; string; The originator of the permit application.
  • Owner; string; The primary (or only) owner of the parcel/property.
  • OwnerEmailId; string; The parcel owner???s email address.
  • OwnerId; integer; The owner ID of the record parcel owner.
  • OwnerKey; integer; The owner key of the record parcel owner.
  • ParcelAddress1; string; Parcel/property address line 1.
  • ParcelAddress2; string; Parcel/property address line 2.
  • ParcelCity; string; The city in the parcel/property address.
  • ParcelCountry; string; The country in the parcel/property address.
  • ParcelCounty; string; The county in the parcel/property address.
  • ParcelId; integer; The identifier of the record parcel.
  • ParcelIdEntered; string; The unique identifier of the parcel retrieved from the map.
  • ParcelKey; integer; The record parcel key.
  • ParcelPostalCode; string; The postal code in the parcel/property address.
  • ParcelProvince; string; The province in the parcel/property address.
  • ParcelState; string; The state in the parcel/property address.
  • ParcelType; string; The current parcel type.
  • Parentclassificationmeaning; string; The classification of the primary application type.
  • Parentfeedueupdate; string; The date the fees due were updated for the primary application.
  • Parentgenjobcost; number; The job cost for the primary application.
  • Parentrecordid; string; The identifier of the primary application.
  • Parentrecordkey; integer; The record ID of the primary application.
  • Parentrecordtype; string; The application type of the primary application.
  • Parentsubclassificationmeaning; string; The subclassification of the primary application type.
  • PermitDescription; string; The description of the permit type.
  • PermitStatus; string; The permit record status.
  • PersonFirstName; string; The applicant???s first name.
  • PersonLastName; string; The applicant???s last name.
  • PersonMiddleName; string; The applicant???s middle name.
  • PersonTitle; string; The contact???s title.
  • PrimaryBalanceDue; number; The balance due for the primary application.
  • PrimaryContactPhonenumber; string; The phone number of the primary contact for the permit application.
  • PrimaryFlag; string; The relationship type indicating the application is a primary application.
  • PrimaryTotalFees; number; The total fees for the primary application.
  • PrimaryTotalOutstanding; number; The total outstanding fee balance for the primary application.
  • PrimaryTotalPaid; number; The total fees paid for the primary application.
  • Primaryapplicationflagmeaning; string; The relationship type indicating the application is a primary application.
  • Primarycontactemail; string; The email address of the primary contact for the permit application.
  • Primarycontactname; string; The primary contact name for the permit application.
  • Primarycontactpartyid; integer; The party ID of the primary contact for the permit application.
  • Primarycontactphoneextension; string; The extension for the primary contact phone number.
  • Primarycontacttype; string; The contact type of the primary contact for the permit application.
  • Primaryissuedate; string; The issue date of the primary application.
  • Primarypermitdescription; string; The description of the primary application.
  • Primarypermitstatus; string; The status of the primary application.
  • Primaryreissuedate; string; The reissue date of the primary application.
  • Primarysystemstatus; string; The system status of the primary application.
  • Primarysystemstatusmeaning; string; The system status of the primary application.
  • ProjectKey; integer; The project name for the permit.
  • PropertyDescription; string; The property description.
  • ReceivedDate; string; The received date for the permit application.
  • RecordStatus; string; The record status.
  • RecordType; string; The permit type (defined by agencies, for example, Residential Addition).
  • RecordTypeId; string; The identifier of the record type.
  • ReissueDate; string; The date the license or permit was reissued (used in the Application Information component of the Permit Designer).
  • RenewalDate; string; The renewal date for the license or permit.
  • RowType; string; The identifier of the record type.
  • SecondaryOwner; string; The secondary owner of the parcel/property.
  • SubapplicationFlag; string; The relationship type indicating the application is a subapplication.
  • Subapplicationflagmeaning; string; The relationship type indicating the application is a subapplication.
  • Subclassification; string; The subclassification code for the permit application type.
  • SubclassificationMeaning; string; The subclassification of the permit application type.
  • SubmitDate; string; The date the permit transaction was submitted (used in the Application Information component of the Permit Designer).
  • SubmittedBy; string; The user ID of the person who submitted the permit application.
  • SystemStastusMeaning; string; The system status description of the permit application.
  • SystemStatus; string; The system status of the permit application.
  • TotalFees; number; The total fees for the permit application.
  • TotalHold; number; The total hold fee amount.
  • TotalOutstanding; number; The total outstanding fee amount.
  • TotalPaid; number; The total fees paid for the permit application.
  • TotalPayable; number; The total payable fees for the permit application.
  • TotalPending; number; The total pending fee amount.
  • TotalWaived; number; The total amount of fees waived.
  • VersionType; string; The version type.
  • VersionTypeDescription; string; The version type description.
  • WfNoOrigFlag; string; Indicates that the transaction type doesn???t include an origination workflow.
  • WithdrawnCreatedBy; string; The user ID of the person who withdrew the permit application.
  • WithdrawnCreatedDate; string; The withdrawal date of the permit application.
  • WithdrawnReason; string; The reason for withdrawing the permit application.
• 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: string
  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: string
  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:
  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.

Body ()

Root Schema : publicSectorWorkflowCommunicationsWithoutTransients

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorWorkflowCommunicationsWithoutTransients-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "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 publicSectorWorkflowCommunicationsWithoutTransients-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorWorkflowCommunicationsWithoutTransients-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 : publicSectorWorkflowCommunicationsWithoutTransients-item-response

Type: object

Show Source

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

  Read Only: true

  The date an expiring license/permit notification is sent.
• AddressKey: integer (int64)
  Read Only: true

  The parcel address key.
• AgencyId: integer (int32)
  Read Only: true

  The identifier of a public-sector agency (typically an alphanumeric ID for a city, county, or state, but it may also be the agency name).
• AppAcceptDate: string (date-time)
  Title: Acceptance Date

  Read Only: true

  The accepted date for the permit application.
• ApplAteDate: string (date-time)
  Title: Application About to Expire Date

  Read Only: true

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

  Read Only: true

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

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

  Read Only: true

  Maximum Length: 240

  Address line 1 for the permit applicant.
• ApplicantAddress2: string
  Title: Applicant Address Line 2

  Read Only: true

  Maximum Length: 240

  Address line 2 for the permit applicant.
• 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 permit applicant address.
• ApplicantCountry: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 320

  The permit applicant???s primary email address.
• ApplicantEmailAddress2: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The permit applicant???s secondary email address.
• ApplicantPersonName: string
  Title: Applicant Full Name

  Read Only: true

  Maximum Length: 450

  The permit applicant name.
• ApplicantPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The area code for the permit applicant???s phone number.
• ApplicantPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The country code for the permit applicant???s phone number.
• ApplicantPhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The phone extension for the permit applicant.
• ApplicantPhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 60

  The postal code in the permit applicant address.
• ApplicantProfileId: integer (int64)
  Read Only: true

  The applicant???s user profile.
• ApplicantProvince: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the permit applicant address.
• ApplicantState: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The state in the permit applicant address.
• BalanceDue: number
  Title: Fees Balance Due

  Read Only: true

  The total fee balance due for the permit application.
• CancelledCreatedBy: string
  Title: Canceled by User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the person who canceled the permit application.
• CancelledCreationDate: string (date-time)
  Title: Cancellation Date

  Read Only: true

  The cancellation date of the permit application.
• CancelledReason: string
  Title: Cancellation Reason

  Read Only: true

  Maximum Length: 1000

  The reason for canceling the permit application.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The record classification (permit, business license, professional license, or planning and zoning).
• ClassificationMeaning: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date the permit application was created.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 3

  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 district name where the property is located.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 15

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

  Read Only: true

  The identifier that records the date when a due-status fee item is added or updated.
• GenFloorAreaAddl: number
  Title: Additional Floor Area

  Read Only: true

  The additional floor area for construction (square footage of the construction area; used in the Construction Information component of the Permit Designer).
• GenFloorAreaExist: number
  Title: Existing Floor Area

  Read Only: true

  The area of existing floor space in the building (used in the Construction Information component of the Permit Designer).
• GenFloorAreaTotal: number
  Title: Total Floor Area

  Read Only: true

  The total floor area under construction (used in the Construction Information component of the Permit Designer).
• GenJobCost: number
  Title: Job Cost

  Read Only: true

  The construction job cost (used in the Construction Information component of the Permit Designer).
• GenNewFloorAreaClass: string
  Title: New Floor Area Classification

  Read Only: true

  Maximum Length: 50

  The classification of the new floor area (used in the Construction Information component of the Permit Designer).
• GenTotalNumStories: number
  Title: Total Number of Stories

  Read Only: true

  The total number of stories in the structure under construction (used in the Construction Information component of the Permit Designer).
• GenTypeConstruction: string
  Title: Type of Construction

  Read Only: true

  Maximum Length: 100

  The construction type (used in the Construction Information component of the Permit Designer).
• GenTypeOfUse: string
  Title: Type of Use

  Read Only: true

  Maximum Length: 100

  The intended use of the construction (used in the Construction Information component of the Permit Designer).
• GenTypeOfWork: string
  Title: Type of Work

  Read Only: true

  Maximum Length: 100

  The type of construction work (used in the Construction Information component of the Permit Designer).
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date the license or permit was issued (used in the Application Information component of the Permit Designer).
• LastAction: string
  Title: Last Action Taken

  Read Only: true

  Maximum Length: 30

  Indicates the last action performed on the transaction.
• LastGISSyncDatetime: string (date-time)
  Title: GIS Last Synced

  Read Only: true

  The date and time transaction information was last synchronized to GIS.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last updated date of the permit application.
• LastUpdatedBy: string
  Title: Last Updated by User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the person who last updated the permit application.
• Latitude: number
  Title: Latitude

  Read Only: true

  The property latitude (north/south of the equator).
• LicenseStatus: string
  Title: Permit Status

  Read Only: true

  Maximum Length: 30

  The overall status of the business license.
• 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 building permit record identifier (for example, Building Permit ID RA-2017-00029).
• LnpRecordKey: integer
  Read Only: true

  The unique identifier of the record.
• Longitude: number
  Title: Longitude

  Read Only: true

  The property longitude (east/west of the meridian).
• OrganizationName: string
  Title: Business Name

  Read Only: true

  Maximum Length: 360

  The applicant???s business name (for example, a contractor???s business name).
• Originator: string
  Title: Originator

  Read Only: true

  Maximum Length: 3

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 50

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

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

  The owner key of the record parcel owner.
• ParcelAddress1: string
  Title: Property Address Line 1

  Read Only: true

  Maximum Length: 240

  Parcel/property address line 1.
• ParcelAddress2: string
  Title: Property Address Line 2

  Read Only: true

  Maximum Length: 240

  Parcel/property address line 2.
• ParcelCity: string
  Title: Property City

  Read Only: true

  Maximum Length: 60

  The city in the parcel/property address.
• ParcelCountry: string
  Title: Property Country

  Read Only: true

  Maximum Length: 60

  The country in the parcel/property address.
• ParcelCounty: string
  Title: Property County

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  The identifier of the record parcel.
• ParcelIdEntered: string
  Title: Parcel Number

  Read Only: true

  Maximum Length: 50

  The unique identifier of the parcel retrieved from the map.
• ParcelKey: integer (int64)
  Read Only: true

  The record parcel key.
• ParcelPostalCode: string
  Title: Property Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the parcel/property address.
• ParcelProvince: string
  Title: Property Province

  Read Only: true

  Maximum Length: 60

  The province in the parcel/property address.
• ParcelState: string
  Title: Property State

  Read Only: true

  Maximum Length: 60

  The state in the parcel/property address.
• ParcelType: string
  Title: Parcel Type

  Read Only: true

  Maximum Length: 30

  The current parcel type.
• Parentclassificationmeaning: string
  Title: Primary Application Classification

  Read Only: true

  Maximum Length: 80

  The classification of the primary application type.
• Parentfeedueupdate: string (date-time)
  Title: Primary Application Fees Due Updated Date

  Read Only: true

  The date the fees due were updated for the primary application.
• Parentgenjobcost: number
  Title: Primary Application Job Cost

  Read Only: true

  The job cost for the primary application.
• Parentrecordid: string
  Title: Primary Application ID

  Read Only: true

  Maximum Length: 50

  The identifier of the primary application.
• Parentrecordkey: integer (int64)
  Read Only: true

  The record ID of the primary application.
• Parentrecordtype: string
  Title: Primary Application Type

  Read Only: true

  Maximum Length: 100

  The application type of the primary application.
• Parentsubclassificationmeaning: string
  Title: Primary Application Subclassification

  Read Only: true

  Maximum Length: 80

  The subclassification of the primary application type.
• PermitDescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 300

  The description of the permit type.
• PermitStatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 100

  The permit record status.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 60

  The contact???s title.
• Primaryapplicationflagmeaning: string
  Title: Primary Application Relationship Type

  Read Only: true

  Maximum Length: 80

  The relationship type indicating the application is a primary application.
• PrimaryBalanceDue: number
  Title: Primary Application Fees Balance Due

  Read Only: true

  The balance due for the primary application.
• Primarycontactemail: string
  Read Only: true

  Maximum Length: 320

  The email address of the primary contact for the permit application.
• Primarycontactname: string
  Read Only: true

  Maximum Length: 450

  The primary contact name for the permit application.
• Primarycontactpartyid: integer (int64)
  Read Only: true

  The party ID of the primary contact for the permit application.
• Primarycontactphoneextension: string
  Read Only: true

  Maximum Length: 20

  The extension for the primary contact phone number.
• PrimaryContactPhonenumber: string
  Read Only: true

  Maximum Length: 80

  The phone number of the primary contact for the permit application.
• Primarycontacttype: string
  Read Only: true

  Maximum Length: 30

  The contact type of the primary contact for the permit application.
• PrimaryFlag: string
  Read Only: true

  Maximum Length: 1

  The relationship type indicating the application is a primary application.
• Primaryissuedate: string (date-time)
  Title: Primary Application Issue Date

  Read Only: true

  The issue date of the primary application.
• Primarypermitdescription: string
  Title: Primary Application Description

  Read Only: true

  Maximum Length: 1000

  The description of the primary application.
• Primarypermitstatus: string
  Title: Primary Application Status

  Read Only: true

  Maximum Length: 15

  The status of the primary application.
• Primaryreissuedate: string (date-time)
  Title: Primary Application Reissue Date

  Read Only: true

  The reissue date of the primary application.
• Primarysystemstatus: string
  Read Only: true

  Maximum Length: 15

  The system status of the primary application.
• Primarysystemstatusmeaning: string
  Title: Primary Application System Status

  Read Only: true

  Maximum Length: 80

  The system status of the primary application.
• PrimaryTotalFees: number
  Title: Primary Application Total Fees

  Read Only: true

  The total fees for the primary application.
• PrimaryTotalOutstanding: number
  Title: Primary Application Outstanding Balance

  Read Only: true

  The total outstanding fee balance for the primary application.
• PrimaryTotalPaid: number
  Title: Primary Application Total Fees Paid

  Read Only: true

  The total fees paid for the primary application.
• ProjectKey: integer (int64)
  Read Only: true

  The project name for the permit.
• PropertyDescription: string
  Title: Property Description

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  The received date for the permit application.
• RecordStatus: string
  Read Only: true

  Maximum Length: 15

  The record status.
• RecordType: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The permit type (defined by agencies, for example, Residential Addition).
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The identifier of the record type.
• ReissueDate: string (date-time)
  Title: Reissue Date

  Read Only: true

  The date the license or permit was reissued (used in the Application Information component of the Permit Designer).
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

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

  Maximum Length: 30

  The identifier of the record type.
• SecondaryOwner: string
  Title: Property Secondary Owner

  Read Only: true

  Maximum Length: 150

  The secondary owner of the parcel/property.
• SubapplicationFlag: string
  Read Only: true

  Maximum Length: 1

  The relationship type indicating the application is a subapplication.
• Subapplicationflagmeaning: string
  Title: Subapplication Relationship Type

  Read Only: true

  Maximum Length: 80

  The relationship type indicating the application is a subapplication.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The subclassification code for the permit application type.
• SubclassificationMeaning: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  The date the permit transaction was submitted (used in the Application Information component of the Permit Designer).
• SubmittedBy: string
  Title: Submitted by User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the person who submitted the permit application.
• SystemStastusMeaning: string
  Title: Application System Status

  Read Only: true

  Maximum Length: 80

  The system status description of the permit application.
• SystemStatus: string
  Title: Permit System Status Code

  Read Only: true

  Maximum Length: 15

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  The total amount of fees waived.
• VersionType: string
  Title: Version Type

  Read Only: true

  Maximum Length: 1

  The version type.
• VersionTypeDescription: string
  Title: Version Type Description

  Read Only: true

  Maximum Length: 80

  The version type description.
• WfNoOrigFlag: string
  Title: No Application Workflow

  Read Only: true

  Maximum Length: 1

  Indicates that the transaction type doesn???t include an origination workflow.
• WithdrawnCreatedBy: string
  Title: Withdrawn by User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the person who withdrew the permit application.
• WithdrawnCreatedDate: string (date-time)
  Title: Withdrawal Date

  Read Only: true

  The withdrawal date of the permit application.
• WithdrawnReason: string
  Title: Withdrawal Reason

  Read Only: true

  Maximum Length: 1000

  The reason for withdrawing the permit application.

{
    "type":"object",
    "properties":{
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"The date an expiring license/permit notification is sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":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
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier of a public-sector agency (typically an alphanumeric ID for a city, county, or state, but it may also be the agency name).",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AppAcceptDate":{
            "title":"Acceptance Date",
            "type":"string",
            "description":"The accepted date for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplAteDate":{
            "title":"Application About to Expire Date",
            "type":"string",
            "description":"The date an about-to-expire notification is sent for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplExpirationDate":{
            "title":"Application Expiration Date",
            "type":"string",
            "description":"The application expiration date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the permit applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicantAddress1":{
            "title":"Applicant Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Address line 1 for the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantAddress2":{
            "title":"Applicant Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Address line 2 for the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"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
        },
        "ApplicantCity":{
            "title":"Applicant City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantCountry":{
            "title":"Applicant Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantCounty":{
            "title":"Applicant County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":320,
            "type":"string",
            "description":"The permit applicant???s primary email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress2":{
            "title":"Applicant Email 2",
            "maxLength":320,
            "type":"string",
            "description":"The permit applicant???s secondary email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPersonName":{
            "title":"Applicant Full Name",
            "maxLength":450,
            "type":"string",
            "description":"The permit applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code for the permit applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code for the permit applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The phone extension for the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":80,
            "type":"string",
            "description":"The permit applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Reecipient":"Y",
                "Phone":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The applicant???s user profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicantProvince":{
            "title":"Applicant Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantState":{
            "title":"Applicant State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The total fee balance due for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y",
                "AmountDispProp":"Y"
            },
            "x-queryable":true
        },
        "CancelledCreatedBy":{
            "title":"Canceled by User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the person who canceled the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CancelledCreationDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"The cancellation date of the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledReason":{
            "title":"Cancellation Reason",
            "maxLength":1000,
            "type":"string",
            "description":"The reason for canceling the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The record classification (permit, business license, professional license, or planning and zoning).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationMeaning":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"The classification of the permit application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created by User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the person who created the permit application.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the permit application was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "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
        },
        "DistrictName":{
            "maxLength":50,
            "type":"string",
            "description":"The district name where the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Grace Period Date",
            "type":"string",
            "description":"The expiration grace date for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationStatus":{
            "title":"Expiration Status",
            "maxLength":15,
            "type":"string",
            "description":"The expiration status of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeDueUpdateDate":{
            "title":"Fees Due Updated Date",
            "type":"string",
            "description":"The identifier that records the date when a due-status fee item is added or updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenFloorAreaAddl":{
            "title":"Additional Floor Area",
            "type":"number",
            "description":"The additional floor area for construction (square footage of the construction area; used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenFloorAreaExist":{
            "title":"Existing Floor Area",
            "type":"number",
            "description":"The area of existing floor space in the building (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenFloorAreaTotal":{
            "title":"Total Floor Area",
            "type":"number",
            "description":"The total floor area under construction (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenJobCost":{
            "title":"Job Cost",
            "type":"number",
            "description":"The construction job cost (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenNewFloorAreaClass":{
            "title":"New Floor Area Classification",
            "maxLength":50,
            "type":"string",
            "description":"The classification of the new floor area (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenTotalNumStories":{
            "title":"Total Number of Stories",
            "type":"number",
            "description":"The total number of stories in the structure under construction (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenTypeConstruction":{
            "title":"Type of Construction",
            "maxLength":100,
            "type":"string",
            "description":"The construction type (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenTypeOfUse":{
            "title":"Type of Use",
            "maxLength":100,
            "type":"string",
            "description":"The intended use of the construction (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenTypeOfWork":{
            "title":"Type of Work",
            "maxLength":100,
            "type":"string",
            "description":"The type of construction work (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date the license or permit was issued (used in the Application Information component of the Permit Designer).",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastAction":{
            "title":"Last Action Taken",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the last action performed on the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastGISSyncDatetime":{
            "title":"GIS Last Synced",
            "type":"string",
            "description":"The date and time transaction information was last synchronized to GIS.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last updated date of the permit application.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated by User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the person who last updated the permit application.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The property latitude (north/south of the equator).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseStatus":{
            "title":"Permit Status",
            "maxLength":30,
            "type":"string",
            "description":"The overall status of the business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":50,
            "type":"string",
            "description":"The building permit record identifier (for example, Building Permit ID RA-2017-00029).",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:Condition:ObjectType":"LNP",
                "brf:Condition:ObjectSubType":"NA"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1"
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The property longitude (east/west of the meridian).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Business Name",
            "maxLength":360,
            "type":"string",
            "description":"The applicant???s business name (for example, a contractor???s business name).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Originator":{
            "title":"Originator",
            "maxLength":3,
            "type":"string",
            "description":"The originator of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Property Owner Name",
            "maxLength":150,
            "type":"string",
            "description":"The primary (or only) owner of the parcel/property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerEmailId":{
            "title":"Property Owner Email",
            "maxLength":50,
            "type":"string",
            "description":"The parcel owner???s email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"The owner ID of the record parcel owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OwnerKey":{
            "type":"integer",
            "description":"The owner key of the record parcel owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelAddress1":{
            "title":"Property Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Parcel/property address line 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddress2":{
            "title":"Property Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Parcel/property address line 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCity":{
            "title":"Property City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel/property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCountry":{
            "title":"Property Country",
            "maxLength":60,
            "type":"string",
            "description":"The country in the parcel/property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCounty":{
            "title":"Property County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel/property address.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the parcel retrieved from the map.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelKey":{
            "type":"integer",
            "description":"The record parcel key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelPostalCode":{
            "title":"Property Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel/property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelProvince":{
            "title":"Property Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel/property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelState":{
            "title":"Property State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel/property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelType":{
            "title":"Parcel Type",
            "maxLength":30,
            "type":"string",
            "description":"The current parcel type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parentclassificationmeaning":{
            "title":"Primary Application Classification",
            "maxLength":80,
            "type":"string",
            "description":"The classification of the primary application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parentfeedueupdate":{
            "title":"Primary Application Fees Due Updated Date",
            "type":"string",
            "description":"The date the fees due were updated for the primary application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parentgenjobcost":{
            "title":"Primary Application Job Cost",
            "type":"number",
            "description":"The job cost for the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parentrecordid":{
            "title":"Primary Application ID",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parentrecordkey":{
            "type":"integer",
            "description":"The record ID of the primary application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Parentrecordtype":{
            "title":"Primary Application Type",
            "maxLength":100,
            "type":"string",
            "description":"The application type of the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Parentsubclassificationmeaning":{
            "title":"Primary Application Subclassification",
            "maxLength":80,
            "type":"string",
            "description":"The subclassification of the primary application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitDescription":{
            "title":"Application Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of the permit type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PermitStatus":{
            "title":"Application Status",
            "maxLength":100,
            "type":"string",
            "description":"The permit record status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"Applicant First Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant???s first name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant???s last name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Applicant Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The applicant???s middle name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Applicant Title",
            "maxLength":60,
            "type":"string",
            "description":"The contact???s title.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PrimaryBalanceDue":{
            "title":"Primary Application Fees Balance Due",
            "type":"number",
            "description":"The balance due for the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "PrimaryContactPhonenumber":{
            "maxLength":80,
            "type":"string",
            "description":"The phone number of the primary contact for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The relationship type indicating the application is a primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryTotalFees":{
            "title":"Primary Application Total Fees",
            "type":"number",
            "description":"The total fees for the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "PrimaryTotalOutstanding":{
            "title":"Primary Application Outstanding Balance",
            "type":"number",
            "description":"The total outstanding fee balance for the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "PrimaryTotalPaid":{
            "title":"Primary Application Total Fees Paid",
            "type":"number",
            "description":"The total fees paid for the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "Primaryapplicationflagmeaning":{
            "title":"Primary Application Relationship Type",
            "maxLength":80,
            "type":"string",
            "description":"The relationship type indicating the application is a primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarycontactemail":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the primary contact for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Primarycontactname":{
            "maxLength":450,
            "type":"string",
            "description":"The primary contact name for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarycontactpartyid":{
            "type":"integer",
            "description":"The party ID of the primary contact for the permit application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "precision":18,
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Primarycontactphoneextension":{
            "maxLength":20,
            "type":"string",
            "description":"The extension for the primary contact phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarycontacttype":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type of the primary contact for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primaryissuedate":{
            "title":"Primary Application Issue Date",
            "type":"string",
            "description":"The issue date of the primary application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarypermitdescription":{
            "title":"Primary Application Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Primarypermitstatus":{
            "title":"Primary Application Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primaryreissuedate":{
            "title":"Primary Application Reissue Date",
            "type":"string",
            "description":"The reissue date of the primary application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarysystemstatus":{
            "maxLength":15,
            "type":"string",
            "description":"The system status of the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarysystemstatusmeaning":{
            "title":"Primary Application System Status",
            "maxLength":80,
            "type":"string",
            "description":"The system status of the primary application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectKey":{
            "type":"integer",
            "description":"The project name for the permit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"The received date for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The record status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":100,
            "type":"string",
            "description":"The permit type (defined by agencies, for example, Residential Addition).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReissueDate":{
            "title":"Reissue Date",
            "type":"string",
            "description":"The date the license or permit was reissued (used in the Application Information component of the Permit Designer).",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"The renewal date for the license or permit.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RowType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryOwner":{
            "title":"Property Secondary Owner",
            "maxLength":150,
            "type":"string",
            "description":"The secondary owner of the parcel/property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubapplicationFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The relationship type indicating the application is a subapplication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subapplicationflagmeaning":{
            "title":"Subapplication Relationship Type",
            "maxLength":80,
            "type":"string",
            "description":"The relationship type indicating the application is a subapplication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subclassification":{
            "maxLength":10,
            "type":"string",
            "description":"The subclassification code for the permit application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubclassificationMeaning":{
            "title":"Subclassification",
            "maxLength":80,
            "type":"string",
            "description":"The subclassification of the permit application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the permit transaction was submitted (used in the Application Information component of the Permit Designer).",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted by User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the person who submitted the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SystemStastusMeaning":{
            "title":"Application System Status",
            "maxLength":80,
            "type":"string",
            "description":"The system status description of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"Permit System Status Code",
            "maxLength":15,
            "type":"string",
            "description":"The system status of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Fees Total Amount",
            "type":"number",
            "description":"The total fees for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalHold":{
            "title":"Fees on Hold",
            "type":"number",
            "description":"The total hold fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalOutstanding":{
            "title":"Fees Outstanding Balance",
            "type":"number",
            "description":"The total outstanding fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Fees Total Paid",
            "type":"number",
            "description":"The total fees paid for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y",
                "AmountDispProp":"Y"
            },
            "x-queryable":true
        },
        "TotalPayable":{
            "title":"Fees Total Payable",
            "type":"number",
            "description":"The total payable fees for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y",
                "AmountDispProp":"Y"
            },
            "x-queryable":true
        },
        "TotalPending":{
            "title":"Fees in Pending Status",
            "type":"number",
            "description":"The total pending fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalWaived":{
            "title":"Fees Waived",
            "type":"number",
            "description":"The total amount of fees waived.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "VersionType":{
            "title":"Version Type",
            "maxLength":1,
            "type":"string",
            "description":"The version type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionTypeDescription":{
            "title":"Version Type Description",
            "maxLength":80,
            "type":"string",
            "description":"The version type description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WfNoOrigFlag":{
            "title":"No Application Workflow",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the transaction type doesn???t include an origination workflow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnCreatedBy":{
            "title":"Withdrawn by User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the person who withdrew the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "WithdrawnCreatedDate":{
            "title":"Withdrawal Date",
            "type":"string",
            "description":"The withdrawal date of the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnReason":{
            "title":"Withdrawal Reason",
            "maxLength":1000,
            "type":"string",
            "description":"The reason for withdrawing the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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