api/docs/project/info.md

28 lines
1.4 KiB
Markdown
Raw Normal View History

# `/project/info` - GET
Returns the list of public projects the user is part of.
## Urlencoded Parameters
You have to set one parameter.
Setting none or two parameters will result in a _400 Bad Request_ Response.
| Parameter | Description |
|-----------|-----------------------------------------------------------------------|
| name | The projectname of the user on which the operation will be performed. |
| id | The projectid of the user on which the operation will be performed. |
## Responses
### 200 - Success
__Content - JSON:__
| Field | Description |
|-------------|---------------------------------------------------------------------------|
| id | The projects unique id. |
| name | The projects unique name. |
| description | The projects description. |
| created | The datetime when the project was created. Represented as UNIX timestamp. |
| members | A list of (username, userid) pairs. |
### 400 - Error: Bad Request
The request was malformed.
### 403 - Error: Forbidden
Blocked for security reasons.
### 404 - Error: Not Found
The project wasn't found.