readOverlay

readOverlay

Path Parameters

dealerUuid string required
menuUuid string required

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string
overlay object
menuUuid string
version string
baseDefinitionVersion string
patch object
addedApplicationUuids string[]
removedApplicationUuids string[]
menuLaborType string
applicationLaborTypes object
property name* string
fixedLaborPrices object
property name* number
fixedMenuPrice number

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string",
  "overlay": {
    "menuUuid": "string",
    "version": "string",
    "baseDefinitionVersion": "string",
    "patch": {
      "addedApplicationUuids": [
        "string"
      ],
      "removedApplicationUuids": [
        "string"
      ],
      "menuLaborType": "string",
      "applicationLaborTypes": {},
      "fixedLaborPrices": {},
      "fixedMenuPrice": 0
    }
  }
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Forbidden

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorName string
errorMessage string
errorCode int32
]
warnings object[]
Array [
warningCode string
warningTitle string
warningMessage string
]
statusCode int32
apiRequestId string

{
  "errors": [
    {
      "errorName": "string",
      "errorMessage": "string",
      "errorCode": 0
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "statusCode": 0,
  "apiRequestId": "string"
}

Loading...