XML Documentation

The Agent API allows an Agent group to request a data response for all UniLodge Properties.

HTTP GET Request

To initiate this request you must use a standard HTTP GET request.

You will be provided with a response of Content-Type 'text/xml'

The response will be generated 'on the fly' so it will usually take ~30 seconds to generate. You can set your client timeout at 90 seconds.

It is requested that you request this URL only a few times a day (a minimum interval of every 6 hours, 24 hours is recommended)

Request URL

https://secure.levartdistributionsystems.com.au/servers/unilodgeAgent.html?type=xml&apiKey=<APIKEY>

HTTP Response

Here is an example of the XML response.

<?xml version="1.0" encoding="UTF-8"?>
<AgentAPI>
  <Generated>2020-09-29T21:51:21+08:00</Generated>
  <ApiKey>de80d29b-6cb1-11b8-aa11-11aaa1e11111</ApiKey>
  <Properties>
    <Property>
      <Title>UniLodge Melbourne Test</Title>
      <Site>www.melbournetest.reserve.unilodge.com.au</Site>
      <Publish>1</Publish>
      <Url>https://www.unilodge.com.au/student-accommodation-melbourne/test</Url>
      <Phone>+61 3 9999 9999</Phone>
      <Email>test@unilodge.com.au</Email>
      <Country>Australia</Country>
      <City>Carlton</City>
      <State>Victoria</State>
      <Address>800 Swanston Street</Address>
      <Postcode>3053</Postcode>
      <Starrez>
        <CategoryId />
        <RoomLocationId />
      </Starrez>
      <Pois>
        <Poi>
          <Name>University of Melbourne - Parkville Campus</Name>
          <Latitude>-37.7963689</Latitude>
          <Longitude>144.96117379</Longitude>
          <Address />
          <City>Parkville</City>
          <Postcode>3010</Postcode>
          <State>Victoria</State>
          <Country>Australia</Country>
          <Distance>0.4</Distance>
        </Poi>
        <Poi>
          <Name>RMIT University - Melbourne City Campus</Name>
          <Latitude>-37.8076138</Latitude>
          <Longitude>144.96375139</Longitude>
          <Address>124 La Trobe Street</Address>
          <City>Melbourne</City>
          <Postcode>3000</Postcode>
          <State>Victoria</State>
          <Country>Australia</Country>
          <Distance>1.1</Distance>
        </Poi>
      </Pois>
      <ListingCity>Melbourne</ListingCity>
      <Latitude>-37.7977387</Latitude>
      <Longitude>144.9652707</Longitude>
      <MapUrl>https://maps.googleapis.com/maps/api/staticmap?key=AIzaSyCKLRWDomcJAx0RA1Apjgzq_JQnw-OZ6Wg&center=-37.7977387,144.9652707&zoom=16&size=400x200&maptype=roadmap&sensor=false&style=feature:poi.business|element:labels|visibility=off&markers=size:mid|color:blue|-37.7977387,144.9652707</MapUrl>
      <Currency>Australian Dollar</Currency>
      <CurrencyCode>AUD</CurrencyCode>
      <NonStudentAccepted>No</NonStudentAccepted>
      <Under18DomesticAccepted>Yes</Under18DomesticAccepted>
      <Under18InternationalAccepted>Yes</Under18InternationalAccepted>
      <ApartmentCount>553</ApartmentCount>
      <BedCount>839</BedCount>
      <Wing1Name />
      <Wing1FloorCount />
      <Wing1BedCount />
      <Wing2Name />
      <Wing2FloorCount />
      <Wing2BedCount />
      <PropertyInclusions>
        <PropertyInclusion>CSP Membership</PropertyInclusion>
      </PropertyInclusions>
      <RoomExclusions>
        <RoomExclusion>Electricity + Water</RoomExclusion>
      </RoomExclusions>
      <LanguageSupport>
        <LanguageSupport>Hindi</LanguageSupport>
      </LanguageSupport>
      <PropertyAmenities>
        <PropertyAmenity>Visitor Parking</PropertyAmenity>
      </PropertyAmenities>
      <InternetSpeed>25 Mbps</InternetSpeed>
      <ApplicationFee />
      <ApplicationFeeUnit />
      <ApplicationFeeUnitDesc />
      <ApplicationFeePayable />
      <ApplicationFeePayableDesc />
      <FacilityFee />
      <FacilityFeeUnit />
      <FacilityFeeUnitDesc />
      <ActivityFee />
      <ActivityFeeUnit />
      <ActivityFeeUnitDesc />
      <OtherFee1Name />
      <OtherFee1 />
      <OtherFee1Unit />
      <OtherFee1UnitDesc />
      <OtherFee2Name />
      <OtherFee2 />
      <OtherFee2Unit />
      <OtherFee2UnitDesc />
      <OtherFee3Name />
      <OtherFee3 />
      <OtherFee3Unit />
      <OtherFee3UnitDesc />
      <DepositQuantity>1month</DepositQuantity>
      <DepositQuantityDesc>1x Month Rent (4.33 Weeks)</DepositQuantityDesc>
      <AdvancedRentQuantity>1month</AdvancedRentQuantity>
      <AdvancedRentQuantityDesc>1x Month Rent (4.33 Weeks)</AdvancedRentQuantityDesc>
      <BookingCoolOff>No</BookingCoolOff>
      <TermsLink>https://www.unilodge.com.au/terms-conditions</TermsLink>
      <DepartureCleaningFee>300.00</DepartureCleaningFee>
      <DepartureCleaningFeeMandatory>Yes</DepartureCleaningFeeMandatory>
      <DepartureCleaningFeePayable>End of Lease</DepartureCleaningFeePayable>
      <LaundryCost>4.00</LaundryCost>
      <DryerCost>4.00</DryerCost>
      <RentCycle>Monthly</RentCycle>
      <PaymentOptions>
        <PaymentOption>BestPay</PaymentOption>
      </PaymentOptions>
      <CohortGoLink>https://unilodge-college-square-swanston.cohortgo.app</CohortGoLink>
      <CarparkCount />
      <CarparkCharge />
      <CarparkChargeCycle />
      <BikeStorageCharge />
      <BikeStorageChargeCycle />
      <AdditionalStorage>No</AdditionalStorage>
      <ResidentialLife>Yes</ResidentialLife>
      <UniversityApproval>All Universities</UniversityApproval>
      <Under18Approval>Melbourne University and Trinity College</Under18Approval>
      <PropertyBenefits>Large spacious size apartments; Prime Locations; On-site Facilities, Safe and Secure; Great Community Programs and Supports.</PropertyBenefits>
      <NrasEligibility />
      <BookingTerms />
      <PromotionDetails />
      <PromotionTerms />
      <PromotionStart />
      <PromotionEnd />
      <Rooms>
        <Room>
          <Id>9984</Id>
          <Title>1 Bedroom Twin Apartment Superior Large</Title>
          <CategoryTitle>1 Bedroom Twin Apartment</CategoryTitle>
          <RoomUrl>https://www.reserve.unilodge.com.au/categoryInfo.html?category=133#room9984</RoomUrl>
          <RoomSearchName>1 Bedroom Apartment</RoomSearchName> 
          <StarrezRoomType />
          <StarrezRoomOptionNames />
          <Images>
            <Image>
              <Src>https://www.reserve.unilodge.com.au/data/deposits/www.collegesquareonswanston.reserve.unilodge.com.au/galleryImage.2581.image/image.png</Src>
              <Caption>1 Bedroom Twin Apartment Superior Large</Caption>
            </Image>
          </Images>
          <BeddingOptions>
            <BeddingOption>2× Long Single Bed (Default Option)</BeddingOption>
          </BeddingOptions>
          <MaxOccupancy>2</MaxOccupancy>
          <MaxApartmentOccupancy>2</MaxApartmentOccupancy>
          <ApartmentRooms>1</ApartmentRooms>
          <FullRoomCount />
          <NrasEligibility>No</NrasEligibility>
          <RoomSize>59.80</RoomSize>
          <ApartmentSize />
          <RoomFurnished>Yes</RoomFurnished>
          <BathroomType>Ensuite</BathroomType>
          <ApartmentGender />
          <RoomAmenities>
            <RoomAmenity>TV</RoomAmenity>
          </RoomAmenities>
          <FloorCovering>Carpet</FloorCovering>
          <VirtualMediaLink />
          <StayPeriods>
            <StayPeriod>
              <Title>Semester 2</Title>
              <StayStart>Between 2020-09-29 and 2021-05-06</StayStart>
              <StayEnd>Between 2020-12-22 and 2021-07-29</StayEnd>
              <MinLos>12 weeks</MinLos>
              <MaxLos>52 weeks</MaxLos>
              <SellEnd>2021-05-06</SellEnd>
              <DiscountRate>376.00</DiscountRate>
              <OriginalRate>496.00</OriginalRate>
              <ExtraPersonCharge>0.00</ExtraPersonCharge>
              <DepositAmount>1629.00</DepositAmount>
              <AdvancedRentAmount>1629.00</AdvancedRentAmount>
              <ReservationStatus>Available</ReservationStatus>
              <AvailableInventory>100</AvailableInventory>
              <AvailableInventoryBand>10+ rooms available</AvailableInventoryBand>
              <NextAvailable>2020-09-29</NextAvailable>
            </StayPeriod>
          </StayPeriods>
        </Room>
      </Rooms>
    </Property>
  </Properties>
</AgentAPI>

Specification Agent XML Response