Get a BL record

get

/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}

Request

Path Parameters
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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