Login


 

Overview

Quick Links

The Login method allows a user to authenticate with the system and obtain an Authentication token to be used in subsequent calls.

Resource Information



Request FormatXML
Response FormatXML

Request Header

Empty

Request Body

NameTypeDescription
emailAddressStringThe email address that acts as a username
passwordStringThe password for the specified email address
environmentStringThe Key for the Environment

Response

NameTypeDescription
ResultStringAuthentication token to be used in the header of subsequent calls
ResultCodeStringString indicating the result. Either "Success" or "Error"
ResultMessageStringEmpty when call successful, error message otherwise

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <Login xmlns="api.billing.inter8.V1_3_2">
            <emailAddress>admin@cloudbilling.nl</emailAddress>
            <password>yourPasswor</password>
            <environment>yourEnvironment</environment>
        </Login>
    </Body>
</Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <LoginResponse xmlns="api.billing.inter8.V1_3_2">
            <LoginResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_3_2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <a:Result>5ce348a5-c3df-4aea-a7d8-2dc67dc8cf95</a:Result>
                <a:ResultCode>Success</a:ResultCode>
                <a:ResultMessage/>
            </LoginResult>
        </LoginResponse>
    </s:Body>
</s:Envelope>