API Documentation for Hillel demo project

Get list of categories

curl -X GET "http://localhost:8081/api/categories?" \
     -H "Content-Type: application/json"

[
  {
    "_id": "58a446fcc26aaf13460533bd",
    "name": "Work"
  }
]

Add new category to all users

Optional parameters

curl -X POST "http://localhost:8081/api/categories" \
     -H "Content-Type: application/json" \
     --data '{}'

{
  "message": "Category created successful"
}

Delete category for all users by id

curl -X DELETE "http://localhost:8081/api/categories/58a446fcc26aaf13460533bd" \
     -H "Content-Type: application/json" \
     --data '{}'

{
  "message": "Category removed successful"
}

Get list of contacts with pagination and search

Optional parameters

curl -X GET "http://localhost:8081/api/phonebook?page=1&limit=25&sort=name&sortValue=1&search=&category=58a446fcc26aaf13460533bd" \
     -H "Content-Type: application/json"

[
  {
    "_id": "58a446fcc26aaf13460533bd",
    "name": "Yurii",
    "surname": "Chikhrai",
    "image": "/img/58a446fcc26aaf13460533bd/awerasef.jpg"
  }
]

Add new contact to phonebook

Optional parameters

curl -X POST "http://localhost:8081/api/phonebook" \
     -H "Content-Type: application/json" \
     --data '{"email":["y.chikhrai@shipnext.com"],"phone":[{"_id":"58a446fcc26aaf13460533bd","category":"mobile","value":"+38096*******"}],"bornDate":"1992-10-19","category":"58a446fcc26aaf13460533bd"}'

{
  "message": "Contact added successful",
  "id": "58a446fcc26aaf13460533bd"
}

Get full information about contact by id

curl -X GET "http://localhost:8081/api/phonebook/58a446fcc26aaf13460533bd?" \
     -H "Content-Type: application/json"

{
  "_id": "58a446fcc26aaf13460533bd",
  "name": "Yurii",
  "surname": "Chikhrai",
  "position": "NodeJS developer as ShipNEXT.com",
  "email": [
    "y.chikhrai@shipnext.com"
  ],
  "phone": [
    {
      "_id": "58a446fcc26aaf13460533bd",
      "category": "mobile",
      "value": "+38096*******"
    }
  ],
  "bornDate": "1992-10-19",
  "category": "58a446fcc26aaf13460533bd",
  "information": "Cool dude.",
  "image": "/img/58a446fcc26aaf13460533bd/awerasef.jpg",
  "addedAt": "2018-04-06T18:18:44.602Z",
  "addedBy": "58a446fcc26aaf13460533bd"
}

Update contact information

Optional parameters

curl -X PUT "http://localhost:8081/api/phonebook/58a446fcc26aaf13460533bd" \
     -H "Content-Type: application/json" \
     --data '{"email":["y.chikhrai@shipnext.com"],"phone":[{"_id":"58a446fcc26aaf13460533bd","category":"mobile","value":"+38096*******"}],"bornDate":"1992-10-19","category":"58a446fcc26aaf13460533bd"}'

{
  "_id": "58a446fcc26aaf13460533bd",
  "name": "Yurii",
  "surname": "Chikhrai",
  "position": "NodeJS developer as ShipNEXT.com",
  "email": [
    "y.chikhrai@shipnext.com"
  ],
  "phone": [
    {
      "_id": "58a446fcc26aaf13460533bd",
      "category": "mobile",
      "value": "+38096*******"
    }
  ],
  "bornDate": "1992-10-19",
  "category": "58a446fcc26aaf13460533bd",
  "information": "Cool dude.",
  "image": "/img/58a446fcc26aaf13460533bd/awerasef.jpg",
  "addedAt": "2018-04-06T18:18:44.602Z",
  "addedBy": "58a446fcc26aaf13460533bd"
}

Delete full information about contact by id

curl -X DELETE "http://localhost:8081/api/phonebook/58a446fcc26aaf13460533bd" \
     -H "Content-Type: application/json" \
     --data '{}'

{
  "message": "Contact deleted successful"
}

Log in into system. Response with header 'set-cookie'. Authorization work on cookie-sessions.

Optional parameters

curl -X POST "http://localhost:8081/api/users/login" \
     -H "Content-Type: application/json" \
     --data '{"email":"y.chikhrai@shipnext.com","password":"*******"}'

{
  "message": "Log in successful"
}

Register into system. Response with header 'set-cookie'. Authorization work on cookie-sessions.

Optional parameters

curl -X POST "http://localhost:8081/api/users/register" \
     -H "Content-Type: application/json" \
     --data '{"email":"y.chikhrai@shipnext.com","password":"*******","name":"Yurii","surname":"Chikhrai"}'

{
  "message": "Register successful"
}