BigQuery Export

Explanation of the BigQuery API

StarRez Data Export

Data Source URL	https://secure.levartdistributionsystems.com.au/servers/unilodgeBigData.html?starrez=1
Data Format	Newline-delimited JSON
Method	GET
Authentication	Basic
Fetch Frequency	Daily
SegmentStream Project	UniLodge GA4

The StarRez data export contains both Applications/Bookings initiated directly from Levart (Online type) and also StarRez and also Applications/Bookings initiated from StarRez directly that have been created manually.

Flowchart

JSON Data Definition

{
  "entryId":10296,
  "property":"south-bank",
  "gender":"Male",
  "nationality":"Australian",
  "city":"Perth",
  "state":"WA",
  "country":"Australia",
  "internationalStudent":true,
  "nonStudent":true,
  "bookings":[
    {
      "bookingId":31151,
      "bookingType":"Online",
      "applicationNumber":"2354567",
      "arrival":"2020-01-27",
      "departure":"2021-01-21",
      "weeksDuration":51.4,
      "nightsDuration":360,
      "currentStatus":"In Room",
      "applicationTime":"2019-10-22T02:35:08Z",
      "heldTime":"2019-10-22T02:35:08Z",
      "reservedTime":"2019-10-22T02:35:08Z",
      "inRoomTime":"2019-10-22T02:35:08Z",
      "historyTime":"2019-10-22T02:35:08Z",
      "cancelledTime":"2019-10-22T02:35:08Z",
      "currency":"AUD",
      "weeklyRate":327.2,
      "total":16817.14,
      "inAustralia":true,
      "ageOnArrival":21,
      "under18":false,
      "roomType":"1 Bedroom Apartment",
      "rateType":"Full Year",
      "residents":1,
      "university":"TAFE - South Bank",
      "courseName":"Computer Science",
      "userAgent":"Mozilla",
      "isMobile":false,
      "isTablet":false,
      "agent": {
        "company": "UHOMES", 
        "name": "John Agent",
        "agentCode": "UHOMES1234",
        "agentCrm": "12345"
      }
    }
  ]
}

BigQuery Data Summary

Resource ID	segmentstream-274801
Dataset ID	segmentstream-274801.unilodge_ga4_us
Table ID	segmentstream-274801.unilodge_ga4_us.Console

Field Name	Type	Mode	Description
entryId	INTEGER	NULLABLE	StarRez Entry ID. This is essentially a unique customer record within StarRez.
property	STRING	NULLABLE	Property ID. e.g. 'south-bank'
gender	STRING	NULLABLE	Gender Type: 'Male', 'Female', 'Transgender male/Transman/FTM', 'Transgender female/Transwoman/MTF', 'Gender Queer', 'Non-Binary', 'Other', 'Decline to answer'
nationality	STRING	NULLABLE	Guest Nationality
city	STRING	NULLABLE	City e.g. Mumbai
state	STRING	NULLABLE	State
country	STRING	NULLABLE	Country e.g. India
internationalStudent	BOOLEAN	NULLABLE	International Student true/false
nonStudent	BOOLEAN	NULLABLE	Is a non-student applicant.
bookings	RECORD	REPEATED	Booking Array[]
> bookingId	INTEGER	NULLABLE	StarRez BookingID
> bookingType	STRING	NULLABLE	Booking Type: 'Online', 'Offline' or 'Renewal'. 'Online' represents an application was initiated through Levart. 'Offline' or 'Renewal' represents an action performed within StarRez only.
> applicationNumber	STRING	NULLABLE	Levart Application Number
> arrival	DATE	NULLABLE	Arrival Date
> departure	DATE	NULLABLE	Departure Date
> weeksDuration	FLOAT	NULLABLE	Weeks duration of stay
> nightsDuration	INTEGER	NULLABLE	Nights duration of stay
> currentStatus	STRING	NULLABLE	Current Status of the Application. Tentative, Held, Reserved, In Room, History, Cancelled
> applicationTime	TIMESTAMP	NULLABLE	The time the Application took place (UTC) When booking has been initiated, the status as this point is “Tentative”.
> heldTime	TIMESTAMP	NULLABLE	The time the Application progressed to Held (UTC) When deposit has been paid the status will be ‘Held”
> reservedTime	TIMESTAMP	NULLABLE	The time the Application progressed to Reserved status. (UTC) When the booking is confirmed and status is ‘Reserved’
> inRoomTime	TIMESTAMP	NULLABLE	The time the Application progressed to 'In Room' status. (UTC) When the user has arrived at the location and status is “in room”
> historyTime	TIMESTAMP	NULLABLE	The time the Application progressed to 'History' status. (UTC) When the user has checked out and status is “History”
> cancelledTime	TIMESTAMP	NULLABLE	The time the Application progressed to 'Cancelled' status. (UTC) When the user canceled the booking and status is “Canceled”
> currency	STRING	NULLABLE	Currency Code e.g. 'AUD'
> weeklyRate	FLOAT	NULLABLE	Weekly rate that was requested.
> total	FLOAT	NULLABLE	Total of accommodation for the whole stay
> inAustralia	BOOLEAN	NULLABLE	In Australia at the time of Application
> ageOnArrival	INTEGER	NULLABLE	Resident's Age on arival.
> under18	BOOLEAN	NULLABLE	Is the guest under 18 years old at the time of Arrival.
> roomType	STRING	NULLABLE	Room Type Title e.g. 'Studio Apartment'
> rateType	STRING	NULLABLE	Rate Type Title e.g. '12 Month Stay'
> residents	INTEGER	NULLABLE	Number of Residents
> university	STRING	NULLABLE	University Name
> courseName	STRING	NULLABLE	University Course Name
> userAgent	STRING	NULLABLE	HTTP User-Agent
> isMobile	BOOLEAN	NULLABLE	Applied on a mobile device
> isTablet	BOOLEAN	NULLABLE	Applied on a tablet device
agent	RECORD	NULLABLE	Agent Information Record
> company	STRING	NULLABLE	Agent Company Name
> name	STRING	NULLABLE	Agent Name
> agentCode	STRING	NULLABLE	Agent Code
> agentCrm	STRING	NULLABLE	Agent CRM

