Open topic with navigation

SK_CallXmlWebService Function

Calls a SOLO Server XML web service method.

Remarks

Syntax

C/C++

SK_ResultCode SK_CallXmlWebService(SK_ApiContext context, int flags, const char *url, SK_XmlDoc request, SK_XmlDoc *response, int *resultCode, int *statusCode);

Visual Basic

Declare Function SK_CallXmlWebService(ByVal context As Long, ByVal flags As Long, ByVal url As String, ByVal request As Long, ByRef response As Long, ByRef resultCode As Long, ByRef statusCode As Long) As Long

Arguments

context

The API Context handle.

flags

Any flags passed into this function-call.

url

The SOLO Server XML web service URL to post to (not including http:// or https://). For SOLO Server Shared URL, constants such as SK_CONST_WEBSERVICE_ACTIVATEINSTALLATION_URL are provided.

request

An XML document containing the request content to send to the web service method.

response

Reference/pointer to a SK_XmlDoc handle, which will point to the XML document handle which contains the web service response when the call succeeds. The pointer must be initialized to NULL (0) prior to calling this function.

resultCode

Reference/pointer to an integer, which will point to the result code received from the web service.

statusCode

Reference/pointer to an integer, which will point to the HTTP response status code for this request.

Returns

All possible return values are included in the SK_ResultCode enumeration. Return codes to expect include: