OBJECT

Query

link GraphQL Schema definition

  • type Query {
  • # Operation will retrieve the first user found matching the corresponding
  • # criteria.
  • #
  • # The query attribute will be automatically inferred from the criteria.
  • #
  • # If the criteria is invalid operation will throw an error.
  • #
  • # (Valid criteria: `phone`, `studentId`, or `id`.)
  • # Uniqueness of the `id` attribute is validated by the Database System.
  • #
  • # Uniqueness of the `email`attribute is validated by the Auth System.
  • #
  • # Uniqueness of the `phone`attribute is not validated.
  • #
  • # Arguments
  • # criteria: Criteria to query the user against.
  • user(criteria: UserSearchCriteria!): User
  • # Operation will retrieve all users matching the parameters.
  • #
  • # A user can only query users with a role of a lesser hierarchy than theirs,
  • # except when a valid API Key is provided and it has the necessary privilages.
  • #
  • # Results can be paginated by the `first` and `after` arguments.
  • #
  • # Arguments
  • # role: Assumed to include all.
  • # campus: Assumed to include all. (Cannot be set without setting
  • # `role`)
  • # first: Assumed to be 100. Limits the results given.
  • # after: The `id` of the item *after* which to start retrieving
  • users(role: Role, campus: Campus, first: Int, after: CarneteID): [User]!
  • # Returns a `Team` with the given id
  • #
  • # Arguments
  • # id: Id of the item.
  • team(id: CarneteID!): Team!
  • # Returns an `Experience` with the given id
  • #
  • # Arguments
  • # id: Id of the item.
  • experience(id: CarneteID!): Experience!
  • # Operation will retrieve all experiences that will occur after the given datr and
  • # that
  • # match the given campus.
  • #
  • # Results can be paginated by the `first` and `after` arguments.
  • #
  • # Arguments
  • # fromDate: Assumed to be today.
  • # If you pass "ALLTIME" it will be taken to mean all time (past and future).
  • # endDate: End date to limit the query. Assumed to be never.
  • # campus: Assumed to include all.
  • # first: Assumed to be 100. Limits the results given.
  • # after: The `id` of the item *after* which to start retrieving.
  • # queryIntercampus: Wether query or not intercampus experiences.
  • # Default true
  • # userInstitution: Institution of the user for which to filter
  • # the results.
  • #
  • # If user institution is "TEC", all experiences are returned.
  • #
  • # If user institution is "EXT", only experiences with `audience`
  • # set to `EVERYONE` will be returned.
  • #
  • # This filter will occurr **after** the matching items are retrievied,
  • # meaning it will subtract from whatever the `first` argument instructs.
  • experiences(
  • fromDate: DateString,
  • endDate: DateString,
  • campus: Campus,
  • first: Int,
  • after: CarneteID,
  • queryIntercampus: Boolean,
  • userInstitution: Institution
  • ): [Experience]!
  • # Operation will retrieve all experiences that will occur after the given date,
  • # that match
  • # the given campus.
  • #
  • # Results can be paginated by the `first` and `after` arguments.
  • #
  • # Arguments
  • # campus: Assumed to include all.
  • # first: Assumed to be 100. Limits the results given.
  • # after: The `id` of the item *after* which to start retrieving
  • teams(campus: Campus, first: Int, after: CarneteID): [Team]!
  • # Operation will all reviews found matching the corresponding criteria.
  • #
  • # The query attribute will be automatically inferred from the criteria.
  • #
  • # If the criteria is invalid operation will throw an error.
  • #
  • # (Valid criteria: `experienceId`, `teamId`, `userId`, or `id`.)
  • #
  • # Arguments
  • # criteria: Criteria to query the Reviews against.
  • review(criteria: ReviewSearchCriteria!): [Review]!
  • # Arguments
  • # campus: [Not documented]
  • campusExperienceAnalytics(campus: Campus!): CampusExperienceAnalytics!
  • }

link Require by

This element is not required by anyone