LoginService-Public_2_0 Web Service Reference

Transcription

1

2 Table of contents Methods... 3 getauth... 4 Complex Types... 6 types... 6 Login... 6 LoginException... 7 getauth... 8 getauthresponse... 8 types_authentication... 9 anonymous... 9 authentication... 9 authenticationfault Elements types LoginException getauth getauthresponse types_authentication authentication authenticationfault DELICom DPD GmbH (c) 2015 Page 2 / 13

3 Methods Following methods are available for the service LoginService-Public_2_0 Method name getauth Creates an authentication token for the committed user if user name and password are valid. The authentication token is needed for accessing other DPD Web Services. DELICom DPD GmbH (c) 2015 Page 3 / 13

4 Method: getauth Creates an authentication token for the committed user if user name and password are valid. The authentication token is needed for accessing other DPD Web Services. Sample request: SOAP: <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:getauth> <delisid><your delisid></delisid> <password><your password></password> <messagelanguage>de_de</messagelanguage> </ns:getauth> </soapenv:body> <soapenv:envelope> REST: URL: <server:port><path>/loginservice/v2_0/getauth JSON-Data for POST-Request (for GET-Request data must send with parameter "request" and for JSONP the Parameter "jsonpcallback" can be used, to send a padding function name): { "delisid" : "<your delisid>", "password": "<your password>", "messagelanguage":"en_en" } REST-Result, without error: { "getauthresponse": {"return": { "delisid": "<your delisid>", "customeruid": "<your customeruid>", "authtoken": "<your authentication token>", "depot": "<your customeruid>" }}, "status": { "type": "OK", "code": "200", DELICom DPD GmbH (c) 2015 Page 4 / 13

5 } } "message": "valid" REST-Result, if an error occurred: {"status": { "type": "AuthenticationFault", "code": "<Error code, e.g. LOGIN_8>", "message": "<Error message, e.g. The combination of user and password is invalid.>" }} Additional REST-State on system error: Error-Code: 100 Error-Type: SystemFault Error-Message: <Message, which describe the error> Action Input The input for method getauth is as follows: Name parameters Element types:getauth Output The output for method getauth is as follows: Name parameters Element types:getauthresponse Faults The defined faults for method getauth are as follows: Name AuthenticationFault Element types_authentication:authenticationfault DELICom DPD GmbH (c) 2015 Page 5 / 13

6 Complex Types URL: Complex Type: Login Is created when a user logs in and contains its login information. delisid xsd:string / customeruid xsd:string / authtoken xsd:string / depot xsd:string / The user's DELIS-Id. The user's customer uid. This is needed for subaccounts, usually this is equal to DELIS-Id The Authtoken, needed for other web service calls. The depot, to which the user is assigned. DELICom DPD GmbH (c) 2015 Page 6 / 13

7 Complex Type: LoginException additionaldata xsd:string / additionalinfo xsd:string / errorclass xsd:string / errorcode xsd:string / fullmessage xsd:string / language xsd:string / message xsd:string / shortmessage xsd:string / systemfullmessage xsd:string / systemmessage xsd:string / systemshortmessage xsd:string / Additional data for an error. Additional info for an error in user language. The class which creates the error. The error code. The complete message text for the error with additional info in user language. Language for messages. The complete message text for the error in user language. The short info text for the error in user language. The complete message text for the error with additional info in system language. The complete message text for the error in system language. The short info text for the error in system language. DELICom DPD GmbH (c) 2015 Page 7 / 13

8 Complex Type: getauth delisid xsd:string / password xsd:string / messagelanguage xsd:string / minlength: 5 maxlength: 5 The DELIS-Id of the user. The password of the user. The language (Java format) for messages. "de_de" for german messages. "en_us" for english messages. Complex Type: getauthresponse return types:login / DELICom DPD GmbH (c) 2015 Page 8 / 13

9 _authentication URL: _authentication Anonymous Complex Type of Element: authentication The data structure for authentication data. delisid xsd:string / minlength: 8 maxlength: 10 authtoken xsd:string / minlength: 0 maxlength: 64 messagelanguage xsd:string / minlength: 5 maxlength: 5 The delis user id for authentication. The token for authentication. Field authtoken of Login, as a result of Method "getauth" of LoginService. The language (Java format) for messages. "de_de" for german messages. "en_us" for english messages. DELICom DPD GmbH (c) 2015 Page 9 / 13

10 _authentication Anonymous Complex Type of Element: authenticationfault The data structure for authentication errors. errorcode xsd:string / errormessage xsd:string / minlength: 1 maxlength: 255 The error code. Valid codes: NoAccessAuthenticationFault=-1 NoRightsAuthenticationFault=-2 The error message text. DELICom DPD GmbH (c) 2015 Page 10 / 13

11 Elements URL: Element: LoginException LoginException types:loginexception / Thrown if authentication fails. Element: getauth getauth types:getauth / Input parameter of getauth. DELICom DPD GmbH (c) 2015 Page 11 / 13

12 Element: getauthresponse getauthresponse types:getauthresponse / Output parameter of getauth. DELICom DPD GmbH (c) 2015 Page 12 / 13

13 _authentication URL: _authentication Element: authentication Anonymous Complex Type types_authentication:authentication _authentication Element: authenticationfault Anonymous Complex Type types_authentication:authenticationfault DELICom DPD GmbH (c) 2015 Page 13 / 13