GET api/TrackTimeProjects/GetProjects?pageIndex={pageIndex}&pageSize={pageSize}

Gets a list of all Track time projects. Pagination is supported.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageIndex

Optional page index (default is 0).

integer

None.

pageSize

Optional page size (default is 200).

integer

None.

Body Parameters

None.

Response Information

Resource Description

GetTrackTimeProjectsResult
NameDescriptionTypeAdditional information
PagedTrackTimeProjects

A page with Track time project rows.

GetTrackTimeProjectResult

None.

Response Formats

application/json, text/json

Sample:
{
  "PagedTrackTimeProjects": {
    "PageIndex": 0,
    "PageSize": 10,
    "TotalItems": 2,
    "TotalPages": 1,
    "Items": [
      {
        "Id": 1,
        "Name": "Default project",
        "Code": "1",
        "Color": "#ffffff",
        "IsArchived": false,
        "Description": null
      },
      {
        "Id": 2,
        "Name": "Archived project",
        "Code": "2",
        "Color": "#ffffff",
        "IsArchived": true,
        "Description": null
      }
    ]
  }
}

application/xml, text/xml

Sample:
<GetTrackTimeProjectsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedTrackTimeProjects>
    <Items>
      <GetTrackTimeProjectResult>
        <Code>1</Code>
        <Color>#ffffff</Color>
        <Description i:nil="true" />
        <Id>1</Id>
        <IsArchived>false</IsArchived>
        <Name>Default project</Name>
      </GetTrackTimeProjectResult>
      <GetTrackTimeProjectResult>
        <Code>2</Code>
        <Color>#ffffff</Color>
        <Description i:nil="true" />
        <Id>2</Id>
        <IsArchived>true</IsArchived>
        <Name>Archived project</Name>
      </GetTrackTimeProjectResult>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
    <TotalItems>2</TotalItems>
    <TotalPages>1</TotalPages>
  </PagedTrackTimeProjects>
</GetTrackTimeProjectsResult>