Get all field groups
get
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlFieldGroups
Request
Path Parameters
-
LnpRecordKey(required): integer(int64)
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
-
dependency: string
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> -
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 a field group using the primary key criteria.
Finder Variables:- LnpRecordKey; integer; The unique identifier of a field group.
- PrimaryKey: Finds a field group using the primary key criteria.
-
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:- BlFieldGroupPuid; string; The unique identifier of the field group transaction record in the legacy system.
- CnlBusinessDetail; string; Indicates the detail about the products or services being sold.
- CnlBusinessFromHome; boolean; Indicates whether all or part of the business be conducted from home.
- CnlBusinessNonprofit; boolean; Indicates whether this business is a non profit or an exempt entity.
- CnlCannabisActivity; boolean; Indicates whether the business involves cannabis activity.
- CnlHzrdMaterial; boolean; Indicates whether the business will handle hazardous materials.
- CnlMobileBusiness; boolean; Indicates whether this a mobile business or makes use of cars or trucks to transport goods.
- CnlModExistingStructure; boolean; Indicates whether there is a plan to make any modifications to an existing structure for the business.
- CnlNewStructure; boolean; Indicates whether there is a plan to make a new structure for the business.
- CnlSellAlcohol; boolean; Indicates whether there is a plan to sell alcohol beverages in the business.
- CnlSellFoodBevrg; boolean; Indicates whether food or beverages will be sold or provided in the business.
- CnlSellTobacco; boolean; Indicates whether there is a plan to sell tobacco or tobacco products.
- CnlSwmmingPool; boolean; Indicates whether the business provides a swimming pool or spa for use by the public.
- CurrencyCode; string; The currency code used for applying payments.
- LnpRecordId; string; The unique identifier for an application record.
- LnpRecordKey; integer; The unique identifier for a record.
- OhrDaysHrsDesc; string; Indicates operating days and hours.
- RecordNumber; string; The parent PUID for the imported transaction.
- RstAlcoholSrvEndTime; string; The serving end time for alcohol in the restaurant.
- RstAlcoholSrvStartTime; string; The serving start time for alcohol in the restaurant.
- RstBeverageVendMach; string; The beverage vending machine in the restaurant.
- RstExistingFloorArea; number; The restaurant's existing floor area.
- RstFoodPrepOnpremise; string; Indicates that the restaurant's food will be prepared on premise.
- RstFoodServiceEndTime; string; The restaurant's food service end time.
- RstFoodServiceStartTime; string; The restaurant's food service start time.
- RstMaxOutdoorSeating; number; The restaurant's maximum outdoor seating capacity.
- RstMaxSeatingBar; number; The restaurant's maximum bar seating capacity.
- RstMaxSeatingPrvteEvnt; number; The restaurant's maximum private seating capacity.
- RstOutdoorSeating; string; The restaurant's outdoor seating.
- RstParkingSpaces; number; The restaurant's parking space area.
- RstPrivateEvents; string; The restaurant's reserved area for private events.
- RstSellAlcohol; string; The restaurant's alcoholic beverages are sold to the public or not.
- RstSitDownBar; string; Indicates if there is a sit-down bar.
- RstTotalSeating; number; The restaurant's total seating capacity.
- RtlBrgCmpName; string; Indicates the alarm company name.
- RtlBrgPerExp; string; Indicates the expiration date for the alarm permit.
- RtlBrgPerNum; string; Indicates the alarm permit number.
- RtlBrgPhnNum; string; Indicates the alarm company phone number.
- RtlCommercial; boolean; Indicates that the business stores any commercial vehicles, tools, or equipment on-site.
- RtlFireInsExp; string; Indicates the expiration date for fire safety inspection.
- RtlFireInsNum; string; Indicates the inspection number for fire safety inspection.
- RtlHazardous; boolean; Indicates if the business manufacturer stores or sells any type of hazardous material.
- RtlMerchandise; boolean; Indicates if any merchandise is displayed outside the building.
- RtlProdDesc; string; Indicates the products to be sold.
- RtlSellerspermitExp; string; Indicates seller???s permit number.
- RtlSellerspermitNum; string; Indicates seller???s permit expiration date.
- RtlSpaceSize; number; Indicates the retail space size.
- RtlWmPermitExp; string; Indicates the permit expiration date for weights and measures permit.
- RtlWmPermitNum; string; Indicates the permit number for weights and measures.
-
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(required):
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(required):
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 : publicSectorBlRecords-BlFieldGroups
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 : publicSectorBlRecords-BlFieldGroups-item-response
Type:
Show Source
object
-
BlFieldGroupPuid: string
Maximum Length:
480
The unique identifier of the field group transaction record in the legacy system. -
CnlBusinessDetail: string
Title:
Describe Products or Services to Be Sold
Maximum Length:1000
Indicates the detail about the products or services being sold. -
CnlBusinessFromHome: boolean
Title:
Will you operate any part of business from home?
Maximum Length:1
Indicates whether all or part of the business be conducted from home. -
CnlBusinessNonprofit: boolean
Title:
Is this business a nonprofit or an exempt entity?
Maximum Length:1
Indicates whether this business is a non profit or an exempt entity. -
CnlCannabisActivity: boolean
Title:
Will you conduct cannabis activity on-site?
Maximum Length:1
Indicates whether the business involves cannabis activity. -
CnlHzrdMaterial: boolean
Title:
Will you store hazardous material on-site?
Maximum Length:1
Indicates whether the business will handle hazardous materials. -
CnlMobileBusiness: boolean
Title:
Will you use any type of commercial vehicles for transportation?
Maximum Length:1
Indicates whether this a mobile business or makes use of cars or trucks to transport goods. -
CnlModExistingStructure: boolean
Title:
Will you modify the existing structure for business?
Maximum Length:1
Indicates whether there is a plan to make any modifications to an existing structure for the business. -
CnlNewStructure: boolean
Title:
Will you construct any new structure for business on-site?
Maximum Length:1
Indicates whether there is a plan to make a new structure for the business. -
CnlSellAlcohol: boolean
Title:
Will you sell alcoholic beverages to the public?
Maximum Length:1
Indicates whether there is a plan to sell alcohol beverages in the business. -
CnlSellFoodBevrg: boolean
Title:
Will you sell or provide food and beverages on premises?
Maximum Length:1
Indicates whether food or beverages will be sold or provided in the business. -
CnlSellTobacco: boolean
Title:
Will you sell tobacco products to the public?
Maximum Length:1
Indicates whether there is a plan to sell tobacco or tobacco products. -
CnlSwmmingPool: boolean
Title:
Will you provide services like swimming pool or spa for public?
Maximum Length:1
Indicates whether the business provides a swimming pool or spa for use by the public. -
CurrencyCode: string
Maximum Length:
3
The currency code used for applying payments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Maximum Length:
50
The unique identifier for an application record. -
LnpRecordKey: integer
(int64)
The unique identifier for a record.
-
OhrDaysHrsDesc: string
Title:
Days and Hours of Operation
Maximum Length:1000
Indicates operating days and hours. -
RecordNumber: string
Maximum Length:
64
The parent PUID for the imported transaction. -
RstAlcoholSrvEndTime: string
(date-time)
Title:
Alcohol Service End Time
The serving end time for alcohol in the restaurant. -
RstAlcoholSrvStartTime: string
(date-time)
Title:
Alcohol Service Start Time
The serving start time for alcohol in the restaurant. -
RstBeverageVendMach: string
Title:
Will you sell beverages from a vending machine?
Maximum Length:1
The beverage vending machine in the restaurant. -
RstExistingFloorArea: number
Title:
Square Footage of Existing Establishment
The restaurant's existing floor area. -
RstFoodPrepOnpremise: string
Title:
Will you prepare food on premises?
Maximum Length:1
Indicates that the restaurant's food will be prepared on premise. -
RstFoodServiceEndTime: string
(date-time)
Title:
Food Service End Time
The restaurant's food service end time. -
RstFoodServiceStartTime: string
(date-time)
Title:
Food Service Start Time
The restaurant's food service start time. -
RstMaxOutdoorSeating: number
Title:
Maximum Outdoor Seating
The restaurant's maximum outdoor seating capacity. -
RstMaxSeatingBar: number
Title:
Maximum Seats or Stools
The restaurant's maximum bar seating capacity. -
RstMaxSeatingPrvteEvnt: number
Title:
Maximum Seats for an Event
The restaurant's maximum private seating capacity. -
RstOutdoorSeating: string
Title:
Will you provide outdoor seating?
Maximum Length:1
The restaurant's outdoor seating. -
RstParkingSpaces: number
The restaurant's parking space area.
-
RstPrivateEvents: string
Title:
Are there any private event rooms?
Maximum Length:1
The restaurant's reserved area for private events. -
RstSellAlcohol: string
Title:
Will you sell alcoholic beverages to the public?
Maximum Length:1
The restaurant's alcoholic beverages are sold to the public or not. -
RstSitDownBar: string
Title:
Will the establishment include a sit down bar?
Maximum Length:1
Indicates if there is a sit-down bar. -
RstTotalSeating: number
Title:
Total Number of Seats
The restaurant's total seating capacity. -
RtlBrgCmpName: string
Title:
Alarm Company Name
Maximum Length:200
Indicates the alarm company name. -
RtlBrgPerExp: string
(date)
Title:
Expiration Date
Indicates the expiration date for the alarm permit. -
RtlBrgPerNum: string
Title:
Alarm Permit Number
Maximum Length:100
Indicates the alarm permit number. -
RtlBrgPhnNum: string
Title:
Alarm Company Phone Number
Maximum Length:100
Indicates the alarm company phone number. -
RtlCommercial: boolean
Title:
Will you store any type of commercial vehicles, tools, or equipment on-site?
Maximum Length:1
Indicates that the business stores any commercial vehicles, tools, or equipment on-site. -
RtlFireInsExp: string
(date)
Title:
Inspection Date
Indicates the expiration date for fire safety inspection. -
RtlFireInsNum: string
Title:
Inspection Number
Maximum Length:100
Indicates the inspection number for fire safety inspection. -
RtlHazardous: boolean
Title:
Will you store hazardous material on-site?
Maximum Length:1
Indicates if the business manufacturer stores or sells any type of hazardous material. -
RtlMerchandise: boolean
Title:
Will you display any merchandise outside the building?
Maximum Length:1
Indicates if any merchandise is displayed outside the building. -
RtlProdDesc: string
Title:
Describe the Products and Services to Be Sold
Maximum Length:1000
Indicates the products to be sold. -
RtlSellerspermitExp: string
(date)
Title:
Seller's Permit Expiration Date
Indicates seller???s permit number. -
RtlSellerspermitNum: string
Title:
Seller's Permit Number
Maximum Length:1000
Indicates seller???s permit expiration date. -
RtlSpaceSize: number
Title:
Retail Space Area
Indicates the retail space size. -
RtlWmPermitExp: string
(date)
Title:
Expiration Date
Indicates the permit expiration date for weights and measures permit. -
RtlWmPermitNum: string
Title:
Permit Number
Maximum Length:100
Indicates the permit number for weights and measures.
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.