SOAP API - GetAvailableLanguages

GetAvailableLanguages( username ) : Language[] 

Since: EngageIP v25.2

Returns the available Languages for the specified user name.

The returned value from this method call is an array of Language objects.  A language object consists of the following properties:

  • ID (Integer) - The unique ID of the language

  • Name (String) - The name of the language

  • OwnerID (Integer) - The owner ID for which this language belongs

  • SortOrder (Integer) - The sort order number of this language for where it belongs in the list of languages.

  • Maintainer (String) - Email address that will be sent notifications regarding missing translations for the language

Parameters:

  • username (String) - The username for which to retrieve the list of languages.  An exception will be thrown if the username does not exist.

Returns:

An array of Language objects for the specified user

Possible Exceptions:

  • INVALID USERNAME


SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1 Host: demo.logisense.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Header> <AuthHeader xmlns="Logisense_EngageIP"> <Username>string</Username> <Password>string</Password> </AuthHeader> </soap12:Header> <soap12:Body> <GetAvailableLanguages xmlns="Logisense_EngageIP"> <username>string</username> </GetAvailableLanguages> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetAvailableLanguagesResponse xmlns="Logisense_EngageIP"> <GetAvailableLanguagesResult> <Language> <Validate /> <ID>int</ID> <Name>string</Name> <OwnerID>int</OwnerID> <SortOrder>int</SortOrder> <Maintainer>string</Maintainer> </Language> <Language> <Validate /> <ID>int</ID> <Name>string</Name> <OwnerID>int</OwnerID> <SortOrder>int</SortOrder> <Maintainer>string</Maintainer> </Language> </GetAvailableLanguagesResult> </GetAvailableLanguagesResponse> </soap12:Body> </soap12:Envelope>



SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1 Host: demo.logisense.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "Logisense_EngageIP/GetAvailableLanguages" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <AuthHeader xmlns="Logisense_EngageIP"> <Username>string</Username> <Password>string</Password> </AuthHeader> </soap:Header> <soap:Body> <GetAvailableLanguages xmlns="Logisense_EngageIP"> <username>string</username> </GetAvailableLanguages> </soap:Body> </soap:Envelope>