Asset APIs

image example

What is Asset API ?

Asset APIs provide the backend processing capabilities for work orders and asset management. Any bookable entity such as a person, location or equipment can be an asset.

From the BookAndPay application perspective, an asset can be anything which can be booked and processed. So asset can be a person, equipment, location, service or a table. For example you may book a person, or book an equipment or book a service from a company or book a table.

The table below shows various types of businesses and possible asset types. The table below is only a guide and not a requirement

business-type assetType notes
sports venues location / court
health, fitness location / person
optometry,dental,clinics location / person
hair saloons location / person
professionals person / location Lawyers,accountants…
training and education person / location / service
service centers location / service
coaches, consultants person
transport route / vehicle ride sharing, taxi,airport shuttle, community transport.
trades people person / service plumbers, technicians, electricians..
cleaning, gardening service / people housekeeping jobs
restaurant location / table
vehicle hire equipment / location
equipment hire equipment/ location
room hire location / room
venue hire location
office space rental location / room
event organizers function / location

Assets can be added to the BookAndPay application via three methods

Manually via web forms
CSV Excel import
API integration

If the number of assets to be added to the BookAndPay system is not huge, its easier to enter the information manually via web forms or via CSV/Excel import If the number of assets are high and the information of the assets need to be obtained and updated regularly from another system, it is recommended to use API integration. See API Guide for more details.

Why is it needed ?

Before one can book something, you need to define what is that you are booking. So adding assets into the BookAndPay system is one of the first steps before that asset can be booked.

How it works ?

Once the asset is added to the BookAndPay application, asset API will provide a unique Id for the assets you added. This id should be used for booking that asset.

Asset API is one of the services within the BookAndPay application. See Getting Started guide on various services which form a part of the BookAndPay application.

Asset API will be installed and activated during deployment. See deployment guide

Details of the user configurable parameters related to Asset API can be found in the configuration guide