Delete Bportal task

bportalTaskDelete(p_companyID, p_code)

 

You can use this endpoint to delete a task from our software.

Parameters

Name Type Required Description
p_companyID string Yes The security code you have been provided with, string (32)
p_code string Yes We will look to delete the Task which has it's code value equal to the supplied value.

Return values

DELETED – the Task was successfully deleted.

ERROR_NO_SECURITY_HASH - user did not supply p_companyId security code.

ERROR_UNKNOWN_SECURITY_HASH - supplied security code p_companyId is invalid.

TASK_NOT_FOUND – no Task was found with the given p_code

CAN_NOT_DELETE_HAS_CHILDREN_TASK – no Task can be deleted if it is linked to childrens (projects to activities or activities to subactivities).

CAN_NOT_DELETE_HAS_PARENT_TASK – no Task can be deleted if it is linked to parents (activities to projects or subactivities to activities).

Sample

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uen="uen:esws">
<soapenv:Header/>
<soapenv:Body>
<uen:Esws.bportalTaskDelete soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<p_companyID xsi:type="xsd:string">^4p;tU0Q+#dEIhTWkuj5FnLD^aOLqVu0</p_companyID>
<p_code xsi:type="xsd:string">2222</p_code>
</uen:Esws.bportalTaskDelete>
</soapenv:Body>
</soapenv:Envelope>

Response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="uen:esws">
<SOAP-ENV:Body>
<ns1:Esws.bportalTaskDeleteResponse xmlns:ns1="uen:esws">
<return xsi:type="xsd:string">DELETED</return>
</return>
</ns1:Esws.bportalTaskDeleteResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>