|
<< Click to Display Table of Contents >> Navigation: »No topics above this level« Log in |
Use the Login API request to obtain a security token. This token must be used in all other API requests.
API request
Name: Login
API request structure
<?xml version="1.0" encoding="utf-8"?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <S:Body> <ns2:Login xmlns:ns2="api.timewriter.nl"> <api_key></api_key> <user_key></user_key> <softwareDesc></softwareDesc> </ns2:Login> </S:Body> </S:Envelope> |
Explanation
Tag/field name |
Type |
Remark |
Description |
api_key |
string |
mandatory |
TimeWriter API key |
user_key |
string |
mandatory |
TimeWriter user key |
softwareDesc |
string |
name of your application |
API response
Name: LoginResponse
API response structure
<?xml version="1.0" encoding="utf-8"?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <S:Body> <ns2:LoginResponse xmlns:ns2="api.timewriter.nl"> <result> <error></error> <errorMessage/> <securityToken></securityToken> </result> </ns2:LoginResponse> </S:Body> </S:Envelope> |
Explanation
Tag/field name |
Type |
||||||||||||
result |
RequestResult
|