Retrieve list of one or more tasks

bportalTasksGet(p_companyID, p_levelId, p_code)

 

You can use this endpoint to retrieve a list of one or more task from our software.

Parameters

Name Type Required Description
p_companyID string Yes The security code you have been provided with, string (32)
p_companyID string No If something provided, the returned Task(s) will be filtered based on the level supplied
p_code string No If something provided we will return one single Task which has the correct code.

NOTE:If neither p_levelId or p_code values are supplied, we will return all Tasks.

Return values

bportalTaskObjectArray, containing structs (arrays) of bportalTaskObject with the following keys (all values are returned as strings):

id: the Task's unique identifier in our db

name

code

level_id: possible values are 1, 2, 3

start_date: yyyy-mm-dd format

end_date: yyyy-mm-dd format

estimated_hours

parents: a json encoded array, containing the codes of it's parents (example: ["project1","project2"])

children: a json encoded array, containing the codes of it's children (example: ["subactivity1","subactivity2"]). If an error will occur during the function call, in the bportalTaskObject structure's id field we will return one of the following error messages:

ERROR_NO_SECURITY_HASH - user did not supply p_companyId security code

ERROR_UNKNOWN_SECURITY_HASH - supplied security code p_companyId is invalid

NO_TASK(S) - no task was found in the db (with the given filters)

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.bportalTasksGet soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<p_companyID xsi:type="xsd:string">^4p;tU0Q+#dEIhTWkuj5FnLD^aOLqVu0</p_companyID>
<p_levelId xsi:type="xsd:string"></p_levelId>
<p_code xsi:type="xsd:string"></p_code>
</uen:Esws.bportalTasksGet>
</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.bportalTasksGetResponse xmlns:ns1="uen:esws">
<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:bportalTaskObject[1]">
<item xsi:type="tns:bportalTaskObject">
<id xsi:type="xsd:string">1</id>
<name xsi:type="xsd:string">Identysoft</name>
<code xsi:type="xsd:string">0100</code>
<level_id xsi:type="xsd:string">1</level_id>
<start_date xsi:type="xsd:string">08-01-2018</start_date>
<end_date xsi:type="xsd:string">28-02-2019</end_date>
<estimated_hours xsi:type="xsd:string">23</estimated_hours>
<parents xsi:type="xsd:string"/>
<children xsi:type="xsd:string">["0023","6666","AC01","001"]</children>
</return>
</ns1:Esws.bportalTasksGetResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>