Login

System authentication. Returns a session UID that can be reused for future requests.

LoginRequest

Property

Type

Description

Credentials

Credentials

Authentication information




LoginResponse

Property

Type

Description

Credentials

Credentials

Authentication information. Will contain the session UID if the authentication was successful.


Examples

Credentials credentials = new Credentials();

credentials.setUsername("api@mycompany.com");

credentials.setPassword("myApiUserPassword");

credentials = progressionWebService.login(credentials); // Will trigger an error if the authentication is invalid

String sessionId = credentials.getSessionId();

Java


$credentials = new StdClass();

$credentials->Username = 'api@mycompany.com';

$credentials->Password = 'myApiUserPassword';

$loginRequest = new StdClass();

$loginRequest->credentials = $credentials;

$loginResponse = $service->Login($loginRequest);   // Will trigger an error if the authentication is invalid

$credentials = $loginResponse->credentials;

PHP