Phases List

# Phaseslist

<Table>
  <thead>
    <tr>
      <th>
        Parameter
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <General />
      </td>

      <td>

      </td>

      <td>
        [IN]

         Parameters described in Overview
      </td>
    </tr>

    <tr>
      <td>
        Company
      </td>

      <td>
        String
      </td>

      <td>
        [IN]

         The users default company number for the companies list
      </td>
    </tr>

    <tr>
      <td>
        Action
      </td>

      <td>
        String
      </td>

      <td>
        [IN]

         Identifier for the list requested
      </td>
    </tr>

    <tr>
      <td>
        Resource
      </td>

      <td>
        String
      </td>

      <td>
        [IN]

         Identifier for the resource context
      </td>
    </tr>

    <tr>
      <td>
        Client 

        [OPTIONAL]
      </td>

      <td>
        String
      </td>

      <td>
        [IN]

         client filter parameter
      </td>
    </tr>

    <tr>
      <td>
        Job 

        [OPTIONAL]
      </td>

      <td>
        String
      </td>

      <td>
        [IN]

         job filter parameter
      </td>
    </tr>

    <tr>
      <td>
        Search 

        [OPTIONAL]
      </td>

      <td>
        String
      </td>

      <td>
        [IN]

         search parameter
      </td>
    </tr>

    <tr>
      <td>
        Phasetype 

        [OPTIONAL]
      </td>

      <td>
        String
      </td>

      <td>
        [IN]

         optional filter
      </td>
    </tr>

    <tr>
      <td>
        Response
      </td>

      <td>
        XML/JSON
      </td>

      <td>
        [OUT]

         An XML tree / JSON string containing phases the user has access to
      </td>
    </tr>
  </tbody>
</Table>

#### Description

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

#### Return Values

Response – List of phases.

The structure of the response is:

```xml
<phases morepages="False" totalpages="1" totalrows="1">
<phase jobphase_uuid="A1D8AD5B2B2041B0A7CAE3E10CBF0464">
<jobphase_displayorder/>
<jobphase_jobandphase>1/00008819.001</jobphase_jobandphase>
<jobphase_phase>001</jobphase_phase>
<variable_phasedescription1stline__jobphase_jobandphase>
copy of activity
</variable_phasedescription1stline__jobphase_jobandphase>
<variable_jobnumber__jobphase_jobnumber>8819
</variable_jobnumber__jobphase_jobnumber>
<variable_jobdescription1stline__jobphase_jobnumber>
My Test copy of activity
</variable_jobdescription1stline__jobphase_jobnumber>
</phase>
</phases>

{
     "errormessage": "",
    "responsecode": 1,
    "pagerows": 0,
    "totalrows": 1,
    "responsestatus": "OK",
    "success": true,
    "responsemessage": "",
    "errorcode": 0,
    "totalpages": 1,
    "pagenumber": 1,
    "data": [
        {
            "uuid": "ACB019FDE89D4E7AB5E3CB149A205EC4",
            "jobphase_jobandphase": "1/00SCP963.001",
        "variable_phasedescription1stline__jobphase_jobandphase__jobphase_jobandphase": "Test Description"
        },
        {
            "jobphase_uuid": "A1D8AD5B2B2041B0A7CAE3E10CBF0464",
            "jobphase_displayorder": "",
            "jobphase_jobandphase": "1/00008819.001",
            "jobphase_phase": "001",
            "variable_phasedescription1stline__jobphase_jobandphase": "copy of activity",
            "variable_jobnumber__jobphase_jobnumber": "8819",
            "variable_jobdescription1stline__jobphase_jobnumber": " copy of activity"
        }

    ]
}