GET api/v{version}/Projects

Gets a list of projects to which the user has access.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

None.

Response Information

Resource Description

A list of projects.

Collection of Project
NameDescriptionTypeAdditional information
Id

The ID of the project.

integer

None.

Name

The name of the project.

string

None.

Identifier

A unique name for the project.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "Project Name",
    "Identifier": "Project 1"
  },
  {
    "Id": 2,
    "Name": "Project Name",
    "Identifier": "Project 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
  <Project>
    <Id>1</Id>
    <Identifier>Project 1</Identifier>
    <Name>Project Name</Name>
  </Project>
  <Project>
    <Id>2</Id>
    <Identifier>Project 2</Identifier>
    <Name>Project Name</Name>
  </Project>
</ArrayOfProject>