Projecten

Authenticatie vereist

Met deze resource kunnen projecten van u opgehaald en aangemaakt worden.

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
GET Collectie Projects.read
POST Collectie Projects.write
GET List Projects.read
GET Element Projects.read
POST Element Projects.write
DELETE Element Projects.write

Resource Containments

Depth Resource
0 Geen containments
1
2

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van het project. Ja Nee Nee
contact_id   Ja Ja Nee
client_count   Ja Ja Nee
reference   Ja Ja Nee
name   Ja Ja Ja
description   Ja Ja Nee
status
  1. 1 Concept
  2. 2 Geoffreerd
  3. 3 In behandeling
  4. 4 Afgerond
  5. 5 Geannuleerd
  6. 6 Gearchiveerd
  7. 7 Gefactureerd
 Ja Ja Nee
date_start   Ja Ja Nee
date_deadline   Ja Ja Nee
created   Ja Nee Nee
modified   Ja Nee Nee
display_code   Ja Ja Nee

Collectie GET

GET Collectie

Een GET request op de collectie zal resulteren in een volledige lijst van uw projecten.

https://api.workspace.nl/api/v1/projects.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "code": 200,
        "data": {
            "count": 2,
            "Projects": [
                {
                    "Project": {
                        "id": "1",
                        "contact_id": "1",
                        "client_count": "0",
                        "reference": null,
                        "name": "Project API",
                        "description": null,
                        "status": "1",
                        "date_start": "2016-05-23",
                        "date_deadline": "2016-05-23",
                        "created": "2016-05-23 15:16:27",
                        "modified": "2016-05-23 15:16:47",
                        "display_code": "0"
                    },
                    "Contact": []
                },
                {
                    "Project": {
                        "id": "2",
                        "contact_id": "2",
                        "client_count": "0",
                        "reference": null,
                        "name": "Project Android",
                        "description": null,
                        "status": "4",
                        "date_start": "2016-05-23",
                        "date_deadline": "2016-05-23",
                        "created": "2016-05-23 15:16:27",
                        "modified": "2016-05-23 15:16:47",
                        "display_code": "0"
                    },
                    "Contact": []
                }
            ]
        }
    }
}

Mogelijke filter parameters

Veld Parameter Type Beschrijving
date_deadline deadline_from Datum De vanafdatum om te sorteren
date_deadline deadline_to Datum De einddatum om te sorteren
name name LIKE %{name}% Matchen op karakterbasis zowel links als rechts van het veld

Collectie POST

POST Collectie

Een POST request op de collectie zal resulteren in het aanmaken van een nieuw element.

https://api.workspace.nl/api/v1/projects.json

Let op

Bij een POST Request via het HTTP protocol wordt de header Content-Type: application/x-www-form-urlencoded verwacht.

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
POST 400 Bad Request Something went wrong while saving the data.

List GET

GET List

Een GET request op de list zal resulteren in een volledige lijst van uw projecten waarbij de key het ID betreft en de valueDe project naam.

https://api.workspace.nl/api/v1/projects/list.json
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "code": 200,
        "data": {
            "Projects": {
                "1": "Project API",
                "2": "Project Android"
            }
        }
    }
}

Mogelijke filter parameters

Veld Parameter Type Beschrijving
date_deadline deadline_from Datum De vanafdatum om te sorteren
date_deadline deadline_to Datum De einddatum om te sorteren
name name LIKE %{name}% Matchen op karakterbasis zowel links als rechts van het veld

ELEMENT GET

GET Element

Een GET request op het element zal resulteren op een enkele project.

https://api.workspace.nl/api/v1/projects/{id}.json
Parameters
{id} Het indentificatie nummer van de project in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "code": 200,
        "data": {
            "Project": {
                "id": "1",
                "contact_id": "1",
                "client_count": "0",
                "reference": null,
                "name": "Project API",
                "description": null,
                "status": "1",
                "date_start": "2016-05-23",
                "date_deadline": "2016-05-23",
                "created": "2016-05-23 15:16:27",
                "modified": "2016-05-23 15:16:47",
                "display_code": "0"
            },
            "Contact": []
        }
    }
}

ELEMENT POST

POST Element

Een POST request op het element zal resulteren in het aanpassen van het element. Alleen specifieke velden zijn aanpasbaar.

https://api.workspace.nl/api/v1/projects/{id}.json
Parameters
{id} Het indentificatie nummer van de project in formaat (0-9)

Let op

Bij een POST Request via het HTTP protocol wordt de header Content-Type: application/x-www-form-urlencoded verwacht.

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
POST 400 Bad Request Something went wrong while saving the data.
POST 404 Not Found Purchase not found.

ELEMENT DELETE

DELETE Element

Een DELETE request op het element zal resulteren in het verwijderen van het element.

https://api.workspace.nl/api/v1/projects/{id}.json
Parameters
{id} Het indentificatie nummer van de project in formaat (0-9)

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
DELETE 404 Not Found Purchase not found.