Ferrysoft
Ferrysoft Help Desk SDK

Ferrysoft Help Desk

Click to learn more about Ferrysoft Help Desk

Ferrysoft Help Desk is a web based help desk solution. The Express Edition is free of charge. Click the screen shot to learn more about Ferrysoft Help Desk.

Integrating with the Ferrysoft Help Desk web services layer

Overview

It is possible to integrate with the Ferrysoft Help Desk web services layer by invoking the web services provided on a Ferrysoft Help Desk server. This section describes the available web services. The web services are available at the following URL (where server is the name of the server where Ferrysoft Help Desk is installed):

http://server/ferrysofthelpdesk/webservices/

Operations

Name Description
CloseCase This method closes the specified case.
CreateCase This method creates a new case.
DeleteCase This method deletes the specified case.
ReadCase This method retrieves the specified case.
ReopenCase This method reopens the specified case.
UndeleteCase This method undeletes the specified case.
UpdateCase This method updates the specified case.

CloseCase

CloseCase Request

<?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>
        <CloseCase xmlns="http://ferrysoft.com/webservices/">
            <Username>string</Username>
            <Password>string</Password>
            <CaseID>int</CaseID>
            <ExceptionMessage>string</ExceptionMessage>
        </CloseCase>
    </soap12:Body>
</soap12:Envelope>
Name Description
Username Must be a valid contact username.
Password Must be a valid password for the username.
CaseID Must be a valid case that the contact is authorised to access.
ExceptionMessage Only applicable in the response.

CloseCase Response

<?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>
        <CloseCaseResponse xmlns="http://ferrysoft.com/webservices/">
            <CloseCaseResult>int</CloseCaseResult>
            <ExceptionMessage>string</ExceptionMessage>
        </CloseCaseResponse>
    </soap12:Body>
</soap12:Envelope>
Name Description
CloseCaseResult 0-Success.
2-Authentication failed.
3-Case not found.
4-Case access denied.
5-Close failed.
ExceptionMessage If successful then this is blank. If unsuccessful then this is a textual description of the reason for the failure.

CreateCase

CreateCase Request

<?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>
        <CreateCase xmlns="http://ferrysoft.com/webservices/">
            <Username>string</Username>
            <Password>string</Password>
            <CaseName>string</CaseName>
            <CaseDescription>string</CaseDescription>
            <Closed>boolean</Closed>
            <CaseID>int</CaseID>
            <ExceptionMessage>string</ExceptionMessage>
        </CreateCase>
    </soap12:Body>
</soap12:Envelope>
Name Description
Username Must be a valid contact username.
Password Must be a valid password for the username.
CaseName A one line case name.
CaseDescription A multi-line case description.
Closed A true/false indicator of whether the case is closed.
CaseID Only applicable in the response.
ExceptionMessage Only applicable in the response.

CreateCase Response

<?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>
        <CreateCaseResponse xmlns="http://ferrysoft.com/webservices/">
            <CreateCaseResult>int</CreateCaseResult>
            <CaseID>int</CaseID>
            <ExceptionMessage>string</ExceptionMessage>
        </CreateCaseResponse>
    </soap12:Body>
</soap12:Envelope>
Name Description
CreateCaseResult 0-Success.
2-Authentication failed.
4-Case access denied.
5-Create failed.
CaseID If successful then this is the CaseID of the new case. If unsuccessful then this is zero.
ExceptionMessage If successful then this is blank. If unsuccessful then this is a textual description of the reason for the failure.

DeleteCase

DeleteCase Request

<?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>
        <DeleteCase xmlns="http://ferrysoft.com/webservices/">
            <Username>string</Username>
            <Password>string</Password>
            <CaseID>int</CaseID>
            <ExceptionMessage>string</ExceptionMessage>
        </DeleteCase>
    </soap12:Body>
</soap12:Envelope>
Name Description
Username Must be a valid contact username.
Password Must be a valid password for the username.
CaseID Must be a valid case that the contact is authorised to access.
ExceptionMessage Only applicable in the response.

DeleteCase Response

<?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>
        <DeleteCaseResponse xmlns="http://ferrysoft.com/webservices/">
            <DeleteCaseResult>int</DeleteCaseResult>
            <ExceptionMessage>string</ExceptionMessage>
        </DeleteCaseResponse>
    </soap12:Body>
</soap12:Envelope>
Name Description
DeleteCaseResult 0-Success.
2-Authentication failed.
3-Case not found.
4-Case access denied.
5-Delete failed.
ExceptionMessage If successful then this is blank. If unsuccessful then this is a textual description of the reason for the failure.

ReadCase

ReadCase Request

<?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>
        <ReadCase xmlns="http://ferrysoft.com/webservices/">
            <Username>string</Username>
            <Password>string</Password>
            <CaseID>int</CaseID>
            <CaseName>string</CaseName>
            <CaseDescription>string</CaseDescription>
            <Deleted>boolean</Deleted>
            <Closed>boolean</Closed>
            <ExceptionMessage>string</ExceptionMessage>
        </ReadCase>
    </soap12:Body>
