OnTime REST API
OnTime REST API / REST Endpoints Resource Group / api/user/updateAvailability (Post)
In This Topic
    Postapi/user/updateAvailability
    In This Topic

    Resource Path: /sites/{company-id}/api/user/updateAvailability

    Uri: https://secure.ontime360.com/sites/{company-id}/api/user/updateAvailability

    Description
    Updates the availability of an existing User.
    Request

    The request body is of type UserAvailability.

    A comprehensive UserAvailability object containing the User's availability.

    Overview

    UserAvailability
    Represents a comprehensive UserAvailability record within the OnTime API.
    ID : string
    The unique identifier for this UserAvailability record.
    UserID : string
    The unique Guid identifier referencing the relative User record assigned to this UserAvailability.
    IsAvailable : boolean
    Indicates if the User is currently available as a driver.
    CurrentStatus : string
    A description of the User's status while they are available.
    LastStatusChange : string
    The date of when the most-recent availability status update was made by the User.
    Latitude : number
    The geographic latitude coordinate of where the most-recent availability status update was made by the User.
    Longitude : number
    The geographic longitude coordinate where the most-recent availability status update was made by the User.
    NextAvailabilityChange : string
    The approximate date of when the next availability status update will be made by the User.
    200 Response

    The response body is of type object.

    Returns true if the User's availability was successfully updated. Otherwise, returns false.
    Fault Responses
    FaultDescription
    Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
    Authorization key is invalid or no longer exists.
    Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.
    See Also