Data objects

Tour object

Contains the tour id, name, description, date, start time, end time, guest count, rate, current status, and bid closing date

{
    id: TOUR_ID,
    name: TOUR_NAME,
    imageURL: IMAGE_URL,
    description: TOUR_DESCRIPTION,
    poiCount: NUMBER_OF_POINTS_OF_INTEREST,
    distance: DISTANCE, <Change UNIT in settings>
    duration: TOUR_DURATION,
    status: STATUS, (NEW | OPEN | OPTED_IN)
    packURL: PACK_URL (URL | NULL)
    packSize: PACK_SIZE (NUMBER | NULL)
}

Opportunity object

Contains the tour id, name, description, date, start time, end time, guest count, rate, current status, and bid closing date

{
    id: TOUR_ID,
    name: TOUR_NAME,
    description: TOUR_DESCRIPTION,
    date: YYYYMMDD,
    start: HHMM,
    end: HHMM,
    guestCount: NUMBER_OF_GUESTS,
    rate: RATE,
    status: STATUS, (NEW | OPEN | BID | ACCEPTED | REJECTED)
    closingDate: YYYYMMDD,
}

Scheduled Tour object

{
    bookingId: BOOKING_ID,
    messageThreadId: MESSAGE_THREAD_ID,
    tourId: TOUR_ID,
    tourName: TOUR_NAME,
    date: YYYYMMDD,
    start: HHMM,
    end: HHMM,
    guestCount: NUMBER_OF_GUESTS,    
    customerName: CUSTOMER_NAME,
}

Message Thread object

Contains two arrays of message objects, one for TCL messages and one for client messages

{
    bookingId: BOOKING_ID,
    messageThreadId: MESSAGE_THREAD_ID,
    label: {
        customerName: CUSTOMER_NAME,
        tourName: TOUR_NAME,
        tourDate: YYYYMMDD,
        tourStart: HHMM,
    },
    tclMessages: [
        MESSAGE_OBJECT,
        MESSAGE_OBJECT...
    ],
    clientMessages: [        
        MESSAGE_OBJECT,
        MESSAGE_OBJECT...
    ]
}

Message object

Contains the message text, timestamp, and whether the message is incoming or outgoing

{
    id: MESSAGE_ID,
    timestamp: YYYYMMDDHHMM,
    message: MESSAGE_TEXT,
    attachments: [
        ATTACHMENT_OBJECT,
        ATTACHMENT_OBJECT...
    ],
    isIncoming: BOOLEAN,
    isRead: BOOLEAN,
}

Attachment object

Contains the attachment type, url, and thumbnail url

{
    type: ATTACHMENT_TYPE, (IMAGE | VIDEO | AUDIO | DOCUMENT | OTHER)
    url: ATTACHMENT_URL,
    thumbnailUrl: ATTACHMENT_THUMBNAIL_URL,
}

Last modified: 19 December 2023