</soap12:Envelope>
Name Description
Username Must be a valid contact username.
Password Must be a valid password for the username.
CaseID Must be a valid case that the contact is authorised to access.
CaseName Only applicable in the response.
CaseDescription Only applicable in the response.
Deleted Only applicable in the response.
Closed Only applicable in the response.
ExceptionMessage Only applicable in the response.

ReadCase Response

<?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>
        <ReadCaseResponse xmlns="http://ferrysoft.com/webservices/">
            <ReadCaseResult>int</ReadCaseResult>
            <CaseName>string</CaseName>
            <CaseDescription>string</CaseDescription>
            <Deleted>boolean</Deleted>
            <Closed>boolean</Closed>
            <ExceptionMessage>string</ExceptionMessage>
        </ReadCaseResponse>
    </soap12:Body>
</soap12:Envelope>
Name Description
ReadCaseResult 0-Success.
2-Authentication failed.
3-Case not found.
4-Case access denied.
CaseName If successful then this is the one line case name. If unsuccessful then this is blank.
CaseDescription If successful then this is the multi-line case description. If unsuccessful then this is blank
Deleted If successful then this is a true/false indicator of whether the case is deleted. If unsuccessful then this is false.
Closed If successful then this is a true/false indicator of whether the case is closed. If unsuccessful then this is false.
ExceptionMessage If successful then this is blank. If unsuccessful then this is a textual description of the reason for the failure.

ReopenCase

ReopenCase Request

<?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>
        <ReopenCase xmlns="http://ferrysoft.com/webservices/">
            <Username>string</Username>
            <Password>string</Password>
            <CaseID>int</CaseID>
            <ExceptionMessage>string</ExceptionMessage>
        </ReopenCase>
    </soap12:Body>
</soap12:Envelope>
Name Description
Username Must be a valid contact username.
Password Must be a valid password for the username.
CaseID Must be a valid case that the contact is authorised to access.
ExceptionMessage Only applicable in the response.

ReopenCase Response

<?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>
        <ReopenCaseResponse xmlns="http://ferrysoft.com/webservices/">
            <ReopenCaseResult>int</ReopenCaseResult>
            <ExceptionMessage>string</ExceptionMessage>
        </ReopenCaseResponse>
    </soap12:Body>
</soap12:Envelope>
Name Description
ReopenCaseResult 0-Success.
2-Authentication failed.
3-Case not found.
4-Case access denied.
5-Reopen failed.
ExceptionMessage If successful then this is blank. If unsuccessful then this is a textual description of the reason for the failure.

UndeleteCase

UndeleteCase Request

<?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>
        <UndeleteCase xmlns="http://ferrysoft.com/webservices/">
            <Username>string</Username>
            <Password>string</Password>
            <CaseID>int</CaseID>
            <ExceptionMessage>string</ExceptionMessage>
        </UndeleteCase>
    </soap12:Body>
</soap12:Envelope>
Name Description
Username Must be a valid contact username.
Password Must be a valid password for the username.
CaseID Must be a valid case that the contact is authorised to access.
ExceptionMessage Only applicable in the response.

UndeleteCase Response

<?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>
        <UndeleteCaseResponse xmlns="http://ferrysoft.com/webservices/">
            <UndeleteCaseResult>int</UndeleteCaseResult>
            <ExceptionMessage>string</ExceptionMessage>
        </UndeleteCaseResponse>
    </soap12:Body>
</soap12:Envelope>
Name Description
UndeleteCaseResult 0-Success.
2-Authentication failed.
3-Case not found.
4-Case access denied.
5-Undelete failed.
ExceptionMessage If successful then this is blank. If unsuccessful then this is a textual description of the reason for the failure.

UpdateCase

UpdateCase Request

<?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>
        <UpdateCase xmlns="http://ferrysoft.com/webservices/">
            <Username>string</Username>
            <Password>string</Password>
            <CaseID>int</CaseID>
            <CaseName>string</CaseName>
            <CaseDescription>string</CaseDescription>
            <NewComment>string</NewComment>
            <Closed>boolean</Closed>
            <ExceptionMessage>string</ExceptionMessage>
        </UpdateCase>
    </soap12:Body>
</soap12:Envelope>
Name Description
Username Must be a valid contact username.
Password Must be a valid password for the username.
CaseID Must be a valid case that the contact is authorised to access.
CaseName A one line case name. If CaseName is blank then no change is made to the case name.
CaseDescription A multi-line case description. If CaseDescription is blank then no change is made to the case description.
NewComment A multi-line new comment to append to the case. If NewComment is blank then no new comment is appended to the case.
Closed A true/false indicator of whether the case is closed.
ExceptionMessage Only applicable in the response.

UpdateCase Response

<?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>
        <UpdateCaseResponse xmlns="http://ferrysoft.com/webservices/">
            <UpdateCaseResult>int</UpdateCaseResult>
            <ExceptionMessage>string</ExceptionMessage>
        </UpdateCaseResponse>
    </soap12:Body>
</soap12:Envelope>
Name Description
UpdateCaseResult 0-Success.
1-Request parameter invalid.
2-Authentication failed.
3-Case not found.
4-Case access denied.
5-Update failed.
ExceptionMessage If successful then this is blank. If unsuccessful then this is a textual description of the reason for the failure.