Console Data Export

Data Source URL	https://secure.levartdistributionsystems.com.au/servers/unilodgeBigData.html?console=1
Data Format	Newline-delimited JSON
Method	GET
Authentication	Basic
Fetch Frequency	Daily
SegmentStream Project	UniLodge GA4

The Console data export only contains applications initiated through Levart, thus has a slightly different data format than for the StarRez data export version.

Flowchart

JSON Data Definition

{
  "applicationNumber": "21582032",
  "property": "college-square-on-lygon",
  "email": "email@gmail.com",
  "gender": "Female",
  "nationality": "Indian",
  "city": "Carlton",
  "state": "Victoria",
  "country": "Australia",
  "internationalStudent": true,
  "nonStudent": false,
  "contactId": 15679882,
  "bookingType": "Online",
  "arrival": "2023-08-23",
  "departure": "2024-08-14",
  "weeksDuration": 51,
  "nightsDuration": 357,
  "currentStatus": "Offered",
  "applicationTime": "2024-05-29T06:56:08Z",
  "heldTime": "2024-05-29T06:56:08Z",
  "reservedTime": "2024-05-29T06:56:08Z",
  "inRoomTime": "2024-05-29T06:56:08Z",
  "historyTime": "2024-05-29T06:56:08Z",
  "cancelledTime": "2024-05-29T06:56:08Z",
  "currency": "AUD",
  "weeklyRate": 337.1,
  "total": 17186.1,
  "inAustralia": true,
  "ageOnArrival": 23,
  "under18": false,
  "roomType": "1 Bedroom",
  "rateType": "Full Year ",
  "residents": 1,
  "university": "Other",
  "courseName": "Masters in Business Analytics",
  "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
  "isMobile": false,
  "isTablet": false,
  "agent": {
    "company": "UHOMES", 
    "name": "John Agent",
    "email":"user@test.com",
    "phone":"123456789",
    "agentCode": "UHOMES1234",
    "agentCrm": "12345"
  },
  "tenantApplications": [
    {
      "tenantApplicationId": "0f2f93f8-addd-4308-aea3-9e12fb761c6d",
      "tenantApplicationProcessId": "ded22d5f-83bf-4fc6-a6ce-f27dbf2a8dcd",
      "status": "NEW",
      "applicants": [
        {
          "tenantApplicationApplicantId": "18991a7d-cec1-4abb-9e22-a8f476250e94",
          "contactId": 15679882
        }
      ],
      "createdDateTime": "2023-08-24T03:20:43.059Z",
      "lastUpdatedDateTime": "2023-08-24T03:20:43.059Z"
    }
  ]
}

BigQuery Data Summary

