JSON 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 'application/json'

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=json&apiKey=<APIKEY>

HTTP Response

Here is an example of the JSON response.

{
  "generated":"2020-12-12T01:00:00+08:00",
  "apiKey":"de80d29b-6cb1-11b8-aa11-11aaa1e11111",
  "properties":[
    {
      "title":"Melbourne Example Property",
      "site":"www.property.reserve.unilodge.com.au",
      "publish":true,
      "url":"https:\/\/www.unilodge.com.au\/student-accommodation-melbourne\/property",
      "phone":"+61 3 9999 9999",
      "email":"property1@unilodge.com.au",
      "country":"Australia",
      "city":"Malbourne",
      "state":"Victoria",
      "address":"800 Melbourne Street",
      "postcode":"3000",
      "starrez":{
        "categoryId":null,
        "roomLocationId":null
      },
      "pois":[
        {
          "name": "University of Melbourne - Parkville Campus",
          "latitude": -37.7963689,
          "longitude": 144.96117379,
          "address": "224 Test St",
          "city": "Parkville",
          "postcode": "3010",
          "state": "Victoria",
          "country": "Australia",
          "distance": 0.4
        }
      ],
      "listingCity": "Melbourne"
      "latitude":"-37.7977387",
      "longitude":"144.9652707",
      "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",
      "currency":"Australian Dollar",
      "currencyCode":"AUD",
      "nonStudentAccepted":"No",
      "under18DomesticAccepted":"Yes",
      "under18InternationalAccepted":"Yes",
      "apartmentCount":"553",
      "bedCount":"839",
      "wing1Name":"",
      "wing1FloorCount":"",
      "wing1BedCount":"",
      "wing2Name":"",
      "wing2FloorCount":"",
      "wing2BedCount":"",
      "propertyInclusions":[
        "unlimited WiFi Internet",
        "Gas",
        "Content insurance",
        "CSP Membership"
      ],
      "roomExclusions":[
        "Electricity + Water"
      ],
      "languageSupport":[
        "Filipino",
        "Indonesian",
        "Hindi"
      ],
      "propertyAmenities":[
        "Vending machines",
        "24-hour security",
        "Laundry",
        "Bilingual staff",
        "Coin or card operated laundry",
        "Conference facilities",
        "Courtyard",
        "Elevators",
        "Exercise gym",
        "Outdoor pool"
      ],
      "internetSpeed":"25 Mbps",
      "applicationFee":"",
      "applicationFeeUnit":"",
      "applicationFeeUnitDesc":null,
      "applicationFeePayable":"",
      "applicationFeePayableDesc":null,
      "facilityFee":"",
      "facilityFeeUnit":"",
      "facilityFeeUnitDesc":null,
      "activityFee":"",
      "activityFeeUnit":"",
      "activityFeeUnitDesc":null,
      "otherFee1Name":"",
      "otherFee1":"",
      "otherFee1Unit":"",
      "otherFee1UnitDesc":null,
      "otherFee2Name":"",
      "otherFee2":"",
      "otherFee2Unit":"",
      "otherFee2UnitDesc":null,
      "otherFee3Name":"",
      "otherFee3":"",
      "otherFee3Unit":"",
      "otherFee3UnitDesc":null,
      "depositQuantity":"1month",
      "depositQuantityDesc":"1x Month Rent (4.33 Weeks)",
      "advancedRentQuantity":"1month",
      "advancedRentQuantityDesc":"1x Month Rent (4.33 Weeks)",
      "bookingCoolOff":"No",
      "termsLink":"https:\/\/www.unilodge.com.au\/terms-conditions",
      "departureCleaningFee":"300.00",
      "departureCleaningFeeMandatory":"Yes",
      "departureCleaningFeePayable":"End of Lease",
      "laundryCost":"4.00",
      "dryerCost":"4.00",
      "rentCycle":"Monthly",
      "paymentOptions":[
        "Direct Debit (from a nominated Australian bank account)",
        "Bank Transfer (into the UniLodge Bank Account)",
        "Credit Card",
        "EFTPOS (At reception during business hours)",
        "JD Pay",
        "WeChat",
        "AliPay",
        "BestPay"
      ],
      "cohortGoLink":"https:\/\/unilodge-college-square-swanston.cohortgo.app",
      "carparkCount":null,
      "carparkCharge":"",
      "carparkChargeCycle":null,
      "bikeStorageCharge":"",
      "bikeStorageChargeCycle":null,
      "additionalStorage":"No",
      "residentialLife":"Yes",
      "universityApproval":"All Universities",
      "under18Approval":"Melbourne University and Trinity College",
      "propertyBenefits":"Large spacious size apartments; Prime Locations; On-site Facilities, Safe and Secure; Great Community Programs and Supports.",
      "nrasEligibility":"",
      "bookingTerms":"",
      "promotionDetails":"",
      "promotionTerms":"",
      "promotionStart":"",
      "promotionEnd":"",
      "rooms":[
        {
          "id":9983,
          "title":"2 Bedroom Apartment Superior Large",
          "categoryTitle":"2 Bedroom Apartment",
          "roomUrl":"https:\/\/www.reserve.unilodge.com.au\/categoryInfo.html?category=134#room9983",
          "roomSearchName":"2 Bedroom Apartment", 
          "starrezRoomType":null,
          "starrezRoomOptionNames":null,
          "images":[
            {
              "src":"https:\/\/www.reserve.unilodge.com.au\/data\/deposits\/www.collegesquareonswanston.reserve.unilodge.com.au\/galleryImage.2249.image\/image.png",
              "caption":"2 Bedroom Apartment Superior Large"
            },
            {
              "src":"https:\/\/www.reserve.unilodge.com.au\/data\/deposits\/www.collegesquareonswanston.reserve.unilodge.com.au\/galleryImage.2186.image\/image.png",
              "caption":"2 Bedroom Apartment Superior Large"
            }
          ],
          "beddingOptions":[
            "1\u00d7 Double Bed (Default Option)"
          ],
          "maxOccupancy":2,
          "maxApartmentOccupancy":4,
          "apartmentRooms":2,
          "fullRoomCount":null,
          "nrasEligibility":"No",
          "roomSize":"69.40 - 70.50",
          "apartmentSize":"69.40 - 70.50",
          "roomFurnished":"Yes",
          "bathroomType":"Ensuite",
          "apartmentGender":null,
          "roomAmenities":[
            "Air conditioning",
            "Alarm clock",
            "AM\/FM radio",
            "Data port"
          ],
          "floorCovering":"Carpet",
          "virtualMediaLink":null,
          "stayPeriods":[
            {
              "title":"Semester 2",
              "stayStart":"Between 2020-09-23 and 2021-05-06",
              "stayEnd":"Between 2020-12-16 and 2021-07-29",
              "minLos":"12 weeks",
              "maxLos":"52 weeks",
              "sellEnd":"2021-05-06",
              "discountRate":"533.00",
              "originalRate":"683.00",
              "extraPersonCharge":"0.00",
              "depositAmount": "2310.00",
              "advancedRentAmount": "2310.00",
              "reservationStatus": "Available",
              "availableInventory": 100,
              "availableInventoryBand": "10+ rooms available",
              "nextAvailable": "23\/09\/2020"
            }
          ]
        }
      ]
    }
  ]
}

Specification Agent JSON Response