Users

class market.restapi.users_endpoint.SpecificUserEndpoint(market_community, pub_key)

This class handles requests for a specific user, identified by their public key.

render_GET(request)

GET /user/(string: user_id)

A GET request to this endpoint returns information about a particular user in the system.

Example request:

curl -X GET http://localhost:8085/user/a94a8fe5ccb19ba61c4c0873d391e987982fbbd3

Example response:

{
    "user": {
        "id": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
        "role": "BORROWER",
        "time_added": "29-03-2017 13:59:39"
    }
}

class market.restapi.users_endpoint.SpecificUserProfileEndpoint(market_community, pub_key)

This class handles requests regarding the profile of a specific user.

render_GET(request)

GET /user/(string: user_id)/profile

A GET request to this endpoint returns information about a profile of a user.

Example request:

curl -X GET http://localhost:8085/user/a94a8fe5ccb19ba61c4c0873d391e987982fbbd3/profile

Example response:

{
    "profile": {
        "type": "investor",
        "first_name": "Piet",
        "last_name": "Tester",
        "email": "piettester@gmail.com",
        "iban": "NL90RABO0759395830",
        "phone_number": "06685985936"
    }
}

class market.restapi.users_endpoint.UsersEndpoint(market_community)

This class handles requests regarding users in the mortgage market community.

render_GET(request)

GET /users

A GET request to this endpoint returns information about the known users in the system.

Example request:

curl -X GET http://localhost:8085/users

Example response:

{
    "users": [{
        "id": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
        "role": "BORROWER",
        "time_added": "29-03-2017 13:59:39"
    }, ...]
}