Skip to content

Programs

APIs for program managament.

LookupProgram

    core.LookupProgram(programKindId)

Load specific program kind.

  • programKindId:Uuid! id to load
  • Program or Nil

LookupProgramInstance

    core.LookupProgramInstance(programId)

Load a specific program instance.

  • programId:Uuid! id to load
  • ProgramInfo or Nil

ListCohorts

    core.ListCohorts(programId)

Load the cohort list.

  • programId:Uuid! id to load
  • Cohort Array

ModifyProgramMembership

    core.ModifyProgramMembership({...})

Add or update user program and cohort status. Either email or user id can be provided.

  • Object
    • email: String email
    • userId: UUID user id
    • programId: UUID! required program id
    • cohortId: UUID cohort id
    • role: String member | trainer | observer
    • state: String active | completed | graduated | incomplete | withdrawn
  • ProgramInfo Array

ListActivePrograms

    core.ListActivePrograms()    

Load a list of all active programs.

None

  • ProgramInfo Array

UserTickets

    core.UserTickets({...})

Retrieve tickets for a specific user. Tickets represent a right to participate in a program.

  • Object
    • userId: UUID user id
    • state ready | consumed | canceled
  • ProgramTicket Array

UpdateUserCohortState

CreateProgramTicket

ListClosingParticipants

Obsolete

The following functions can now be accomplished with the program query language.

  1. ListUserPrograms
  2. ListPrograms
  3. UserFuturePrograms
  4. UserActivePrograms