GET api/Student/CollegeCampuses?type={type}&suburb={suburb}&state={state}&postcode={postcode}&country={country}

Get college/campus contact details for student

Request Information

URI Parameters

NameDescriptionTypeAdditional information
type

Type of information. Only 2 possible value returned.
- 'Campus': to filter only campus address information.
- 'College': to bring only college main address returned.

string

None.

suburb

Suburb

string

None.

state

State

string

None.

postcode

Postcode

string

None.

country

Country

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of StdCollegeCampusModels
NameDescriptionTypeAdditional information
CollegeName

College/RTO/Institute name
Data presented only Type='College'

string

Required

RTONumber

College/RTO/Institute national code
Data presented only Type='College'

string

Required

CRICOSNumber

College/RTO/Institute CRICOS code
Data presented only Type='College'

string

Required

Type

Type of information. Only 2 possible value returned
- 'Campus': indicate that this record is campus address where student is currently or had been studying at.
- 'College': indicate that this record is the college main address. Normally, it is the registered legal contact address of the college. This address type is always returned.

string

Required

CampusName

If 'Campus' type, campus name will be provided. Else, it will be empty.

string

None.

Address

Street address detail

string

None.

Suburb

Suburb

string

None.

State

State

string

None.

Postcode

Postcode

string

None.

Country

Country

string

None.

ContactNo

Contact phone number

string

Data type: PhoneNumber

Website

College website URL (General, not RTOManager system). This will be provided only by 'College' type.

string

Data type: Url

ContactEmail

College main contact email address. This will be provided only by 'College' type.

string

Data type: EmailAddress

Response Formats

application/json, text/json

Sample:
[
  {
    "CollegeName": "sample string 1",
    "RTONumber": "sample string 2",
    "CRICOSNumber": "sample string 3",
    "Type": "sample string 4",
    "CampusName": "sample string 5",
    "Address": "sample string 6",
    "Suburb": "sample string 7",
    "State": "sample string 8",
    "Postcode": "sample string 9",
    "Country": "sample string 10",
    "ContactNo": "sample string 11",
    "Website": "sample string 12",
    "ContactEmail": "sample string 13"
  },
  {
    "CollegeName": "sample string 1",
    "RTONumber": "sample string 2",
    "CRICOSNumber": "sample string 3",
    "Type": "sample string 4",
    "CampusName": "sample string 5",
    "Address": "sample string 6",
    "Suburb": "sample string 7",
    "State": "sample string 8",
    "Postcode": "sample string 9",
    "Country": "sample string 10",
    "ContactNo": "sample string 11",
    "Website": "sample string 12",
    "ContactEmail": "sample string 13"
  }
]

application/xml, text/xml

Sample:
<ArrayOfStdCollegeCampusModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileApp_WebAPI.Models.Students">
  <StdCollegeCampusModels>
    <Address>sample string 6</Address>
    <CRICOSNumber>sample string 3</CRICOSNumber>
    <CampusName>sample string 5</CampusName>
    <CollegeName>sample string 1</CollegeName>
    <ContactEmail>sample string 13</ContactEmail>
    <ContactNo>sample string 11</ContactNo>
    <Country>sample string 10</Country>
    <Postcode>sample string 9</Postcode>
    <RTONumber>sample string 2</RTONumber>
    <State>sample string 8</State>
    <Suburb>sample string 7</Suburb>
    <Type>sample string 4</Type>
    <Website>sample string 12</Website>
  </StdCollegeCampusModels>
  <StdCollegeCampusModels>
    <Address>sample string 6</Address>
    <CRICOSNumber>sample string 3</CRICOSNumber>
    <CampusName>sample string 5</CampusName>
    <CollegeName>sample string 1</CollegeName>
    <ContactEmail>sample string 13</ContactEmail>
    <ContactNo>sample string 11</ContactNo>
    <Country>sample string 10</Country>
    <Postcode>sample string 9</Postcode>
    <RTONumber>sample string 2</RTONumber>
    <State>sample string 8</State>
    <Suburb>sample string 7</Suburb>
    <Type>sample string 4</Type>
    <Website>sample string 12</Website>
  </StdCollegeCampusModels>
</ArrayOfStdCollegeCampusModels>