GET api/V1/Campuses?campusid={campusid}&courseid={courseid}&vcode={vcode}&vsuburb={vsuburb}&vstate={vstate}&vpostcode={vpostcode}&vcountry={vcountry}&refresh={refresh}

Get all campuses information list

[Optional] You can filter campuses result with specific search filter by query strings

E.g.
  • GET 'api/V1/Campuses'
  • GET 'api/V1/Campuses?vstate=NSW'
  • GET 'api/V1/Campuses?vstate=NSW&courseid=BSB50207'

Request Information

URI Parameters

NameDescriptionTypeAdditional information
campusid

Specified valid campus id (positive whole number only)

integer

None.
courseid

Course/qualification identifier

string

None.
vcode

Venue/Training location code

string

None.
vsuburb

Venue/Training location suburb

string

None.
vstate

Venue/Training location state

string

None.
vpostcode

Venue/Training location postcode

string

None.
vcountry

Venue/Training location country

string

None.
refresh

Specify to retrieve fresh real data or get from refresh data.
Expected value (true/false).
If true, data will retrieve from fresh (realtime) data of RTOManager system.
If false, data will retrieve from cached data for quicker response.

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ModelCampusV1
NameDescriptionTypeAdditional information
CampusId

Unique campus identifier.

integer

Required
CampusName

Campus name

string

Required
Venues

A collection of associated venues/training locations

Collection of ModelVenueV1

None.
CourseIds

A collection of associated course ids assigned and available for a campus

Collection of string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "CampusId": 1,
    "CampusName": "sample string 2",
    "Venues": [
      {
        "VenueCode": "sample string 1",
        "CampusId": 2,
        "VenueName": "sample string 3",
        "BuildingName": "sample string 4",
        "FlatUnitDetail": "sample string 5",
        "StreetNumber": "sample string 6",
        "StreetName": "sample string 7",
        "Suburb": "sample string 8",
        "State": "sample string 9",
        "Postcode": "sample string 10",
        "Country": "sample string 11",
        "ContactNo": "sample string 12"
      },
      {
        "VenueCode": "sample string 1",
        "CampusId": 2,
        "VenueName": "sample string 3",
        "BuildingName": "sample string 4",
        "FlatUnitDetail": "sample string 5",
        "StreetNumber": "sample string 6",
        "StreetName": "sample string 7",
        "Suburb": "sample string 8",
        "State": "sample string 9",
        "Postcode": "sample string 10",
        "Country": "sample string 11",
        "ContactNo": "sample string 12"
      }
    ],
    "CourseIds": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "CampusId": 1,
    "CampusName": "sample string 2",
    "Venues": [
      {
        "VenueCode": "sample string 1",
        "CampusId": 2,
        "VenueName": "sample string 3",
        "BuildingName": "sample string 4",
        "FlatUnitDetail": "sample string 5",
        "StreetNumber": "sample string 6",
        "StreetName": "sample string 7",
        "Suburb": "sample string 8",
        "State": "sample string 9",
        "Postcode": "sample string 10",
        "Country": "sample string 11",
        "ContactNo": "sample string 12"
      },
      {
        "VenueCode": "sample string 1",
        "CampusId": 2,
        "VenueName": "sample string 3",
        "BuildingName": "sample string 4",
        "FlatUnitDetail": "sample string 5",
        "StreetNumber": "sample string 6",
        "StreetName": "sample string 7",
        "Suburb": "sample string 8",
        "State": "sample string 9",
        "Postcode": "sample string 10",
        "Country": "sample string 11",
        "ContactNo": "sample string 12"
      }
    ],
    "CourseIds": [
      "sample string 1",
      "sample string 2"
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfModelCampusV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Models.Cricos.V1">
  <ModelCampusV1>
    <CampusId>1</CampusId>
    <CampusName>sample string 2</CampusName>
    <CourseIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CourseIds>
    <Venues>
      <ModelVenueV1>
        <BuildingName>sample string 4</BuildingName>
        <CampusId>2</CampusId>
        <ContactNo>sample string 12</ContactNo>
        <Country>sample string 11</Country>
        <FlatUnitDetail>sample string 5</FlatUnitDetail>
        <Postcode>sample string 10</Postcode>
        <State>sample string 9</State>
        <StreetName>sample string 7</StreetName>
        <StreetNumber>sample string 6</StreetNumber>
        <Suburb>sample string 8</Suburb>
        <VenueCode>sample string 1</VenueCode>
        <VenueName>sample string 3</VenueName>
      </ModelVenueV1>
      <ModelVenueV1>
        <BuildingName>sample string 4</BuildingName>
        <CampusId>2</CampusId>
        <ContactNo>sample string 12</ContactNo>
        <Country>sample string 11</Country>
        <FlatUnitDetail>sample string 5</FlatUnitDetail>
        <Postcode>sample string 10</Postcode>
        <State>sample string 9</State>
        <StreetName>sample string 7</StreetName>
        <StreetNumber>sample string 6</StreetNumber>
        <Suburb>sample string 8</Suburb>
        <VenueCode>sample string 1</VenueCode>
        <VenueName>sample string 3</VenueName>
      </ModelVenueV1>
    </Venues>
  </ModelCampusV1>
  <ModelCampusV1>
    <CampusId>1</CampusId>
    <CampusName>sample string 2</CampusName>
    <CourseIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CourseIds>
    <Venues>
      <ModelVenueV1>
        <BuildingName>sample string 4</BuildingName>
        <CampusId>2</CampusId>
        <ContactNo>sample string 12</ContactNo>
        <Country>sample string 11</Country>
        <FlatUnitDetail>sample string 5</FlatUnitDetail>
        <Postcode>sample string 10</Postcode>
        <State>sample string 9</State>
        <StreetName>sample string 7</StreetName>
        <StreetNumber>sample string 6</StreetNumber>
        <Suburb>sample string 8</Suburb>
        <VenueCode>sample string 1</VenueCode>
        <VenueName>sample string 3</VenueName>
      </ModelVenueV1>
      <ModelVenueV1>
        <BuildingName>sample string 4</BuildingName>
        <CampusId>2</CampusId>
        <ContactNo>sample string 12</ContactNo>
        <Country>sample string 11</Country>
        <FlatUnitDetail>sample string 5</FlatUnitDetail>
        <Postcode>sample string 10</Postcode>
        <State>sample string 9</State>
        <StreetName>sample string 7</StreetName>
        <StreetNumber>sample string 6</StreetNumber>
        <Suburb>sample string 8</Suburb>
        <VenueCode>sample string 1</VenueCode>
        <VenueName>sample string 3</VenueName>
      </ModelVenueV1>
    </Venues>
  </ModelCampusV1>
</ArrayOfModelCampusV1>