Get all workflow communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowCommunications
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 satisfies the criteria provided.
Finder Variables:- Caller; string; The application making the call. It should always be BRF.
- Criteria; string; The criteria for the rows. This should be formatted with semicolons before and after the field names. For example (;ApplicantCountry; = 'US') AND (;RecordType; = 'Permit1001').
- PrimaryKey: Finds workflow communication data with the specified record key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AboutToExpireDate; string; The date when the notification about an expiring license or permit is sent.
- AddressKey; integer; The parcel address key.
- AgencyId; integer; The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
- AppAcceptDate; string; Identifies the accepted date for the permit application.
- ApplAteDate; string; Identifies the date on which an about-to-expire notification is sent for the permit application.
- ApplExpirationDate; string; The date the application expires.
- Applicant; integer; The party ID of the permit applicant.
- ApplicantAddress1; string; The first line of the permit applicant address.
- ApplicantAddress2; string; The second line of the permit applicant address.
- 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 first email address of the permit applicant.
- ApplicantEmailAddress2; string; The second email address of the permit applicant.
- ApplicantPersonName; string; The permit applicant name.
- ApplicantPhoneAreaCode; string; The area code in the phone number of the permit applicant.
- ApplicantPhoneCountryCode; string; The country code in the phone number of the permit applicant.
- ApplicantPhoneExtension; string; The phone number 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 user profile of the applicant.
- ApplicantProvince; string; The province in the permit applicant address.
- ApplicantState; string; The state in the permit applicant address.
- ApplicantUserId; string; The user ID of the permit applicant.
- BalanceDue; number; The total fees balance due for the permit application.
- CancelledByName; string; Identifies the user name of the person who canceled the permit application.
- CancelledCreatedBy; string; Identifies the user ID of the person who canceled the permit application.
- CancelledCreationDate; string; Identifies the cancelation date of the permit application.
- CancelledReason; string; Identifies the reason for the cancelation of the permit application.
- Classification; string; The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
- ClassificationMeaning; string; Identifies the classification of the permit application type.
- CreatedBy; string; Identifies the user ID of the person who created the permit application.
- CreatedByName; string; Identifies the user name of the person who created the permit application.
- CreationDate; string; Identifies the date on which the permit application was created.
- CurrencyCode; string; Identifies the currency code.
- DelinquentDate; string; The date the license becomes delinquent.
- DistrictName; string; The name of the district in which the property is located.
- ExpirationDate; string; The date the license or permit is no longer valid.
- ExpirationGraceDate; string; Identifies the expiration grace date for the permit application.
- ExpirationStatus; string; Identifies the expiration status of the permit application.
- FeeDueUpdateDate; string; Identifier that captures the date when fee item with due status is added or updated.
- GenFloorAreaAddl; number; The additional floor area for construction. The floor area refers to the square footage of the construction area. Used in the construction information component of the Permit Designer.
- GenFloorAreaExist; number; The area of the existing floor 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 cost of the construction job. 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 of the structure under construction. Used in the construction information component of the Permit Designer.
- GenTypeConstruction; string; The type of construction. 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.
- LastUpdateDate; string; Identifies the last updated date of the permit application.
- LastUpdatedBy; string; Identifies the user ID of the person who last updated the permit application.
- LastUpdatedByName; string; Identifies the user name of the person who last updated the permit application.
- Latitude; number; The geographic location of the parcel that is to the North or South of the equator.
- LicenseStatus; string; The overall status of the business license.
- LnpRecordId; string; The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.
- LnpRecordKey; integer; The unique identifier for the record.
- Longitude; number; The geographic location of the parcel that is to the East or West of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
- OrganizationName; string; The business name of the applicant. For example, a contractor enters his or her contracting business name.
- Originator; string; Identifies the originator of the permit application.
- Owner; string; The primary or only owner of the parcel or property.
- OwnerEmailId; string; The parcel owner email address.
- OwnerId; integer; The owner ID of the record parcel owner.
- OwnerKey; integer; The owner key of the record parcel owner.
- ParcelAddress1; string; The first line of the parcel or property address.
- ParcelAddress2; string; The second line of the parcel or property address.
- ParcelCity; string; The city in the parcel or property address.
- ParcelCountry; string; The country in the parcel or property address.
- ParcelCounty; string; The county in the parcel or property address.
- ParcelId; integer; The identifier of the record parcel.
- ParcelKey; integer; The key of the record parcel.
- ParcelPostalCode; string; The postal code in the parcel or property address.
- ParcelProvince; string; The province in the parcel or property address.
- ParcelState; string; The state in the parcel or property address.
- ParcelType; string; The type of the current parcel.
- Parentclassificationmeaning; string; The application type classification of the primary application.
- Parentfeedueupdate; string; The date on which the fees due was 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 application type subclassification of the primary application.
- PermitDescription; string; The description of the permit type.
- PermitStatus; string; The status of the permit record.
- PersonFirstName; string; The applicant first name.
- PersonLastName; string; The applicant last name.
- PersonMiddleName; string; The applicant middle name.
- PersonTitle; string; The title of the contact.
- PrimaryBalanceDue; number; The balance due for the primary application.
- PrimaryContactPhonenumber; string; Identifies the phone number of the primary contact of the permit application.
- PrimaryContatUserId; string; Identifies the user ID of the primary contact.
- PrimaryFlag; string; The application's relationship type as 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 of the primary application.
- Primaryapplicationflagmeaning; string; The application's relationship type as primary application.
- Primarycontactemail; string; Identifies the email of the primary contact of the permit application.
- Primarycontactname; string; Identifies the primary contact name of the permit application.
- Primarycontactpartyid; integer; Identifies the party ID of the primary contact of the permit application.
- Primarycontactphoneextension; string; The contact phone number extension for the primary contact.
- Primarycontacttype; string; Identifies the contact type of the primary contact of 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 information for a permit.
- PropertyDescription; string; The property description.
- ReceivedDate; string; Identifies the received date for the permit application.
- RecordStatus; string; The status of the record.
- RecordType; string; The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.
- RecordTypeId; string; The identifier for a 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 for a record type.
- SecondaryOwner; string; The secondary owner of the parcel or property.
- SubapplicationFlag; string; The application's relationship type as subapplication.
- Subapplicationflagmeaning; string; The application's relationship type as subapplication.
- Subclassification; string; The subclassification code of the permit application type.
- SubclassificationMeaning; string; Identifies the subclassification of the permit application type.
- SubmitDate; string; The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer.
- SubmittedBy; string; Identifies the user ID of the person who submitted the permit application.
- SubmittedByName; string; Identifies the user name of the person who submitted the permit application.
- SystemStastusMeaning; string; The system status description of the permit application.
- SystemStatus; string; Identifies the system status of the permit application.
- TotalFees; number; The total fees for the permit application.
- TotalHold; number; Identifies the total hold fee amount.
- TotalOutstanding; number; Identifies the total outstanding fee amount.
- TotalPaid; number; The total fees paid for the permit application.
- TotalPayable; number; The total fees payable for the permit application.
- TotalPending; number; Identifies the total pending fee amount.
- TotalWaived; number; Identifies the total fee waived.
- Url; string; The URL label for the permit application.
- UrlLabel; string; The URL for the permit application.
- VersionType; string; Indicates the version type.
- WfNoOrigFlag; string; Indicates that the transaction type does not contain an origination workflow.
- WithDrawnByName; string; Identifies the user name of the person who withdrew the permit application.
- WithdrawnCreatedBy; string; Identifies the user ID of the person who withdrew the permit application.
- WithdrawnCreatedDate; string; Identifies the withdrawal date of the permit application.
- WithdrawnReason; string; Identifies the reason for the withdrawal of 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:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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.
Root Schema : publicSectorWorkflowCommunications
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorWorkflowCommunications-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Title:
About to Expire Date
Read Only:true
The date when the notification about an expiring license or permit is sent. -
AddressKey: integer
(int64)
Read Only:
true
The parcel address key. -
AgencyId: integer
(int32)
Read Only:
true
The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
AppAcceptDate: string
(date-time)
Title:
Acceptance Date
Read Only:true
Identifies the accepted date for the permit application. -
ApplAteDate: string
(date-time)
Title:
Application About to Expire Date
Read Only:true
Identifies the date on which an about-to-expire notification is sent for the permit application. -
ApplExpirationDate: string
(date-time)
Title:
Application Expiration Date
Read Only:true
The date the application expires. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the permit applicant. -
ApplicantAddress1: string
Title:
Applicant Address Line 1
Read Only:true
Maximum Length:240
The first line of the permit applicant address. -
ApplicantAddress2: string
Title:
Applicant Address Line 2
Read Only:true
Maximum Length:240
The second line of the permit applicant address. -
ApplicantBizProfileId: integer
(int64)
Read Only:
true
The business profile used by the applicant. -
ApplicantCity: string
Title:
Applicant City
Read Only:true
Maximum Length:60
The city in the 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 first email address of the permit applicant. -
ApplicantEmailAddress2: string
Title:
Applicant Email 2
Read Only:true
Maximum Length:320
The second email address of the permit applicant. -
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 in the phone number of the permit applicant. -
ApplicantPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The country code in the phone number of the permit applicant. -
ApplicantPhoneExtension: string
Title:
Applicant Phone Extension
Read Only:true
Maximum Length:20
The phone number 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 user profile of the applicant. -
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. -
ApplicantUserId: string
Title:
Applicant User ID
Read Only:true
Maximum Length:20
The user ID of the permit applicant. -
BalanceDue: number
Title:
Fees Balance Due
Read Only:true
The total fees balance due for the permit application. -
CancelledByName: string
Title:
Canceled by Name
Read Only:true
Identifies the user name of the person who canceled the permit application. -
CancelledCreatedBy: string
Title:
Canceled by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who canceled the permit application. -
CancelledCreationDate: string
(date-time)
Title:
Cancellation Date
Read Only:true
Identifies the cancelation date of the permit application. -
CancelledReason: string
Title:
Cancellation Reason
Read Only:true
Maximum Length:1000
Identifies the reason for the cancelation of the permit application. -
Classification: string
Read Only:
true
Maximum Length:3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
ClassificationMeaning: string
Title:
Classification
Read Only:true
Maximum Length:80
Identifies the classification of the permit application type. -
CreatedBy: string
Title:
Created by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who created the permit application. -
CreatedByName: string
Title:
Created by Name
Read Only:true
Identifies the user name of the person who created the permit application. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Identifies the date on which the permit application was created. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:3
Identifies the currency code. -
DelinquentDate: string
(date-time)
Read Only:
true
The date the license becomes delinquent. -
DistrictName: string
Read Only:
true
Maximum Length:50
The name of the district in which the property is located. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Read Only:true
The date the license or permit is no longer valid. -
ExpirationGraceDate: string
(date-time)
Title:
Grace Period Date
Read Only:true
Identifies the expiration grace date for the permit application. -
ExpirationStatus: string
Title:
Expiration Status
Read Only:true
Maximum Length:15
Identifies the expiration status of the permit application. -
FeeDueUpdateDate: string
(date-time)
Title:
Fees Due Updated Date
Read Only:true
Identifier that captures the date when fee item with due status is added or updated. -
GenFloorAreaAddl: number
Title:
Additional Floor Area
Read Only:true
The additional floor area for construction. The floor area refers to the 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 the existing floor 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 cost of the construction job. 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 of 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 type of construction. 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. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Identifies the last updated date of the permit application. -
LastUpdatedBy: string
Title:
Last Updated by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who last updated the permit application. -
LastUpdatedByName: string
Title:
Last Updated by Name
Read Only:true
Identifies the user name of the person who last updated the permit application. -
Latitude: number
Read Only:
true
The geographic location of the parcel that is to the North or 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:
Permit ID
Read Only:true
Maximum Length:50
The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey: integer
Read Only:
true
The unique identifier for the record. -
Longitude: number
Read Only:
true
The geographic location of the parcel that is to the East or West of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
OrganizationName: string
Title:
Business Name
Read Only:true
Maximum Length:360
The business name of the applicant. For example, a contractor enters his or her contracting business name. -
Originator: string
Title:
Originator
Read Only:true
Maximum Length:3
Identifies the originator of the permit application. -
Owner: string
Title:
Property Owner Name
Read Only:true
Maximum Length:150
The primary or only owner of the parcel or property. -
OwnerEmailId: string
Title:
Property Owner Email
Read Only:true
Maximum Length:50
The parcel owner 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
The first line of the parcel or property address. -
ParcelAddress2: string
Title:
Property Address Line 2
Read Only:true
Maximum Length:240
The second line of the parcel or property address. -
ParcelCity: string
Title:
Property City
Read Only:true
Maximum Length:60
The city in the parcel or property address. -
ParcelCountry: string
Title:
Property Country
Read Only:true
Maximum Length:60
The country in the parcel or property address. -
ParcelCounty: string
Title:
Property County
Read Only:true
Maximum Length:60
The county in the parcel or property address. -
ParcelId: integer
(int64)
Title:
Parcel
Read Only:true
The identifier of the record parcel. -
ParcelKey: integer
(int64)
Read Only:
true
The key of the record parcel. -
ParcelPostalCode: string
Title:
Property Postal Code
Read Only:true
Maximum Length:60
The postal code in the parcel or property address. -
ParcelProvince: string
Title:
Property Province
Read Only:true
Maximum Length:60
The province in the parcel or property address. -
ParcelState: string
Title:
Property State
Read Only:true
Maximum Length:60
The state in the parcel or property address. -
ParcelType: string
Title:
Parcel Type
Read Only:true
Maximum Length:30
The type of the current parcel. -
Parentclassificationmeaning: string
Title:
Primary Application Classification
Read Only:true
Maximum Length:80
The application type classification of the primary application. -
Parentfeedueupdate: string
(date-time)
Title:
Primary Application Fees Due Updated Date
Read Only:true
The date on which the fees due was 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 application type subclassification of the primary application. -
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 status of the permit record. -
PersonFirstName: string
Title:
Applicant First Name
Read Only:true
Maximum Length:150
The applicant first name. -
PersonLastName: string
Title:
Applicant Last Name
Read Only:true
Maximum Length:150
The applicant last name. -
PersonMiddleName: string
Title:
Applicant Middle Name
Read Only:true
Maximum Length:60
The applicant middle name. -
PersonTitle: string
Title:
Applicant Title
Read Only:true
Maximum Length:60
The title of the contact. -
Primaryapplicationflagmeaning: string
Title:
Primary Application Relationship Type
Read Only:true
Maximum Length:80
The application's relationship type as 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
Identifies the email of the primary contact of the permit application. -
Primarycontactname: string
Read Only:
true
Maximum Length:450
Identifies the primary contact name of the permit application. -
Primarycontactpartyid: integer
(int64)
Read Only:
true
Identifies the party ID of the primary contact of the permit application. -
Primarycontactphoneextension: string
Read Only:
true
Maximum Length:20
The contact phone number extension for the primary contact. -
PrimaryContactPhonenumber: string
Read Only:
true
Maximum Length:80
Identifies the phone number of the primary contact of the permit application. -
Primarycontacttype: string
Read Only:
true
Maximum Length:30
Identifies the contact type of the primary contact of the permit application. -
PrimaryContatUserId: string
Read Only:
true
Identifies the user ID of the primary contact. -
PrimaryFlag: string
Read Only:
true
Maximum Length:1
The application's relationship type as 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 of the primary application. -
ProjectKey: integer
(int64)
Read Only:
true
The project name information for a 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
Identifies the received date for the permit application. -
RecordStatus: string
Read Only:
true
Maximum Length:15
The status of the record. -
RecordType: string
Title:
Application Type
Read Only:true
Maximum Length:100
The permit type. Agencies define the types of permits that they administer, for example, Residential Addition. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The identifier for a 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 for a record type. -
SecondaryOwner: string
Title:
Property Secondary Owner
Read Only:true
Maximum Length:150
The secondary owner of the parcel or property. -
SubapplicationFlag: string
Read Only:
true
Maximum Length:1
The application's relationship type as subapplication. -
Subapplicationflagmeaning: string
Title:
Subapplication Relationship Type
Read Only:true
Maximum Length:80
The application's relationship type as subapplication. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification code of the permit application type. -
SubclassificationMeaning: string
Title:
Subclassification
Read Only:true
Maximum Length:80
Identifies the subclassification of the permit application type. -
SubmitDate: string
(date-time)
Title:
Submission Date
Read Only:true
The date the license and 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
Identifies the user ID of the person who submitted the permit application. -
SubmittedByName: string
Title:
Submitted by Name
Read Only:true
Identifies the user name 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
Identifies 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
Identifies the total hold fee amount. -
TotalOutstanding: number
Title:
Fees Outstanding Balance
Read Only:true
Identifies the total outstanding fee amount. -
TotalPaid: number
Title:
Fees Total Paid
Read Only:true
The total fees paid for the permit application. -
TotalPayable: number
Title:
Fees Total Payable
Read Only:true
The total fees payable for the permit application. -
TotalPending: number
Title:
Fees in Pending Status
Read Only:true
Identifies the total pending fee amount. -
TotalWaived: number
Title:
Fees Waived
Read Only:true
Identifies the total fee waived. -
Url: string
Title:
URL
Read Only:true
The URL label for the permit application. -
UrlLabel: string
Title:
Link to Permit Application
Read Only:true
The URL for the permit application. -
VersionType: string
Title:
Version Type
Read Only:true
Maximum Length:1
Indicates the version type. -
WfNoOrigFlag: string
Title:
No Application Workflow
Read Only:true
Maximum Length:1
Indicates that the transaction type does not contain an origination workflow. -
WithDrawnByName: string
Title:
Withdrawn by Name
Read Only:true
Identifies the user name of the person who withdrew the permit application. -
WithdrawnCreatedBy: string
Title:
Withdrawn by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who withdrew the permit application. -
WithdrawnCreatedDate: string
(date-time)
Title:
Withdrawal Date
Read Only:true
Identifies the withdrawal date of the permit application. -
WithdrawnReason: string
Title:
Withdrawal Reason
Read Only:true
Maximum Length:1000
Identifies the reason for the withdrawal of the permit application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.