This section correlates this documentation with the implementation status in Hasura using the following scale:

• Scoping: Requirements are being gathered and work is being assessed.
• In Queue: Work scheduled.
• Schema: Schema defined and available but no data
• Development: Development ecosystem data available
• Production: Production ecosystem data available

As of 2023-02-17, features had the following statuses:

• Authentication: Development
• Authorization: Development
• Profile information: Development
• Reservations and events: Schema but Development very close
• Orders and products: Schema but Development very close
• Content: Schema
• User state: Scoping
• Messages: Scoping

This API uses JWT authentication.

JWTs can be obtained through your Auth0 application.

Application credentials provided upon request.

You must provide both the clientId and audience when authenticating with Auth0. If you omit the audience Auth0 will return a JWT with an empty payload!

For general users with the person role, queries to most tables will only return data if it is related to the logged in user's personId.

This means you don't have to add conditions to your queries restricting them to your user's Id.

You'll still want to use the _by_pk queries when looking up an individual object. But if you're getting all Reservations for your user, you don't need a where clause specifying the user Id.

In GraphQL, a query is a request to a server to retrieve data. Queries are written in the GraphQL query language, which is similar to JSON.

The server response to a GraphQL query contains only the data specified in the query. This allows the client to retrieve only the data it needs, reducing the amount of data sent over the network.

Basic Query

query GetAllPeople {
  Person {
    email
    familyName
    givenName
  }
}

The GraphQL query is fetching data from the "Person" type in the GraphQL server and requesting the "email," "familyName," and "givenName" fields. The query is named "GetAllPeople". The response from the server will contain a list of all people and the values for the specified fields.

In GraphQL, variables allow you to pass dynamic values to a query or mutation. Instead of hardcoding values directly in the query, you can define variables in your client and then pass those variables as arguments in the query. Variables are defined with a $ symbol in the query and are passed as an additional argument to the query, separate from the actual query.

For example, instead of hardcoding the values in the following query, you could use variables as demonstrated:

Query

query GetPersonByIdentifier(
  $valueReference: String!, $name: String!, $value: String!) {
    Person(where: {
        identifier: {
            valueReference: { _eq: $valueReference }, 
            value: { _eq: $value }, 
            name: { _eq: $name }
        }
    }
    ) {
        familyName
        givenName
        id
        honorificPrefix
        honorificSuffix
        telephone
        email
    }
}

And then you can pass the actual values as variables in your client:

{
  "valueReference": "AnExternalSystem", 
  "name": "user_identifier", 
  "value": "testing123"
}

Using variables in this way can make your queries more flexible and reusable, as you can pass different values to the same query without having to modify the query text. It can also help to prevent security issues such as SQL injection by ensuring that user-supplied data is always passed as a variable and never directly included in the query.

Specific Examples

A Person and Their Reservations (Visits)

Starting from a PersonIdentifier

Query

query GetPersonByIdentifier(
  $valueReference: String!, 
  $name: String!, 
  $value: String!) 
  {
    Person(where: {
      identifier: {
        valueReference: {_eq: $valueReference}, 
        value: {_eq: $value}, 
        name: {_eq: $name}}
    }) {
    familyName
    givenName
    id
    honorificPrefix
    honorificSuffix
    telephone
    email
    reservation {
      bookingTime
      reservationFor {
        doorTime
        startDate
        endDate
        eventStatus {
          name
        }
        superEvent {
          id
          eventStatus {
            name
          }
          location {
            id
            name
          }
        }
      }
    }
  }
}

Variable Values

{
  "valueReference": "AnExternalSystem", 
  "name": "user_identifier", 
  "value": "testing123"
}

Get Orders by Person

Query

query GetPersonByIdentifier(
  $valueReference: String!, $name: String!, $value: String!) {
  Person(where: {
    identifier: {
      valueReference: {_eq: $valueReference},
      value: {_eq: $value}, 
      name: {_eq: $name}
      }
    }
  ) {
    familyName
    givenName
    id
    honorificPrefix
    honorificSuffix
    telephone
    email
    order {
      id
      isGift
      orderedItem {
        orderQuantity
        totalPaymentDue
        product {
          name
        }
      }
      totalPaymentDue
      seller {
        id
        name
      }
    }
  }
}

Variable Values

{
  "valueReference": "AnExternalSystem", 
  "name": "user_identifier", 
  "value": "testing123"
}

User profile data spans multiple tables, but can be quickly accessed through the Person table.

The query below will grab data for the user, their address book, their reservations, and the tickets for each reservation.

Query

query GetUserProfile {
  Person {
    givenName
    familyName
    telephone
    email
    homeLocationId
    address {
      id
      streetAddress
      postalCode
      postOfficeBoxNumber
    }
    reservation {
      bookingTime
      reservedTicket {
        ticketNumber
        ticketToken
      }
    }
  }
}

User Reservations

If you don't need user details and just want to look up their Reservations, you can query the Reservations table directly. Through this we can also see the tickets assigned to the reservation.

Query

query GetUserReservations {
              Reservation {
                bookingTime
                reservedTicket {
                  ticketNumber
                  ticketToken     
                }
              }
            }
            
            

User Tickets

Maybe you just want to see your user's Tickets

Query

query GetUserTickets {
  Ticket {
    id
    ticketNumber
    ticketToken
    dateIssued
  }
}

These queries are for development only and will change in the future.

Get A Specific Video

query GetMediaById($id: String!) {
  mediaObject(_filter: {id: {_eq: $id}}) {
    id
    name
    contentUrl
  }
}

Get All Gyre Videos

query GetMediaByKeyword {
  mediaObject(keyword: "Gyre Peephole") {
    id
    name
    contentUrl
  }
}

Common Fields

Here is an example query returning the most commonly used fields on the MediaObject.

query GetMedia {
  mediaObject {
    id
    name
    description
    contentUrl
    duration
    height
    thumbnail
    width
    size
    isPartOfExhibition {
      id
      name
    }
    isPArtOfAnchor {
      id
      name
    }
    isPartOfNarrativePlace {
      id
      name
    }
    isPartOfNarrativeStory {
      id
      name
    }
    isPartOfProject {
      id
      name
    }
  }
}