Get all BL records

get

/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords

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 record based on the specified primary key criteria.
      Finder Variables:
      • LnpRecordKey; integer; The unique identifier for a record.
  • 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 when the notification about a license expiring should be sent out.
    • 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.
    • AdjustmentFlag; boolean; Indicates that this row was initiated by the agency as an adjustment.
    • AgencyId; integer; The unique identifier for a public sector agency.
    • AmendmentType; string; The comma separated list of all amendment types.
    • AppAcceptDate; string; The date when the application was accepted.
    • ApplAteDate; string; The application about to expire date.
    • ApplExpirationDate; string; The date when the application expires.
    • 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.
    • BusAddress1; string; The address portion of the business??? address.
    • BusAddress2; string; The address portion of the business??? address.
    • BusAddress3; string; The address portion of the business??? address.
    • BusAddress4; string; The address portion of the business??? address.
    • BusAddressId; integer; The reference key to the TCA location table.
    • BusBusinessLegalName; string; The legal name of the business entity.
    • BusBusinessName; string; The name of the applicant's business. For example, a contractor enters his or her contracting business name.
    • BusCity; string; The city portion of the business??? address.
    • BusCountry; string; The address portion of the business??? address.
    • BusCounty; string; The county portion of the business??? address.
    • BusDbaBusinessName; string; A field in the business information component of the form designer used to describe the business name, which is different than the legal business name.
    • BusDescription; string; A field in the business information component of the form designer used to enter a description of the business.
    • BusDisadvOwnedFlag; boolean; Indicates whether a business is owned, operated, or controlled by women, minorities, persons with disabilities, or veterans. The default value is No.
    • BusEmployerIdNumber; string; The Employer Identifier Number for the business.
    • BusEnabledFlag; boolean; Indicates if the business entity is enabled.
    • BusEstAnnualGross; number; A field in the business information component of the form designer used to describe the estimated annual gross receipts for the business.
    • BusExemptFlag; boolean; Indicates if the business is tax exempt.
    • BusExemptType; string; The tax exemption type for the business.
    • BusExistAnnualGross; number; A field in the existing annual gross component of the form designer used to describe the existing annual gross receipts.
    • BusFedTaxId; string; A field in the business information component of the form designer used to describe the federal tax ID.
    • BusFemaleOwnedFlag; boolean; Indicates whether a woman owns the business. The default value is No.
    • BusFiscalYrEnd; string; The date of the business fiscal year end.
    • BusFloorArea; integer; A field in the business information component of the form designer used to describe the square footage of the office floor.
    • BusHideInfoFlag; boolean; Indicates if the business information should be hidden for public users.
    • BusInactiveReason; string; The reason why the business entity was changed to Inactive status.
    • BusIndustryId; string; A field in the business information component of the form designer used to describe the primary industry for the business.
    • BusMinorityOwnedFlag; boolean; Indicates whether the business is owned by a minority. The default value is No.
    • BusNumEmployees; integer; A field in the business information component of the form designer used to describe the number of employees at the business.
    • BusOwnershipType; string; A field in the business information component of the form designer used to describe the type of business ownership.
    • BusPartyId; integer; The unique identifier for business entity???s TCA party.
    • BusPostalCode; string; The postal code portion of the business??? address.
    • BusPostalPlusFourCode; string; The postal4 code portion of the business??? address.
    • BusProvince; string; The province portion of the business??? address.
    • BusSmallBusFlag; boolean; Indicates if the business is categorized as a small business.
    • BusStartDate; string; A field in the business information component of the form designer used to enter the date when the business was established.
    • BusState; string; The state portion of the business??? address.
    • BusStateTaxId; string; A field in the business information component of the form designer used to describe the business state tax ID.
    • BusStatus; string; The current status of the business entity.
    • BusVeteranOwnedFlag; boolean; Indicates if the business is owned by a military veteran.
    • BusinessEntityId; string; The unique identifier for the business entity.
    • BusinessEntityKey; integer; The unique identifier for the business entity.
    • ChangeReason; string; The reason for the amendment for adjustment.
    • ChangeType; string; The type of change allowed by the agency.
    • City; string; The city in the parcel address.
    • Classification; string; The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
    • CoordinateX; number; The x-axis coordinate for the record parcel.
    • CoordinateY; number; The y-axis coordinate for the record parcel.
    • Country; string; The country in the address.
    • County; string; The county in the parcel address.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • CurrentDate; string; Indicates the current date as shown by the system.
    • CurrentTransFlag; string; Indicates that this row is selected for the current transaction.
    • DateOfBirth; string; The applicant date of birth.
    • DelinquentDate; string; The date when the license becomes delinquent.
    • Description; string; The record description.
    • DocGroupId; string; The unique identifier of the document group for the application.
    • EffChangeDate; string; The effective change date of a business license record.
    • EmailAddress1; string; The applicant main email address.
    • EmailAddress2; string; The applicant secondary email address.
    • ExpirationDate; string; The date when the permit expires.
    • ExpirationGraceDate; string; The expiration date including a grace period for the application.
    • ExpirationStatus; string; The expiration status for the transaction.
    • FilerId; integer; The party ID of the filer or owner of this application.
    • FinalInsCmpDate; string; The date when the final inspection was completed.
    • FiscalYearendDay; integer; The day of the month that the fiscal year ends for organization. Range determined by the month.
    • FiscalYearendMon; string; The month that the fiscal year ends for the organization.
    • Gender; string; The applicant sex. Values are male or female.
    • InactReactLicense; string; Indicates whether an inactive application should be reactivated from the amendment intake form.
    • InsCommenceAteDate; string; The date on which the inspection commencement will be set as about to expire.
    • InsCommenceExpDate; string; The date that the inspection commencement will expire.
    • InsCommenceGraceDate; string; The expiration date, which includes a grace period.
    • IssueDate; string; The date when the permit was issued.
    • LastUpdateDate; string; The user who last updated the record.
    • LastUpdatedBy; string; The date when the record was last updated.
    • LayoutVersion; string; The version ID assigned to a specific intake form layout.
    • LevelOneTrans; integer; The primary level number for the transaction.
    • LevelTwoTrans; integer; The secondary level number for the transaction.
    • LicenseFinancialStatus; string; The overall financial status for the business license.
    • LicensePeriod; string; The reporting period that applies to the transaction.
    • LicenseStatus; string; The overall status for the business license.
    • 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.
    • MobileFlag; string; Indicates whether the entry was created using a mobile device. The default value is No.
    • ObjectVersionNumber; integer; System attribute that captures the incremental version number for an object.
    • OrganizationName; string; The name of the applicant's organization.
    • OriginalIssueDate; string; The date the business license was originally issued.
    • Originator; string; Indicates who submitted the record.
    • ParentRecordKey; integer; The parent key of the application.
    • 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 phone number.
    • PhoneCountryCode; string; The country code in the applicant phone number.
    • PhoneExtension; string; The extension for the applicant phone number.
    • PhoneNumber; string; The applicant telephone number.
    • PlanReviewCmpDate; string; The date when the plan review was completed.
    • PostalCode; string; The postal code in the parcel address.
    • PostalPlus4Code; string; The extended postal code in the parcel address.
    • ProjectKey; integer; The project to which this permit belongs.
    • Province; string; The province in the parcel address.
    • ReceivedDate; string; The date when the application was received.
    • RecordName; string; The name of the application.
    • RecordNumber; string; System generated identifier for the application.
    • RenewalDate; string; The date when the permit was renewed.
    • RenewalDueDate; string; The due date for renewing the permit.
    • RowType; string; Structure definition of the user descriptive flex field.
    • Srid; integer; The GIS coordinate system in use.
    • State; string; The state in the parcel address.
    • Status; string; This column is used to indicate status.
    • SubmitDate; string; The date when the application was submitted.
    • SubmittedBy; string; The user who submitted the application.
    • SystemStatus; string; The predefined system status to which the record status maps.
    • TermsUseAcceptDate; string; The date when the terms and conditions were accepted by the user.
    • TermsUseAcceptedBy; string; The party who accepted the terms and conditions.
    • TermsUseId; string; The terms of use ID.
    • TermsUsePersonType; string; The type of the person who uses the terms and conditions.
    • VersionType; string; The version of the permit. Values are original, amendment, and renewal.
  • 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 : publicSectorBlRecords
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorBlRecords-item-response
Type: object
Show Source
Nested Schema : BlFieldGroups
Type: array
Title: BlFieldGroups
The business field groups resource is used to view, create, modify, or delete a business field group information. This is the Field groups information associated with a BL record. Note: The standard actions are not available in the BL records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : BlGlobalCustoms
Type: array
Title: BlGlobalCustoms
The business global custom resource is used to view, create, modify, or delete a business global custom information. This is the global custom information associated with a BL record. Note: The standard actions are not available in the BL records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : BL Naics
Type: array
Title: BL Naics
The bl naics resource is used to view the naics code associated with the license.
Show Source
Nested Schema : Business Locations
Type: array
Title: Business Locations
The business location resource is used to view, create, modify, or delete a business location. A business location shows the location information associated with a record. Note: The standard actions are not available in the BL records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : Business Owners
Type: array
Title: Business Owners
The business owner resource is used to view, create, modify, or delete a business owner information. This is the owner information associated with a BL record. Note: The standard actions are not available in the BL records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : ContactLists
Type: array
Title: ContactLists
The contact list resource is used to view, create, modify, or delete a contact list. A contact list shows the contact information associated with a record. Note: The standard actions are not available in the BL records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : Credentials
Type: array
Title: Credentials
The credential resource is used to view, create, modify, or delete a credential. A credential shows the credential information associated with a record. Note: The standard actions are not available in the BL records resource. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : Record Comments
Type: array
Title: Record Comments
The record comment resource is used to view the comments of a record.
Show Source
Nested Schema : Record Contractor Licenses
Type: array
Title: Record Contractor Licenses
The record contractor license resource is used to view, create, modify, or delete a record contractor license. You must use the agency???s dynamic REST. API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : RecordGISAttr
Type: array
Show Source
Nested Schema : Record Parcel Address Owners
Type: array
Title: Record Parcel Address Owners
The record parcel address owner resource is used to view the owners of a parcel.
Show Source
Nested Schema : Tax Details
Type: array
Title: Tax Details
The tax details resource is used to view the tax details of a record.
Show Source
Nested Schema : Workflow References
Type: array
Title: Workflow References
The workflow reference resource is used to view the workflow reference of a record.
Show Source
Nested Schema : publicSectorBlRecords-BlFieldGroups-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-BlGlobalCustom-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-BlNaics-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-BusinessLocation-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-BusinessOwner-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-ContactList-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-Credential-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-RecordComment-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-RecordContractorLicense-item-response
Type: object
Show Source
Nested Schema : Record Contractor License Facts
Type: array
Title: Record Contractor License Facts
The record contractor license fact resource is used to view, create, modify, or delete a record contractor license fact. A contractor license fact indicates license fact information associated with contractor license. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : Record Contractor License Insurances
Type: array
Title: Record Contractor License Insurances
The record contractor license Insurance resource is used to view, create, modify, or delete a record contractor license Insurance. A contractor license Insurance indicates license Insurance information associated with contractor license. You must use the agency???s dynamic REST API: /fscmRestApi/resources/11.13.18.05/LNP_c.
Show Source
Nested Schema : publicSectorBlRecords-RecordContractorLicense-RecordContractorLicFact-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-RecordContractorLicense-RecordContractorLicInsurance-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-RecordGISAttr-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-RecordParcelAddressOwner-item-response
Type: object
Show Source
Nested Schema : Shape
Type: object
Nested Schema : publicSectorBlRecords-TaxDetails-item-response
Type: object
Show Source
Nested Schema : publicSectorBlRecords-WorkflowReference-item-response
Type: object
Show Source
Back to Top