Support Hours

List support hours.

get

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters

start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0

max-resultsinteger · int32 · max: 50Optional

the maximum number of results when paging through a list of support hours.

Default: 50

Responses

200

list of support hours

application/json

get

/support-hours

HTTPcURLJavaScriptPython

GET /api/support-hours HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

list of support hours

[
  {
    "id": 1,
    "name": "text",
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "timezone": "Europe/Berlin",
    "supportDays": {
      "MONDAY": {
        "start": "22:33:06",
        "end": "22:33:06"
      },
      "TUESDAY": {
        "start": "22:33:06",
        "end": "22:33:06"
      },
      "WEDNESDAY": {
        "start": "22:33:06",
        "end": "22:33:06"
      },
      "THURSDAY": {
        "start": "22:33:06",
        "end": "22:33:06"
      },
      "FRIDAY": {
        "start": "22:33:06",
        "end": "22:33:06"
      },
      "SATURDAY": {
        "start": "22:33:06",
        "end": "22:33:06"
      },
      "SUNDAY": {
        "start": "22:33:06",
        "end": "22:33:06"
      }
    }
  }
]

Create a new support hour.

post

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Body

application/json

idinteger · int64Optional

namestringRequired

timezonestring · enumRequiredPossible values:

Responses

201

the response

application/json

post

/support-hours

HTTPcURLJavaScriptPython

POST /api/support-hours HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 435

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "TUESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "WEDNESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "THURSDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "FRIDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SATURDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SUNDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    }
  }
}

201

the response

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "TUESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "WEDNESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "THURSDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "FRIDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SATURDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SUNDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    }
  }
}

Get the support hour with specified id.

get

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Responses

200

the support hour object

application/json

get

/support-hours/{id}

HTTPcURLJavaScriptPython

GET /api/support-hours/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

the support hour object

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "TUESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "WEDNESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "THURSDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "FRIDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SATURDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SUNDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    }
  }
}

Update an existing support hour.

put

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Body

application/json

idinteger · int64Optional

namestringRequired

timezonestring · enumRequiredPossible values:

Responses

200

the updated support hour object

application/json

put

/support-hours/{id}

HTTPcURLJavaScriptPython

PUT /api/support-hours/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 435

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "TUESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "WEDNESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "THURSDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "FRIDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SATURDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SUNDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    }
  }
}

200

the updated support hour object

{
  "id": 1,
  "name": "text",
  "teams": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "timezone": "Europe/Berlin",
  "supportDays": {
    "MONDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "TUESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "WEDNESDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "THURSDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "FRIDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SATURDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    },
    "SUNDAY": {
      "start": "22:33:06",
      "end": "22:33:06"
    }
  }
}

Delete the specified support hour.

delete

Authorizations

apiKey

AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters

idnumberRequired

entity ID

Responses

204

if deletion was successful

delete

/support-hours/{id}

HTTPcURLJavaScriptPython

DELETE /api/support-hours/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

if deletion was successful

No content