Get all permits

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries

Request

Query Parameters
  • 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).
  • 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
  • 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 a permit using the primary key criteria.
      Finder Variables:
      • LnpRecordKey; integer; The unique identifier for a record. The record can be for a permit, business license, professional license, or planning and zoning, which is determined by the classification.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 to indicate when the permit application is about to expire.
    • Address1; string; The first or main address.
    • Address2; string; The second address, if present.
    • Address3; string; The third address, if present.
    • Address4; string; The fourth address, if present.
    • Applicant; integer; The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
    • ApplicantBizProfileId; integer; The unique identifier of the applicant business profile when the applicant is a business entity.
    • ApplicantProfileId; integer; The unique identifier of the applicant user profile.
    • ApplicantUserId; string; The user ID of the applicant.
    • City; string; The city in the parcel address.
    • Classification; string; The classification of the permit type.
    • Country; string; The country in the address.
    • County; string; The county in the parcel address.
    • CreatedByName; string; Used to indicate the name of the person who created the application.
    • CreationDate; string; The date when the record was created.
    • CurrencyCode; string; The currency code used for applying payments.
    • DateOfBirth; string; The applicant date of birth.
    • DepartmentId; string; The unique identifier for a department.
    • Description; string; The record description.
    • DocGroupId; string; Indicates the document group used by the application. The document group is defined by a set of attachment document categories.
    • EmailAddress1; string; The applicant main email address.
    • EmailAddress2; string; The applicant secondary email address.
    • ExpirationDate; string; The date when the permit expires.
    • ExpirationGraceDate; string; Indicates the date that the application can be extended to.
    • ExpirationGroupId; string; Identifies the expiration group associated with the record type.
    • FullAddress; string; The full address of the permit applicant.
    • Gender; string; The applicant sex. Values are male or female.
    • InsCommenceAteDate; string; Indicates the date that the inspection commencement will be about to expire.
    • InsCommenceExpDate; string; Indicates the date that the inspection commencement will expire.
    • InsCommenceGraceDate; string; Indicates the date that the inspection commencement can be extended to.
    • InspectionGroup; string; The group of inspections if multiple inspections are required for the permit type.
    • IssueDate; string; The date when the permit was issued.
    • LastAction; string; The last action performed on a transaction.
    • LastUpdateDate; string; The date when the record was last updated.
    • LayoutVersion; string; The layout version used for this record.
    • LicensePeriod; string; Indicates the period of license application.
    • LicenseStatus; string; Indicates the status of license application.
    • LnpRecordId; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
    • LnpRecordKey; integer; The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
    • OrganizationName; string; The name of the applicant organization.
    • PersonFirstName; string; The applicant first name.
    • PersonLastName; string; The applicant last name.
    • PersonMiddleName; string; The applicant middle name.
    • PersonName; string; The applicant full name.
    • PersonNameSuffix; string; The applicant name suffix, such as Junior or Senior.
    • PersonPreNameAdjunct; string; The salutation for the applicant, such as Mr. or Mrs.
    • PersonTitle; string; The applicant title.
    • PhoneAreaCode; string; The area code in the applicant telephone number.
    • PhoneCountryCode; string; The country code in the applicant telephone number.
    • PhoneExtension; string; The extension for the applicant telephone number.
    • PhoneNumber; string; The applicant telephone number.
    • PostalCode; string; The postal code in the parcel address.
    • PostalPlus4Code; string; The extended postal code in the parcel address.
    • PrimaryFlag; string; Indicates whether the record is primary.
    • PrimaryRecordId; string; Used to store the parent record ID for a sub-record.
    • PrimaryRecordKey; string; Used to store the primary record key for a sub-record.
    • ProjectKey; integer; The project to which this permit belongs.
    • Province; string; The province in the parcel address.
    • ReceivedDate; string; The date on which the transaction was received.
    • RecordNumber; string; The public unique identifier of the parent record used in the import process.
    • RecordType; string; The user-friendly name for the permit type.
    • RecordTypeCode; string; The unique alphanumeric code or short name for the permit type.
    • RecordTypeId; string; The unique identifier for a permit type.
    • ReissueDate; string; The date when the permit was reissued.
    • RenewalDate; string; The date when the permit was renewed.
    • State; string; The state in the parcel address.
    • Status; string; The permit status.
    • SubapplicationFlag; string; Indicates whether the record is a sub application.
    • Subclassification; string; The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
    • SubmitDate; string; The date when the application was submitted.
    • SubmittedByName; string; The name of the person who submitted the application.
    • SystemStatus; string; The predefined system status to which the record status maps.
    • VersionType; string; The version of the permit. Values are original, amendment, and renewal.
    • WfNoAmendFlag; string; Indicates that the transaction type does not contain an amendment workflow. If the value is Y, the workflow is disabled for amendment. The default value is N.
    • WfNoOrigFlag; string; Indicates that the transaction type does not contain an original workflow. If the value is Y, the workflow is disabled for origination. The default value is N.
    • WfNoRenewFlag; string; Indicates that the transaction type does not contain a renewal workflow. If the value is Y, the workflow is disabled for renewal. The default value is N.
    • WfProcessId; integer; The workflow process ID.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorRecordQueries
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorRecordQueries-item-response
Type: object
Show Source
Nested Schema : Record Contact Lists
Type: array
Title: Record Contact Lists
The contact list resource is used to find attributes related to the contacts that are added to the permit application.
Show Source
Nested Schema : Record GIS Objects
Type: array
Title: Record GIS Objects
The record GIS object resource is used to view the gis objects that are associated with the application.
Show Source
Nested Schema : Record Parcel Queries
Type: array
Title: Record Parcel Queries
The record parcel queries resource is used to view the parcels that are associated with the application.
Show Source
Nested Schema : publicSectorRecordQueries-ContactLists-item-response
Type: object
Show Source
Nested Schema : publicSectorRecordQueries-RecordGISObjects-item-response
Type: object
Show Source
Nested Schema : Shape
Type: object
The Oracle spatial field of a record parcel, which is the storage field for shape data.
Nested Schema : publicSectorRecordQueries-RecordParcel-item-response
Type: object
Show Source
Nested Schema : Parcel Addresses
Type: array
Title: Parcel Addresses
The parcel addresses resource is used to view the parcel addresses.
Show Source
Nested Schema : Parcel Owners
Type: array
Title: Parcel Owners
The parcel owners resource is used to view the parcel owners.
Show Source
Nested Schema : Shape
Type: object
The Oracle spatial field of a record parcel, which is the storage field for shape data.
Nested Schema : publicSectorRecordQueries-RecordParcel-ParcelAddress-item-response
Type: object
Show Source
Nested Schema : publicSectorRecordQueries-RecordParcel-ParcelOwner-item-response
Type: object
Show Source
Back to Top