8000 Project API · mifort-org/mifort-timesheet Wiki · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Project API

Jump to bottom
Andrew Voitov edited this page Mar 28, 2016 · 4 revisions

Get a project by id

Property Value
Method GET
URL /api/v1/project/<projectId>
Parameters projectId - unique project id
Content-Type application/json
Response: 
{
    "id":"13",
    "name":"Super Project",
    "description": "Bla bla bla",
    "createdOn": "01/01/2015",
    "updatedOn": "01/02/2015",
    "template": {
        "date": "",
        "role": "",
        "time": "4",
        "comment": ""
    },
    "defaultValues": [
        {
            "date": "01/01/2015",
            "comment": "AAAAA"
        }
    ],
    "periods" : [
        {
            "start": "01/01/2015",
            "end": "02/01/2015"
        }
    ]
}

Save/update a project

Property Value
Method POST
URL /api/v1/project
Content-Type application/json
Body: 
{
    //if id not empty - update, else -create
    "name":"Super Project",
    "description": "Bla bla bla",
    "companyId": "56575e5f4e17567c266c0243"
}

Response:

{
    //saved object
}

Get projects by company id (Returns only active projects)

Property Value
Method GET
URL /api/v1/project/list?companyId=<companyId>
Parameters companyId- unique company id
Content-Type application/json
Response: 
[{
    "id":"13",
    "name":"Super Project",
    "description": "Bla bla bla",
    "createdOn": "01/01/2015",
    "updatedOn": "01/02/2015",
    "active": true,
    "template": {
        "date": "",
        "role": "",
        "time": "4",
        "comment": ""
    },
    "defaultValues": [
        {
            "date": "01/01/2015",
            "comment": "AAAAA"
        }
    ],
    "periods" : [
        {
            "start": "01/01/2015",
            "end": "02/01/2015"
        }
    ]
}]

Deactivate project

Property Value
Method GET
URL /api/v1/project/deactivate/
Parameters projectId - unique project id
Content-Type application/json
Response: 
{
    "_id":"13",
    "name":"Super Project",
    "description": "Bla bla bla",
    "createdOn": "01/01/2015",
    "updatedOn": "01/02/2015",
    "active": false,
    "template": {
        "date": "",
        "role": "",
        "time": "4",
        "comment": ""
    },
    "defaultValues": [
        {
            "date": "01/01/2015",
            "comment": "AAAAA"
        }
    ],
    "periods" : [
        {
            "start": "01/01/2015",
            "end": "02/01/2015"
        }
    ]
}

Activate/Restore project

Property Value
Method GET
URL /api/v1/project/activate/
Parameters projectId - unique project id
Content-Type application/json
Response: 
{
    "_id":"13",
    "name":"Super Project",
    "description": "Bla bla bla",
    "createdOn": "01/01/2015",
    "updatedOn": "01/02/2015",
    "active": true,
    "template": {
        "date": "",
        "role": "",
        "time": "4",
        "comment": ""
    },
    "defaultValues": [
        {
            "date": "01/01/2015",
            "comment": "AAAAA"
        }
    ],
    "periods" : [
        {
            "start": "01/01/2015",
            "end": "02/01/2015"
        }
    ]
}

Delete project

Property Value
Method DELETE
URL /api/v1/project/<projectId>
Parameters projectId - unique project id
Content-Type application/json
Response: 
204 No content

© 2016 - 2018 Mifort.org

Table of Contents

Clone this wiki locally
0