Jump to

• Request
• Response

Update a field group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlFieldGroups/{LnpRecordKey2}

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.
• LnpRecordKey2(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 materials 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.
• OhrDaysHrsDesc: string
  Title: Days and Hours of Operation

  Maximum Length: 1000

  Indicates operating days and hours.
• 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.

{
    "type":"object",
    "properties":{
        "CnlCannabisActivity":{
            "title":"Will you conduct cannabis activity on-site?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the business involves cannabis activity.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlBrgCmpName":{
            "title":"Alarm Company Name",
            "maxLength":200,
            "type":"string",
            "description":"Indicates the alarm company name.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlSellerspermitNum":{
            "title":"Seller's Permit Number",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates seller???s permit expiration date.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlFireInsExp":{
            "title":"Inspection Date",
            "type":"string",
            "description":"Indicates the expiration date for fire safety inspection.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstSitDownBar":{
            "title":"Will the establishment include a sit down bar?",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if there is a sit-down bar.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlBusinessFromHome":{
            "title":"Will you operate any part of business from home?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether all or part of the business be conducted from home.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlBusinessNonprofit":{
            "title":"Is this business a nonprofit or an exempt entity?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this business is a non profit or an exempt entity.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlModExistingStructure":{
            "title":"Will you modify the existing structure for business?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether there is a plan to make any modifications to an existing structure for the business.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code used for applying payments.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstTotalSeating":{
            "title":"Total Number of Seats",
            "type":"number",
            "description":"The restaurant's total seating capacity.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstParkingSpaces":{
            "type":"number",
            "description":"The restaurant's parking space area.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstExistingFloorArea":{
            "title":"Square Footage of Existing Establishment",
            "type":"number",
            "description":"The restaurant's existing floor area.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlSwmmingPool":{
            "title":"Will you provide services like swimming pool or spa for public?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the business provides a swimming pool or spa for use by the public.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstAlcoholSrvStartTime":{
            "title":"Alcohol Service Start Time",
            "type":"string",
            "description":"The serving start time for alcohol in the restaurant.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlHazardous":{
            "title":"Will you store hazardous material on-site?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the business manufacturer stores or sells any type of  hazardous material.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlNewStructure":{
            "title":"Will you construct any new structure for business on-site?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether there is a plan to make a new structure for the business.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlBrgPerExp":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Indicates the expiration date for the alarm permit.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlSellerspermitExp":{
            "title":"Seller's Permit Expiration Date",
            "type":"string",
            "description":"Indicates seller???s permit number.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstMaxOutdoorSeating":{
            "title":"Maximum Outdoor Seating",
            "type":"number",
            "description":"The restaurant's maximum outdoor seating capacity.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlWmPermitNum":{
            "title":"Permit Number",
            "maxLength":100,
            "type":"string",
            "description":"Indicates the permit number for weights and measures.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlBusinessDetail":{
            "title":"Describe Products or Services to Be Sold",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the detail about the products or services being sold.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstBeverageVendMach":{
            "title":"Will you sell beverages from a vending machine?",
            "maxLength":1,
            "type":"string",
            "description":"The beverage vending machine in the restaurant.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlMobileBusiness":{
            "title":"Will you use any type of commercial vehicles for transportation?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this a mobile business or makes use of cars or trucks to transport goods.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstSellAlcohol":{
            "title":"Will you sell alcoholic beverages to the public?",
            "maxLength":1,
            "type":"string",
            "description":"The restaurant's alcoholic beverages are sold to the public or not.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlProdDesc":{
            "title":"Describe the Products and Services to Be Sold",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the products to be sold.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlSellFoodBevrg":{
            "title":"Will you sell or provide food and beverages on premises?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether food or beverages will be sold or provided in the business.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlSpaceSize":{
            "title":"Retail Space Area",
            "type":"number",
            "description":"Indicates the retail space size.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstAlcoholSrvEndTime":{
            "title":"Alcohol Service End Time",
            "type":"string",
            "description":"The serving end time for alcohol in the restaurant.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstOutdoorSeating":{
            "title":"Will you provide outdoor seating?",
            "maxLength":1,
            "type":"string",
            "description":"The restaurant's outdoor seating.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlSellTobacco":{
            "title":"Will you sell tobacco products to the public?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether there is a plan to sell tobacco or tobacco products.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlBrgPerNum":{
            "title":"Alarm Permit Number",
            "maxLength":100,
            "type":"string",
            "description":"Indicates the alarm permit number.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlMerchandise":{
            "title":"Will you display any merchandise outside the building?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if any merchandise is displayed outside the building.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlFireInsNum":{
            "title":"Inspection Number",
            "maxLength":100,
            "type":"string",
            "description":"Indicates the inspection number for fire safety inspection.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "OhrDaysHrsDesc":{
            "title":"Days and Hours of Operation",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates operating days and hours.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstMaxSeatingBar":{
            "title":"Maximum Seats or Stools",
            "type":"number",
            "description":"The restaurant's maximum bar seating capacity.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstFoodPrepOnpremise":{
            "title":"Will you prepare food on premises?",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the restaurant's food will be prepared on premise.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstMaxSeatingPrvteEvnt":{
            "title":"Maximum Seats for an Event",
            "type":"number",
            "description":"The restaurant's maximum private seating capacity.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlWmPermitExp":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Indicates the permit expiration date for weights and measures permit.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlSellAlcohol":{
            "title":"Will you sell alcoholic beverages to the public?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether there is a plan to sell alcohol beverages in the business.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlCommercial":{
            "title":"Will you store any type of commercial vehicles, tools, or equipment on-site?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the business stores any commercial vehicles, tools, or equipment on-site.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstFoodServiceEndTime":{
            "title":"Food Service End Time",
            "type":"string",
            "description":"The restaurant's food service end time.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RtlBrgPhnNum":{
            "title":"Alarm Company Phone Number",
            "maxLength":100,
            "type":"string",
            "description":"Indicates the alarm company phone number.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "CnlHzrdMaterial":{
            "title":"Will you store hazardous materials on-site?",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the business will handle hazardous materials.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstFoodServiceStartTime":{
            "title":"Food Service Start Time",
            "type":"string",
            "description":"The restaurant's food service start time.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "RstPrivateEvents":{
            "title":"Are there any private event rooms?",
            "maxLength":1,
            "type":"string",
            "description":"The restaurant's reserved area for private events.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : publicSectorBlRecords-BlFieldGroups-item-response

Type: object

Show Source

• 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 materials 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.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top