SupportCenter Plus

    General Operations

     

    While invoking the general 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 general operations and its corresponding parameters, please note that the parameters are case sensitive and should be used as defined.

     


    The following operations can be performed on a request through API,  


     

    Logging On to the Application

     

    Through this operation, you can log on to the application.

     

    URL Format

     

     

    The URL format to log on to the Application.

     

    For xml output
     

    http://<server-name>:<port-number>/api/xml/AUTH

     

     

    For json output

     

    http://<server-name>:<port-number>/api/json/AUTH

     

     

    Parameters

     

    The parameters that needs to be passed via HTTP method for updating a request are as follows,

     

     

    Parameter

     

    Value

     

    Description

     

    usesname

     

    string

     

    Login name

     

    password

     

    string

     

    Password to authenticate the application.

     

     

     

    Output Response Format

     

    The output response format for both xml and json consists of three parameters:-

    • response uri: The response uri is the url value sent over HTTP POST or GET method.

    • status: The status denotes the status of the operation. Here there are only two status - Success and Failure.

    • statuscode: The statuscode denotes the code displayed when the status is Success or Failure. For a successful operation, the status code is 200.

    Success

     

    When the operation is successful, the output response format is as given below,

     

    response uri=[url value]

     

    status=Success

     

    statuscode=200

     

     

    Sample Response

     

    response uri="api/xml/AUTH"

     

    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 Response

     

    response uri="api/xml/AUTH"

     

    status=Failure

     

    statuscode=5003

     

    statusmessage=Username and/or password provided is wrong.

     

     

    Sample Input Form

     

    Sample form for the operation 'AUTH' is given below,

     

    <form method="POST" action="http(s)://<server-name>:<port-number>/api/xml/AUTH">

    <input type="hidden" name="apikey" value="[SupportCenter API Key]">

    <input type="text" name="username" value="[Login name]">

    <input type="text" name="password" value="[Password]">

    <input type="submit" name="submit" value="submit">

    </form>  

     

     

    View Business Unit List

     

    This operation displays all the business units to which the support rep belong.

     

    URL Format

     

     

    The URL format for the Request operation - View Business Unit List

     

    For xml output
     

    http://<server-name>:<port-number>/api/xml/getBUINFO

     

     

    For json output

     

    http://<server-name>:<port-number>/api/json/getBUINFO

     

     

    Parameters

     

    The parameter to be passed via HTTP method is,

     

     

    Parameter

     

    Value

     

    Description

     
    apikey

     

    string

     

    SupportCenter API Key.

     

     

    Output Response Format

     

    The output response format for both xml and json consists of three parameters:-

    • response uri: The response uri is the url value sent over HTTP POST method.

    • status: The status denotes the status of the operation. Here there are only two status - Success and Failure.

    • statuscode: The statuscode denotes the code displayed when the status is Success or Failure. For a successful operation, the status code is 200.

    Success

     

    When the operation is successful, the output response format is as given below,

     

    response uri=[url value]

     

    status=Success

     

    statuscode=200

     

     

    Sample Response

     

    response uri="api/xml/getBUINFO"

     

    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 Response

     

    response uri="api/xml/getBUINFO"

     

    status=Failure

     

    statuscode=5000

     

    statusmessage=Invalid api key.

     

     

    Sample Input Form

     

    Sample form for the operation 'getRecentItems' is given below,

     

    <form method="GET" action="http(s)://<server-name>:<port-number>/api/xml/getBUINFO">

    <input type="hidden" name="apikey" value="[SupportCenter-API-Key]">

    <input type="submit" name="submit" value="submit">

    </form>

     

     

    Change Business Unit

     

    Through this operation, you can change the business unit of a user.

     

    URL Format

     

     

    The URL format for the Request operation - View Business Unit List

     

    For xml output
     

    http://<server-name>:<port-number>/api/xml/changeBusinessUnit

     

     

    For json output

     

    http://<server-name>:<port-number>/api/json/changeBusinessUnit

     

     

    Parameters

     

    The parameter to be passed via HTTP method is,

     

     

    Parameter

     

    Value

     

    Description

     
    businessUnit

     

    string

     

    Business Unit

     

     

    Output Response Format

     

    The output response format for both xml and json consists of three parameters:-

    • response uri: The response uri is the url value sent over HTTP POST method.

    • status: The status denotes the status of the operation. Here there are only two status - Success and Failure.

    • statuscode: The statuscode denotes the code displayed when the status is Success or Failure. For a successful operation, the status code is 200.

    Success

     

    When the operation is successful, the output response format is as given below,

     

    response uri=[url value]

     

    status=Success

     

    statuscode=200

     

     

    Sample Response

     

    response uri="api/xml/changeBusinessUnit"

     

    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 Response

     

    response uri="api/xml/changeBusinessUnit"

     

    status=Failure

     

    statuscode=5000

     

    statusmessage=No such Business Unit exists.

     

     

    Sample Input Form

     

    Sample form for the operation 'changeBusinessUnit' is given below,

     

    <form method="POST" action="http(s)://<server-name>:<port-number>/api/xml/changeBusinessUnit">

    <input type="hidden" name="apikey" value="[SupportCenter-API-Key]">

    <input type="text" name="businessUnit" value="[Business Unit]">

    <input type="submit" name="submit" value="submit">

    </form>

     

     

    View Recent Items

     

    This operation displays the recent items viewed by the user from a business unit.

     

    URL Format

     

     

    The URL format for the Request operation - View Recent Items

     

    For xml output
     

    http://<server-name>:<port-number>/api/xml/getRecentItems

     

     

    For json output

     

    http://<server-name>:<port-number>/api/json/getRecentItems

     

     

    Parameters

     

    The parameter to be passed via HTTP method is,

     

     

    Parameter

     

    Value

     

    Description

     
    businessUnit

     

    string

     

    Business Unit

     

    NOTE: Please note that the recent request related items can only be viewed using this operation.

     

     

    Output Response Format

     

    The output response format for both xml and json consists of three parameters:-

    • response uri: The response uri is the url value sent over HTTP POST method.

    • status: The status denotes the status of the operation. Here there are only two status - Success and Failure.

    • statuscode: The statuscode denotes the code displayed when the status is Success or Failure. For a successful operation, the status code is 200.

    Success

     

    When the operation is successful, the output response format is as given below,

     

    response uri=[url value]

     

    status=Success

     

    statuscode=200

     

     

    Sample Response

     

    response uri="api/xml/getRecentItems"

     

    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 Response

     

    response uri="api/xml/getRecentItems"

     

    status=Failure

     

    statuscode=5000

     

    statusmessage=No such Business Unit exists.

     

     

    Sample Input Form

     

    Sample form for the operation 'getRecentItems' is given below,

     

    <form method="GET" action="http(s)://<server-name>:<port-number>/api/xml/getRecentItems">

    <input type="hidden" name="apikey" value="[SupportCenter-API-Key]">

    <input type="text" name="businessUnit" value="[Business Unit]">

    <input type="submit" name="submit" value="submit">

    </form>

     

    Copyright © 2017, ZOHO Corp. All Rights Reserved.