Homestay Network API

Sections

» Introduction
» Public
» Hosts
» Students
» Placements
» Agents
» Admin

Developers

» Apply

Public

The Homestay Network API provides access to the following public data:

Validate Username/Email

http://api.homestaynetwork.org/validate_username?username=myname

Returns a boolean declaring whether the passed username parameter is available to be used in the system.

http://api.homestaynetwork.org/validate_email?email=email%40example.com

Returns a boolean declaring whether the passed email parameter is available to be used in the system.

Supervisors

http://api.homestaynetwork.org/supervisors

Returns a list of all public supervisors.

Response

<supervisors>
	<supervisor>
	   <url-alias>ies</url-alias>
	   <id type="integer">1</id>
	   <title>IES Accommodation</title>
	</supervisor>
	...
</supervisors>

Institutions

http://api.homestaynetwork.org/institutions

Returns a list of all Australian institutions.

Response

<institutions>
	<institution>
	   <id type="integer">1</id>
	   <nickname>UQ</nickname>
	   <title>University of Queensland</title>
	</institution>
	...
</institutions>

Campuses

http://api.homestaynetwork.org/institutions/1/campuses

Returns a list of all campuses within a particular institution.

Response

<campuses>
	<campus>
	   <id type="integer">1</id>
	   <title>St Lucia</title>
	</campus>
	...
</campuses>

Countries

http://api.homestaynetwork.org/countries

Returns a list of all countires in the AHN database.

Response

<countries>
	<country>
	   <abbreviation>AUS</abbreviation>
	   <id type="integer">1</id>
	   <title>Australia</title>
	</country>
	...
</countries>

States

http://api.homestaynetwork.org/countries/1/states

Returns a list of all states for a particular country.

Response

<states>
	<state>
	   <abbreviation>ACT</abbreviation>
	   <id type="integer">8</id>
	   <title>Australian Capital Territory</title>
	</state>
	...
</states>

Cities

http://api.homestaynetwork.org/states/1/cities

Returns a list of all cities for a particular state.

Response

<cities>
	<city>
	   <id type="integer">8</id>
	   <title>Brisbane</title>
	</city>
	...
</cities>

Languages

http://api.homestaynetwork.org/languages

Returns a list of languages.

Response

<languages>
	<host-service>
	   <id type="integer">1</id>
	   <title>English</title>
	</languages>
	...
</host-services>

Courses

http://api.homestaynetwork.org/courses

Returns a list of the courses a student may study in Australia.

Response

<courses>
	<course>
	   <id type="integer">2</id>
	   <title>Architecture</title>
	</course>
	...
</courses>

Host Service Levels

http://api.homestaynetwork.org/host_services

Returns a list of the host service levels offered by all Hosts.

Response

<host-services>
	<host-service>
	   <description>Halal etc</description>
	   <id type="integer">2</id>
	   <title>Special Service</title>
	</host-service>
	...
</host-services>