Sections

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

Developers

» Apply

Placements

Authentication required

Successful authentication provides the developer with access to the Placement data for their supervising organisation. A placement refers to the homestay relationship between a student and host. The Homestay Network API provides access to Placement data in the RESTful approach (GET, POST, PUT, DELETE). All requests must provide the token parameter.

List placements

Returns student, host, dates and other basic information for all Placements for students supervised by the organisation.

Name Description
id The unique identifier in the AHN database
name The name of the student
address The street address
city The name of the city
state The name of the state
country The name of the country
post-code The postal/zip code
student-status The status of the student's application
external-id The External Id of the student's application

GET: http://api.homestaynetwork.org/placements/?token=xxxxx

To restrict the response to a particular placement status, provide the status parameter with the request:

GET: http://api.homestaynetwork.org/placements/?status=(status-id)&token=xxxxx

status-id relates to the Id column of the Placement Status model in AHN.

Available Status Ids:

  1. Pending
  2. Current/Active
  3. Past/Complete
  4. Cancelled
  5. Transferred
  6. Tentative
  7. Arrival Confirmed

Response

<homestays>
	<homestay>
		...
	</homestay>
	...
</homestays>

Get placement

Returns a single placement details.

GET: http://api.homestaynetwork.org/placements/(placement-id)?token=xxxxx

placement-id relates to the Id column of the Placement model in AHN.

Response

<homestay>
	...
</homestay>

List host's placements

Returns a list of placements related to a specific host under the supervison of the developer's organisation.

GET: http://api.homestaynetwork.org/hosts/(host-id)/placements?token=xxxxx

host-id relates to the Id column of the Host model in AHN.

Response

<homestays>
	<homestay>
		...
	</homestay>
	...
</homestays>

List student's placements

Returns a list of placements related to a specific student under the supervison of the developer's organisation.

GET: http://api.homestaynetwork.org/student/(student-id)/placements?token=xxxxx

student-id relates to the Id column of the Student model in AHN.

Response

<homestays>
	<homestay>
		...
	</homestay>
	...
</homestays>