Resource ID	segmentstream-274801
Dataset ID	segmentstream-274801.unilodge_ga4_us
Table ID	segmentstream-274801.unilodge_ga4_us.Console

BigQuery Data Schema

Field Name	Type	Mode	Description
applicationNumber	STRING	NULLABLE	Levart Application Number
property	STRING	NULLABLE	Property ID e.g. 'south-bank'
email	STRING	NULLABLE	Email Address
gender	STRING	NULLABLE	Gender Type: 'Male', 'Female', 'Transgender male/Transman/FTM', 'Transgender female/Transwoman/MTF', 'Gender Queer', 'Non-Binary', 'Other', 'Decline to answer'
nationality	STRING	NULLABLE	Guest Nationality
city	STRING	NULLABLE	City e.g. Mumbai
state	STRING	NULLABLE	State
country	STRING	NULLABLE	Country e.g. India
internationalStudent	BOOLEAN	NULLABLE	International Student true/false
nonStudent	BOOLEAN	NULLABLE	Is a non-student applicant.
contactId	INTEGER	NULLABLE	Console 'Contact ID'
bookingType	STRING	NULLABLE	Only 'Online' status supported (Application initiated through Levart). (Offline and Renewal not supported)
arrival	DATE	NULLABLE	Arrival Date
departure	DATE	NULLABLE	Departure Date
weeksDuration	INTEGER	NULLABLE	Weeks duration of stay
nightsDuration	INTEGER	NULLABLE	Nights duration of stay
currentStatus	STRING	NULLABLE	Current Status of Application
applicationTime	TIMESTAMP	NULLABLE	The time the Application took place (UTC)
heldTime	TIMESTAMP	NULLABLE	The time the Application progressed to Held (UTC)
reservedTime	TIMESTAMP	NULLABLE	The time the Application progressed to Reserved status. (UTC)
inRoomTime	TIMESTAMP	NULLABLE	The time the Application progressed to 'In Room' status. (UTC)
historyTime	TIMESTAMP	NULLABLE	The time the Application progressed to 'History' status. (UTC)
cancelledTime	TIMESTAMP	NULLABLE	The time the Application progressed to 'Cancelled' status. (UTC)
currency	STRING	NULLABLE	Currency Code e.g. 'AUD'
weeklyRate	FLOAT	NULLABLE	Weekly rate that was requested.
total	FLOAT	NULLABLE	Total of accommodation for the whole stay
inAustralia	BOOLEAN	NULLABLE	In Australia at the time of Application
ageOnArrival	INTEGER	NULLABLE	Resident's Age on arival.
under18	BOOLEAN	NULLABLE	Is the guest under 18 years old at the time of Arrival.
roomType	STRING	NULLABLE	Room Type Title e.g. 'Studio Apartment'
rateType	STRING	NULLABLE	Rate Type Title e.g. '12 Month Stay'
residents	INTEGER	NULLABLE	Number of resuidents in this Application.
university	STRING	NULLABLE	University Name
courseName	STRING	NULLABLE	University Course Name
userAgent	STRING	NULLABLE	HTTP User-Agent
isMobile	BOOLEAN	NULLABLE	Applied on a mobile device
isTablet	BOOLEAN	NULLABLE	Applied on a tablet device
agent	RECORD	NULLABLE	Agent Information Record
> company	STRING	NULLABLE	Agent Company
> name	STRING	NULLABLE	Agent Name
> email	STRING	NULLABLE	Agent Email
> phone	STRING	NULLABLE	Agent Phone Number
> agentCode	STRING	NULLABLE	Agent Code
> agentCrm	STRING	NULLABLE	Agent CRM
tenantApplications	RECORD	REPEATED
> tenantApplicationId	STRING	NULLABLE	Console tenantApplicationId UUID
> tenantApplicationProcessId	STRING	NULLABLE	Console tenantApplicationProcessId UUID
> status	STRING	NULLABLE	Console Status: NEW
> applicants	RECORD	REPEATED	Applicants Attached to this Tenant Application (Inclusive of current applicant)
>> tenantApplicationApplicantId	STRING	NULLABLE	Console Tenant Application Applicant ID
>> contactId	INTEGER	NULLABLE	Console 'Contact ID' of the Applicant
> createdDateTime	TIMESTAMP	NULLABLE	Time that this tenantApplicationId was created. (UTC)
> lastUpdatedDateTime	TIMESTAMP	NULLABLE	Time that this tenantApplicationId was last updated. (UTC)