API Documentation

Frontend Pages

Home page

Gets basic contents for the home page
Resource URL: GET http://api.zama.ng/v1/home
Resource Information
Requires authentication? NO
Parameters
None


Buy Page

Gets basic contents for the buy page
Resource URL: GET http://api.zama.ng/v1/buy
Resource Information
Requires authentication? NO
Parameters
None


Sell Page

Gets basic contents for the sell page
Resource URL: GET http://api.zama.ng/v1/sell
Resource Information
Requires authentication? NO
Parameters
None


Development Page

Gets basic contents for the development page
Resource URL: GET http://api.zama.ng/v1/development
Resource Information
Requires authentication? NO
Parameters
None


Rent Page

Gets basic contents for the rent page
Resource URL: GET http://api.zama.ng/v1/rent
Resource Information
Requires authentication? NO
Parameters
None


Neighbourhood details page

Gets details of neighbourhood page
Resource URL: GET http://api.zama.ng/v1/neighbourhood/:id
Resource Information
Requires authentication? NO
Parameters
None



Contact Agent

Used to contact agents of a listed property
Resource URL: POST http://api.zama.ng/v1/contact-agent
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
user_id int
message String
telephone String
name String


Authentication

Registration

Registers a new user.
Resource URL: POST http://api.zama.ng/v1/register
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
firstname String Used ONLY when registering as Independent Agent or Property Owner
lastname String Used ONLY when registering as Independent Agent or Property Owner
agency_name String Used ONLY when registering as Agency
telephone String
password String
confirm_password String
email String
role_id int Integers for various roles: Agency = 2, Independent Agent => 3, Property Owner => 4


Login

Logs in a registered user.
Resource URL: POST http://api.zama.ng/v1/login
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
password String
email String


Logout

Logs out a user.
Resource URL: POST http://api.zama.ng/v1/logout
Resource Information
Requires authentication? YES
Parameters
None.


Register Device

This allow device (Android and IOS) register to receive notifications
Resource URL: POST http://api.zama.ng/v1/register/device
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
device_token String
os_type String e.g ios or android
.


Forgot Password

This allow a user to request a reset password
Resource URL: POST http://api.zama.ng/v1/forget-password
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
email String
.


Reset Password

User reset password using reset token
Resource URL: POST http://api.zama.ng/v1/reset-password
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
token String
new_password String
.


Agency

An Agency's Agent's List

Used to get all agents in an agency.
Resource URL: GET http://api.zama.ng/v1/agency/agent/list/:agency_id
Resource Information
Requires authentication? NO.
Parameters
None

Create Agents

Creates a new agent under the agency.
Resource URL: POST http://api.zama.ng/v1/agent/create
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
firstname String
lastname String
designation String Sales or Leasing
telephone String
password String
email String


Suspend Agent

Used by the agency to suspend an agent.
Resource URL: POST http://api.zama.ng/v1/agent/suspend
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
agent_id Int Required


List Agents

Get a list of agents or a particular agent for the authenticated agency
Resource URL: GET http://api.zama.ng/v1/agent/list
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
agent_id Int Optional
page_size Int Optional. Defaults to 10 per per page if not passed


Media

Upload Images

Uploads Images and returns image url
Resource URL: POST http://api.zama.ng/v1/media/image/upload
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
image object Ensure the POST is a multipart/form-data request
dir_name string


Delete Image

Deletes an image
Resource URL: DELETE http://api.zama.ng/v1/media/image/{image_id}
Resource Information
Requires authentication? YES
Parameters
None

Upload Videos

Uploads Video and returns video url
Resource URL: POST http://api.zama.ng/v1/media/video/upload
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
video object Ensure the POST is a multipart/form-data request
string

Delete Video

Deletes a video
Resource URL: DELETE http://api.zama.ng/v1/media/video/{video_id}
Resource Information
Requires authentication? YES
Parameters
None


Delete Video

Deletes a video
Resource URL: DELETE http://api.zama.ng/v1/media/video
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
slug string Slug is the absolute URL e.g /v1/media/video?slug=https://api.zama.ng/uploads/video/11-1566199184.MP4
string


Video Types

Get a list of video types
Resource URL: GET http://api.zama.ng/v1/media/video/types
Resource Information
Requires authentication? YES
Parameters
None

Account

Me

Details of the logged in user
Resource URL: GET http://api.zama.ng/v1/me
Resource Information
Requires authentication? YES
Parameters
None


Dashboard

Get details of the logged in user's dashboard
Resource URL: GET http://api.zama.ng/v1/dashboard
Resource Information
Requires authentication? YES
Parameters
None


Update Profile Agency

