Solution Related Operations
While invoking the solutions related operations through API, the operation defined are based on the parameter value, and the developer needs to submit a request to the url via HTTP POST or GET method.
NOTE: Before proceeding with the solution related operations and its corresponding parameters, please note that the parameters are case sensitive and should be used as defined.
The operations that can be performed over solutions is,
The solutions can be viewed based on the Solution Id or by conducting a search using keywords.
URL Format
Parameters
Either of the following parameters should be passed via HTTP method.
Output Response Format
The output response format for both xml and json consists of three parameters:
Success
When the operation is successful, the output response format is as given below,
response uri=[url value]
status=Success
statuscode=200
Error
Errors occur when the API Key is not valid or the parameter value does not exist in the application. In such cases, the output format is as shown below,
response uri=[url value]
status=Failure
statuscode=failurecode
Sample Input Form
Sample form for the operation 'getSolution' is given below,
<form method="POST" action="http(s)://<server-name>:<port-number>/api/xml/getSolution"> <input type="hidden" name="apikey" value="[SupportCenter-API-Key]"> <input type="text" name="id" value="[Your solution ID]"> <input type="text" name="search" value="[Your solution search keyword]"> <input type="submit" name="submit" value="submit"> </form> |