OnTime REST API
OnTime REST API / REST Endpoints Resource Group / api/customers/authenticate (Get)
In This Topic
    Getapi/customers/authenticate
    In This Topic

    Resource Path: /sites/{company-id}/api/customers/authenticate

    Uri: https://secure.ontime360.com/sites/{company-id}/api/customers/authenticate

    Description
    Authenticates a Customer using a username and password, and returns its unique identifier on success.
    Parameters
    NameDescriptionData Type
    The Customer's username as a plain-text String.string
    The Customer's password as a plain-text String.string
    200 Response

    The response body is of type string.

    On success, returns the unique identifier of a Customer as a Guid. Returns null if the username or password does not belong to any existing Customer.
    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