To update agencies profile details
Resource URL: POST http://api.zama.ng/v1/profile/update/agency
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
telephone string
website string
rc_number string
image_url string
about string
youtube_url string
video_url string
video_type string
year_of_experience string
specialities string
address string
address_2 string
location_id int
coverage_area ARRAY


Update Profile Agent

To update agents profile details
Resource URL: POST http://api.zama.ng/v1/profile/update/agent
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
first_name string
last_name string
other_names string
telephone string
website string
image_url string
about string
youtube_url string
video_url string
video_type string
year_of_experience string
specialities string
address string
address_2 string
location_id int
coverage_area ARRAY


Update Profile Property Owner

To update property owners profile details
Resource URL: POST http://api.zama.ng/v1/profile/update/property-owner
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
first_name string
last_name string
other_names string
telephone string
website string
image_url string
about string
youtube_url string
video_url string
video_type string
address string
address_2 string
location_id int
coverage_area ARRAY


Property

Properties Types

Get a list of property types
Resource URL: GET http://api.zama.ng/v1/property/property_types
Resource Information
Requires authentication? YES
Parameters
None

Create Property

Creates a property
Resource URL: POST http://api.zama.ng/v1/property/create
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
title String Required
description String
property_type_id int Required
property_sub_type_id int Required
location_id int Required
currency String e.g NGN, USD. Also Required
price int Required
price_per_sqm int
leasable_area String
plot_size String
floor_size String
built_up_area String
floor_type_id int Required
year_built String
parking_options Json Example: [{"id": 2, "name": On site}, {"id": 3, "name": off site}]
landmarks Json
features_and_amenities Json
has_kitchen Boolean
are_pet_allowed Boolean
bathroom_no Int
toilet_no Int
kitchen_size Int
address_line1 String
address_line2 String
security_deposit Int
property_purpose_id Int
longitude Int
latitude Int
property_images Array

Update Property

Update a property
Resource URL: POST http://api.zama.ng/v1/property/update
Resource Information
Requires authentication? YES.
NOTE: When status is approved, only price can be update.
Parameters
Name Data Type Details
property_id int Required
title String Required
description String
property_type_id int Required
property_sub_type_id int Required
location_id int Required
currency String e.g NGN, USD. Also Required
price int Required
price_per_sqm int
leasable_area String
plot_size String
floor_size String
built_up_area String
floor_type_id int Required
year_built String
parking_options Json Example: [{"id": 2, "name": On site}, {"id": 3, "name": off site}]
landmarks Json
features_and_amenities Json
has_kitchen Boolean
are_pet_allowed Boolean
bathroom_no Int
toilet_no Int
kitchen_size Int
address_line1 String
address_line2 String
security_deposit Int
property_purpose_id Int
property_images Array
longitude Int
latitude Int


Properties Details

Get details of a property by ID
Resource URL: GET http://api.zama.ng/v1/property/show/:id
Resource Information
Requires authentication? NO
Parameters
None


List Properties Types

Get a list of properties types
Resource URL: GET http://api.zama.ng/v1/property/property-types
Resource Information
Requires authentication? NO
Parameters
None


List Properties

Get a list of properties
Resource URL: GET http://api.zama.ng/v1/property/list
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
property_id Int Optional. When passed it gets the specific property with the id
user_id Int Optional.
page_size Int Optional. Defaults to 10 per per page if not passed


List My Properties

Get a list of properties listed by the logged in user
Resource URL: GET http://api.zama.ng/v1/property/list/me
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
status Int Optional. status = 1(approved) or status = 2 (published)
sold Int Optional. sold = 1(sold properties) or sold = 0 (unsold properties)


Floor Types

Get a list of floor types on a property
Resource URL: GET http://api.zama.ng/v1/property/floor-types
Resource Information
Requires authentication? NO
Parameters
None

Parking Options

Get a list of parking options
Resource URL: GET http://api.zama.ng/v1/property/parking-options
Resource Information
Requires authentication? NO
Parameters
None

Property Sub Types

Get a list of property sub types for a particular property type
Resource URL: GET http://api.zama.ng/v1/property/property-sub-types
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
property_type_id Int Required

Property Purpose

Get a list of property purpose
Resource URL: GET http://api.zama.ng/v1/property/property-purpose
Resource Information
Requires authentication? NO
Parameters
None


Property Features and Amenities

Get a list of features and amenities
Resource URL: GET http://api.zama.ng/v1/property/features-amenities
Resource Information
Requires authentication? NO
Parameters
None


Create Property Draft

Used to create property draft
Resource URL: POST http://api.zama.ng/v1/property/draft/create
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
draft String Required


