Overview
Requests an authentication token
The function is available as a Web Service request.
Request
Parameters of the API request:
| Parameter | Type | Description | Requirements |
|---|
| eid | String |
| Mandatory |
| loginName | String | Login ID of the API user | Mandatory |
| password | String | Password of the API user | Mandatory |
Response
Parameters of the API response:
| Parameter | Type | Description |
|---|
| status | Status | Possible return values: - OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED
|
| token | String | Token to be used in subsequent API calls |
Examples
Example RequestToken transaction.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v3:requestToken>
<eid>0000</eid>
<loginName>verba_api_user</loginName>
<password>api_user_password</password>
</v3:requestToken>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:requestTokenResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
<return>
<status>
<statusCode>OK</statusCode>
</status>
<token>OLZqneyISmy5eoKeGEd418X0nvzuu7Ll</token>
</return>
</ns2:requestTokenResponse>
</S:Body>
</S:Envelope>
Example RequestToken transaction with bad password.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v3:requestToken>
<eid>0000</eid>
<loginName>verba_api_user</loginName>
<password>api_user_wrong_password</password>
</v3:requestToken>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:requestTokenResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
<return>
<status>
<message>com.verba.web.user.UserNotFoundException</message>
<statusCode>ERROR_GENERAL</statusCode>
</status>
</return>
</ns2:requestTokenResponse>
</S:Body>
</S:Envelope>
Example RequestToken transaction with bad permissions.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v3:requestToken>
<eid>0000</eid>
<loginName>verba_standard_user</loginName>
<password>api_user_password</password>
</v3:requestToken>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:requestTokenResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
<return>
<status>
<message>com.verba.web.api.KnownException: User should be a System Supervisor.</message>
<statusCode>ERROR_GENERAL</statusCode>
</status>
</return>
</ns2:requestTokenResponse>
</S:Body>
</S:Envelope>