d-pac

Base URI

http://tool.d-pac.be/api

string required

A valid, activated e-mail address

Example:

john.doe@example.com

Operations: Signin Update authenticated user Update user

password

string required

Example:

Foo15^

Operations: Signin Update authenticated user Update user

password_confirm

string required

Example:

Foo15^

Operations: Signin Update authenticated user Update user

Request-UUID

string optional

Applied to all operations

Pass a unique id for each request for easier tracking of requests logs on the back-end

401 Unauthorized

You are not authorized

Body

Error

Operations: Signin

400 Bad Request

The server cannot or will not process the request due to something that is perceived to be a client error.

Body

Error

Operations: Signin

Lorem ipsum

Signin

POST /user/session

Status

GET /user/session

Signout

DELETE /user/session

POST /user/session

Creates a session, i.e. authenticates the user.

Request parameters

string required

A valid, activated e-mail address

Example:

john.doe@example.com

password

string required

Example:

Foo15^

password_confirm

string required

Example:

Foo15^

Request headers

Request-UUID

string optional

Pass a unique id for each request for easier tracking of requests logs on the back-end

Responses

200 OK

Body

UserModel

401 Unauthorized

You are not authorized

400 Bad Request

The server cannot or will not process the request due to something that is perceived to be a client error.

Examples

POST http://tool.d-pac.be/api/user/session?email=john.doe@example.com&password=Foo15^&password_confirm=Foo15^ HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "53a984cca87b4b7d57a99858",
    "email": "john.doe@example.com",
    "name": {
        "first": "John",
        "last": "Doe"
    }
}

POST http://tool.d-pac.be/api/user/session HTTP/1.1 

Content-Type: application/json

{
    "email": "john.doe@example.com",
    "password": "Foo15^"
    "password_confirm": "Foo15^"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "53a984cca87b4b7d57a99858",
    "email": "john.doe@example.com",
    "name": {
        "first": "John",
        "last": "Doe"
    }
}

GET /user/session

Retrieves the authentication status

Request headers

Request-UUID

string optional

Pass a unique id for each request for easier tracking of requests logs on the back-end

Responses

200 OK

Body

UserModel

DELETE /user/session

Request headers

Request-UUID

string optional

Pass a unique id for each request for easier tracking of requests logs on the back-end

Responses

204 No Content

Access and modify account details

List users

GET /users

Retrieve user

GET /users/{id}

Update user

PATCH /users/{id}

Retrieve authenticated user

GET /user

Update authenticated user

PATCH /user

GET /users

Request headers

Request-UUID

string optional

Pass a unique id for each request for easier tracking of requests logs on the back-end

Responses

200 OK

Body

Array of UserModel

GET /users/{id}

Path variables

string optional

Request headers

Request-UUID

string optional

Pass a unique id for each request for easier tracking of requests logs on the back-end

Responses

200 OK

Body

UserModel

PATCH /users/{id}

Allows updating all account details of the logged in user

Path variables

string optional

Request parameters

string required

A valid, activated e-mail address

Example:

john.doe@example.com

password

string required

Example:

Foo15^

password_confirm

string required

Example:

Foo15^

Request headers

Request-UUID

string optional

Pass a unique id for each request for easier tracking of requests logs on the back-end

Responses

200 OK

Body

UserModel

GET /user

Request headers

Request-UUID

string optional

Pass a unique id for each request for easier tracking of requests logs on the back-end

Responses

200 OK

Body

UserModel

PATCH /user

Allows updating all account details of the logged in user

Request parameters

string required

A valid, activated e-mail address

Example:

john.doe@example.com

password

string required

Example:

Foo15^

password_confirm

string required

Example:

Foo15^

Request headers

Request-UUID

string optional

Pass a unique id for each request for easier tracking of requests logs on the back-end

Responses

200 OK

Body

UserModel

Object

string

Example:

53a984cca87b4b7d57a99858

string

Example:

john.doe@example.com

name

Object

first

string

Example:

John

last

string

Example:

Doe

Methods: List users Retrieve authenticated user Retrieve user Signin Status Update authenticated user Update user

HTTP Status Error

Object

code

number

Example:

422

status

number

Example:

422

name

string

Example:

Http422Error

message

string

Example:

Validation failed

explanation

Array of string

Example:

Passwords must match

Responses: Bad Request Unauthorized

Object

user

Object data_container

Methods: List users Retrieve authenticated user Retrieve user Signin Status Update authenticated user Update user