LeFla Accomodations

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

account

read

GET /api/account/{user_id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action account read -p user_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["account", "read"]
var params = {
    user_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["account", "read"]
params = {
    "user_id": ...,
}
result = client.action(schema, action, params=params)

activate

read

GET /api/activate/{uidb64}/{token}/

used to activate the user account using link sent to the email. When the user clicks on the link sent them , this end point will check to see if it's authentic before redirecticting the user to the login page of the website if legit.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`uidb64` required
`token` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action activate read -p uidb64=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["activate", "read"]
var params = {
    uidb64: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["activate", "read"]
params = {
    "uidb64": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

add-hostel

create

POST /api/add-hostel

this endpoint is used in adding hostels/rentals to the system. This is done by landlords after being registered Below is the skeleton request body that is ti be used

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`hostel_name` required
`hostel_description` required
`hostel_rating`
`avilable_amenities` required
`town`
`landlord` required
`lon`
`lat`
`place_name`

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action add-hostel create -p hostel_name=... -p hostel_description=... -p hostel_rating=... -p avilable_amenities=... -p town=... -p landlord=... -p lon=... -p lat=... -p place_name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["add-hostel", "create"]
var params = {
    hostel_name: ...,
    hostel_description: ...,
    hostel_rating: ...,
    avilable_amenities: ...,
    town: ...,
    landlord: ...,
    lon: ...,
    lat: ...,
    place_name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["add-hostel", "create"]
params = {
    "hostel_name": ...,
    "hostel_description": ...,
    "hostel_rating": ...,
    "avilable_amenities": ...,
    "town": ...,
    "landlord": ...,
    "lon": ...,
    "lat": ...,
    "place_name": ...,
}
result = client.action(schema, action, params=params)

bookings

book-hostel > create

POST /api/bookings/book-hostel/{booking_id}

used to book hostels after paying a visit

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`booking_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`PhoneNumber` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action bookings book-hostel create -p booking_id=... -p PhoneNumber=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["bookings", "book-hostel > create"]
var params = {
    booking_id: ...,
    PhoneNumber: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["bookings", "book-hostel > create"]
params = {
    "booking_id": ...,
    "PhoneNumber": ...,
}
result = client.action(schema, action, params=params)

book-hostel-visit > create

POST /api/bookings/book-hostel-visit

Used to make a booking . you will have to pass both hostel id and the potential tenant id (user_id) as the tenant id

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`room`
`tenant` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action bookings book-hostel-visit create -p room=... -p tenant=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["bookings", "book-hostel-visit > create"]
var params = {
    room: ...,
    tenant: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["bookings", "book-hostel-visit > create"]
params = {
    "room": ...,
    "tenant": ...,
}
result = client.action(schema, action, params=params)

booking-status > update

PUT /api/bookings/booking-status

This endpoint takes three parameters as shown below. The status Parameter should have one of the foollowing Five options.(REQUESTED,ACCEPTED,BOOKED,COMPLETED,CANCELLED). This status option is what will be used to track the booking progress

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`booking_id`
`status` required
`reason_for_cancelling`

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action bookings booking-status update -p booking_id=... -p status=... -p reason_for_cancelling=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["bookings", "booking-status > update"]
var params = {
    booking_id: ...,
    status: ...,
    reason_for_cancelling: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["bookings", "booking-status > update"]
params = {
    "booking_id": ...,
    "status": ...,
    "reason_for_cancelling": ...,
}
result = client.action(schema, action, params=params)

list-bookings > read

GET /api/bookings/list-bookings/{user_id}

Used to list all the bookings made by the user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action bookings list-bookings read -p user_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["bookings", "list-bookings > read"]
var params = {
    user_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["bookings", "list-bookings > read"]
params = {
    "user_id": ...,
}
result = client.action(schema, action, params=params)

requested-bookings > read

GET /api/bookings/requested-bookings/{landlord_id}

used to check all the new requested visits made by interested tenants

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`landlord_id` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action bookings requested-bookings read -p landlord_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["bookings", "requested-bookings > read"]
var params = {
    landlord_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["bookings", "requested-bookings > read"]
params = {
    "landlord_id": ...,
}
result = client.action(schema, action, params=params)

hostels

list

GET /api/hostels/

Used to get specific hostels from the db. You can add page size or page number as parameters for pagination.d

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action hostels list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["hostels", "list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["hostels", "list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/hostels/{id}/

Used to get specific hostels from the db. You can add page size or page number as parameters for pagination.d

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this hostel.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action hostels read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["hostels", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["hostels", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

hostels-cat

read

GET /api/hostels-cat/{category}

Used to filter hostels based on the categories

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`category` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action hostels-cat read -p category=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["hostels-cat", "read"]
var params = {
    category: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["hostels-cat", "read"]
params = {
    "category": ...,
}
result = client.action(schema, action, params=params)

is_landlord

read

GET /api/is_landlord/{user_id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action is_landlord read -p user_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["is_landlord", "read"]
var params = {
    user_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["is_landlord", "read"]
params = {
    "user_id": ...,
}
result = client.action(schema, action, params=params)

landlords

list

GET /api/landlords

used to list all the landlords in the system

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action landlords list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["landlords", "list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["landlords", "list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

POST /api/login/

Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required
`password` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action login create -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["login", "create"]
var params = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["login", "create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

register

create

POST /api/register/

Enables registration of a new user returning the keyed in details if successful

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required
`username` required
`phonenumber`
`password` required
`password_confirmation`
`fullname`
`picture`

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action register create -p email=... -p username=... -p phonenumber=... -p password=... -p password_confirmation=... -p fullname=... -p picture=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["register", "create"]
var params = {
    email: ...,
    username: ...,
    phonenumber: ...,
    password: ...,
    password_confirmation: ...,
    fullname: ...,
    picture: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["register", "create"]
params = {
    "email": ...,
    "username": ...,
    "phonenumber": ...,
    "password": ...,
    "password_confirmation": ...,
    "fullname": ...,
    "picture": ...,
}
result = client.action(schema, action, params=params)

reset-password

create

POST /api/reset-password

Handles reset password request and sends the reset link to the provided email provided if exist in the database

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action reset-password create -p email=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["reset-password", "create"]
var params = {
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["reset-password", "create"]
params = {
    "email": ...,
}
result = client.action(schema, action, params=params)

rooms

list

GET /api/rooms/

Used to get rooms from the db. You can add page size or page number as parameters for pagination.d

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action rooms list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["rooms", "list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["rooms", "list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/rooms/{id}/

Used to get rooms from the db. You can add page size or page number as parameters for pagination.d

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this room.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action rooms read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["rooms", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["rooms", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

search-rooms

list

GET /api/search-rooms

use this endpoint for search.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action search-rooms list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["search-rooms", "list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["search-rooms", "list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

set-password

create

POST /api/set-password/

Enables reset of a new password

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`uidb64` required
`token` required
`password` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action set-password create -p uidb64=... -p token=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["set-password", "create"]
var params = {
    uidb64: ...,
    token: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["set-password", "create"]
params = {
    "uidb64": ...,
    "token": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

token

refresh > create

POST /api/token/refresh/

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`refresh` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action token refresh create -p refresh=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["token", "refresh > create"]
var params = {
    refresh: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["token", "refresh > create"]
params = {
    "refresh": ...,
}
result = client.action(schema, action, params=params)

verify > create

POST /api/token/verify/

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`token` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action token verify create -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["token", "verify > create"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["token", "verify > create"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

top-up-wallet

create

POST /api/top-up-wallet

used to deposit money on the wallet using wallet Id

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`Amount` required
`PhoneNumber` required
`wallet_id` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action top-up-wallet create -p Amount=... -p PhoneNumber=... -p wallet_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["top-up-wallet", "create"]
var params = {
    Amount: ...,
    PhoneNumber: ...,
    wallet_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["top-up-wallet", "create"]
params = {
    "Amount": ...,
    "PhoneNumber": ...,
    "wallet_id": ...,
}
result = client.action(schema, action, params=params)

transactions

callback > create

POST /api/transactions/callback

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`Amount` required
`PhoneNumber` required
`booking` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action transactions callback create -p Amount=... -p PhoneNumber=... -p booking=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["transactions", "callback > create"]
var params = {
    Amount: ...,
    PhoneNumber: ...,
    booking: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["transactions", "callback > create"]
params = {
    "Amount": ...,
    "PhoneNumber": ...,
    "booking": ...,
}
result = client.action(schema, action, params=params)

users

list

GET /api/users/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/users/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required
`username` required
`id`
`password` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users create -p email=... -p username=... -p id=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "create"]
var params = {
    email: ...,
    username: ...,
    id: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "create"]
params = {
    "email": ...,
    "username": ...,
    "id": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

activation

POST /api/users/activation/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`uid` required
`token` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users activation -p uid=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "activation"]
var params = {
    uid: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "activation"]
params = {
    "uid": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

resend_activation

POST /api/users/resend_activation/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users resend_activation -p email=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "resend_activation"]
var params = {
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "resend_activation"]
params = {
    "email": ...,
}
result = client.action(schema, action, params=params)

reset_password

POST /api/users/reset_password/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users reset_password -p email=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "reset_password"]
var params = {
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "reset_password"]
params = {
    "email": ...,
}
result = client.action(schema, action, params=params)

reset_password_confirm

POST /api/users/reset_password_confirm/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`uid` required
`token` required
`new_password` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users reset_password_confirm -p uid=... -p token=... -p new_password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "reset_password_confirm"]
var params = {
    uid: ...,
    token: ...,
    new_password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "reset_password_confirm"]
params = {
    "uid": ...,
    "token": ...,
    "new_password": ...,
}
result = client.action(schema, action, params=params)

reset_username

POST /api/users/reset_username/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users reset_username -p email=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "reset_username"]
var params = {
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "reset_username"]
params = {
    "email": ...,
}
result = client.action(schema, action, params=params)

reset_username_confirm

POST /api/users/reset_username_confirm/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`new_username` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users reset_username_confirm -p new_username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "reset_username_confirm"]
var params = {
    new_username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "reset_username_confirm"]
params = {
    "new_username": ...,
}
result = client.action(schema, action, params=params)

set_password

POST /api/users/set_password/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`new_password` required
`current_password` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users set_password -p new_password=... -p current_password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "set_password"]
var params = {
    new_password: ...,
    current_password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "set_password"]
params = {
    "new_password": ...,
    "current_password": ...,
}
result = client.action(schema, action, params=params)

set_username

POST /api/users/set_username/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`current_password` required
`new_username` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users set_username -p current_password=... -p new_username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "set_username"]
var params = {
    current_password: ...,
    new_username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "set_username"]
params = {
    "current_password": ...,
    "new_username": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this User.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this User.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required
`id`

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users update -p id=... -p email=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "update"]
var params = {
    id: ...,
    email: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "update"]
params = {
    "id": ...,
    "email": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this User.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email`
`id`

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users partial_update -p id=... -p email=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "partial_update"]
var params = {
    id: ...,
    email: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "partial_update"]
params = {
    "id": ...,
    "email": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this User.

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

me > read

GET /api/users/me/

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users me read

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "me > read"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "me > read"]
result = client.action(schema, action)

me > update

PUT /api/users/me/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required
`id`

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users me update -p email=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "me > update"]
var params = {
    email: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "me > update"]
params = {
    "email": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

me > partial_update

PATCH /api/users/me/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email`
`id`

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users me partial_update -p email=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "me > partial_update"]
var params = {
    email: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "me > partial_update"]
params = {
    "email": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

me > delete

DELETE /api/users/me/

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action users me delete

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "me > delete"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["users", "me > delete"]
result = client.action(schema, action)

wallet

read

GET /api/wallet/{user_id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

# Load the schema document
$ coreapi get http://lefla.azurewebsites.net/api/docs/

# Interact with the API endpoint
$ coreapi action wallet read -p user_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["wallet", "read"]
var params = {
    user_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://lefla.azurewebsites.net/api/docs/")

# Interact with the API endpoint
action = ["wallet", "read"]
params = {
    "user_id": ...,
}
result = client.action(schema, action, params=params)