Visitor Application API Documentation

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

# Install the Python client library
$ pip install coreapi

accounts

api > adduser > create

POST /accounts/api/adduser/

Request Body

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

Parameter	Description
`nin` required
`email` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api adduser create -p nin=... -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 = ["accounts", "api > adduser > create"]
var params = {
    nin: ...,
    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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["accounts", "api > adduser > create"]
params = {
    "nin": ...,
    "email": ...,
}
result = client.action(schema, action, params=params)

api > blacklistninlist > list

GET /accounts/api/blacklistninlist/

Query Parameters

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

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api blacklistninlist list -p search=...

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 = ["accounts", "api > blacklistninlist > list"]
var params = {
    search: ...,
}
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["accounts", "api > blacklistninlist > list"]
params = {
    "search": ...,
}
result = client.action(schema, action, params=params)

api > companyregistration > create

POST /accounts/api/companyregistration/

Request Body

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

Parameter	Description
`username`
`email` required
`password` required
`nin`

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api companyregistration create -p username=... -p email=... -p password=... -p nin=...

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 = ["accounts", "api > companyregistration > create"]
var params = {
    username: ...,
    email: ...,
    password: ...,
    nin: ...,
}
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["accounts", "api > companyregistration > create"]
params = {
    "username": ...,
    "email": ...,
    "password": ...,
    "nin": ...,
}
result = client.action(schema, action, params=params)

api > companysendotp > create

POST /accounts/api/companysendotp/

Request Body

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

Parameter	Description
`identifier` required	Enter your username or email

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api companysendotp create -p identifier=...

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 = ["accounts", "api > companysendotp > create"]
var params = {
    identifier: ...,
}
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("https://public.flowpass.com.ng/")

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

api > companyverifyotp > create

POST /accounts/api/companyverifyotp/

Request Body

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

Parameter	Description
`identifier` required	Enter your username or email

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api companyverifyotp create -p identifier=...

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 = ["accounts", "api > companyverifyotp > create"]
var params = {
    identifier: ...,
}
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("https://public.flowpass.com.ng/")

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

api > ninlist > list

GET /accounts/api/ninlist/

Query Parameters

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

Parameter	Description
`search`	A search term.

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api ninlist list -p search=...

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 = ["accounts", "api > ninlist > list"]
var params = {
    search: ...,
}
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["accounts", "api > ninlist > list"]
params = {
    "search": ...,
}
result = client.action(schema, action, params=params)

api > subusers > viewset > list

GET /accounts/api/subusers/viewset/

ViewSet for SubUser CRUD operations

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api subusers viewset list

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 = ["accounts", "api > subusers > viewset > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["accounts", "api > subusers > viewset > list"]
result = client.action(schema, action)

api > subusers > viewset > create

POST /accounts/api/subusers/viewset/

ViewSet for SubUser CRUD operations

Request Body

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

Parameter	Description
`user` required
`username` required
`email` required
`password` required
`department` required
`is_active`

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api subusers viewset create -p user=... -p username=... -p email=... -p password=... -p department=... -p is_active=...

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 = ["accounts", "api > subusers > viewset > create"]
var params = {
    user: ...,
    username: ...,
    email: ...,
    password: ...,
    department: ...,
    is_active: ...,
}
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["accounts", "api > subusers > viewset > create"]
params = {
    "user": ...,
    "username": ...,
    "email": ...,
    "password": ...,
    "department": ...,
    "is_active": ...,
}
result = client.action(schema, action, params=params)

api > subusersendotp > create

POST /accounts/api/subusersendotp/

Request Body

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

Parameter	Description
`identifier` required	Enter your username or email

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api subusersendotp create -p identifier=...

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 = ["accounts", "api > subusersendotp > create"]
var params = {
    identifier: ...,
}
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("https://public.flowpass.com.ng/")

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

api > subuserverifyotp > create

POST /accounts/api/subuserverifyotp/

Request Body

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

Parameter	Description
`identifier` required	Enter your username or email

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action accounts api subuserverifyotp create -p identifier=...

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 = ["accounts", "api > subuserverifyotp > create"]
var params = {
    identifier: ...,
}
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("https://public.flowpass.com.ng/")

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

company

api > adddepartments > create

POST /company/api/adddepartments/

Request Body

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

Parameter	Description
`name` required
`number_of_visitors`
`opening_time`
`closing_time`
`saturday`
`sunday`
`user` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api adddepartments create -p name=... -p number_of_visitors=... -p opening_time=... -p closing_time=... -p saturday=... -p sunday=... -p user=...

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 = ["company", "api > adddepartments > create"]
var params = {
    name: ...,
    number_of_visitors: ...,
    opening_time: ...,
    closing_time: ...,
    saturday: ...,
    sunday: ...,
    user: ...,
}
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > adddepartments > create"]
params = {
    "name": ...,
    "number_of_visitors": ...,
    "opening_time": ...,
    "closing_time": ...,
    "saturday": ...,
    "sunday": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

api > addpurpose > create

POST /company/api/addpurpose/

Request Body

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

Parameter	Description
`purpose` required
`department` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api addpurpose create -p purpose=... -p department=...

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 = ["company", "api > addpurpose > create"]
var params = {
    purpose: ...,
    department: ...,
}
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > addpurpose > create"]
params = {
    "purpose": ...,
    "department": ...,
}
result = client.action(schema, action, params=params)

api > allcompanyprofiles > list

GET /company/api/allcompanyprofiles/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api allcompanyprofiles list

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 = ["company", "api > allcompanyprofiles > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > allcompanyprofiles > list"]
result = client.action(schema, action)

api > alldepartments > read

GET /company/api/alldepartments/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api alldepartments 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 = ["company", "api > alldepartments > 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("https://public.flowpass.com.ng/")

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

api > appointments > list

GET /company/api/appointments/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api appointments list

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 = ["company", "api > appointments > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > appointments > list"]
result = client.action(schema, action)

api > company > appointments > read

GET /company/api/company/appointments/{company_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api company appointments read -p company_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 = ["company", "api > company > appointments > read"]
var params = {
    company_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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > company > appointments > read"]
params = {
    "company_id": ...,
}
result = client.action(schema, action, params=params)

api > company > appointments > search > list

GET /company/api/company/appointments/search/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api company appointments search list

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 = ["company", "api > company > appointments > search > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > company > appointments > search > list"]
result = client.action(schema, action)

api > company > dashboard > read

GET /company/api/company/dashboard/{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 https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api company dashboard 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 = ["company", "api > company > dashboard > 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("https://public.flowpass.com.ng/")

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

api > company > purposeofvisitors > list

GET /company/api/company/{company_id}/purposeofvisitors/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api company purposeofvisitors list -p company_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 = ["company", "api > company > purposeofvisitors > list"]
var params = {
    company_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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > company > purposeofvisitors > list"]
params = {
    "company_id": ...,
}
result = client.action(schema, action, params=params)

api > companyprofile > read

GET /company/api/companyprofile/{user_id}/

Retrieve, update or delete the company profile for the authenticated user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api companyprofile 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 = ["company", "api > companyprofile > 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("https://public.flowpass.com.ng/")

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

api > companyprofile > update

PUT /company/api/companyprofile/{user_id}/

Retrieve, update or delete the company profile for the authenticated user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api companyprofile update -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 = ["company", "api > companyprofile > update"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > companyprofile > update"]
params = {
    "user_id": ...,
}
result = client.action(schema, action, params=params)

api > companyprofile > partial_update

PATCH /company/api/companyprofile/{user_id}/

Retrieve, update or delete the company profile for the authenticated user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api companyprofile partial_update -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 = ["company", "api > companyprofile > partial_update"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > companyprofile > partial_update"]
params = {
    "user_id": ...,
}
result = client.action(schema, action, params=params)

api > companyprofile > delete

DELETE /company/api/companyprofile/{user_id}/

Retrieve, update or delete the company profile for the authenticated user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api companyprofile delete -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 = ["company", "api > companyprofile > delete"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > companyprofile > delete"]
params = {
    "user_id": ...,
}
result = client.action(schema, action, params=params)

api > departmentpurpose > read

GET /company/api/departmentpurpose/{department_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`department_id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api departmentpurpose read -p department_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 = ["company", "api > departmentpurpose > read"]
var params = {
    department_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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "api > departmentpurpose > read"]
params = {
    "department_id": ...,
}
result = client.action(schema, action, params=params)

api > departments > read

GET /company/api/departments/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api departments 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 = ["company", "api > departments > 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("https://public.flowpass.com.ng/")

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

api > departments > update

PUT /company/api/departments/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api departments update -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 = ["company", "api > departments > update"]
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("https://public.flowpass.com.ng/")

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

api > departments > delete

DELETE /company/api/departments/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api departments 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 = ["company", "api > departments > 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("https://public.flowpass.com.ng/")

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

api > visitorpurposecompany > read

GET /company/api/visitorpurposecompany/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company api visitorpurposecompany 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 = ["company", "api > visitorpurposecompany > 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("https://public.flowpass.com.ng/")

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

appointments > checkinnull > list

GET /company/appointments/checkinnull/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company appointments checkinnull list

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 = ["company", "appointments > checkinnull > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "appointments > checkinnull > list"]
result = client.action(schema, action)

appointments > checkoutnull > list

GET /company/appointments/checkoutnull/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company appointments checkoutnull list

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 = ["company", "appointments > checkoutnull > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "appointments > checkoutnull > list"]
result = client.action(schema, action)

appointments > completed > list

GET /company/appointments/completed/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company appointments completed list

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 = ["company", "appointments > completed > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "appointments > completed > list"]
result = client.action(schema, action)

appointments > confirmed > list

GET /company/appointments/confirmed/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company appointments confirmed list

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 = ["company", "appointments > confirmed > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "appointments > confirmed > list"]
result = client.action(schema, action)

appointments > declined > list

GET /company/appointments/declined/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company appointments declined list

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 = ["company", "appointments > declined > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "appointments > declined > list"]
result = client.action(schema, action)

company > allpublicholidays > read

GET /company/company/allpublicholidays/{company_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`company_id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company company allpublicholidays read -p company_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 = ["company", "company > allpublicholidays > read"]
var params = {
    company_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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "company > allpublicholidays > read"]
params = {
    "company_id": ...,
}
result = client.action(schema, action, params=params)

payment > process > create

POST /company/payment/process/

Process a payment and convert it to subscription units

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action company payment process create

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 = ["company", "payment > process > create"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["company", "payment > process > create"]
result = client.action(schema, action)

user

api > alluseprofile > list

GET /user/api/alluseprofile/

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action user api alluseprofile list

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 = ["user", "api > alluseprofile > list"]
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["user", "api > alluseprofile > list"]
result = client.action(schema, action)

api > createappointment > create

POST /user/api/createappointment/{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 https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action user api createappointment create -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 = ["user", "api > createappointment > create"]
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("https://public.flowpass.com.ng/")

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

api > createappointment > user > create

POST /user/api/createappointment/{user_id}/user/

Generic class-based view for creating appointments

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`user_id` required

Request Body

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

Parameter	Description
`expecting_date`
`expecting_time`
`barcode`
`ref_code`
`check_in`
`check_out`
`confirm`
`declined`
`reasonForDecline`
`completed`

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action user api createappointment user create -p user_id=... -p expecting_date=... -p expecting_time=... -p barcode=... -p ref_code=... -p check_in=... -p check_out=... -p confirm=... -p declined=... -p reasonForDecline=... -p completed=...

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 = ["user", "api > createappointment > user > create"]
var params = {
    user_id: ...,
    expecting_date: ...,
    expecting_time: ...,
    barcode: ...,
    ref_code: ...,
    check_in: ...,
    check_out: ...,
    confirm: ...,
    declined: ...,
    reasonForDecline: ...,
    completed: ...,
}
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("https://public.flowpass.com.ng/")

# Interact with the API endpoint
action = ["user", "api > createappointment > user > create"]
params = {
    "user_id": ...,
    "expecting_date": ...,
    "expecting_time": ...,
    "barcode": ...,
    "ref_code": ...,
    "check_in": ...,
    "check_out": ...,
    "confirm": ...,
    "declined": ...,
    "reasonForDecline": ...,
    "completed": ...,
}
result = client.action(schema, action, params=params)

api > userprofile > partial_update

PATCH /user/api/userprofile/{id}/

Retrieve, update or delete the company profile for the authenticated user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action user api userprofile partial_update -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 = ["user", "api > userprofile > partial_update"]
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("https://public.flowpass.com.ng/")

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

api > userprofile > delete

DELETE /user/api/userprofile/{id}/

Retrieve, update or delete the company profile for the authenticated user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://public.flowpass.com.ng/

# Interact with the API endpoint
$ coreapi action user api userprofile 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 = ["user", "api > userprofile > 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("https://public.flowpass.com.ng/")

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