Portal Web Service

A SOAP web service exists within the Portal application.

For the CORE module, the following methods are available:

Method Name	Description
getInfo	Returns basic information for the system i.e. system name and version. This can be used to test access to the Web Service
getKey	Returns a remote key which grants access to the Portal system for an existing user

Request Header

On all requests made to the Portal Web Service, a SOAP header will be required supplying a Username and Password.

The username and password used should correspond to a valid login account on the Portal system, and in addition for the getKey method, the User Type set against the user must be ‘W’ (see section 2.4.2)

The login information will be used to set the restrictions that the response will use to return the data i.e. the user’s group will determine the restrictions setup against the user and these will be used (as they are in the actual TTM system) to restrict the data that the user can see. Any valid username/password can be used, including users where no restrictions have been added.

Response Header

The Response Header will be included on all responses from the Portal Web Service.

Parameter	Data Type	Format	Description
<response_id>	xs:string	A35	A unique ID for the web service response. This code (along with the response_datestamp) can be used to identify requests in the log files.
<response_datestamp>	xs:dateTime	XML Date/Time	A string date representing the time of the response as recorded on the logging table.
<response_code>	xs:int	999	The response code for the request. A return of 0 denotes a successful request/response and a return greater than 0 denotes an error.
<response_code_desc>	xs:string	A50	The description of the response.
<record_count>	xs:int	99999	A count of the number of records contained in the response for the given method: getTrip - the count will be the number of trips getOrder - the count will be the number of orders

An example response header will be as follows:

<responseHdr>
<response_id>befc95d5-5a74-4ecb-a3c5-91242ede3619</response_id>
<response_datestamp>2015-12-31 00:00:00</response_datestamp>
<response_code>0</response_code>
<response_code_desc>OK</response_code_desc>
<record_count>1</record_count>
</responseHdr>

Method: getKey

The getKey method can be used to retrieve a remote key which grants access to the Portal system for an existing user.

Request Details

Parameter	Data Type	Format	Description
<user_id>	xs:string	A8	This must be an existing user on the Portal system which is Active
<no_keys>	xs:int	99	The number of keys to generate. If not supplied or non-numeric the default will be used and a single key will be returned. If supplied, the number of keys must be between 1 and 99.
<key_length>	xs:int	99	The length of the key to be generated. If not supplied or non-numeric the default will be used and a 6 digit key will be returned. If supplied, the key length must be between 6 and 40.
<key_min>	xs:int	9999	The length in minutes that the generated keys will be valid for, before they expire. If not supplied or non-numeric the default will be used and the key(s) will expire after 1 minute. If supplied, the key min must be between 1 and 1440 (1 day).
<session_min>	xsint	9999	The length in minutes that the portal session will last for, once the key has been accepted and the user enters the system. If not supplied or non-numeric the default will be used and the session will expire after 1 hour. If supplied, the session min must be between 1 and 1440 (1 day).

Note: A valid request header is required.

Validation – The user id is required, all other fields are optional, and validated as described above.

Response Details

<portalKey> Section

Field Name	Data Type	Format	Description
<passKey>	xs:string	A*	A comma separated list containing the requested number of keys for the user. The keys may contain any of the following characters: ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-~ Note: Each key can only be used for a single login, and cannot be re-used once the user has logged out, or after the key or session has expired