get-break-type-response.md

Get Break Type Response

The response to a request to get a BreakType. The response contains the requested BreakType objects and might contain a set of Error objects if the request resulted in errors.

Structure

GetBreakTypeResponse

Fields

Name	Type	Tags	Description
breakType	BreakType | undefined	Optional	A defined break template that sets an expectation for possible Break instances on a Shift.
errors	Error[] | undefined	Optional	Any errors that occurred during the request.

Example (as JSON)

{
  "break_type": {
    "break_name": "Lunch Break",
    "created_at": "2019-02-21T17:50:00Z",
    "expected_duration": "PT30M",
    "id": "lA0mj_RSOprNPwMUXdYp",
    "is_paid": true,
    "location_id": "059SB0E0WCNWS",
    "updated_at": "2019-02-21T17:50:00Z",
    "version": 1
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    },
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}