Web Services (SOAP)

Last updated
Save as PDF

The Kinetic Task SOAP API exposes Kinetic Task API calls via a SOAP based web service. SOAP is a protocol that utilizes formatted XML "messages" sent over HTTP. For more information about SOAP, see http://www.w3.org/TR/soap/.

Details

Just like the other API options, the SOAP API exposes the createStart and createDeferred methods. For more information about utilizing the createStart and createDeferred API methods, please see the parent API Reference page.

The Kinetic Task SOAP API can be accessed using the following URLs, where SERVER is the ip address or domain name of the machine that is running Kinetic Task and PORT is the TCP port number that Kinetic Task is running under.

Endpoint URL	http://SERVER:PORT/kineticTask/soap/v1/Trigger
WSDL Definition	http://SERVER:PORT/kineticTask/soap/v1/Trigger?wsdl
WSDL Schema	http://SERVER:PORT/kineticTask/soap/v1/Trigger?xsd=1

Sample Messages - createStart

Success

Request

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:createStart xmlns:ns2="urn:v1:TriggerService">
            <ns2:source_name>Kinetic Request</ns2:source_name>
            <ns2:source_group>Kinetic Service Center &gt; iPad Request</ns2:source_group>
            <ns2:source_id>AG005056b50003ralGTwMDGfEgBLzN</ns2:source_id>
            <ns2:tree_name>Procure iPad</ns2:tree_name>
        </ns2:createStart>
    </S:Body>
</S:Envelope>

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header/>
    <S:Body>
        <ns2:createStartResponse xmlns:ns2="urn:v1:TriggerService">
            <Id>AG0050569600512R6IUQatAWsAIBtM</Id>
        </ns2:createStartResponse>
    </S:Body>
</S:Envelope>

API Error

Request

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:createStart xmlns:ns2="urn:v1:TriggerService">
            <ns2:source_name>Kinetic Request</ns2:source_name>
            <ns2:source_group>Kinetic Service Center &gt; iPad Request</ns2:source_group>
            <ns2:source_id>AG005056b50003ralGTwMDGfEgBLzN</ns2:source_id>
            <ns2:tree_name>Missing Tree</ns2:tree_name>
        </ns2:createStart>
    </S:Body>
</S:Envelope>

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header/>
    <S:Body>
        <S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
            <faultcode>S:Server</faultcode>
            <faultstring>Unable to locate a tree with the specified source name (Kinetic Request), source group (Kinetic Service Center > iPad Request), and tree name (Missing Tree).</faultstring>
        </S:Fault>
    </S:Body>
</S:Envelope>

Authorization Error

Request

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:createStart xmlns:ns2="urn:v1:TriggerService">
            <ns2:source_name>Kinetic Request</ns2:source_name>
            <ns2:source_group>Kinetic Service Center &gt; iPad Request</ns2:source_group>
            <ns2:source_id>AG005056b50003ralGTwMDGfEgBLzN</ns2:source_id>
            <ns2:tree_name>Procure iPad</ns2:tree_name>
        </ns2:createStart>
    </S:Body>
</S:Envelope>

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header/>
    <S:Body>
        <S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
            <faultcode>S:Server</faultcode>
            <faultstring>request does not originate from IP whitelist (192.168.159.1)</faultstring>
        </S:Fault>
    </S:Body>
</S:Envelope>

Sample Messages - createDeferred

Success

Request

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:createDeferred xmlns:ns2="urn:v1:TriggerService">
            <ns2:token>e67069a7392dc8ca7347f2edd127f779ef440dc1</ns2:token>
            <ns2:action>Complete</ns2:action>
            <ns2:results>&lt;results&gt;&lt;result name="Procurement Id"&gt;PID1101&lt;/result&gt;&lt;/results&gt;</ns2:results>
        </ns2:createDeferred>
    </S:Body>
</S:Envelope>

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header/>
    <S:Body>
        <ns2:createDeferredResponse xmlns:ns2="urn:v1:TriggerService">
            <Id>AG005056960051tCKIUQM-AlsAOyRM</Id>
        </ns2:createDeferredResponse>
    </S:Body>
</S:Envelope>

API Error

Request

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:createDeferred xmlns:ns2="urn:v1:TriggerService">
            <ns2:token>e67069a7392dc8ca7347f2edd127f779ef440dc1</ns2:token>
            <ns2:action>Complete</ns2:action>
            <ns2:results>&lt;results&gt;&lt;result name="Procurement Id"&gt;PID1101&lt;/result&gt;&lt;/results&gt;</ns2:results>
        </ns2:createDeferred>
    </S:Body>
</S:Envelope>

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header/>
    <S:Body>
        <S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
            <faultcode>S:Server</faultcode>
            <faultstring>Unable to locate a task instance with the specified deferral token (e67069a7392dc8ca7347f2edd127f779ef440dc1)</faultstring>
        </S:Fault>
    </S:Body>
</S:Envelope>

Authorization Error

Request

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:createDeferred xmlns:ns2="urn:v1:TriggerService">
            <ns2:token>e67069a7392dc8ca7347f2edd127f779ef440dc1</ns2:token>
            <ns2:action>Complete</ns2:action>
            <ns2:results>&lt;results&gt;&lt;result name="Procurement Id"&gt;PID1101&lt;/result&gt;&lt;/results&gt;</ns2:results>
        </ns2:createDeferred>
    </S:Body>
</S:Envelope>

Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header/>
    <S:Body>
        <S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
            <faultcode>S:Server</faultcode>
            <faultstring>security token not provided</faultstring>
        </S:Fault>
    </S:Body>
</S:Envelope>