Mindbody · Schema

Location1

Implementation of the 'Location1' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
BusinessId integer The model property of type int.
SiteId integer The model property of type int.
BusinessDescription string The model property of type str.
AdditionalImageURLs array The model property of type List[str].
FacilitySquareFeet integer The model property of type int.
ProSpaFinderSite boolean The model property of type bool.
HasClasses boolean The model property of type bool.
PhoneExtension string The model property of type str.
Action object The model property of type ActionEnum.
Id integer The model property of type int.
Name string The model property of type str.
Address string The model property of type str.
Address2 string The model property of type str.
Tax1 number The model property of type float.
Tax2 number The model property of type float.
Tax3 number The model property of type float.
Tax4 number The model property of type float.
Tax5 number The model property of type float.
Phone string The model property of type str.
City string The model property of type str.
StateProvCode string The model property of type str.
PostalCode string The model property of type str.
Latitude number The model property of type float.
Longitude number The model property of type float.
DistanceInMiles number The model property of type float.
ImageURL string The model property of type str.
Description string The model property of type str.
HasSite boolean The model property of type bool.
CanBook boolean The model property of type bool.
NumberTreatmentRooms integer The model property of type int.
Active boolean The model property of type bool.
InvActive boolean The model property of type bool.
WsShow boolean The model property of type bool.
Email string The model property of type str.
ContactName string The model property of type str.
ShipAddress string The model property of type str.
ShipState string The model property of type str.
ShipPostal string The model property of type str.
ShipPhone string The model property of type str.
ShipPOC string The model property of type str.
TaxGrouping boolean The model property of type bool.
LabelTax1 string The model property of type str.
LabelTax2 string The model property of type str.
LabelTax3 string The model property of type str.
LabelTax4 string The model property of type str.
LabelTax5 string The model property of type str.
WAC boolean The model property of type bool.
ShipAddress2 string The model property of type str.
MasterLocId integer The model property of type int.
StreetAddress string The model property of type str.
Country string The model property of type str.
Ext string The model property of type str.
Amenities array The model property of type List[Amenity1].
TotalNumberOfDeals integer The model property of type int.
TotalNumberOfRatings integer The model property of type int.
AverageRating number The model property of type float.
View JSON Schema on GitHub

JSON Schema

public-api-v6-location1-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-location1-schema.json",
  "title": "Location1",
  "description": "Implementation of the 'Location1' model.",
  "type": "object",
  "properties": {
    "BusinessId": {
      "type": "integer",
      "format": "int32",
      "description": "The model property of type int.",
      "example": 123456
    },
    "SiteId": {
      "type": "integer",
      "format": "int32",
      "description": "The model property of type int.",
      "example": -99
    },
    "BusinessDescription": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "Example note for Mindbody Public API."
    },
    "AdditionalImageURLs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The model property of type List[str].",
      "example": [
        "example-value"
      ]
    },
    "FacilitySquareFeet": {
      "type": "integer",
      "format": "int32",
      "description": "The model property of type int.",
      "example": 1
    },
    "ProSpaFinderSite": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "HasClasses": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "PhoneExtension": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "Action": {
      "$ref": "#/components/schemas/ActionEnum",
      "description": "The model property of type ActionEnum."
    },
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The model property of type int.",
      "example": 123456
    },
    "Name": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "Sunset Yoga Studio"
    },
    "Address": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "123 Market St"
    },
    "Address2": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "123 Market St"
    },
    "Tax1": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    },
    "Tax2": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    },
    "Tax3": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    },
    "Tax4": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    },
    "Tax5": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    },
    "Phone": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "+15551234567"
    },
    "City": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "San Francisco"
    },
    "StateProvCode": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "PostalCode": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "94110"
    },
    "Latitude": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    },
    "Longitude": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    },
    "DistanceInMiles": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    },
    "ImageURL": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "Description": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "Example note for Mindbody Public API."
    },
    "HasSite": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "CanBook": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "NumberTreatmentRooms": {
      "type": "integer",
      "format": "int32",
      "description": "The model property of type int.",
      "example": 1
    },
    "Active": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "InvActive": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "WsShow": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "Email": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "[email protected]"
    },
    "ContactName": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "ShipAddress": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "123 Market St"
    },
    "ShipState": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "ShipPostal": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "ShipPhone": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "+15551234567"
    },
    "ShipPOC": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "TaxGrouping": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "LabelTax1": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "LabelTax2": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "LabelTax3": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "LabelTax4": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "LabelTax5": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "WAC": {
      "type": "boolean",
      "description": "The model property of type bool.",
      "example": true
    },
    "ShipAddress2": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "123 Market St"
    },
    "MasterLocId": {
      "type": "integer",
      "format": "int32",
      "description": "The model property of type int.",
      "example": 123456
    },
    "StreetAddress": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "123 Market St"
    },
    "Country": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "US"
    },
    "Ext": {
      "type": "string",
      "description": "The model property of type str.",
      "example": "example-value"
    },
    "Amenities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Amenity1"
      },
      "description": "The model property of type List[Amenity1].",
      "example": [
        {}
      ]
    },
    "TotalNumberOfDeals": {
      "type": "integer",
      "format": "int32",
      "description": "The model property of type int.",
      "example": 1
    },
    "TotalNumberOfRatings": {
      "type": "integer",
      "format": "int32",
      "description": "The model property of type int.",
      "example": 1
    },
    "AverageRating": {
      "type": "number",
      "format": "double",
      "description": "The model property of type float.",
      "example": 1.0
    }
  }
}