LoginStart for Free

Support Hours

List support hours.

get
Authorizations
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
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": "08:14:43",
        "end": "08:14:43"
      },
      "TUESDAY": {
        "start": "08:14:43",
        "end": "08:14:43"
      },
      "WEDNESDAY": {
        "start": "08:14:43",
        "end": "08:14:43"
      },
      "THURSDAY": {
        "start": "08:14:43",
        "end": "08:14:43"
      },
      "FRIDAY": {
        "start": "08:14:43",
        "end": "08:14:43"
      },
      "SATURDAY": {
        "start": "08:14:43",
        "end": "08:14:43"
      },
      "SUNDAY": {
        "start": "08:14:43",
        "end": "08:14:43"
      }
    }
  }
]

Create a new support hour.

post
Authorizations
Body
idinteger · int64Optional
namestringRequired
timezonestring · enumRequiredPossible values:
Responses
201
the response
application/json
post
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": "08:14:43",
      "end": "08:14:43"
    },
    "TUESDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "WEDNESDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "THURSDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "FRIDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "SATURDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "SUNDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    }
  }
}
201

the response

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

Get the support hour with specified id.

get
Authorizations
Path parameters
idnumberRequired

entity ID

Responses
200
the support hour object
application/json
get
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": "08:14:43",
      "end": "08:14:43"
    },
    "TUESDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "WEDNESDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "THURSDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "FRIDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "SATURDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "SUNDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    }
  }
}

Update an existing support hour.

put
Authorizations
Path parameters
idnumberRequired

entity ID

Body
idinteger · int64Optional
namestringRequired
timezonestring · enumRequiredPossible values:
Responses
200
the updated support hour object
application/json
put
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": "08:14:43",
      "end": "08:14:43"
    },
    "TUESDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "WEDNESDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "THURSDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "FRIDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "SATURDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    },
    "SUNDAY": {
      "start": "08:14:43",
      "end": "08:14:43"
    }
  }
}
200

the updated support hour object

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

Delete the specified support hour.

delete
Authorizations
Path parameters
idnumberRequired

entity ID

Responses
204
if deletion was successful
delete
DELETE /api/support-hours/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

if deletion was successful

No content
PreviousAlert ActionsNextConnectors

Was this helpful?