StatusSigned

Return the status of the Lab Management web service, and the name of the authenticated user when authentication is used via a signed method.

This provides proof that the API, and authentication to the API are working properly. The only status returned is OK. If the authentication is not successful, you will get a Permission Denied error. If the API key is expired, you will get a Permission Denied: API key expired error.

URL

/cubit_api/1/status_signed

Authentication

This method requires authentication using an API key.

Parameters

sig ( Required, once ): API authentication hash signature.; Type: String
userid ( Required, once ): The login name of the user initiating the request.; Type: String

Example Response

        
    <?xml version='1.0'?>
    <cubit version='1'>
        <status>OK</status>
        <userid>grue</userid>
    </cubit>

In addition to returning the OK message, the username of the authenticated user is provided.

Response Codes

200 - ok
400 - Login failed / Insufficient permissions