Get a User’s Work Day Details

Let’s you find out if a user is available on a given day. If the user is available, the API will also return the user’s work hours. It is mandatory to pass the following parameters in the API URL –

  • “UserId” of the user who’s availability status you want to get.
  • “Date” you want to get the availability status for. You must pass the date in “yyyy-MM-dd” format.

The “IsAvailable”, “StatusReason” and “WorkingHours” parameters in the response will give you the following information –

IsAvailable StatusReason WorkingHours
1  – Work hours will be shown as defined in the Work Day Template*.
1 WorkDayTemplateNotDefined If a Work Day Template isn’t defined, you’ll see 00:00:00 to 23:59:59
0 Holiday
0 Leave
0 NotScheduled

* “WorkingHours” returns an array as it is possible for users to work in 2 shifts in the same day.

 

API URL

GET
https://{host}/v2/UserManagement.svc/User/GetWorkDayDetails?accessKey=AccessKey&secretKey=SecretKey&userId=UserId&date=Date
Copy URL

URL Parameters

Parameter Description
UserId The Id of the user who's availability you want to check.
Date The date you want to check the availability on.

Response

200 OK

Content-Type: application/json

{
    "IsAvailable": 1,
    "StatusReason": "",
    "UserId": "dd908e91-c5c9-11e5-8de3-22000aa5088d",
    "WorkingHours": [
        {
            "StartTime": "09:00:00",
            "EndTime": "18:00:00"
        }
    ]
}

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.