Update Property Draft

Used to update property draft
Resource URL: POST http://api.zama.ng/v1/property/draft/update
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
draft_id int Required
draft String Required


List Property Drafts

Get a list of the logged user's property drafts
Resource URL: GET http://api.zama.ng/v1/property/draft/list
Resource Information
Requires authentication? YES
Parameters
None


Get Property Draft

Used to get property draft
Resource URL: GET http://api.zama.ng/v1/property/draft/show/:id
Resource Information
Requires authentication? YES
Parameters
None


Mark Property Sold

Used to set the property availability to sold
Resource URL: GET http://api.zama.ng/v1/property/mark-sold
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
property_id int Required


Delete Property Draft

Used to delete a property draft
Resource URL: DELETE http://api.zama.ng/v1/property/draft/:draft_id
Resource Information
Requires authentication? YES
Parameters
None

Delete Property

Used to delete a property
Resource URL: DELETE http://api.zama.ng/v1/property/:property_id
Resource Information
Requires authentication? YES
Parameters
None



General

Countries

Get a list of countries
Resource URL: GET http://api.zama.ng/v1/countries
Resource Information
Requires authentication? NO
Parameters
None

States

Get a list of states
Resource URL: GET http://api.zama.ng/v1/states
Resource Information
Requires authentication? NO
Parameters
Parameters
Name Data Type Details
country_id Int Optional

Location

Get a list of locations within a state
Resource URL: GET http://api.zama.ng/v1/location/list
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
state_id Int Required
user_id Int Optional. Used to get locations in the user's coverage area only

Landmarks

Get a list of landmarks
Resource URL: GET http://api.zama.ng/v1/location/landmarks
Resource Information
Requires authentication? NO
Parameters
None

Property Features and Amenities

Get a list of property features and amenities
Resource URL: GET http://api.zama.ng/v1/property/features-amenities
Resource Information
Requires authentication? NO
Parameters
None


Agent Details

Get agent details
Resource URL: GET http://api.zama.ng/v1/agent/show/:id
Resource Information
Requires authentication? NO
Parameters
None

Agency Details

Get agency details
Resource URL: GET http://api.zama.ng/v1/agency/show/:id
Resource Information
Requires authentication? NO
Parameters
None

Property Owners Details

Get property owner details
Resource URL: GET http://api.zama.ng/v1/property-owner/show/:id
Resource Information
Requires authentication? NO
Parameters
None

Currencies

Get a list of currencies
Resource URL: GET http://api.zama.ng/v1/currencies
Resource Information
Requires authentication? NO
Parameters
None


Clear Notifications

Deletes all read notifications
Resource URL: POST http://api.zama.ng/v1/clear-notifications
Resource Information
Requires authentication? YES
Parameters
None


Ratings

Rate a User

Used to rate agents, agency and property owners
Resource URL: POST http://api.zama.ng/v1/rating/rate
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
user_id Int Required
num_stars Int Required
name String Optional. Name of user making the rating
comment String Optional. Comment on the rating


Rating Reviews

Get a user's reviews
Resource URL: GET http://api.zama.ng/v1/rating/reviews/:user_id
Resource Information
Requires authentication? NO
Parameters
Name Data Type Details
user_id Int Required
name String Required
email String Required
telephone String Required

Rating Reviews

Get users make rating requests
Resource URL: GET http://api.zama.ng/v1/rating/request
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
message string optional
email String Required


Pricing

Subscription Plans

Get a list of subscription plans
Resource URL: GET http://api.zama.ng/v1/pricing/subscription/list
Resource Information
Requires authentication? NO
Parameters
None

Value Added Services

Get a list of value added services
Resource URL: GET http://api.zama.ng/v1/pricing/vas/list
Resource Information
Requires authentication? NO
Parameters
None

Checkout

Used to checkout and send order
Resource URL: POST http://api.zama.ng/v1/checkout
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
cart JSON Required. e.g{ "subscription": {"id": 4, "quantity": 3}, "vas": [ 4, 6, 2], "total" : 6000 }


Subscribe

Used to subscribe user after payment
Resource URL: POST http://api.zama.ng/v1/subscribe
Resource Information
Requires authentication? YES
Parameters
Name Data Type Details
reference String Required


My Subscription

Used to get the logged in user's active subscription.
Resource URL: GET http://api.zama.ng/v1/subscription/me
Resource Information
Requires authentication? YES
Parameters
None.

My Value Added Service

Used to get the logged in user's active value added services.
Resource URL: GET http://api.zama.ng/v1/vas/me
Resource Information
Requires authentication? YES
Parameters
None.