Jobs List

Jobslist

Parameter

Type

Description

[IN]

Parameters described in Overview

Company

String

[IN]

The users default company number for the companies list

Action

String

[IN]

Identifier for the list requested

Resource

String

[IN]

Identifier for the resource context

Client

[OPTIONAL]

String

[IN]

client filter parameter

Search

[OPTIONAL]

String

[IN]

search parameter

Response

XML/JSON

[OUT]

An XML tree / JSON string containing jobs the user has access to

Description

Calling the timesheets API with an action of jobslist retrieves a list of job numbers and associated 1st line of job description.

Return Values

Response – List of jobs.

The structure of the response is:

<jobs morepages="False" totalpages="1" totalrows="1">
<job jobheader_uuid="46E920602EE14F9DA56EF722ADF2AFFD">
<jobheader_jobnumber>1/00000597</jobheader_jobnumber>
<variable_jobnumber__jobheader_jobnumber>597
</variable_jobnumber__jobheader_jobnumber>
<variable_jobdescription1stline__jobheader_jobnumber>
Test Global Description
</variable_jobdescription1stline__jobheader_jobnumber>
</job>
</jobs>
{
    "errormessage": "",
    "responsecode": 1,
    "pagerows": 0,
    "totalrows": 1,
    "responsestatus": "OK",
    "success": true,
    "responsemessage": "",
    "errorcode": 0,
    "totalpages": 1,
    "pagenumber": 1,
    "data": [
        	{
            "jobheader_uuid": "EE56359071D548D3A0A6F176DE14CB67",
            "jobheader_jobnumber": "1/00000730",
            "variable_jobnumber__jobheader_jobnumber": "730",
            "variable_jobdescription1stline__jobheader_jobnumber": "Synergist Systems"
        }
    ]
}