GraphQL API Reference
This GraphQL API provides programmatic access to the Collaboratory Data Warehouse, enabling consumers to execute structured queries directly against the stored data.
The API is structured around a series of operations, which are categorized as mutations in the GraphQL schema. Despite the use of the term "mutations," it's important to note that this API is strictly read-only; it does not support any operations that alter data.
Clients can leverage these mutations to apply various filters and perform geolocation-based queries on activities stored within the warehouse.
The API's design ensures that data retrieval is both efficient and tailored to the specific requirements of the client application, without permitting any form of data manipulation or entry.
Terms of Service
API Endpoints
# Staging:
https://reportingapi-staging.cecollaboratory.com/graphql
# Production:
https://reportingapi.cecollaboratory.com/graphql
Headers
# Your key for accessing the API
X-Api-Key: <YOUR_API_KEY_HERE>Important
While we strive to maintain stability in the API, continuous improvement is a cornerstone of our development philosophy. Consequently, enhancements and modifications may occur as part of our commitment to evolving the API's capabilities and performance. Users are encouraged to regularly consult the API documentation for updates on any changes.
Mutations
getActivitiesCoursesFunc
Description
Function to retrieve activities associated with courses based on filters.
Response
Returns a GetActivitiesCoursesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivitiesCoursesFuncInput!
|
Example
Query
mutation GetActivitiesCoursesFunc($input: GetActivitiesCoursesFuncInput!) {
getActivitiesCoursesFunc(input: $input) {
results {
totalRows
insertTimestamp
id
authorId
created
modified
archived
deleted
slug
name
description
startTime
endTime
latitude
longitude
logoId
logoUrl
url
productId
externalId
mutualBenefit
reciprocity
scholarship
teaching
scholarlyResearch
studentParticipation
studentMembers
studentMembersActual
studentHours
facultyParticipation
facultyMembers
reflections
reflectionDescription
frequency
contactPhonePublic
contactEmailPublic
irbProtocol
irbProtocolId
individualsServed
communityInsight
goalsFeedback
focuses
focusAreas
populations
organizingFramework
eventsServices
scholarshipTypes
expectedScholarlyOutputs
achievedScholarlyOutputs
expectedPsOutputs
achievedPsOutputs
expectedOutcomes
achievedOutcomes
expectedImpacts
achievedImpacts
researchTypes
externalPartners
studentHoursActual
modifiedBy
status
contactFirstname
contactLastname
contactEmail
contactOffice
contactPhone
contactPrivateEmail
contactPrivateName
primaryActivity
type
featured
contactPrivatePhone
portalId
activityLead
activityLeadStatus
distance
address
funders
communities
units
programs
faculties
institutions
courses
enrolledParticipation
enrolledHours
}
}
}
Variables
{"input": GetActivitiesCoursesFuncInput}
Response
{
"data": {
"getActivitiesCoursesFunc": {
"results": [GetActivitiesCoursesFuncRecord]
}
}
}
getActivitiesFunc
Description
Retrieves active portal activities, excluding those that are deleted or archived.
Response
Returns a GetActivitiesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivitiesFuncInput!
|
Example
Query
mutation GetActivitiesFunc($input: GetActivitiesFuncInput!) {
getActivitiesFunc(input: $input) {
results {
totalRows
insertTimestamp
id
authorId
created
modified
archived
deleted
slug
name
description
startTime
endTime
latitude
longitude
logoId
logoUrl
url
productId
externalId
mutualBenefit
reciprocity
scholarship
teaching
scholarlyResearch
studentParticipation
studentMembers
studentMembersActual
studentHours
facultyParticipation
facultyMembers
reflections
reflectionDescription
frequency
contactPhonePublic
contactEmailPublic
irbProtocol
irbProtocolId
individualsServed
communityInsight
goalsFeedback
focuses
focusAreas
populations
organizingFramework
eventsServices
scholarshipTypes
expectedScholarlyOutputs
achievedScholarlyOutputs
expectedPsOutputs
achievedPsOutputs
expectedOutcomes
achievedOutcomes
expectedImpacts
achievedImpacts
researchTypes
externalPartners
studentHoursActual
modifiedBy
status
contactFirstname
contactLastname
contactEmail
contactOffice
contactPhone
contactPrivateEmail
contactPrivateName
primaryActivity
type
featured
contactPrivatePhone
portalId
activityLead
activityLeadStatus
virtualupdated
unitsupdated
virtualLocation
physicalLocation
distance
address
funders
communities
units
programs
faculties
institutions
}
}
}
Variables
{"input": GetActivitiesFuncInput}
Response
{
"data": {
"getActivitiesFunc": {
"results": [GetActivitiesFuncRecord]
}
}
}
getActivityAddressFunc
Description
Retrieves the address of a specific activity based on its ID.
Response
Returns a GetActivityAddressFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityAddressFuncInput!
|
Example
Query
mutation GetActivityAddressFunc($input: GetActivityAddressFuncInput!) {
getActivityAddressFunc(input: $input) {
addresses
}
}
Variables
{"input": GetActivityAddressFuncInput}
Response
{
"data": {
"getActivityAddressFunc": {
"addresses": ["abc123"]
}
}
}
getActivityCommunityOrgFunc
Description
Retrieves community organizations associated with a specific activity.
Response
Returns a GetActivityCommunityOrgFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityCommunityOrgFuncInput!
|
Example
Query
mutation GetActivityCommunityOrgFunc($input: GetActivityCommunityOrgFuncInput!) {
getActivityCommunityOrgFunc(input: $input) {
communities
}
}
Variables
{"input": GetActivityCommunityOrgFuncInput}
Response
{
"data": {
"getActivityCommunityOrgFunc": {
"communities": ["xyz789"]
}
}
}
getActivityCountByFocusesDrilldownFunc
Description
Retrieves drilldown count of activities by focus areas.
Response
Arguments
| Name | Description |
|---|---|
input - GetActivityCountByFocusesDrilldownFuncInput!
|
Example
Query
mutation GetActivityCountByFocusesDrilldownFunc($input: GetActivityCountByFocusesDrilldownFuncInput!) {
getActivityCountByFocusesDrilldownFunc(input: $input) {
results {
totalRows
focusArea
activityCnt
}
}
}
Variables
{"input": GetActivityCountByFocusesDrilldownFuncInput}
Response
{
"data": {
"getActivityCountByFocusesDrilldownFunc": {
"results": [
GetActivityCountByFocusesDrilldownFuncRecord
]
}
}
}
getActivityCountByFocusesFunc
Description
Retrieves the count of activities by focus areas.
Response
Returns a GetActivityCountByFocusesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityCountByFocusesFuncInput!
|
Example
Query
mutation GetActivityCountByFocusesFunc($input: GetActivityCountByFocusesFuncInput!) {
getActivityCountByFocusesFunc(input: $input) {
results {
totalRows
focuses
activityCnt
focusAreas
}
}
}
Variables
{"input": GetActivityCountByFocusesFuncInput}
Response
{
"data": {
"getActivityCountByFocusesFunc": {
"results": [GetActivityCountByFocusesFuncRecord]
}
}
}
getActivityCountByTargetFunc
Description
Retrieves the count of activities by target population.
Response
Returns a GetActivityCountByTargetFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityCountByTargetFuncInput!
|
Example
Query
mutation GetActivityCountByTargetFunc($input: GetActivityCountByTargetFuncInput!) {
getActivityCountByTargetFunc(input: $input) {
results {
totalRows
population
activityCnt
}
}
}
Variables
{"input": GetActivityCountByTargetFuncInput}
Response
{
"data": {
"getActivityCountByTargetFunc": {
"results": [GetActivityCountByTargetFuncRecord]
}
}
}
getActivityCountByUnitsFunc
Description
Retrieves the count of activities associated with units based on filters.
Response
Returns a GetActivityCountByUnitsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityCountByUnitsFuncInput!
|
Example
Query
mutation GetActivityCountByUnitsFunc($input: GetActivityCountByUnitsFuncInput!) {
getActivityCountByUnitsFunc(input: $input) {
results {
totalRows
unitId
unitName
activitiesCnt
}
}
}
Variables
{"input": GetActivityCountByUnitsFuncInput}
Response
{
"data": {
"getActivityCountByUnitsFunc": {
"results": [GetActivityCountByUnitsFuncRecord]
}
}
}
getActivityCountFunc
Description
Function to retrieve the count of activities based on filters.
Response
Returns a GetActivityCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityCountFuncInput!
|
Example
Query
mutation GetActivityCountFunc($input: GetActivityCountFuncInput!) {
getActivityCountFunc(input: $input) {
results {
portalid
count
}
}
}
Variables
{"input": GetActivityCountFuncInput}
Response
{
"data": {
"getActivityCountFunc": {
"results": [GetActivityCountFuncRecord]
}
}
}
getActivityCoursesFunc
Description
Retrieves courses associated with a specific activity.
Response
Returns a GetActivityCoursesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityCoursesFuncInput!
|
Example
Query
mutation GetActivityCoursesFunc($input: GetActivityCoursesFuncInput!) {
getActivityCoursesFunc(input: $input) {
results {
totalRows
activityId
activityName
activityCreated
courses
}
}
}
Variables
{"input": GetActivityCoursesFuncInput}
Response
{
"data": {
"getActivityCoursesFunc": {
"results": [GetActivityCoursesFuncRecord]
}
}
}
getActivityFacultyStaffFunc
Description
Retrieves faculty and staff associated with a specific activity.
Response
Returns a GetActivityFacultyStaffFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityFacultyStaffFuncInput!
|
Example
Query
mutation GetActivityFacultyStaffFunc($input: GetActivityFacultyStaffFuncInput!) {
getActivityFacultyStaffFunc(input: $input) {
faculties
}
}
Variables
{"input": GetActivityFacultyStaffFuncInput}
Response
{
"data": {
"getActivityFacultyStaffFunc": {
"faculties": ["abc123"]
}
}
}
getActivityFundersCountFunc
Response
Returns a GetActivityFundersCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityFundersCountFuncInput!
|
Example
Query
mutation GetActivityFundersCountFunc($input: GetActivityFundersCountFuncInput!) {
getActivityFundersCountFunc(input: $input) {
integer
}
}
Variables
{"input": GetActivityFundersCountFuncInput}
Response
{"data": {"getActivityFundersCountFunc": {"integer": 42}}}
getActivityFundersFunc
Response
Returns a GetActivityFundersFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityFundersFuncInput!
|
Example
Query
mutation GetActivityFundersFunc($input: GetActivityFundersFuncInput!) {
getActivityFundersFunc(input: $input) {
results {
totalRows
insertTimestamp
activityId
funderId
name
startTs
endTs
amount
source
deleted
}
}
}
Variables
{"input": GetActivityFundersFuncInput}
Response
{
"data": {
"getActivityFundersFunc": {
"results": [GetActivityFundersFuncRecord]
}
}
}
getActivityFundersTotalAmountFunc
Description
Retrieves the total amount funded for activities based on filters.
Response
Returns a GetActivityFundersTotalAmountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityFundersTotalAmountFuncInput!
|
Example
Query
mutation GetActivityFundersTotalAmountFunc($input: GetActivityFundersTotalAmountFuncInput!) {
getActivityFundersTotalAmountFunc(input: $input) {
integer
}
}
Variables
{"input": GetActivityFundersTotalAmountFuncInput}
Response
{"data": {"getActivityFundersTotalAmountFunc": {"integer": 42}}}
getActivityInstitutionsFunc
Response
Returns a GetActivityInstitutionsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityInstitutionsFuncInput!
|
Example
Query
mutation GetActivityInstitutionsFunc($input: GetActivityInstitutionsFuncInput!) {
getActivityInstitutionsFunc(input: $input) {
institutions
}
}
Variables
{"input": GetActivityInstitutionsFuncInput}
Response
{
"data": {
"getActivityInstitutionsFunc": {
"institutions": ["xyz789"]
}
}
}
getActivityLearnigObjectivesFunc
Description
Retrieves learning objectives associated with a specific activity.
Response
Returns a GetActivityLearnigObjectivesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityLearnigObjectivesFuncInput!
|
Example
Query
mutation GetActivityLearnigObjectivesFunc($input: GetActivityLearnigObjectivesFuncInput!) {
getActivityLearnigObjectivesFunc(input: $input) {
results {
totalRows
activityId
activityName
activityCreated
learningObjectives
}
}
}
Variables
{"input": GetActivityLearnigObjectivesFuncInput}
Response
{
"data": {
"getActivityLearnigObjectivesFunc": {
"results": [GetActivityLearnigObjectivesFuncRecord]
}
}
}
getActivityPedagogiesFunc
Description
Retrieves pedagogies associated with a specific activity.
Response
Returns a GetActivityPedagogiesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityPedagogiesFuncInput!
|
Example
Query
mutation GetActivityPedagogiesFunc($input: GetActivityPedagogiesFuncInput!) {
getActivityPedagogiesFunc(input: $input) {
results {
totalRows
activityId
activityName
activityCreated
pedagogies
}
}
}
Variables
{"input": GetActivityPedagogiesFuncInput}
Response
{
"data": {
"getActivityPedagogiesFunc": {
"results": [GetActivityPedagogiesFuncRecord]
}
}
}
getActivityProgramsFunc
Description
Retrieves programs associated with a specific activity.
Response
Returns a GetActivityProgramsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetActivityProgramsFuncInput!
|
Example
Query
mutation GetActivityProgramsFunc($input: GetActivityProgramsFuncInput!) {
getActivityProgramsFunc(input: $input) {
programs
}
}
Variables
{"input": GetActivityProgramsFuncInput}
Response
{
"data": {
"getActivityProgramsFunc": {
"programs": ["xyz789"]
}
}
}
getCommIndividualsServedActTotalsFunc
Description
Retrieves the total number of activities associated by individuals in the community.
Response
Arguments
| Name | Description |
|---|---|
input - GetCommIndividualsServedActTotalsFuncInput!
|
Example
Query
mutation GetCommIndividualsServedActTotalsFunc($input: GetCommIndividualsServedActTotalsFuncInput!) {
getCommIndividualsServedActTotalsFunc(input: $input) {
results {
totalRows
activityCnt
}
}
}
Variables
{"input": GetCommIndividualsServedActTotalsFuncInput}
Response
{
"data": {
"getCommIndividualsServedActTotalsFunc": {
"results": [
GetCommIndividualsServedActTotalsFuncRecord
]
}
}
}
getCommunityCountByFocusesDrilldownFunc
Description
Retrieves the count of community organizations based on focus areas drilldown.
Response
Arguments
| Name | Description |
|---|---|
input - GetCommunityCountByFocusesDrilldownFuncInput!
|
Example
Query
mutation GetCommunityCountByFocusesDrilldownFunc($input: GetCommunityCountByFocusesDrilldownFuncInput!) {
getCommunityCountByFocusesDrilldownFunc(input: $input) {
results {
totalRows
focusArea
organizationCnt
}
}
}
Variables
{"input": GetCommunityCountByFocusesDrilldownFuncInput}
Response
{
"data": {
"getCommunityCountByFocusesDrilldownFunc": {
"results": [
GetCommunityCountByFocusesDrilldownFuncRecord
]
}
}
}
getCommunityOrgByFocusesFunc
Description
Retrieves community organizations by focus areas.
Response
Returns a GetCommunityOrgByFocusesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCommunityOrgByFocusesFuncInput!
|
Example
Query
mutation GetCommunityOrgByFocusesFunc($input: GetCommunityOrgByFocusesFuncInput!) {
getCommunityOrgByFocusesFunc(input: $input) {
results {
totalRows
id
name
street
street2
zipcode
city
state
county
country
latitude
longitude
type
description
url
phone
email
archived
status
activityCnt
activityName
role
contactNames
contactEmails
sectionCnt
courses
unitCnt
unitNames
externalId
}
}
}
Variables
{"input": GetCommunityOrgByFocusesFuncInput}
Response
{
"data": {
"getCommunityOrgByFocusesFunc": {
"results": [GetCommunityOrgByFocusesFuncRecord]
}
}
}
getCommunityOrgCountByFocusesFunc
Description
Retrieves the count of community organizations by focus areas.
Response
Returns a GetCommunityOrgCountByFocusesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCommunityOrgCountByFocusesFuncInput!
|
Example
Query
mutation GetCommunityOrgCountByFocusesFunc($input: GetCommunityOrgCountByFocusesFuncInput!) {
getCommunityOrgCountByFocusesFunc(input: $input) {
results {
totalRows
focuses
organizationCnt
}
}
}
Variables
{"input": GetCommunityOrgCountByFocusesFuncInput}
Response
{
"data": {
"getCommunityOrgCountByFocusesFunc": {
"results": [GetCommunityOrgCountByFocusesFuncRecord]
}
}
}
getCommunityOrgCountByUnitsFunc
Description
Retrieves the count of community organizations by units based on filters.
Response
Returns a GetCommunityOrgCountByUnitsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCommunityOrgCountByUnitsFuncInput!
|
Example
Query
mutation GetCommunityOrgCountByUnitsFunc($input: GetCommunityOrgCountByUnitsFuncInput!) {
getCommunityOrgCountByUnitsFunc(input: $input) {
results {
totalRows
childId
childName
organizationCnt
maxDepth
affiliated
}
}
}
Variables
{"input": GetCommunityOrgCountByUnitsFuncInput}
Response
{
"data": {
"getCommunityOrgCountByUnitsFunc": {
"results": [GetCommunityOrgCountByUnitsFuncRecord]
}
}
}
getCommunityOrgFullFunc
Response
Returns a GetCommunityOrgFullFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCommunityOrgFullFuncInput!
|
Example
Query
mutation GetCommunityOrgFullFunc($input: GetCommunityOrgFullFuncInput!) {
getCommunityOrgFullFunc(input: $input) {
results {
totalRows
id
name
street
street2
zipcode
city
state
county
country
latitude
longitude
type
description
url
phone
email
archived
status
activityCnt
activityName
role
contactNames
contactEmails
sectionCnt
courses
unitCnt
unitNames
externalId
}
}
}
Variables
{"input": GetCommunityOrgFullFuncInput}
Response
{
"data": {
"getCommunityOrgFullFunc": {
"results": [GetCommunityOrgFullFuncRecord]
}
}
}
getCommunityOrgFunc
Description
Retrieves community organizations based on filters.
Response
Returns a GetCommunityOrgFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCommunityOrgFuncInput!
|
Example
Query
mutation GetCommunityOrgFunc($input: GetCommunityOrgFuncInput!) {
getCommunityOrgFunc(input: $input) {
results {
totalRows
id
name
street
street2
zipcode
city
state
county
country
latitude
longitude
type
description
url
phone
email
archived
status
activityCnt
activityName
role
contactNames
contactEmails
sectionCnt
courses
unitCnt
unitNames
externalId
}
}
}
Variables
{"input": GetCommunityOrgFuncInput}
Response
{
"data": {
"getCommunityOrgFunc": {
"results": [GetCommunityOrgFuncRecord]
}
}
}
getCommunityOrgTypeTotalsFunc
Description
Retrieves the total number of community organization by community organization type.
Response
Returns a GetCommunityOrgTypeTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCommunityOrgTypeTotalsFuncInput!
|
Example
Query
mutation GetCommunityOrgTypeTotalsFunc($input: GetCommunityOrgTypeTotalsFuncInput!) {
getCommunityOrgTypeTotalsFunc(input: $input) {
results {
totalRows
commOrgType
organizationCnt
}
}
}
Variables
{"input": GetCommunityOrgTypeTotalsFuncInput}
Response
{
"data": {
"getCommunityOrgTypeTotalsFunc": {
"results": [GetCommunityOrgTypeTotalsFuncRecord]
}
}
}
getCommunityPartnersCountByProgramsFunc
Description
Retrieves the count of community partners by programs and initiatives.
Response
Arguments
| Name | Description |
|---|---|
input - GetCommunityPartnersCountByProgramsFuncInput!
|
Example
Query
mutation GetCommunityPartnersCountByProgramsFunc($input: GetCommunityPartnersCountByProgramsFuncInput!) {
getCommunityPartnersCountByProgramsFunc(input: $input) {
results {
totalRows
programs
organizationcnt
}
}
}
Variables
{"input": GetCommunityPartnersCountByProgramsFuncInput}
Response
{
"data": {
"getCommunityPartnersCountByProgramsFunc": {
"results": [
GetCommunityPartnersCountByProgramsFuncRecord
]
}
}
}
getCommunityPartnersCountByTargetFunc
Description
Retrieves the count of community partners by target population.
Response
Arguments
| Name | Description |
|---|---|
input - GetCommunityPartnersCountByTargetFuncInput!
|
Example
Query
mutation GetCommunityPartnersCountByTargetFunc($input: GetCommunityPartnersCountByTargetFuncInput!) {
getCommunityPartnersCountByTargetFunc(input: $input) {
results {
totalRows
population
organizationcnt
}
}
}
Variables
{"input": GetCommunityPartnersCountByTargetFuncInput}
Response
{
"data": {
"getCommunityPartnersCountByTargetFunc": {
"results": [
GetCommunityPartnersCountByTargetFuncRecord
]
}
}
}
getCommunityPartnersCountFunc
Description
Function to retrieve the count of community partners based on filters.
Response
Returns a GetCommunityPartnersCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCommunityPartnersCountFuncInput!
|
Example
Query
mutation GetCommunityPartnersCountFunc($input: GetCommunityPartnersCountFuncInput!) {
getCommunityPartnersCountFunc(input: $input) {
integer
}
}
Variables
{"input": GetCommunityPartnersCountFuncInput}
Response
{"data": {"getCommunityPartnersCountFunc": {"integer": 42}}}
getCommunityPartnersFunc
Response
Returns a GetCommunityPartnersFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCommunityPartnersFuncInput!
|
Example
Query
mutation GetCommunityPartnersFunc($input: GetCommunityPartnersFuncInput!) {
getCommunityPartnersFunc(input: $input) {
results {
totalRows
insertTimestamp
id
type
authorId
created
modified
archived
deleted
slug
vanity
name
description
latitude
longitude
logoId
logoUrl
url
externalId
portal
welcomeMessage
officeName
allowOffline
missionStatement
email
phone
fax
disableEmailNotifications
registrarUrl
courseCatalogUrl
street
street2
city
state
county
zipcode
zipcodeAddon
country
modifiedBy
status
parentId
}
}
}
Variables
{"input": GetCommunityPartnersFuncInput}
Response
{
"data": {
"getCommunityPartnersFunc": {
"results": [GetCommunityPartnersFuncRecord]
}
}
}
getCoursesByFocusesFunc
Description
Retrieves courses by focus areas.
Response
Returns a GetCoursesByFocusesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCoursesByFocusesFuncInput!
|
Example
Query
mutation GetCoursesByFocusesFunc($input: GetCoursesByFocusesFuncInput!) {
getCoursesByFocusesFunc(input: $input) {
results {
totalRows
courseId
courseName
courseDesription
activePeriod
periods
sectionFormats
}
}
}
Variables
{"input": GetCoursesByFocusesFuncInput}
Response
{
"data": {
"getCoursesByFocusesFunc": {
"results": [GetCoursesByFocusesFuncRecord]
}
}
}
getCoursesByStudentLearningObjFunc
Response
Arguments
| Name | Description |
|---|---|
input - GetCoursesByStudentLearningObjFuncInput!
|
Example
Query
mutation GetCoursesByStudentLearningObjFunc($input: GetCoursesByStudentLearningObjFuncInput!) {
getCoursesByStudentLearningObjFunc(input: $input) {
results {
totalRows
courseId
courseName
courseDesription
activePeriod
periods
sectionFormats
}
}
}
Variables
{"input": GetCoursesByStudentLearningObjFuncInput}
Response
{
"data": {
"getCoursesByStudentLearningObjFunc": {
"results": [
GetCoursesByStudentLearningObjFuncRecord
]
}
}
}
getCoursesByUnitFunc
Description
Retrieves courses filtered by unit.
Response
Returns a GetCoursesByUnitFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCoursesByUnitFuncInput!
|
Example
Query
mutation GetCoursesByUnitFunc($input: GetCoursesByUnitFuncInput!) {
getCoursesByUnitFunc(input: $input) {
results {
totalRows
courseId
courseNumber
courseName
unitId
units
courseLevel
sectionNumber
activityCnt
activityName
learningObjectives
pedagogies
instructors
enrollment
website
activePeriod
communityEngagementConnection
format
term
enrStudentParticipation
enrStudentHours
communityCnt
communityNames
crossListingName
}
}
}
Variables
{"input": GetCoursesByUnitFuncInput}
Response
{
"data": {
"getCoursesByUnitFunc": {
"results": [GetCoursesByUnitFuncRecord]
}
}
}
getCoursesCountByFocusesDrilldownFunc
Description
Retrieves the count of courses by focus areas drilldown.
Response
Arguments
| Name | Description |
|---|---|
input - GetCoursesCountByFocusesDrilldownFuncInput!
|
Example
Query
mutation GetCoursesCountByFocusesDrilldownFunc($input: GetCoursesCountByFocusesDrilldownFuncInput!) {
getCoursesCountByFocusesDrilldownFunc(input: $input) {
results {
totalRows
focusArea
sectionCnt
}
}
}
Variables
{"input": GetCoursesCountByFocusesDrilldownFuncInput}
Response
{
"data": {
"getCoursesCountByFocusesDrilldownFunc": {
"results": [
GetCoursesCountByFocusesDrilldownFuncRecord
]
}
}
}
getCoursesCountByFocusesFunc
Description
Retrieves the count of courses by focus areas.
Response
Returns a GetCoursesCountByFocusesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCoursesCountByFocusesFuncInput!
|
Example
Query
mutation GetCoursesCountByFocusesFunc($input: GetCoursesCountByFocusesFuncInput!) {
getCoursesCountByFocusesFunc(input: $input) {
results {
totalRows
sectionCnt
focuses
}
}
}
Variables
{"input": GetCoursesCountByFocusesFuncInput}
Response
{
"data": {
"getCoursesCountByFocusesFunc": {
"results": [GetCoursesCountByFocusesFuncRecord]
}
}
}
getCoursesCountByProgramsFunc
Description
Retrieves the count of courses by programs and initiatives.
Response
Returns a GetCoursesCountByProgramsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCoursesCountByProgramsFuncInput!
|
Example
Query
mutation GetCoursesCountByProgramsFunc($input: GetCoursesCountByProgramsFuncInput!) {
getCoursesCountByProgramsFunc(input: $input) {
results {
totalRows
programs
sectionCnt
}
}
}
Variables
{"input": GetCoursesCountByProgramsFuncInput}
Response
{
"data": {
"getCoursesCountByProgramsFunc": {
"results": [GetCoursesCountByProgramsFuncRecord]
}
}
}
getCoursesCountByTargetFunc
Description
Retrieves the count of courses by target population.
Response
Returns a GetCoursesCountByTargetFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCoursesCountByTargetFuncInput!
|
Example
Query
mutation GetCoursesCountByTargetFunc($input: GetCoursesCountByTargetFuncInput!) {
getCoursesCountByTargetFunc(input: $input) {
results {
totalRows
population
sectionCnt
}
}
}
Variables
{"input": GetCoursesCountByTargetFuncInput}
Response
{
"data": {
"getCoursesCountByTargetFunc": {
"results": [GetCoursesCountByTargetFuncRecord]
}
}
}
getCoursesCountByUnitsFunc
Description
Retrieves the count of courses associated with units based on filters.
Response
Returns a GetCoursesCountByUnitsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCoursesCountByUnitsFuncInput!
|
Example
Query
mutation GetCoursesCountByUnitsFunc($input: GetCoursesCountByUnitsFuncInput!) {
getCoursesCountByUnitsFunc(input: $input) {
results {
totalRows
childId
childName
sectionCnt
maxDepth
affiliated
}
}
}
Variables
{"input": GetCoursesCountByUnitsFuncInput}
Response
{
"data": {
"getCoursesCountByUnitsFunc": {
"results": [GetCoursesCountByUnitsFuncRecord]
}
}
}
getCoursesFullFunc
Description
Retrieves full information about courses based on filters.
Response
Returns a GetCoursesFullFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCoursesFullFuncInput!
|
Example
Query
mutation GetCoursesFullFunc($input: GetCoursesFullFuncInput!) {
getCoursesFullFunc(input: $input) {
results {
totalRows
courseId
courseNumber
courseName
unitId
units
courseLevel
sectionNumber
activityCnt
activityName
learningObjectives
pedagogies
instructors
enrollment
website
activePeriod
communityEngagementConnection
format
term
enrStudentParticipation
enrStudentHours
communityCnt
communityNames
crossListingName
}
}
}
Variables
{"input": GetCoursesFullFuncInput}
Response
{
"data": {
"getCoursesFullFunc": {
"results": [GetCoursesFullFuncRecord]
}
}
}
getCoursesFunc
Description
Retrieves courses based on filters.
Response
Returns a GetCoursesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetCoursesFuncInput!
|
Example
Query
mutation GetCoursesFunc($input: GetCoursesFuncInput!) {
getCoursesFunc(input: $input) {
results {
totalRows
courseId
courseName
courseDesription
activePeriod
periods
sectionFormats
}
}
}
Variables
{"input": GetCoursesFuncInput}
Response
{
"data": {
"getCoursesFunc": {"results": [GetCoursesFuncRecord]}
}
}
getFacStaffCountFunc
Description
Function to retrieve the count of faculty and staff based on filters.
Response
Returns a GetFacStaffCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFacStaffCountFuncInput!
|
Example
Query
mutation GetFacStaffCountFunc($input: GetFacStaffCountFuncInput!) {
getFacStaffCountFunc(input: $input) {
integer
}
}
Variables
{"input": GetFacStaffCountFuncInput}
Response
{"data": {"getFacStaffCountFunc": {"integer": 42}}}
getFacStaffCountWithIdsFunc
Response
Returns a GetFacStaffCountWithIdsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFacStaffCountWithIdsFuncInput!
|
Example
Query
mutation GetFacStaffCountWithIdsFunc($input: GetFacStaffCountWithIdsFuncInput!) {
getFacStaffCountWithIdsFunc(input: $input) {
results {
factCount
ids
}
}
}
Variables
{"input": GetFacStaffCountWithIdsFuncInput}
Response
{
"data": {
"getFacStaffCountWithIdsFunc": {
"results": [GetFacStaffCountWithIdsFuncRecord]
}
}
}
getFacStaffFunc
Response
Returns a GetFacStaffFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFacStaffFuncInput!
|
Example
Query
mutation GetFacStaffFunc($input: GetFacStaffFuncInput!) {
getFacStaffFunc(input: $input) {
results {
totalRows
userId
firstname
lastname
email
}
}
}
Variables
{"input": GetFacStaffFuncInput}
Response
{
"data": {
"getFacStaffFunc": {
"results": [GetFacStaffFuncRecord]
}
}
}
getFactultyStaffByFocusesFunc
Description
Retrieves faculty and staff by focus areas.
Response
Returns a GetFactultyStaffByFocusesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffByFocusesFuncInput!
|
Example
Query
mutation GetFactultyStaffByFocusesFunc($input: GetFactultyStaffByFocusesFuncInput!) {
getFactultyStaffByFocusesFunc(input: $input) {
results {
totalRows
firstname
lastname
email
}
}
}
Variables
{"input": GetFactultyStaffByFocusesFuncInput}
Response
{
"data": {
"getFactultyStaffByFocusesFunc": {
"results": [GetFactultyStaffByFocusesFuncRecord]
}
}
}
getFactultyStaffByProgramsfunc
Description
Retrieves faculty/staff by programs and initiatives.
Response
Returns a GetFactultyStaffByProgramsfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffByProgramsfuncInput!
|
Example
Query
mutation GetFactultyStaffByProgramsfunc($input: GetFactultyStaffByProgramsfuncInput!) {
getFactultyStaffByProgramsfunc(input: $input) {
results {
totalRows
programs
firstname
lastname
email
}
}
}
Variables
{"input": GetFactultyStaffByProgramsfuncInput}
Response
{
"data": {
"getFactultyStaffByProgramsfunc": {
"results": [GetFactultyStaffByProgramsfuncRecord]
}
}
}
getFactultyStaffByTargetFunc
Description
Retrieves faculty and staff by target population.
Response
Returns a GetFactultyStaffByTargetFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffByTargetFuncInput!
|
Example
Query
mutation GetFactultyStaffByTargetFunc($input: GetFactultyStaffByTargetFuncInput!) {
getFactultyStaffByTargetFunc(input: $input) {
results {
totalRows
population
firstname
lastname
email
}
}
}
Variables
{"input": GetFactultyStaffByTargetFuncInput}
Response
{
"data": {
"getFactultyStaffByTargetFunc": {
"results": [GetFactultyStaffByTargetFuncRecord]
}
}
}
getFactultyStaffByUnitFunc
Description
Retrieves faculty and staff by units filtered by unit.
Response
Returns a GetFactultyStaffByUnitFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffByUnitFuncInput!
|
Example
Query
mutation GetFactultyStaffByUnitFunc($input: GetFactultyStaffByUnitFuncInput!) {
getFactultyStaffByUnitFunc(input: $input) {
results {
totalRows
userId
contactName
email
workPhone
relationships
positions
personalStatement
resumeUrl
scholarlyWebsiteUrl
activityCnt
activityName
communityCnt
communityName
sectionCnt
courses
}
}
}
Variables
{"input": GetFactultyStaffByUnitFuncInput}
Response
{
"data": {
"getFactultyStaffByUnitFunc": {
"results": [GetFactultyStaffByUnitFuncRecord]
}
}
}
getFactultyStaffCountByFocusesFunc
Response
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffCountByFocusesFuncInput!
|
Example
Query
mutation GetFactultyStaffCountByFocusesFunc($input: GetFactultyStaffCountByFocusesFuncInput!) {
getFactultyStaffCountByFocusesFunc(input: $input) {
results {
totalRows
focuses
facultyStaffCnt
focusAreas
}
}
}
Variables
{"input": GetFactultyStaffCountByFocusesFuncInput}
Response
{
"data": {
"getFactultyStaffCountByFocusesFunc": {
"results": [
GetFactultyStaffCountByFocusesFuncRecord
]
}
}
}
getFactultyStaffCountByProgramsFunc
Description
Retrieves the count of faculty/staff by programs and initiatives.
Response
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffCountByProgramsFuncInput!
|
Example
Query
mutation GetFactultyStaffCountByProgramsFunc($input: GetFactultyStaffCountByProgramsFuncInput!) {
getFactultyStaffCountByProgramsFunc(input: $input) {
results {
totalRows
programs
facultyStaffCnt
}
}
}
Variables
{"input": GetFactultyStaffCountByProgramsFuncInput}
Response
{
"data": {
"getFactultyStaffCountByProgramsFunc": {
"results": [
GetFactultyStaffCountByProgramsFuncRecord
]
}
}
}
getFactultyStaffCountByTargetFunc
Description
Retrieves the count of faculty/staff by target population.
Response
Returns a GetFactultyStaffCountByTargetFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffCountByTargetFuncInput!
|
Example
Query
mutation GetFactultyStaffCountByTargetFunc($input: GetFactultyStaffCountByTargetFuncInput!) {
getFactultyStaffCountByTargetFunc(input: $input) {
results {
totalRows
population
facultyStaffCnt
}
}
}
Variables
{"input": GetFactultyStaffCountByTargetFuncInput}
Response
{
"data": {
"getFactultyStaffCountByTargetFunc": {
"results": [GetFactultyStaffCountByTargetFuncRecord]
}
}
}
getFactultyStaffCountByUnitsFunc
Description
Retrieves the count of faculty and staff by units based on filters.
Response
Returns a GetFactultyStaffCountByUnitsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffCountByUnitsFuncInput!
|
Example
Query
mutation GetFactultyStaffCountByUnitsFunc($input: GetFactultyStaffCountByUnitsFuncInput!) {
getFactultyStaffCountByUnitsFunc(input: $input) {
results {
totalRows
parentId
unitName
facultyStaffCnt
}
}
}
Variables
{"input": GetFactultyStaffCountByUnitsFuncInput}
Response
{
"data": {
"getFactultyStaffCountByUnitsFunc": {
"results": [GetFactultyStaffCountByUnitsFuncRecord]
}
}
}
getFactultyStaffFunc
Response
Returns a GetFactultyStaffFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffFuncInput!
|
Example
Query
mutation GetFactultyStaffFunc($input: GetFactultyStaffFuncInput!) {
getFactultyStaffFunc(input: $input) {
results {
totalRows
userId
contactName
email
workPhone
relationships
positions
personalStatement
resumeUrl
scholarlyWebsiteUrl
activityCnt
activityName
communityCnt
communityName
sectionCnt
courses
}
}
}
Variables
{"input": GetFactultyStaffFuncInput}
Response
{
"data": {
"getFactultyStaffFunc": {
"results": [GetFactultyStaffFuncRecord]
}
}
}
getFactultyStaffNestedCountByUnitsFunc
Description
Retrieves the count of faculty/staff nested by units.
Response
Arguments
| Name | Description |
|---|---|
input - GetFactultyStaffNestedCountByUnitsFuncInput!
|
Example
Query
mutation GetFactultyStaffNestedCountByUnitsFunc($input: GetFactultyStaffNestedCountByUnitsFuncInput!) {
getFactultyStaffNestedCountByUnitsFunc(input: $input) {
results {
totalRows
childId
childName
facultyStaffCnt
maxDepth
affiliated
}
}
}
Variables
{"input": GetFactultyStaffNestedCountByUnitsFuncInput}
Response
{
"data": {
"getFactultyStaffNestedCountByUnitsFunc": {
"results": [
GetFactultyStaffNestedCountByUnitsFuncRecord
]
}
}
}
getFacultyByFocusesDrilldownFunc
Description
Retrieves drilldown information of faculty by focus areas.
Response
Returns a GetFacultyByFocusesDrilldownFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFacultyByFocusesDrilldownFuncInput!
|
Example
Query
mutation GetFacultyByFocusesDrilldownFunc($input: GetFacultyByFocusesDrilldownFuncInput!) {
getFacultyByFocusesDrilldownFunc(input: $input) {
results {
totalRows
firstname
lastname
email
}
}
}
Variables
{"input": GetFacultyByFocusesDrilldownFuncInput}
Response
{
"data": {
"getFacultyByFocusesDrilldownFunc": {
"results": [GetFacultyByFocusesDrilldownFuncRecord]
}
}
}
getFacultyCountByFocusesDrilldownFunc
Description
Retrieves drilldown count of faculty by focus areas.
Response
Arguments
| Name | Description |
|---|---|
input - GetFacultyCountByFocusesDrilldownFuncInput!
|
Example
Query
mutation GetFacultyCountByFocusesDrilldownFunc($input: GetFacultyCountByFocusesDrilldownFuncInput!) {
getFacultyCountByFocusesDrilldownFunc(input: $input) {
results {
totalRows
focusArea
facultyStaffCnt
}
}
}
Variables
{"input": GetFacultyCountByFocusesDrilldownFuncInput}
Response
{
"data": {
"getFacultyCountByFocusesDrilldownFunc": {
"results": [
GetFacultyCountByFocusesDrilldownFuncRecord
]
}
}
}
getFacultyPartnersTotalFunc
Description
Retrieves the total number of faculty partners based on filters.
Response
Returns a GetFacultyPartnersTotalFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFacultyPartnersTotalFuncInput!
|
Example
Query
mutation GetFacultyPartnersTotalFunc($input: GetFacultyPartnersTotalFuncInput!) {
getFacultyPartnersTotalFunc(input: $input) {
integer
}
}
Variables
{"input": GetFacultyPartnersTotalFuncInput}
Response
{"data": {"getFacultyPartnersTotalFunc": {"integer": 42}}}
getFundersActivityFunc
Description
Retrieves funders associated with a specific activity.
Response
Returns a GetFundersActivityFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetFundersActivityFuncInput!
|
Example
Query
mutation GetFundersActivityFunc($input: GetFundersActivityFuncInput!) {
getFundersActivityFunc(input: $input) {
communityFunders
}
}
Variables
{"input": GetFundersActivityFuncInput}
Response
{
"data": {
"getFundersActivityFunc": {
"communityFunders": ["xyz789"]
}
}
}
getImpactsCommunityActTotalsFunc
Description
Retrieves the total number of activities by community impacts.
Response
Returns a GetImpactsCommunityActTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetImpactsCommunityActTotalsFuncInput!
|
Example
Query
mutation GetImpactsCommunityActTotalsFunc($input: GetImpactsCommunityActTotalsFuncInput!) {
getImpactsCommunityActTotalsFunc(input: $input) {
results {
totalRows
impact
achievedCnt
expectedCnt
}
}
}
Variables
{"input": GetImpactsCommunityActTotalsFuncInput}
Response
{
"data": {
"getImpactsCommunityActTotalsFunc": {
"results": [GetImpactsCommunityActTotalsFuncRecord]
}
}
}
getInstitutionPartnersFunc
Description
Function to retrieve institutional partners based on filters.
Response
Returns a GetInstitutionPartnersFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetInstitutionPartnersFuncInput!
|
Example
Query
mutation GetInstitutionPartnersFunc($input: GetInstitutionPartnersFuncInput!) {
getInstitutionPartnersFunc(input: $input) {
results {
totalRows
id
name
street
street2
zipcode
city
state
county
country
latitude
longitude
type
description
url
phone
email
archived
status
activityCnt
activityName
contactNames
contactEmails
sectionCnt
courses
unitCnt
unitNames
externalId
}
}
}
Variables
{"input": GetInstitutionPartnersFuncInput}
Response
{
"data": {
"getInstitutionPartnersFunc": {
"results": [GetInstitutionPartnersFuncRecord]
}
}
}
getInstitutionalFunc
Description
Function to retrieve institutional partners based on filters.
Response
Returns a GetInstitutionalFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetInstitutionalFuncInput!
|
Example
Query
mutation GetInstitutionalFunc($input: GetInstitutionalFuncInput!) {
getInstitutionalFunc(input: $input) {
results {
totalRows
id
name
type
parentId
description
contactName
contactEmail
contactPhone
url
activityCnt
activityName
sectionCnt
courses
communityCnt
communityNames
reportsTo
prefixes
coursePrefixDescription
}
}
}
Variables
{"input": GetInstitutionalFuncInput}
Response
{
"data": {
"getInstitutionalFunc": {
"results": [GetInstitutionalFuncRecord]
}
}
}
getInstitutionalOutcomesActTotalsFunc
Description
Retrieves the total number of activities by institutional outcomes.
Response
Arguments
| Name | Description |
|---|---|
input - GetInstitutionalOutcomesActTotalsFuncInput!
|
Example
Query
mutation GetInstitutionalOutcomesActTotalsFunc($input: GetInstitutionalOutcomesActTotalsFuncInput!) {
getInstitutionalOutcomesActTotalsFunc(input: $input) {
results {
totalRows
institution
achievedCnt
expectedCnt
}
}
}
Variables
{"input": GetInstitutionalOutcomesActTotalsFuncInput}
Response
{
"data": {
"getInstitutionalOutcomesActTotalsFunc": {
"results": [
GetInstitutionalOutcomesActTotalsFuncRecord
]
}
}
}
getInstitutionalPartnersCountFunc
Description
Function to retrieve the count of unit partners based on filters.
Response
Returns a GetInstitutionalPartnersCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetInstitutionalPartnersCountFuncInput!
|
Example
Query
mutation GetInstitutionalPartnersCountFunc($input: GetInstitutionalPartnersCountFuncInput!) {
getInstitutionalPartnersCountFunc(input: $input) {
integer
}
}
Variables
{"input": GetInstitutionalPartnersCountFuncInput}
Response
{"data": {"getInstitutionalPartnersCountFunc": {"integer": 42}}}
getInstitutionalPartnersFunc
Description
Function to retrieve unit partners list based on filters.
Response
Returns a GetInstitutionalPartnersFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetInstitutionalPartnersFuncInput!
|
Example
Query
mutation GetInstitutionalPartnersFunc($input: GetInstitutionalPartnersFuncInput!) {
getInstitutionalPartnersFunc(input: $input) {
results {
totalRows
insertTimestamp
id
type
authorId
created
modified
archived
deleted
slug
vanity
name
description
latitude
longitude
logoId
logoUrl
url
externalId
portal
welcomeMessage
officeName
allowOffline
missionStatement
email
phone
fax
disableEmailNotifications
registrarUrl
courseCatalogUrl
street
street2
city
state
county
zipcode
zipcodeAddon
country
modifiedBy
status
parentId
}
}
}
Variables
{"input": GetInstitutionalPartnersFuncInput}
Response
{
"data": {
"getInstitutionalPartnersFunc": {
"results": [GetInstitutionalPartnersFuncRecord]
}
}
}
getInstructorsCountFunc
Response
Returns a GetInstructorsCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetInstructorsCountFuncInput!
|
Example
Query
mutation GetInstructorsCountFunc($input: GetInstructorsCountFuncInput!) {
getInstructorsCountFunc(input: $input) {
integer
}
}
Variables
{"input": GetInstructorsCountFuncInput}
Response
{"data": {"getInstructorsCountFunc": {"integer": 42}}}
getInstructorsFunc
Response
Returns a GetInstructorsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetInstructorsFuncInput!
|
Example
Query
mutation GetInstructorsFunc($input: GetInstructorsFuncInput!) {
getInstructorsFunc(input: $input) {
results {
totalRows
userId
contactName
email
workPhone
relationships
positions
personalStatement
resumeUrl
scholarlyWebsiteUrl
activityCnt
activityName
communityCnt
communityName
sectionCnt
courses
}
}
}
Variables
{"input": GetInstructorsFuncInput}
Response
{
"data": {
"getInstructorsFunc": {
"results": [GetInstructorsFuncRecord]
}
}
}
getLocationType
Description
Retrieves the location type of a specific activity.
Response
Returns a GetLocationTypePayload
Arguments
| Name | Description |
|---|---|
input - GetLocationTypeInput!
|
Example
Query
mutation GetLocationType($input: GetLocationTypeInput!) {
getLocationType(input: $input) {
results {
locationType
activityId
}
}
}
Variables
{"input": GetLocationTypeInput}
Response
{
"data": {
"getLocationType": {
"results": [GetLocationTypeRecord]
}
}
}
getNestedUnitActivitiesFunc
Description
Retrieves activities for nested units based on filters.
Response
Returns a GetNestedUnitActivitiesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetNestedUnitActivitiesFuncInput!
|
Example
Query
mutation GetNestedUnitActivitiesFunc($input: GetNestedUnitActivitiesFuncInput!) {
getNestedUnitActivitiesFunc(input: $input) {
results {
totalRows
childId
childName
activityCnt
parentName
maxDepth
affiliated
}
}
}
Variables
{"input": GetNestedUnitActivitiesFuncInput}
Response
{
"data": {
"getNestedUnitActivitiesFunc": {
"results": [GetNestedUnitActivitiesFuncRecord]
}
}
}
getOrganizationRoleTotalsFunc
Description
Retrieves totals of community organization roles.
Response
Returns a GetOrganizationRoleTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetOrganizationRoleTotalsFuncInput!
|
Example
Query
mutation GetOrganizationRoleTotalsFunc($input: GetOrganizationRoleTotalsFuncInput!) {
getOrganizationRoleTotalsFunc(input: $input) {
results {
totalRows
roles
organizationCnt
}
}
}
Variables
{"input": GetOrganizationRoleTotalsFuncInput}
Response
{
"data": {
"getOrganizationRoleTotalsFunc": {
"results": [GetOrganizationRoleTotalsFuncRecord]
}
}
}
getOutputsTotalFunc
Description
Retrieves the total number of outputs by activities.
Response
Returns a GetOutputsTotalFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetOutputsTotalFuncInput!
|
Example
Query
mutation GetOutputsTotalFunc($input: GetOutputsTotalFuncInput!) {
getOutputsTotalFunc(input: $input) {
results {
totalRows
output
expectedCnt
achievedCnt
}
}
}
Variables
{"input": GetOutputsTotalFuncInput}
Response
{
"data": {
"getOutputsTotalFunc": {
"results": [GetOutputsTotalFuncRecord]
}
}
}
getPedagogiesActivitiesTotalsFunc
Description
Retrieves the total number of activities by pedagogies.
Response
Returns a GetPedagogiesActivitiesTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetPedagogiesActivitiesTotalsFuncInput!
|
Example
Query
mutation GetPedagogiesActivitiesTotalsFunc($input: GetPedagogiesActivitiesTotalsFuncInput!) {
getPedagogiesActivitiesTotalsFunc(input: $input) {
results {
totalRows
activityCnt
pedagogy
}
}
}
Variables
{"input": GetPedagogiesActivitiesTotalsFuncInput}
Response
{
"data": {
"getPedagogiesActivitiesTotalsFunc": {
"results": [GetPedagogiesActivitiesTotalsFuncRecord]
}
}
}
getPedagogiesCoursesTotalsFunc
Description
Retrieves the total number of courses by pedagogies.
Response
Returns a GetPedagogiesCoursesTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetPedagogiesCoursesTotalsFuncInput!
|
Example
Query
mutation GetPedagogiesCoursesTotalsFunc($input: GetPedagogiesCoursesTotalsFuncInput!) {
getPedagogiesCoursesTotalsFunc(input: $input) {
results {
totalRows
pedagogy
sectionCnt
}
}
}
Variables
{"input": GetPedagogiesCoursesTotalsFuncInput}
Response
{
"data": {
"getPedagogiesCoursesTotalsFunc": {
"results": [GetPedagogiesCoursesTotalsFuncRecord]
}
}
}
getProfilesFunc
Description
Retrieves user profiles based on filters.
Response
Returns a GetProfilesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetProfilesFuncInput!
|
Example
Query
mutation GetProfilesFunc($input: GetProfilesFuncInput!) {
getProfilesFunc(input: $input) {
results {
userId
firstname
lastname
email
edupersonPrincipalName
portalid
profileurl
isProjectAssociated
}
}
}
Variables
{"input": GetProfilesFuncInput}
Response
{
"data": {
"getProfilesFunc": {
"results": [GetProfilesFuncRecord]
}
}
}
getProgramInitiativesByFocusesFunc
Description
Retrieves program initiatives by focus areas.
Response
Arguments
| Name | Description |
|---|---|
input - GetProgramInitiativesByFocusesFuncInput!
|
Example
Query
mutation GetProgramInitiativesByFocusesFunc($input: GetProgramInitiativesByFocusesFuncInput!) {
getProgramInitiativesByFocusesFunc(input: $input) {
results {
totalRows
focuses
programId
programName
programDescription
}
}
}
Variables
{"input": GetProgramInitiativesByFocusesFuncInput}
Response
{
"data": {
"getProgramInitiativesByFocusesFunc": {
"results": [
GetProgramInitiativesByFocusesFuncRecord
]
}
}
}
getProgramInitiativesByTargetFunc
Description
Retrieves program initiatives by target population.
Response
Returns a GetProgramInitiativesByTargetFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetProgramInitiativesByTargetFuncInput!
|
Example
Query
mutation GetProgramInitiativesByTargetFunc($input: GetProgramInitiativesByTargetFuncInput!) {
getProgramInitiativesByTargetFunc(input: $input) {
results {
totalRows
population
programId
programName
programDescription
}
}
}
Variables
{"input": GetProgramInitiativesByTargetFuncInput}
Response
{
"data": {
"getProgramInitiativesByTargetFunc": {
"results": [GetProgramInitiativesByTargetFuncRecord]
}
}
}
getProgramInitiativesFunc
Description
Retrieves program initiatives based on filters.
Response
Returns a GetProgramInitiativesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetProgramInitiativesFuncInput!
|
Example
Query
mutation GetProgramInitiativesFunc($input: GetProgramInitiativesFuncInput!) {
getProgramInitiativesFunc(input: $input) {
results {
totalRows
unitId
unitName
programId
programName
programDescription
}
}
}
Variables
{"input": GetProgramInitiativesFuncInput}
Response
{
"data": {
"getProgramInitiativesFunc": {
"results": [GetProgramInitiativesFuncRecord]
}
}
}
getProgramsCountByFocusesDrilldownFunc
Description
Retrieves the count of programs based on focus areas drilldown.
Response
Arguments
| Name | Description |
|---|---|
input - GetProgramsCountByFocusesDrilldownFuncInput!
|
Example
Query
mutation GetProgramsCountByFocusesDrilldownFunc($input: GetProgramsCountByFocusesDrilldownFuncInput!) {
getProgramsCountByFocusesDrilldownFunc(input: $input) {
results {
totalRows
focusArea
programCnt
}
}
}
Variables
{"input": GetProgramsCountByFocusesDrilldownFuncInput}
Response
{
"data": {
"getProgramsCountByFocusesDrilldownFunc": {
"results": [
GetProgramsCountByFocusesDrilldownFuncRecord
]
}
}
}
getProgramsCountByFocusesFunc
Description
Retrieves the count of programs by focus areas.
Response
Returns a GetProgramsCountByFocusesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetProgramsCountByFocusesFuncInput!
|
Example
Query
mutation GetProgramsCountByFocusesFunc($input: GetProgramsCountByFocusesFuncInput!) {
getProgramsCountByFocusesFunc(input: $input) {
results {
totalRows
focuses
programCnt
}
}
}
Variables
{"input": GetProgramsCountByFocusesFuncInput}
Response
{
"data": {
"getProgramsCountByFocusesFunc": {
"results": [GetProgramsCountByFocusesFuncRecord]
}
}
}
getProgramsCountByProgramsFunc
Description
Retrieves the count of programs and initiatives by programs and initiatives.
Response
Returns a GetProgramsCountByProgramsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetProgramsCountByProgramsFuncInput!
|
Example
Query
mutation GetProgramsCountByProgramsFunc($input: GetProgramsCountByProgramsFuncInput!) {
getProgramsCountByProgramsFunc(input: $input) {
results {
totalRows
programs
programCnt
}
}
}
Variables
{"input": GetProgramsCountByProgramsFuncInput}
Response
{
"data": {
"getProgramsCountByProgramsFunc": {
"results": [GetProgramsCountByProgramsFuncRecord]
}
}
}
getProgramsCountByTargetFunc
Description
Retrieves the count of programs by target population.
Response
Returns a GetProgramsCountByTargetFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetProgramsCountByTargetFuncInput!
|
Example
Query
mutation GetProgramsCountByTargetFunc($input: GetProgramsCountByTargetFuncInput!) {
getProgramsCountByTargetFunc(input: $input) {
results {
totalRows
population
programCnt
}
}
}
Variables
{"input": GetProgramsCountByTargetFuncInput}
Response
{
"data": {
"getProgramsCountByTargetFunc": {
"results": [GetProgramsCountByTargetFuncRecord]
}
}
}
getProgramsCountByUnitsFunc
Description
Retrieves the count of programs associated with specific units based on filters.
Response
Returns a GetProgramsCountByUnitsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetProgramsCountByUnitsFuncInput!
|
Example
Query
mutation GetProgramsCountByUnitsFunc($input: GetProgramsCountByUnitsFuncInput!) {
getProgramsCountByUnitsFunc(input: $input) {
results {
totalRows
childId
childName
programCnt
maxDepth
affiliated
}
}
}
Variables
{"input": GetProgramsCountByUnitsFuncInput}
Response
{
"data": {
"getProgramsCountByUnitsFunc": {
"results": [GetProgramsCountByUnitsFuncRecord]
}
}
}
getProgramsInitiativesTotalsFunc
Description
Retrieves totals of activities by programs and initiatives.
Response
Returns a GetProgramsInitiativesTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetProgramsInitiativesTotalsFuncInput!
|
Example
Query
mutation GetProgramsInitiativesTotalsFunc($input: GetProgramsInitiativesTotalsFuncInput!) {
getProgramsInitiativesTotalsFunc(input: $input) {
results {
totalRows
activityCnt
programs
}
}
}
Variables
{"input": GetProgramsInitiativesTotalsFuncInput}
Response
{
"data": {
"getProgramsInitiativesTotalsFunc": {
"results": [GetProgramsInitiativesTotalsFuncRecord]
}
}
}
getScholarshipTotalsFunc
Description
Retrieves totals related to scholarships.
Response
Returns a GetScholarshipTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetScholarshipTotalsFuncInput!
|
Example
Query
mutation GetScholarshipTotalsFunc($input: GetScholarshipTotalsFuncInput!) {
getScholarshipTotalsFunc(input: $input) {
results {
totalRows
scholarshipTotals
}
}
}
Variables
{"input": GetScholarshipTotalsFuncInput}
Response
{
"data": {
"getScholarshipTotalsFunc": {
"results": [GetScholarshipTotalsFuncRecord]
}
}
}
getScholaryProductsTotalFunc
Description
Retrieves totals related to scholarly products.
Response
Returns a GetScholaryProductsTotalFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetScholaryProductsTotalFuncInput!
|
Example
Query
mutation GetScholaryProductsTotalFunc($input: GetScholaryProductsTotalFuncInput!) {
getScholaryProductsTotalFunc(input: $input) {
results {
totalRows
scholaryProduct
expectedCnt
achievedCnt
}
}
}
Variables
{"input": GetScholaryProductsTotalFuncInput}
Response
{
"data": {
"getScholaryProductsTotalFunc": {
"results": [GetScholaryProductsTotalFuncRecord]
}
}
}
getSectionTermsTotalsFunc
Description
Retrieves totals of section terms.
Response
Returns a GetSectionTermsTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetSectionTermsTotalsFuncInput!
|
Example
Query
mutation GetSectionTermsTotalsFunc($input: GetSectionTermsTotalsFuncInput!) {
getSectionTermsTotalsFunc(input: $input) {
results {
totalRows
term
sectionCnt
}
}
}
Variables
{"input": GetSectionTermsTotalsFuncInput}
Response
{
"data": {
"getSectionTermsTotalsFunc": {
"results": [GetSectionTermsTotalsFuncRecord]
}
}
}
getSectionTotalsFunc
Description
Retrieves total section count and graduate/undergraduate level counts.
Response
Returns a GetSectionTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetSectionTotalsFuncInput!
|
Example
Query
mutation GetSectionTotalsFunc($input: GetSectionTotalsFuncInput!) {
getSectionTotalsFunc(input: $input) {
results {
totalRows
levels
sectionCnt
}
}
}
Variables
{"input": GetSectionTotalsFuncInput}
Response
{
"data": {
"getSectionTotalsFunc": {
"results": [GetSectionTotalsFuncRecord]
}
}
}
getStudentHoursPerTermCountFunc
Description
Retrieves totals of Number of Students / Hours Per Term.
Response
Returns a GetStudentHoursPerTermCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetStudentHoursPerTermCountFuncInput!
|
Example
Query
mutation GetStudentHoursPerTermCountFunc($input: GetStudentHoursPerTermCountFuncInput!) {
getStudentHoursPerTermCountFunc(input: $input) {
results {
totalRows
studentHourPart
}
}
}
Variables
{"input": GetStudentHoursPerTermCountFuncInput}
Response
{
"data": {
"getStudentHoursPerTermCountFunc": {
"results": [GetStudentHoursPerTermCountFuncRecord]
}
}
}
getStudentInvolmentTotalsFunc
Description
Retrieves total student involvement for activities based on filters.
Response
Returns a GetStudentInvolmentTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetStudentInvolmentTotalsFuncInput!
|
Example
Query
mutation GetStudentInvolmentTotalsFunc($input: GetStudentInvolmentTotalsFuncInput!) {
getStudentInvolmentTotalsFunc(input: $input) {
results {
totalRows
studentInvolmentCnt
studentInvolment
}
}
}
Variables
{"input": GetStudentInvolmentTotalsFuncInput}
Response
{
"data": {
"getStudentInvolmentTotalsFunc": {
"results": [GetStudentInvolmentTotalsFuncRecord]
}
}
}
getStudentLearningObjectivesActivitiesFunc
Description
Retrieves activities associated with student learning objectives.
Response
Arguments
| Name | Description |
|---|---|
input - GetStudentLearningObjectivesActivitiesFuncInput!
|
Example
Query
mutation GetStudentLearningObjectivesActivitiesFunc($input: GetStudentLearningObjectivesActivitiesFuncInput!) {
getStudentLearningObjectivesActivitiesFunc(input: $input) {
results {
totalRows
activityCnt
studentLearningObj
}
}
}
Variables
{"input": GetStudentLearningObjectivesActivitiesFuncInput}
Response
{
"data": {
"getStudentLearningObjectivesActivitiesFunc": {
"results": [
GetStudentLearningObjectivesActivitiesFuncRecord
]
}
}
}
getStudentLearningObjectivesActivitiesTotalsFunc
Description
Retrieves total activities by student learning objectives.
Response
Returns a GetStudentLearningObjectivesActivitiesTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetStudentLearningObjectivesActivitiesTotalsFuncInput!
|
Example
Query
mutation GetStudentLearningObjectivesActivitiesTotalsFunc($input: GetStudentLearningObjectivesActivitiesTotalsFuncInput!) {
getStudentLearningObjectivesActivitiesTotalsFunc(input: $input) {
results {
totalRows
activityCnt
studentLearningObj
}
}
}
Variables
{
"input": GetStudentLearningObjectivesActivitiesTotalsFuncInput
}
Response
{
"data": {
"getStudentLearningObjectivesActivitiesTotalsFunc": {
"results": [
GetStudentLearningObjectivesActivitiesTotalsFuncRecord
]
}
}
}
getStudentLearningObjectivesCoursesTotalsFunc
Description
Retrieves totals courses by student learning objectives.
Response
Returns a GetStudentLearningObjectivesCoursesTotalsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetStudentLearningObjectivesCoursesTotalsFuncInput!
|
Example
Query
mutation GetStudentLearningObjectivesCoursesTotalsFunc($input: GetStudentLearningObjectivesCoursesTotalsFuncInput!) {
getStudentLearningObjectivesCoursesTotalsFunc(input: $input) {
results {
totalRows
sectionCnt
studentLearningObj
}
}
}
Variables
{
"input": GetStudentLearningObjectivesCoursesTotalsFuncInput
}
Response
{
"data": {
"getStudentLearningObjectivesCoursesTotalsFunc": {
"results": [
GetStudentLearningObjectivesCoursesTotalsFuncRecord
]
}
}
}
getTopUnitPartnersFunc
Description
Function to retrieve the top count of activities associated with a unit based on filters.
Response
Returns a GetTopUnitPartnersFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetTopUnitPartnersFuncInput!
|
Example
Query
mutation GetTopUnitPartnersFunc($input: GetTopUnitPartnersFuncInput!) {
getTopUnitPartnersFunc(input: $input) {
results {
totalRows
id
name
countactivities
}
}
}
Variables
{"input": GetTopUnitPartnersFuncInput}
Response
{
"data": {
"getTopUnitPartnersFunc": {
"results": [GetTopUnitPartnersFuncRecord]
}
}
}
getUnitCountByFocusesDrilldownFunc
Description
Retrieves the count of organizational units based on focus areas drilldown.
Response
Arguments
| Name | Description |
|---|---|
input - GetUnitCountByFocusesDrilldownFuncInput!
|
Example
Query
mutation GetUnitCountByFocusesDrilldownFunc($input: GetUnitCountByFocusesDrilldownFuncInput!) {
getUnitCountByFocusesDrilldownFunc(input: $input) {
results {
totalRows
focusArea
unitCnt
}
}
}
Variables
{"input": GetUnitCountByFocusesDrilldownFuncInput}
Response
{
"data": {
"getUnitCountByFocusesDrilldownFunc": {
"results": [
GetUnitCountByFocusesDrilldownFuncRecord
]
}
}
}
getUnitDatasetFunc
Description
Retrieves dataset for units.
Response
Returns a GetUnitDatasetFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitDatasetFuncInput!
|
Example
Query
mutation GetUnitDatasetFunc($input: GetUnitDatasetFuncInput!) {
getUnitDatasetFunc(input: $input) {
results {
totalRows
id
name
type
parentId
description
contactName
contactEmail
contactPhone
url
activityCnt
activityName
sectionCnt
courses
communityCnt
communityNames
reportsTo
prefixes
coursePrefixDescription
}
}
}
Variables
{"input": GetUnitDatasetFuncInput}
Response
{
"data": {
"getUnitDatasetFunc": {
"results": [GetUnitDatasetFuncRecord]
}
}
}
getUnitPartnerCountFunc
Description
Retrieves the count of unit partners based on filters.
Response
Returns a GetUnitPartnerCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitPartnerCountFuncInput!
|
Example
Query
mutation GetUnitPartnerCountFunc($input: GetUnitPartnerCountFuncInput!) {
getUnitPartnerCountFunc(input: $input) {
integer
}
}
Variables
{"input": GetUnitPartnerCountFuncInput}
Response
{"data": {"getUnitPartnerCountFunc": {"integer": 42}}}
getUnitPartnersCountFunc
Response
Returns a GetUnitPartnersCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitPartnersCountFuncInput!
|
Example
Query
mutation GetUnitPartnersCountFunc($input: GetUnitPartnersCountFuncInput!) {
getUnitPartnersCountFunc(input: $input) {
integer
}
}
Variables
{"input": GetUnitPartnersCountFuncInput}
Response
{"data": {"getUnitPartnersCountFunc": {"integer": 42}}}
getUnitPartnersFunc
Response
Returns a GetUnitPartnersFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitPartnersFuncInput!
|
Example
Query
mutation GetUnitPartnersFunc($input: GetUnitPartnersFuncInput!) {
getUnitPartnersFunc(input: $input) {
results {
totalRows
insertTimestamp
id
authorId
created
modified
archived
deleted
type
name
description
logoUrl
url
externalId
bypassProfileModeration
parentId
portalId
contactFirstname
contactLastname
contactPhone
contactEmail
}
}
}
Variables
{"input": GetUnitPartnersFuncInput}
Response
{
"data": {
"getUnitPartnersFunc": {
"results": [GetUnitPartnersFuncRecord]
}
}
}
getUnitsByFocusesCountFunc
Description
Retrieves the count of units by focus areas.
Response
Returns a GetUnitsByFocusesCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitsByFocusesCountFuncInput!
|
Example
Query
mutation GetUnitsByFocusesCountFunc($input: GetUnitsByFocusesCountFuncInput!) {
getUnitsByFocusesCountFunc(input: $input) {
results {
totalRows
focuses
unitCnt
}
}
}
Variables
{"input": GetUnitsByFocusesCountFuncInput}
Response
{
"data": {
"getUnitsByFocusesCountFunc": {
"results": [GetUnitsByFocusesCountFuncRecord]
}
}
}
getUnitsByFocusesFunc
Description
Retrieves units by focus areas.
Response
Returns a GetUnitsByFocusesFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitsByFocusesFuncInput!
|
Example
Query
mutation GetUnitsByFocusesFunc($input: GetUnitsByFocusesFuncInput!) {
getUnitsByFocusesFunc(input: $input) {
results {
totalRows
id
name
type
parentId
description
contactName
contactEmail
contactPhone
url
activityCnt
activityName
sectionCnt
courses
communityCnt
communityNames
reportsTo
prefixes
coursePrefixDescription
}
}
}
Variables
{"input": GetUnitsByFocusesFuncInput}
Response
{
"data": {
"getUnitsByFocusesFunc": {
"results": [GetUnitsByFocusesFuncRecord]
}
}
}
getUnitsByProgramsCountFunc
Description
Retrieves the count of units by programs and initiatives.
Response
Returns a GetUnitsByProgramsCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitsByProgramsCountFuncInput!
|
Example
Query
mutation GetUnitsByProgramsCountFunc($input: GetUnitsByProgramsCountFuncInput!) {
getUnitsByProgramsCountFunc(input: $input) {
results {
totalRows
programs
unitCnt
}
}
}
Variables
{"input": GetUnitsByProgramsCountFuncInput}
Response
{
"data": {
"getUnitsByProgramsCountFunc": {
"results": [GetUnitsByProgramsCountFuncRecord]
}
}
}
getUnitsByTargetCountFunc
Description
Retrieves the count of units by target population.
Response
Returns a GetUnitsByTargetCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitsByTargetCountFuncInput!
|
Example
Query
mutation GetUnitsByTargetCountFunc($input: GetUnitsByTargetCountFuncInput!) {
getUnitsByTargetCountFunc(input: $input) {
results {
totalRows
population
unitCnt
}
}
}
Variables
{"input": GetUnitsByTargetCountFuncInput}
Response
{
"data": {
"getUnitsByTargetCountFunc": {
"results": [GetUnitsByTargetCountFuncRecord]
}
}
}
getUnitsFunc
Description
Retrieves the total number of activities associated with a unit.
Response
Returns a GetUnitsFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitsFuncInput!
|
Example
Query
mutation GetUnitsFunc($input: GetUnitsFuncInput!) {
getUnitsFunc(input: $input) {
results {
totalRows
activityCnt
unitName
parentId
}
}
}
Variables
{"input": GetUnitsFuncInput}
Response
{
"data": {
"getUnitsFunc": {"results": [GetUnitsFuncRecord]}
}
}
getUnitsRelatedToUnitCountFunc
Description
Retrieves the count of units related to a specific unit based on filters.
Response
Returns a GetUnitsRelatedToUnitCountFuncPayload
Arguments
| Name | Description |
|---|---|
input - GetUnitsRelatedToUnitCountFuncInput!
|
Example
Query
mutation GetUnitsRelatedToUnitCountFunc($input: GetUnitsRelatedToUnitCountFuncInput!) {
getUnitsRelatedToUnitCountFunc(input: $input) {
results {
totalRows
childId
childName
unitCnt
maxDepth
affiliated
}
}
}
Variables
{"input": GetUnitsRelatedToUnitCountFuncInput}
Response
{
"data": {
"getUnitsRelatedToUnitCountFunc": {
"results": [GetUnitsRelatedToUnitCountFuncRecord]
}
}
}
getactivityfacstaffidsfunc
Description
@omit: "create,update,delete"
Response
Returns a GetactivityfacstaffidsfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetactivityfacstaffidsfuncInput!
|
Example
Query
mutation Getactivityfacstaffidsfunc($input: GetactivityfacstaffidsfuncInput!) {
getactivityfacstaffidsfunc(input: $input) {
activityIds
}
}
Variables
{"input": GetactivityfacstaffidsfuncInput}
Response
{
"data": {
"getactivityfacstaffidsfunc": {
"activityIds": ["abc123"]
}
}
}
getactivityfundersActivitiesfunc
Description
Function to retrieve activities funded by funders based on filters.
Response
Returns a GetactivityfundersActivitiesfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetactivityfundersActivitiesfuncInput!
|
Example
Query
mutation GetactivityfundersActivitiesfunc($input: GetactivityfundersActivitiesfuncInput!) {
getactivityfundersActivitiesfunc(input: $input) {
results {
totalRows
insertTimestamp
id
authorId
created
modified
archived
deleted
slug
name
description
startTime
endTime
latitude
longitude
logoId
logoUrl
url
productId
externalId
mutualBenefit
reciprocity
scholarship
teaching
scholarlyResearch
studentParticipation
studentMembers
studentMembersActual
studentHours
facultyParticipation
facultyMembers
reflections
reflectionDescription
frequency
contactPhonePublic
contactEmailPublic
irbProtocol
irbProtocolId
individualsServed
communityInsight
goalsFeedback
focuses
focusAreas
populations
organizingFramework
eventsServices
scholarshipTypes
expectedScholarlyOutputs
achievedScholarlyOutputs
expectedPsOutputs
achievedPsOutputs
expectedOutcomes
achievedOutcomes
expectedImpacts
achievedImpacts
researchTypes
externalPartners
studentHoursActual
modifiedBy
status
contactFirstname
contactLastname
contactEmail
contactOffice
contactPhone
contactPrivateEmail
contactPrivateName
primaryActivity
type
featured
contactPrivatePhone
portalId
activityLead
activityLeadStatus
virtualupdated
unitsupdated
virtualLocation
physicalLocation
distance
address
funders
communities
units
programs
faculties
institutions
}
}
}
Variables
{"input": GetactivityfundersActivitiesfuncInput}
Response
{
"data": {
"getactivityfundersActivitiesfunc": {
"results": [GetactivityfundersActivitiesfuncRecord]
}
}
}
getactivityidsfunc
Description
@omit: "create,update,delete"
Response
Returns a GetactivityidsfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetactivityidsfuncInput!
|
Example
Query
mutation Getactivityidsfunc($input: GetactivityidsfuncInput!) {
getactivityidsfunc(input: $input) {
results {
retId
distance
}
}
}
Variables
{"input": GetactivityidsfuncInput}
Response
{
"data": {
"getactivityidsfunc": {
"results": [GetactivityidsfuncRecord]
}
}
}
getactivitylocationidsfunc
Description
@omit: "create,update,delete"
Response
Returns a GetactivitylocationidsfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetactivitylocationidsfuncInput!
|
Example
Query
mutation Getactivitylocationidsfunc($input: GetactivitylocationidsfuncInput!) {
getactivitylocationidsfunc(input: $input) {
actLocationIds
}
}
Variables
{"input": GetactivitylocationidsfuncInput}
Response
{
"data": {
"getactivitylocationidsfunc": {
"actLocationIds": ["abc123"]
}
}
}
getactivitytopunitidsfunc
Description
@omit: "create,update,delete"
Response
Returns a GetactivitytopunitidsfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetactivitytopunitidsfuncInput!
|
Example
Query
mutation Getactivitytopunitidsfunc($input: GetactivitytopunitidsfuncInput!) {
getactivitytopunitidsfunc(input: $input) {
activityIds
}
}
Variables
{"input": GetactivitytopunitidsfuncInput}
Response
{
"data": {
"getactivitytopunitidsfunc": {
"activityIds": ["xyz789"]
}
}
}
getactivityunitidsfunc
Description
@omit: "create,update,delete"
Response
Returns a GetactivityunitidsfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetactivityunitidsfuncInput!
|
Example
Query
mutation Getactivityunitidsfunc($input: GetactivityunitidsfuncInput!) {
getactivityunitidsfunc(input: $input) {
activityIds
}
}
Variables
{"input": GetactivityunitidsfuncInput}
Response
{
"data": {
"getactivityunitidsfunc": {
"activityIds": ["abc123"]
}
}
}
getactivityunitsfunc
Response
Returns a GetactivityunitsfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetactivityunitsfuncInput!
|
Example
Query
mutation Getactivityunitsfunc($input: GetactivityunitsfuncInput!) {
getactivityunitsfunc(input: $input) {
units
}
}
Variables
{"input": GetactivityunitsfuncInput}
Response
{
"data": {
"getactivityunitsfunc": {
"units": ["abc123"]
}
}
}
getcommunitypartnersActivitiesfunc
Response
Arguments
| Name | Description |
|---|---|
input - GetcommunitypartnersActivitiesfuncInput!
|
Example
Query
mutation GetcommunitypartnersActivitiesfunc($input: GetcommunitypartnersActivitiesfuncInput!) {
getcommunitypartnersActivitiesfunc(input: $input) {
results {
totalRows
insertTimestamp
id
authorId
created
modified
archived
deleted
slug
name
description
startTime
endTime
latitude
longitude
logoId
logoUrl
url
productId
externalId
mutualBenefit
reciprocity
scholarship
teaching
scholarlyResearch
studentParticipation
studentMembers
studentMembersActual
studentHours
facultyParticipation
facultyMembers
reflections
reflectionDescription
frequency
contactPhonePublic
contactEmailPublic
irbProtocol
irbProtocolId
individualsServed
communityInsight
goalsFeedback
focuses
focusAreas
populations
organizingFramework
eventsServices
scholarshipTypes
expectedScholarlyOutputs
achievedScholarlyOutputs
expectedPsOutputs
achievedPsOutputs
expectedOutcomes
achievedOutcomes
expectedImpacts
achievedImpacts
researchTypes
externalPartners
studentHoursActual
modifiedBy
status
contactFirstname
contactLastname
contactEmail
contactOffice
contactPhone
contactPrivateEmail
contactPrivateName
primaryActivity
type
featured
contactPrivatePhone
portalId
activityLead
activityLeadStatus
distance
funders
communities
units
programs
faculties
address
institutions
coursesSection
}
}
}
Variables
{"input": GetcommunitypartnersActivitiesfuncInput}
Response
{
"data": {
"getcommunitypartnersActivitiesfunc": {
"results": [
GetcommunitypartnersActivitiesfuncRecord
]
}
}
}
getfacstaffActivitiesfunc
Response
Returns a GetfacstaffActivitiesfuncPayload
Arguments
| Name | Description |
|---|---|
input - GetfacstaffActivitiesfuncInput!
|
Example
Query
mutation GetfacstaffActivitiesfunc($input: GetfacstaffActivitiesfuncInput!) {
getfacstaffActivitiesfunc(input: $input) {
results {
totalRows
insertTimestamp
id
authorId
created
modified
archived
deleted
slug
name
description
startTime
endTime
latitude
longitude
logoId
logoUrl
url
productId
externalId
mutualBenefit
reciprocity
scholarship
teaching
scholarlyResearch
studentParticipation
studentMembers
studentMembersActual
studentHours
facultyParticipation
facultyMembers
reflections
reflectionDescription
frequency
contactPhonePublic
contactEmailPublic
irbProtocol
irbProtocolId
individualsServed
communityInsight
goalsFeedback
focuses
focusAreas
populations
organizingFramework
eventsServices
scholarshipTypes
expectedScholarlyOutputs
achievedScholarlyOutputs
expectedPsOutputs
achievedPsOutputs
expectedOutcomes
achievedOutcomes
expectedImpacts
achievedImpacts
researchTypes
externalPartners
studentHoursActual
modifiedBy
status
contactFirstname
contactLastname
contactEmail
contactOffice
contactPhone
contactPrivateEmail
contactPrivateName
primaryActivity
type
featured
contactPrivatePhone
portalId
activityLead
activityLeadStatus
distance
funders
communities
units
programs
faculties
address
institutions
}
}
}
Variables
{"input": GetfacstaffActivitiesfuncInput}
Response
{
"data": {
"getfacstaffActivitiesfunc": {
"results": [GetfacstaffActivitiesfuncRecord]
}
}
}
getinstitutionalpartnersActivitiesfunc
Response
Arguments
| Name | Description |
|---|---|
input - GetinstitutionalpartnersActivitiesfuncInput!
|
Example
Query
mutation GetinstitutionalpartnersActivitiesfunc($input: GetinstitutionalpartnersActivitiesfuncInput!) {
getinstitutionalpartnersActivitiesfunc(input: $input) {
results {
totalRows
insertTimestamp
id
authorId
created
modified
archived
deleted
slug
name
description
startTime
endTime
latitude
longitude
logoId
logoUrl
url
productId
externalId
mutualBenefit
reciprocity
scholarship
teaching
scholarlyResearch
studentParticipation
studentMembers
studentMembersActual
studentHours
facultyParticipation
facultyMembers
reflections
reflectionDescription
frequency
contactPhonePublic
contactEmailPublic
irbProtocol
irbProtocolId
individualsServed
communityInsight
goalsFeedback
focuses
focusAreas
populations
organizingFramework
eventsServices
scholarshipTypes
expectedScholarlyOutputs
achievedScholarlyOutputs
expectedPsOutputs
achievedPsOutputs
expectedOutcomes
achievedOutcomes
expectedImpacts
achievedImpacts
researchTypes
externalPartners
studentHoursActual
modifiedBy
status
contactFirstname
contactLastname
contactEmail
contactOffice
contactPhone
contactPrivateEmail
contactPrivateName
primaryActivity
type
featured
contactPrivatePhone
portalId
activityLead
activityLeadStatus
distance
funders
communities
units
programs
faculties
address
institutions
coursesSection
}
}
}
Variables
{"input": GetinstitutionalpartnersActivitiesfuncInput}
Response
{
"data": {
"getinstitutionalpartnersActivitiesfunc": {
"results": [
GetinstitutionalpartnersActivitiesfuncRecord
]
}
}
}
Types
AWSDateTime
Description
The AWSDateTime scalar type provided by AWS AppSync, represents a valid extended ISO 8601 DateTime string. In other words, this scalar type accepts datetime strings of the form YYYY-MM-DDThh:mm:ss.SSSZ. The scalar can also accept "negative years" of the form -YYYY which correspond to years before 0000. For example, "-2017-01-01T00:00Z" and "-9999-01-01T00:00Z" are both valid datetime strings. The field after the two digit seconds field is a nanoseconds field. It can accept between 1 and 9 digits. So, for example, "1970-01-01T12:00:00.2Z", "1970-01-01T12:00:00.277Z" and "1970-01-01T12:00:00.123456789Z" are all valid datetime strings. The seconds and nanoseconds fields are optional (the seconds field must be specified if the nanoseconds field is to be used). The time zone offset is compulsory for this scalar. The time zone offset must either be Z (representing the UTC time zone) or be in the format ±hh:mm:ss. The seconds field in the timezone offset will be considered valid even though it is not part of the ISO 8601 standard.
Example
AWSDateTime
AWSJSON
Description
The AWSJSON scalar type provided by AWS AppSync, represents a JSON string that complies with RFC 8259. Maps like "{\"upvotes\": 10}", lists like "[1,2,3]", and scalar values like "\"AWSJSON example string\"", "1", and "true" are accepted as valid JSON and will automatically be parsed and loaded in the resolver mapping templates as Maps, Lists, or Scalar values rather than as the literal input strings. Invalid JSON strings like "{a: 1}", "{'a': 1}" and "Unquoted string" will throw GraphQL validation errors.
Example
AWSJSON
Boolean
Description
The Boolean scalar type represents true or false.
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
GetActivitiesCoursesFuncInput
Description
All input for the getActivitiesCoursesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pIncludeAddress - Boolean
|
Boolean flag to determine if addresses should be included in the returned activities. |
pIncludeFunders - Boolean
|
Boolean flag to include funders associated with the activities. |
pIncludeCommunities - Boolean
|
Boolean flag to include community associations related to the activities. |
pIncludeUnits - Boolean
|
Boolean flag to include information about organizational units involved in the activities. |
pIncludePrograms - Boolean
|
Boolean flag to include detailed program information for each activity. |
pIncludeFaculties - Boolean
|
Boolean flag to include faculty information associated with the activities. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pTopUnits - [String]
|
Array of top unit identifiers to filter records. |
pIncludeInstitutions - Boolean
|
Boolean flag to include institution data for activities. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pIncludeAddress": true,
"pIncludeFunders": false,
"pIncludeCommunities": true,
"pIncludeUnits": true,
"pIncludePrograms": true,
"pIncludeFaculties": false,
"pConnectedCourse": false,
"pTopUnits": ["xyz789"],
"pIncludeInstitutions": false,
"pFocuses": ["abc123"],
"pToken": "abc123"
}
GetActivitiesCoursesFuncPayload
Description
The output of our getActivitiesCoursesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivitiesCoursesFuncRecord]
|
Example
{"results": [GetActivitiesCoursesFuncRecord]}
GetActivitiesCoursesFuncRecord
Description
The return type of our getActivitiesCoursesFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - ID
|
|
authorId - ID
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
slug - String
|
|
name - String
|
|
description - String
|
|
startTime - AWSDateTime
|
|
endTime - AWSDateTime
|
|
latitude - Float
|
|
longitude - Float
|
|
logoId - ID
|
|
logoUrl - String
|
|
url - String
|
|
productId - Int
|
|
externalId - String
|
|
mutualBenefit - Boolean
|
|
reciprocity - Boolean
|
|
scholarship - Boolean
|
|
teaching - Boolean
|
|
scholarlyResearch - Boolean
|
|
studentParticipation - Boolean
|
|
studentMembers - Int
|
|
studentMembersActual - Boolean
|
|
studentHours - Int
|
|
facultyParticipation - Boolean
|
|
facultyMembers - Int
|
|
reflections - Boolean
|
|
reflectionDescription - String
|
|
frequency - Int
|
|
contactPhonePublic - Boolean
|
|
contactEmailPublic - Boolean
|
|
irbProtocol - Boolean
|
|
irbProtocolId - String
|
|
individualsServed - Int
|
|
communityInsight - String
|
|
goalsFeedback - String
|
|
focuses - [String]
|
|
focusAreas - AWSJSON
|
|
populations - [String]
|
|
organizingFramework - [String]
|
|
eventsServices - [String]
|
|
scholarshipTypes - [String]
|
|
expectedScholarlyOutputs - [String]
|
|
achievedScholarlyOutputs - [String]
|
|
expectedPsOutputs - [String]
|
|
achievedPsOutputs - [String]
|
|
expectedOutcomes - [String]
|
|
achievedOutcomes - [String]
|
|
expectedImpacts - [String]
|
|
achievedImpacts - [String]
|
|
researchTypes - [String]
|
|
externalPartners - Boolean
|
|
studentHoursActual - Boolean
|
|
modifiedBy - ID
|
|
status - String
|
|
contactFirstname - String
|
|
contactLastname - String
|
|
contactEmail - String
|
|
contactOffice - String
|
|
contactPhone - String
|
|
contactPrivateEmail - Boolean
|
|
contactPrivateName - Boolean
|
|
primaryActivity - String
|
|
type - String
|
|
featured - AWSDateTime
|
|
contactPrivatePhone - Boolean
|
|
portalId - ID
|
|
activityLead - ID
|
|
activityLeadStatus - String
|
|
distance - Float
|
|
address - String
|
|
funders - String
|
|
communities - String
|
|
units - String
|
|
programs - String
|
|
faculties - String
|
|
institutions - String
|
|
courses - String
|
|
enrolledParticipation - String
|
|
enrolledHours - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": 4,
"authorId": 4,
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": false,
"deleted": true,
"slug": "abc123",
"name": "xyz789",
"description": "xyz789",
"startTime": AWSDateTime,
"endTime": AWSDateTime,
"latitude": 987.65,
"longitude": 987.65,
"logoId": 4,
"logoUrl": "xyz789",
"url": "xyz789",
"productId": 42,
"externalId": "xyz789",
"mutualBenefit": true,
"reciprocity": false,
"scholarship": true,
"teaching": true,
"scholarlyResearch": true,
"studentParticipation": true,
"studentMembers": 42,
"studentMembersActual": false,
"studentHours": 42,
"facultyParticipation": false,
"facultyMembers": 42,
"reflections": true,
"reflectionDescription": "xyz789",
"frequency": 42,
"contactPhonePublic": true,
"contactEmailPublic": true,
"irbProtocol": false,
"irbProtocolId": "abc123",
"individualsServed": 42,
"communityInsight": "xyz789",
"goalsFeedback": "abc123",
"focuses": ["xyz789"],
"focusAreas": AWSJSON,
"populations": ["abc123"],
"organizingFramework": ["abc123"],
"eventsServices": ["abc123"],
"scholarshipTypes": ["abc123"],
"expectedScholarlyOutputs": ["xyz789"],
"achievedScholarlyOutputs": ["abc123"],
"expectedPsOutputs": ["xyz789"],
"achievedPsOutputs": ["abc123"],
"expectedOutcomes": ["abc123"],
"achievedOutcomes": ["abc123"],
"expectedImpacts": ["xyz789"],
"achievedImpacts": ["abc123"],
"researchTypes": ["xyz789"],
"externalPartners": true,
"studentHoursActual": false,
"modifiedBy": 4,
"status": "xyz789",
"contactFirstname": "abc123",
"contactLastname": "xyz789",
"contactEmail": "abc123",
"contactOffice": "xyz789",
"contactPhone": "xyz789",
"contactPrivateEmail": false,
"contactPrivateName": false,
"primaryActivity": "xyz789",
"type": "abc123",
"featured": AWSDateTime,
"contactPrivatePhone": false,
"portalId": "4",
"activityLead": "4",
"activityLeadStatus": "xyz789",
"distance": 987.65,
"address": "abc123",
"funders": "xyz789",
"communities": "abc123",
"units": "abc123",
"programs": "xyz789",
"faculties": "xyz789",
"institutions": "xyz789",
"courses": "abc123",
"enrolledParticipation": "xyz789",
"enrolledHours": "abc123"
}
GetActivitiesFuncInput
Description
All input for the getActivitiesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pIncludeAddress - Boolean
|
Boolean flag to determine if addresses should be included in the returned activities. |
pIncludeFunders - Boolean
|
Boolean flag to include funders associated with the activities. |
pIncludeCommunities - Boolean
|
Boolean flag to include community associations related to the activities. |
pIncludeUnits - Boolean
|
Boolean flag to include information about organizational units involved in the activities. |
pIncludePrograms - Boolean
|
Boolean flag to include detailed program information for each activity. |
pIncludeFaculties - Boolean
|
Boolean flag to include faculty information associated with the activities. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pTopUnits - [String]
|
Array of top unit identifiers to filter records. |
pIncludeInstitutions - Boolean
|
Boolean flag to include institution data for activities. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pScholarshipConnection - String
|
String to filter activities that have a connection to scholarships. |
pScholarlyExpected - [String]
|
Array of expected scholarly outcomes from the activities. |
pScholarlyAchieved - [String]
|
Array of achieved scholarly outcomes from the activities, to compare against expectations. |
pStudentLearning - Boolean
|
Boolean flag to filter activities based on whether they contribute to student learning. |
pStudentLearningObj - String
|
Specific learning objectives of the student learning activities. |
pPedagogy - Boolean
|
Boolean flag to include activities that incorporate specific pedagogical approaches. |
pPedagogies - String
|
Detailed description of the pedagogies involved in the activities. |
pOnlyExpectedOutcomes - Boolean
|
Boolean flag to filter activities that only include expected outcomes. |
pOnlyAchievedOutcomes - Boolean
|
Boolean flag to filter activities that only include achieved outcomes. |
pExpectedOutcomes - String
|
Detailed description of expected outcomes from the activities. |
pAchievedOutcomes - String
|
Detailed description of outcomes that have been achieved by the activities. |
pOnlyExpectedImpactComm - Boolean
|
Boolean flag to filter activities that only have expected community impacts documented. |
pOnlyAchievedImpactComm - Boolean
|
Boolean flag to filter activities that only have achieved community impacts. |
pExpectedImpactComm - String
|
Expected impacts of the activities on the community. |
pAchievedImpactComm - String
|
Achieved impacts of the activities on the community. |
pAchievedPsOutputs - String
|
Description of outputs from post-secondary activities that have been achieved. |
pExpectedPsOutputs - String
|
Description of expected outputs from post-secondary activities. |
pOnlyExpectedOutputs - Boolean
|
Boolean flag to filter activities based on only expected outputs being documented. |
pOnlyAchievedOutputs - Boolean
|
Boolean flag to filter activities based on only achieved outputs. |
pCommunityIndividualServed - Boolean
|
Boolean flag to include activities that serve individuals in the community. |
pOnlyStudentInvolment - Boolean
|
Boolean flag to filter activities based on only student involvement. |
pStudentInvolment - String
|
Details of student involvement in the activities. |
pOnlyFactStaff - Boolean
|
Boolean flag to filter activities based on only faculty and staff involvement. |
pFilterByOther - Boolean
|
Boolean flag to apply additional filters specified by other criteria. |
pCollectsData - Boolean
|
Boolean flag to filter activities based on whether they collect data. |
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pNonEnrParticipation - Boolean
|
Boolean flag to include activities that involve non-enrolled participants. |
pNonEnrStudentHours - Boolean
|
Flag to include data on hours spent by non-enrolled students in activities. |
pEnrStudentParticipation - Boolean
|
Boolean flag to filter activities based on enrolled student participation. |
pEnrStudentHours - Boolean
|
Details on the number of hours enrolled students spend in activities. |
pStudentParticipation - Boolean
|
Boolean flag to include activities based on student participation. |
pStudentHours - Boolean
|
Total hours students spend participating in activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pIncludeAddress": true,
"pIncludeFunders": true,
"pIncludeCommunities": true,
"pIncludeUnits": true,
"pIncludePrograms": false,
"pIncludeFaculties": true,
"pConnectedCourse": true,
"pTopUnits": ["xyz789"],
"pIncludeInstitutions": false,
"pFocuses": ["abc123"],
"pTargetPopulation": "abc123",
"pScholarshipConnection": "xyz789",
"pScholarlyExpected": ["abc123"],
"pScholarlyAchieved": ["abc123"],
"pStudentLearning": true,
"pStudentLearningObj": "abc123",
"pPedagogy": true,
"pPedagogies": "abc123",
"pOnlyExpectedOutcomes": false,
"pOnlyAchievedOutcomes": false,
"pExpectedOutcomes": "xyz789",
"pAchievedOutcomes": "xyz789",
"pOnlyExpectedImpactComm": false,
"pOnlyAchievedImpactComm": false,
"pExpectedImpactComm": "xyz789",
"pAchievedImpactComm": "abc123",
"pAchievedPsOutputs": "xyz789",
"pExpectedPsOutputs": "xyz789",
"pOnlyExpectedOutputs": false,
"pOnlyAchievedOutputs": false,
"pCommunityIndividualServed": false,
"pOnlyStudentInvolment": false,
"pStudentInvolment": "xyz789",
"pOnlyFactStaff": false,
"pFilterByOther": false,
"pCollectsData": true,
"pOnlyPrograms": false,
"pPrograms": "abc123",
"pNonEnrParticipation": true,
"pNonEnrStudentHours": false,
"pEnrStudentParticipation": false,
"pEnrStudentHours": false,
"pStudentParticipation": false,
"pStudentHours": true,
"pToken": "abc123"
}
GetActivitiesFuncPayload
Description
The output of our getActivitiesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivitiesFuncRecord]
|
Example
{"results": [GetActivitiesFuncRecord]}
GetActivitiesFuncRecord
Description
The return type of our getActivitiesFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - ID
|
|
authorId - ID
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
slug - String
|
|
name - String
|
|
description - String
|
|
startTime - AWSDateTime
|
|
endTime - AWSDateTime
|
|
latitude - Float
|
|
longitude - Float
|
|
logoId - ID
|
|
logoUrl - String
|
|
url - String
|
|
productId - Int
|
|
externalId - String
|
|
mutualBenefit - Boolean
|
|
reciprocity - Boolean
|
|
scholarship - Boolean
|
|
teaching - Boolean
|
|
scholarlyResearch - Boolean
|
|
studentParticipation - Boolean
|
|
studentMembers - Int
|
|
studentMembersActual - Boolean
|
|
studentHours - Int
|
|
facultyParticipation - Boolean
|
|
facultyMembers - Int
|
|
reflections - Boolean
|
|
reflectionDescription - String
|
|
frequency - Int
|
|
contactPhonePublic - Boolean
|
|
contactEmailPublic - Boolean
|
|
irbProtocol - Boolean
|
|
irbProtocolId - String
|
|
individualsServed - Int
|
|
communityInsight - String
|
|
goalsFeedback - String
|
|
focuses - [String]
|
|
focusAreas - AWSJSON
|
|
populations - [String]
|
|
organizingFramework - [String]
|
|
eventsServices - [String]
|
|
scholarshipTypes - [String]
|
|
expectedScholarlyOutputs - [String]
|
|
achievedScholarlyOutputs - [String]
|
|
expectedPsOutputs - [String]
|
|
achievedPsOutputs - [String]
|
|
expectedOutcomes - [String]
|
|
achievedOutcomes - [String]
|
|
expectedImpacts - [String]
|
|
achievedImpacts - [String]
|
|
researchTypes - [String]
|
|
externalPartners - Boolean
|
|
studentHoursActual - Boolean
|
|
modifiedBy - ID
|
|
status - String
|
|
contactFirstname - String
|
|
contactLastname - String
|
|
contactEmail - String
|
|
contactOffice - String
|
|
contactPhone - String
|
|
contactPrivateEmail - Boolean
|
|
contactPrivateName - Boolean
|
|
primaryActivity - String
|
|
type - String
|
|
featured - AWSDateTime
|
|
contactPrivatePhone - Boolean
|
|
portalId - ID
|
|
activityLead - ID
|
|
activityLeadStatus - String
|
|
virtualupdated - Boolean
|
|
unitsupdated - Boolean
|
|
virtualLocation - Boolean
|
|
physicalLocation - Boolean
|
|
distance - Float
|
|
address - String
|
|
funders - String
|
|
communities - String
|
|
units - String
|
|
programs - String
|
|
faculties - String
|
|
institutions - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": "4",
"authorId": "4",
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": true,
"deleted": true,
"slug": "xyz789",
"name": "abc123",
"description": "xyz789",
"startTime": AWSDateTime,
"endTime": AWSDateTime,
"latitude": 987.65,
"longitude": 987.65,
"logoId": 4,
"logoUrl": "abc123",
"url": "abc123",
"productId": 42,
"externalId": "xyz789",
"mutualBenefit": true,
"reciprocity": true,
"scholarship": false,
"teaching": false,
"scholarlyResearch": true,
"studentParticipation": false,
"studentMembers": 42,
"studentMembersActual": false,
"studentHours": 42,
"facultyParticipation": true,
"facultyMembers": 42,
"reflections": false,
"reflectionDescription": "abc123",
"frequency": 42,
"contactPhonePublic": true,
"contactEmailPublic": false,
"irbProtocol": true,
"irbProtocolId": "abc123",
"individualsServed": 42,
"communityInsight": "xyz789",
"goalsFeedback": "abc123",
"focuses": ["abc123"],
"focusAreas": AWSJSON,
"populations": ["xyz789"],
"organizingFramework": ["xyz789"],
"eventsServices": ["abc123"],
"scholarshipTypes": ["xyz789"],
"expectedScholarlyOutputs": ["abc123"],
"achievedScholarlyOutputs": ["abc123"],
"expectedPsOutputs": ["abc123"],
"achievedPsOutputs": ["xyz789"],
"expectedOutcomes": ["xyz789"],
"achievedOutcomes": ["abc123"],
"expectedImpacts": ["abc123"],
"achievedImpacts": ["xyz789"],
"researchTypes": ["xyz789"],
"externalPartners": true,
"studentHoursActual": false,
"modifiedBy": 4,
"status": "abc123",
"contactFirstname": "xyz789",
"contactLastname": "abc123",
"contactEmail": "xyz789",
"contactOffice": "abc123",
"contactPhone": "xyz789",
"contactPrivateEmail": false,
"contactPrivateName": true,
"primaryActivity": "xyz789",
"type": "xyz789",
"featured": AWSDateTime,
"contactPrivatePhone": true,
"portalId": 4,
"activityLead": "4",
"activityLeadStatus": "abc123",
"virtualupdated": false,
"unitsupdated": false,
"virtualLocation": false,
"physicalLocation": true,
"distance": 123.45,
"address": "abc123",
"funders": "xyz789",
"communities": "xyz789",
"units": "xyz789",
"programs": "abc123",
"faculties": "xyz789",
"institutions": "xyz789"
}
GetActivityAddressFuncInput
Description
All input for the getActivityAddressFunc mutation.
Fields
| Input Field | Description |
|---|---|
pActivityId - String
|
Filter activities by ID. |
Example
{"pActivityId": "abc123"}
GetActivityAddressFuncPayload
Description
The output of our getActivityAddressFunc mutation.
Fields
| Field Name | Description |
|---|---|
addresses - [String]
|
Example
{"addresses": ["abc123"]}
GetActivityCommunityOrgFuncInput
Description
All input for the getActivityCommunityOrgFunc mutation.
Fields
| Input Field | Description |
|---|---|
pActivityId - String
|
Filter activities by ID. |
Example
{"pActivityId": "abc123"}
GetActivityCommunityOrgFuncPayload
Description
The output of our getActivityCommunityOrgFunc mutation.
Fields
| Field Name | Description |
|---|---|
communities - [String]
|
Example
{"communities": ["xyz789"]}
GetActivityCountByFocusesDrilldownFuncInput
Description
All input for the getActivityCountByFocusesDrilldownFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pFocuses": ["abc123"],
"pToken": "xyz789"
}
GetActivityCountByFocusesDrilldownFuncPayload
Description
The output of our getActivityCountByFocusesDrilldownFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityCountByFocusesDrilldownFuncRecord]
|
Example
{
"results": [
GetActivityCountByFocusesDrilldownFuncRecord
]
}
GetActivityCountByFocusesDrilldownFuncRecord
GetActivityCountByFocusesFuncInput
Description
All input for the getActivityCountByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pFocuses": ["abc123"],
"pToken": "xyz789"
}
GetActivityCountByFocusesFuncPayload
Description
The output of our getActivityCountByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityCountByFocusesFuncRecord]
|
Example
{"results": [GetActivityCountByFocusesFuncRecord]}
GetActivityCountByFocusesFuncRecord
GetActivityCountByTargetFuncInput
Description
All input for the getActivityCountByTargetFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": false,
"pToken": "abc123"
}
GetActivityCountByTargetFuncPayload
Description
The output of our getActivityCountByTargetFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityCountByTargetFuncRecord]
|
Example
{"results": [GetActivityCountByTargetFuncRecord]}
GetActivityCountByTargetFuncRecord
GetActivityCountByUnitsFuncInput
Description
All input for the getActivityCountByUnitsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetActivityCountByUnitsFuncPayload
Description
The output of our getActivityCountByUnitsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityCountByUnitsFuncRecord]
|
Example
{"results": [GetActivityCountByUnitsFuncRecord]}
GetActivityCountByUnitsFuncRecord
GetActivityCountFuncInput
Description
All input for the getActivityCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pCollectsData - Boolean
|
Boolean flag to filter activities based on whether they collect data. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": false,
"pFocuses": ["abc123"],
"pCollectsData": true,
"pToken": "abc123"
}
GetActivityCountFuncPayload
Description
The output of our getActivityCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityCountFuncRecord]
|
Example
{"results": [GetActivityCountFuncRecord]}
GetActivityCountFuncRecord
GetActivityCoursesFuncInput
Description
All input for the getActivityCoursesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pActivityId - String
|
Filter activities by ID. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pActivityId": "xyz789",
"pConnectedCourse": false,
"pFocuses": ["abc123"],
"pToken": "abc123"
}
GetActivityCoursesFuncPayload
Description
The output of our getActivityCoursesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityCoursesFuncRecord]
|
Example
{"results": [GetActivityCoursesFuncRecord]}
GetActivityCoursesFuncRecord
Description
The return type of our getActivityCoursesFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
activityId - String
|
|
activityName - String
|
|
activityCreated - AWSDateTime
|
|
courses - String
|
Example
{
"totalRows": 42,
"activityId": "xyz789",
"activityName": "abc123",
"activityCreated": AWSDateTime,
"courses": "xyz789"
}
GetActivityFacultyStaffFuncInput
Description
All input for the getActivityFacultyStaffFunc mutation.
Fields
| Input Field | Description |
|---|---|
pActivityId - String
|
Filter activities by ID. |
Example
{"pActivityId": "xyz789"}
GetActivityFacultyStaffFuncPayload
Description
The output of our getActivityFacultyStaffFunc mutation.
Fields
| Field Name | Description |
|---|---|
faculties - [String]
|
Example
{"faculties": ["abc123"]}
GetActivityFundersCountFuncInput
Description
All input for the getActivityFundersCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pFounderSource - String
|
|
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pFounderSource": "abc123",
"pConnectedCourse": true,
"pToken": "xyz789"
}
GetActivityFundersCountFuncPayload
Description
The output of our getActivityFundersCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetActivityFundersFuncInput
Description
All input for the getActivityFundersFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pFounderSource - String
|
|
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pFounderSource": "xyz789",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetActivityFundersFuncPayload
Description
The output of our getActivityFundersFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityFundersFuncRecord]
|
Example
{"results": [GetActivityFundersFuncRecord]}
GetActivityFundersFuncRecord
Description
The return type of our getActivityFundersFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
activityId - String
|
|
funderId - String
|
|
name - String
|
|
startTs - AWSDateTime
|
|
endTs - AWSDateTime
|
|
amount - Float
|
|
source - String
|
|
deleted - Boolean
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"activityId": "xyz789",
"funderId": "xyz789",
"name": "abc123",
"startTs": AWSDateTime,
"endTs": AWSDateTime,
"amount": 987.65,
"source": "abc123",
"deleted": true
}
GetActivityFundersTotalAmountFuncInput
Description
All input for the getActivityFundersTotalAmountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pFounderSource - String
|
|
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pFounderSource": "abc123",
"pConnectedCourse": false,
"pToken": "xyz789"
}
GetActivityFundersTotalAmountFuncPayload
Description
The output of our getActivityFundersTotalAmountFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetActivityInstitutionsFuncInput
Description
All input for the getActivityInstitutionsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pActivityId - String
|
Filter activities by ID. |
Example
{"pActivityId": "abc123"}
GetActivityInstitutionsFuncPayload
Description
The output of our getActivityInstitutionsFunc mutation.
Fields
| Field Name | Description |
|---|---|
institutions - [String]
|
Example
{"institutions": ["xyz789"]}
GetActivityLearnigObjectivesFuncInput
Description
All input for the getActivityLearnigObjectivesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pActivityId - String
|
Filter activities by ID. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pSortBy": "xyz789",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pActivityId": "abc123",
"pFocuses": ["xyz789"],
"pToken": "xyz789"
}
GetActivityLearnigObjectivesFuncPayload
Description
The output of our getActivityLearnigObjectivesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityLearnigObjectivesFuncRecord]
|
Example
{"results": [GetActivityLearnigObjectivesFuncRecord]}
GetActivityLearnigObjectivesFuncRecord
Description
The return type of our getActivityLearnigObjectivesFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
activityId - String
|
|
activityName - String
|
|
activityCreated - AWSDateTime
|
|
learningObjectives - [String]
|
Example
{
"totalRows": 42,
"activityId": "xyz789",
"activityName": "xyz789",
"activityCreated": AWSDateTime,
"learningObjectives": ["abc123"]
}
GetActivityPedagogiesFuncInput
Description
All input for the getActivityPedagogiesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pActivityId - String
|
Filter activities by ID. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pActivityId": "xyz789",
"pConnectedCourse": false,
"pFocuses": ["xyz789"],
"pToken": "abc123"
}
GetActivityPedagogiesFuncPayload
Description
The output of our getActivityPedagogiesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetActivityPedagogiesFuncRecord]
|
Example
{"results": [GetActivityPedagogiesFuncRecord]}
GetActivityPedagogiesFuncRecord
Description
The return type of our getActivityPedagogiesFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
activityId - String
|
|
activityName - String
|
|
activityCreated - AWSDateTime
|
|
pedagogies - [String]
|
Example
{
"totalRows": 42,
"activityId": "abc123",
"activityName": "abc123",
"activityCreated": AWSDateTime,
"pedagogies": ["xyz789"]
}
GetActivityProgramsFuncInput
Description
All input for the getActivityProgramsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pActivityId - String
|
Filter activities by ID. |
Example
{"pActivityId": "abc123"}
GetActivityProgramsFuncPayload
Description
The output of our getActivityProgramsFunc mutation.
Fields
| Field Name | Description |
|---|---|
programs - [String]
|
Example
{"programs": ["xyz789"]}
GetCommIndividualsServedActTotalsFuncInput
Description
All input for the getCommIndividualsServedActTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": false,
"pFocuses": ["abc123"],
"pTargetPopulation": "abc123",
"pToken": "abc123"
}
GetCommIndividualsServedActTotalsFuncPayload
Description
The output of our getCommIndividualsServedActTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommIndividualsServedActTotalsFuncRecord]
|
Example
{"results": [GetCommIndividualsServedActTotalsFuncRecord]}
GetCommIndividualsServedActTotalsFuncRecord
GetCommunityCountByFocusesDrilldownFuncInput
Description
All input for the getCommunityCountByFocusesDrilldownFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pFocuses": ["xyz789"],
"pToken": "abc123"
}
GetCommunityCountByFocusesDrilldownFuncPayload
Description
The output of our getCommunityCountByFocusesDrilldownFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityCountByFocusesDrilldownFuncRecord]
|
Example
{
"results": [
GetCommunityCountByFocusesDrilldownFuncRecord
]
}
GetCommunityCountByFocusesDrilldownFuncRecord
GetCommunityOrgByFocusesFuncInput
Description
All input for the getCommunityOrgByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": true,
"pFocuses": ["abc123"],
"pToken": "abc123"
}
GetCommunityOrgByFocusesFuncPayload
Description
The output of our getCommunityOrgByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityOrgByFocusesFuncRecord]
|
Example
{"results": [GetCommunityOrgByFocusesFuncRecord]}
GetCommunityOrgByFocusesFuncRecord
Description
The return type of our getCommunityOrgByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
id - ID
|
|
name - String
|
|
street - String
|
|
street2 - String
|
|
zipcode - String
|
|
city - String
|
|
state - String
|
|
county - String
|
|
country - String
|
|
latitude - Float
|
|
longitude - Float
|
|
type - String
|
|
description - String
|
|
url - String
|
|
phone - String
|
|
email - String
|
|
archived - Boolean
|
|
status - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
role - String
|
|
contactNames - [String]
|
|
contactEmails - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
|
unitCnt - Int
|
|
unitNames - [String]
|
|
externalId - String
|
Example
{
"totalRows": 42,
"id": "4",
"name": "xyz789",
"street": "xyz789",
"street2": "abc123",
"zipcode": "xyz789",
"city": "abc123",
"state": "xyz789",
"county": "xyz789",
"country": "abc123",
"latitude": 987.65,
"longitude": 123.45,
"type": "abc123",
"description": "abc123",
"url": "xyz789",
"phone": "abc123",
"email": "xyz789",
"archived": false,
"status": "abc123",
"activityCnt": 42,
"activityName": ["abc123"],
"role": "xyz789",
"contactNames": ["xyz789"],
"contactEmails": ["xyz789"],
"sectionCnt": 42,
"courses": ["abc123"],
"unitCnt": 42,
"unitNames": ["abc123"],
"externalId": "abc123"
}
GetCommunityOrgCountByFocusesFuncInput
Description
All input for the getCommunityOrgCountByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": false,
"pFocuses": ["xyz789"],
"pToken": "xyz789"
}
GetCommunityOrgCountByFocusesFuncPayload
Description
The output of our getCommunityOrgCountByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityOrgCountByFocusesFuncRecord]
|
Example
{"results": [GetCommunityOrgCountByFocusesFuncRecord]}
GetCommunityOrgCountByFocusesFuncRecord
GetCommunityOrgCountByUnitsFuncInput
Description
All input for the getCommunityOrgCountByUnitsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFilterUnit - String
|
Filters by specific unit ID. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pOrganizationType - String
|
|
pOnlyCommOrgType - Boolean
|
|
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pFilterUnit": "abc123",
"pTargetPopulation": "abc123",
"pOrganizationType": "xyz789",
"pOnlyCommOrgType": false,
"pOnlyPrograms": false,
"pPrograms": "xyz789",
"pToken": "abc123"
}
GetCommunityOrgCountByUnitsFuncPayload
Description
The output of our getCommunityOrgCountByUnitsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityOrgCountByUnitsFuncRecord]
|
Example
{"results": [GetCommunityOrgCountByUnitsFuncRecord]}
GetCommunityOrgCountByUnitsFuncRecord
Description
The return type of our getCommunityOrgCountByUnitsFunc mutation.
Example
{
"totalRows": 42,
"childId": 4,
"childName": "abc123",
"organizationCnt": 42,
"maxDepth": 42,
"affiliated": true
}
GetCommunityOrgFullFuncInput
Description
All input for the getCommunityOrgFullFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pOrganizationType - String
|
|
pOnlyCommOrgType - Boolean
|
|
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pFilterUnit - String
|
Filters by specific unit ID. |
pOrganizationRole - String
|
|
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": false,
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "xyz789",
"pOrganizationType": "xyz789",
"pOnlyCommOrgType": false,
"pOnlyPrograms": true,
"pPrograms": "abc123",
"pFilterUnit": "xyz789",
"pOrganizationRole": "xyz789",
"pToken": "abc123"
}
GetCommunityOrgFullFuncPayload
Description
The output of our getCommunityOrgFullFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityOrgFullFuncRecord]
|
Example
{"results": [GetCommunityOrgFullFuncRecord]}
GetCommunityOrgFullFuncRecord
Description
The return type of our getCommunityOrgFullFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
id - ID
|
|
name - String
|
|
street - String
|
|
street2 - String
|
|
zipcode - String
|
|
city - String
|
|
state - String
|
|
county - String
|
|
country - String
|
|
latitude - Float
|
|
longitude - Float
|
|
type - String
|
|
description - String
|
|
url - String
|
|
phone - String
|
|
email - String
|
|
archived - Boolean
|
|
status - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
role - String
|
|
contactNames - [String]
|
|
contactEmails - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
|
unitCnt - Int
|
|
unitNames - [String]
|
|
externalId - String
|
Example
{
"totalRows": 42,
"id": 4,
"name": "abc123",
"street": "abc123",
"street2": "abc123",
"zipcode": "xyz789",
"city": "xyz789",
"state": "abc123",
"county": "xyz789",
"country": "xyz789",
"latitude": 987.65,
"longitude": 123.45,
"type": "xyz789",
"description": "xyz789",
"url": "xyz789",
"phone": "xyz789",
"email": "abc123",
"archived": false,
"status": "xyz789",
"activityCnt": 42,
"activityName": ["abc123"],
"role": "xyz789",
"contactNames": ["xyz789"],
"contactEmails": ["xyz789"],
"sectionCnt": 42,
"courses": ["abc123"],
"unitCnt": 42,
"unitNames": ["abc123"],
"externalId": "abc123"
}
GetCommunityOrgFuncInput
Description
All input for the getCommunityOrgFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pOrganizationType - String
|
|
pOnlyCommOrgType - Boolean
|
|
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pFilterUnit - String
|
Filters by specific unit ID. |
pOrganizationRole - String
|
|
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "xyz789",
"pOrganizationType": "abc123",
"pOnlyCommOrgType": true,
"pOnlyPrograms": false,
"pPrograms": "xyz789",
"pFilterUnit": "xyz789",
"pOrganizationRole": "abc123",
"pToken": "abc123"
}
GetCommunityOrgFuncPayload
Description
The output of our getCommunityOrgFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityOrgFuncRecord]
|
Example
{"results": [GetCommunityOrgFuncRecord]}
GetCommunityOrgFuncRecord
Description
The return type of our getCommunityOrgFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
id - ID
|
|
name - String
|
|
street - String
|
|
street2 - String
|
|
zipcode - String
|
|
city - String
|
|
state - String
|
|
county - String
|
|
country - String
|
|
latitude - Float
|
|
longitude - Float
|
|
type - String
|
|
description - String
|
|
url - String
|
|
phone - String
|
|
email - String
|
|
archived - Boolean
|
|
status - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
role - String
|
|
contactNames - [String]
|
|
contactEmails - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
|
unitCnt - Int
|
|
unitNames - [String]
|
|
externalId - String
|
Example
{
"totalRows": 42,
"id": 4,
"name": "abc123",
"street": "abc123",
"street2": "xyz789",
"zipcode": "abc123",
"city": "abc123",
"state": "abc123",
"county": "abc123",
"country": "xyz789",
"latitude": 123.45,
"longitude": 987.65,
"type": "abc123",
"description": "xyz789",
"url": "abc123",
"phone": "xyz789",
"email": "xyz789",
"archived": false,
"status": "xyz789",
"activityCnt": 42,
"activityName": ["abc123"],
"role": "abc123",
"contactNames": ["xyz789"],
"contactEmails": ["xyz789"],
"sectionCnt": 42,
"courses": ["xyz789"],
"unitCnt": 42,
"unitNames": ["abc123"],
"externalId": "xyz789"
}
GetCommunityOrgTypeTotalsFuncInput
Description
All input for the getCommunityOrgTypeTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pToken": "xyz789"
}
GetCommunityOrgTypeTotalsFuncPayload
Description
The output of our getCommunityOrgTypeTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityOrgTypeTotalsFuncRecord]
|
Example
{"results": [GetCommunityOrgTypeTotalsFuncRecord]}
GetCommunityOrgTypeTotalsFuncRecord
GetCommunityPartnersCountByProgramsFuncInput
Description
All input for the getCommunityPartnersCountByProgramsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pFocuses": ["abc123"],
"pTargetPopulation": "abc123",
"pToken": "xyz789"
}
GetCommunityPartnersCountByProgramsFuncPayload
Description
The output of our getCommunityPartnersCountByProgramsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityPartnersCountByProgramsFuncRecord]
|
Example
{
"results": [
GetCommunityPartnersCountByProgramsFuncRecord
]
}
GetCommunityPartnersCountByProgramsFuncRecord
GetCommunityPartnersCountByTargetFuncInput
Description
All input for the getCommunityPartnersCountByTargetFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pFocuses": ["xyz789"],
"pTargetPopulation": "abc123",
"pToken": "xyz789"
}
GetCommunityPartnersCountByTargetFuncPayload
Description
The output of our getCommunityPartnersCountByTargetFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityPartnersCountByTargetFuncRecord]
|
Example
{"results": [GetCommunityPartnersCountByTargetFuncRecord]}
GetCommunityPartnersCountByTargetFuncRecord
GetCommunityPartnersCountFuncInput
Description
All input for the getCommunityPartnersCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pToken": "xyz789"
}
GetCommunityPartnersCountFuncPayload
Description
The output of our getCommunityPartnersCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetCommunityPartnersFuncInput
Description
All input for the getCommunityPartnersFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pTargetPopulation": "abc123",
"pToken": "xyz789"
}
GetCommunityPartnersFuncPayload
Description
The output of our getCommunityPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCommunityPartnersFuncRecord]
|
Example
{"results": [GetCommunityPartnersFuncRecord]}
GetCommunityPartnersFuncRecord
Description
The return type of our getCommunityPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - String
|
|
type - String
|
|
authorId - String
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
slug - String
|
|
vanity - String
|
|
name - String
|
|
description - String
|
|
latitude - Float
|
|
longitude - Float
|
|
logoId - ID
|
|
logoUrl - String
|
|
url - String
|
|
externalId - String
|
|
portal - Boolean
|
|
welcomeMessage - String
|
|
officeName - String
|
|
allowOffline - Boolean
|
|
missionStatement - String
|
|
email - String
|
|
phone - String
|
|
fax - String
|
|
disableEmailNotifications - Boolean
|
|
registrarUrl - String
|
|
courseCatalogUrl - String
|
|
street - String
|
|
street2 - String
|
|
city - String
|
|
state - String
|
|
county - String
|
|
zipcode - String
|
|
zipcodeAddon - Int
|
|
country - String
|
|
modifiedBy - String
|
|
status - String
|
|
parentId - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": "abc123",
"type": "abc123",
"authorId": "abc123",
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": true,
"deleted": false,
"slug": "abc123",
"vanity": "xyz789",
"name": "xyz789",
"description": "abc123",
"latitude": 987.65,
"longitude": 123.45,
"logoId": "4",
"logoUrl": "abc123",
"url": "abc123",
"externalId": "xyz789",
"portal": false,
"welcomeMessage": "abc123",
"officeName": "xyz789",
"allowOffline": true,
"missionStatement": "xyz789",
"email": "abc123",
"phone": "abc123",
"fax": "abc123",
"disableEmailNotifications": false,
"registrarUrl": "xyz789",
"courseCatalogUrl": "xyz789",
"street": "abc123",
"street2": "xyz789",
"city": "abc123",
"state": "xyz789",
"county": "xyz789",
"zipcode": "xyz789",
"zipcodeAddon": 42,
"country": "abc123",
"modifiedBy": "xyz789",
"status": "xyz789",
"parentId": "xyz789"
}
GetCoursesByFocusesFuncInput
Description
All input for the getCoursesByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": true,
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pFocuses": ["abc123"],
"pToken": "xyz789"
}
GetCoursesByFocusesFuncPayload
Description
The output of our getCoursesByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesByFocusesFuncRecord]
|
Example
{"results": [GetCoursesByFocusesFuncRecord]}
GetCoursesByFocusesFuncRecord
Description
The return type of our getCoursesByFocusesFunc mutation.
Example
{
"totalRows": 42,
"courseId": 4,
"courseName": "xyz789",
"courseDesription": "xyz789",
"activePeriod": "xyz789",
"periods": ["abc123"],
"sectionFormats": ["xyz789"]
}
GetCoursesByStudentLearningObjFuncInput
Description
All input for the getCoursesByStudentLearningObjFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pFocuses": ["xyz789"]
}
GetCoursesByStudentLearningObjFuncPayload
Description
The output of our getCoursesByStudentLearningObjFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesByStudentLearningObjFuncRecord]
|
Example
{"results": [GetCoursesByStudentLearningObjFuncRecord]}
GetCoursesByStudentLearningObjFuncRecord
Description
The return type of our getCoursesByStudentLearningObjFunc mutation.
Example
{
"totalRows": 42,
"courseId": 4,
"courseName": "abc123",
"courseDesription": "abc123",
"activePeriod": "abc123",
"periods": ["abc123"],
"sectionFormats": ["xyz789"]
}
GetCoursesByUnitFuncInput
Description
All input for the getCoursesByUnitFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pStudentLearning - Boolean
|
Boolean flag to filter activities based on whether they contribute to student learning. |
pStudentLearningObj - String
|
Specific learning objectives of the student learning activities. |
pPedagogyFilter - String
|
|
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "abc123",
"pStudentLearning": true,
"pStudentLearningObj": "abc123",
"pPedagogyFilter": "xyz789",
"pFocuses": ["xyz789"],
"pOnlyPrograms": false,
"pPrograms": "abc123",
"pFilterUnit": "abc123",
"pToken": "xyz789"
}
GetCoursesByUnitFuncPayload
Description
The output of our getCoursesByUnitFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesByUnitFuncRecord]
|
Example
{"results": [GetCoursesByUnitFuncRecord]}
GetCoursesByUnitFuncRecord
Description
The return type of our getCoursesByUnitFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
courseId - ID
|
|
courseNumber - String
|
|
courseName - String
|
|
unitId - ID
|
|
units - String
|
|
courseLevel - [String]
|
|
sectionNumber - [String]
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
learningObjectives - [String]
|
|
pedagogies - [String]
|
|
instructors - [String]
|
|
enrollment - [Int]
|
|
website - [String]
|
|
activePeriod - [String]
|
|
communityEngagementConnection - [String]
|
|
format - [String]
|
|
term - [String]
|
|
enrStudentParticipation - Int
|
|
enrStudentHours - Int
|
|
communityCnt - Int
|
|
communityNames - [String]
|
|
crossListingName - [String]
|
Example
{
"totalRows": 42,
"courseId": "4",
"courseNumber": "abc123",
"courseName": "abc123",
"unitId": "4",
"units": "abc123",
"courseLevel": ["xyz789"],
"sectionNumber": ["xyz789"],
"activityCnt": 42,
"activityName": ["abc123"],
"learningObjectives": ["abc123"],
"pedagogies": ["abc123"],
"instructors": ["abc123"],
"enrollment": [42],
"website": ["xyz789"],
"activePeriod": ["xyz789"],
"communityEngagementConnection": [
"abc123"
],
"format": ["xyz789"],
"term": ["xyz789"],
"enrStudentParticipation": 42,
"enrStudentHours": 42,
"communityCnt": 42,
"communityNames": ["xyz789"],
"crossListingName": ["xyz789"]
}
GetCoursesCountByFocusesDrilldownFuncInput
Description
All input for the getCoursesCountByFocusesDrilldownFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pFocuses": ["abc123"],
"pToken": "abc123"
}
GetCoursesCountByFocusesDrilldownFuncPayload
Description
The output of our getCoursesCountByFocusesDrilldownFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesCountByFocusesDrilldownFuncRecord]
|
Example
{"results": [GetCoursesCountByFocusesDrilldownFuncRecord]}
GetCoursesCountByFocusesDrilldownFuncRecord
GetCoursesCountByFocusesFuncInput
Description
All input for the getCoursesCountByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pFocuses": ["abc123"],
"pToken": "xyz789"
}
GetCoursesCountByFocusesFuncPayload
Description
The output of our getCoursesCountByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesCountByFocusesFuncRecord]
|
Example
{"results": [GetCoursesCountByFocusesFuncRecord]}
GetCoursesCountByFocusesFuncRecord
GetCoursesCountByProgramsFuncInput
Description
All input for the getCoursesCountByProgramsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pFocuses": ["xyz789"],
"pTargetPopulation": "xyz789",
"pToken": "abc123"
}
GetCoursesCountByProgramsFuncPayload
Description
The output of our getCoursesCountByProgramsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesCountByProgramsFuncRecord]
|
Example
{"results": [GetCoursesCountByProgramsFuncRecord]}
GetCoursesCountByProgramsFuncRecord
GetCoursesCountByTargetFuncInput
Description
All input for the getCoursesCountByTargetFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pFocuses": ["abc123"],
"pTargetPopulation": "xyz789",
"pToken": "abc123"
}
GetCoursesCountByTargetFuncPayload
Description
The output of our getCoursesCountByTargetFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesCountByTargetFuncRecord]
|
Example
{"results": [GetCoursesCountByTargetFuncRecord]}
GetCoursesCountByTargetFuncRecord
GetCoursesCountByUnitsFuncInput
Description
All input for the getCoursesCountByUnitsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFilterUnit - String
|
Filters by specific unit ID. |
pPedagogyFilter - String
|
|
pStudentLearningObj - String
|
Specific learning objectives of the student learning activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pFilterUnit": "abc123",
"pPedagogyFilter": "abc123",
"pStudentLearningObj": "abc123",
"pToken": "xyz789"
}
GetCoursesCountByUnitsFuncPayload
Description
The output of our getCoursesCountByUnitsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesCountByUnitsFuncRecord]
|
Example
{"results": [GetCoursesCountByUnitsFuncRecord]}
GetCoursesCountByUnitsFuncRecord
Description
The return type of our getCoursesCountByUnitsFunc mutation.
Example
{
"totalRows": 42,
"childId": 4,
"childName": "xyz789",
"sectionCnt": 42,
"maxDepth": 42,
"affiliated": false
}
GetCoursesFullFuncInput
Description
All input for the getCoursesFullFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pStudentLearning - Boolean
|
Boolean flag to filter activities based on whether they contribute to student learning. |
pStudentLearningObj - String
|
Specific learning objectives of the student learning activities. |
pPedagogyFilter - String
|
|
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pFilterUnit - String
|
Filters by specific unit ID. |
pTerm - String
|
|
pLevels - String
|
|
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "abc123",
"pStudentLearning": true,
"pStudentLearningObj": "abc123",
"pPedagogyFilter": "xyz789",
"pFocuses": ["abc123"],
"pOnlyPrograms": true,
"pPrograms": "abc123",
"pFilterUnit": "abc123",
"pTerm": "abc123",
"pLevels": "xyz789",
"pToken": "abc123"
}
GetCoursesFullFuncPayload
Description
The output of our getCoursesFullFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesFullFuncRecord]
|
Example
{"results": [GetCoursesFullFuncRecord]}
GetCoursesFullFuncRecord
Description
The return type of our getCoursesFullFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
courseId - ID
|
|
courseNumber - String
|
|
courseName - String
|
|
unitId - ID
|
|
units - String
|
|
courseLevel - [String]
|
|
sectionNumber - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
learningObjectives - [String]
|
|
pedagogies - [String]
|
|
instructors - [String]
|
|
enrollment - Int
|
|
website - String
|
|
activePeriod - String
|
|
communityEngagementConnection - String
|
|
format - [String]
|
|
term - [String]
|
|
enrStudentParticipation - Int
|
|
enrStudentHours - Int
|
|
communityCnt - Int
|
|
communityNames - [String]
|
|
crossListingName - [String]
|
Example
{
"totalRows": 42,
"courseId": 4,
"courseNumber": "abc123",
"courseName": "xyz789",
"unitId": "4",
"units": "xyz789",
"courseLevel": ["xyz789"],
"sectionNumber": "xyz789",
"activityCnt": 42,
"activityName": ["abc123"],
"learningObjectives": ["abc123"],
"pedagogies": ["abc123"],
"instructors": ["xyz789"],
"enrollment": 42,
"website": "xyz789",
"activePeriod": "abc123",
"communityEngagementConnection": "abc123",
"format": ["abc123"],
"term": ["abc123"],
"enrStudentParticipation": 42,
"enrStudentHours": 42,
"communityCnt": 42,
"communityNames": ["xyz789"],
"crossListingName": ["abc123"]
}
GetCoursesFuncInput
Description
All input for the getCoursesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pStudentLearning - Boolean
|
Boolean flag to filter activities based on whether they contribute to student learning. |
pStudentLearningObj - String
|
Specific learning objectives of the student learning activities. |
pPedagogy - Boolean
|
Boolean flag to include activities that incorporate specific pedagogical approaches. |
pPedagogies - String
|
Detailed description of the pedagogies involved in the activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "abc123",
"pStudentLearning": false,
"pStudentLearningObj": "abc123",
"pPedagogy": true,
"pPedagogies": "xyz789",
"pToken": "xyz789"
}
GetCoursesFuncPayload
Description
The output of our getCoursesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetCoursesFuncRecord]
|
Example
{"results": [GetCoursesFuncRecord]}
GetCoursesFuncRecord
Description
The return type of our getCoursesFunc mutation.
Example
{
"totalRows": 42,
"courseId": "4",
"courseName": "abc123",
"courseDesription": "xyz789",
"activePeriod": "xyz789",
"periods": ["abc123"],
"sectionFormats": ["xyz789"]
}
GetFacStaffCountFuncInput
Description
All input for the getFacStaffCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pIncludeStudents - Boolean
|
|
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pIncludeStudents": true,
"pToken": "abc123"
}
GetFacStaffCountFuncPayload
Description
The output of our getFacStaffCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetFacStaffCountWithIdsFuncInput
Description
All input for the getFacStaffCountWithIdsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true
}
GetFacStaffCountWithIdsFuncPayload
Description
The output of our getFacStaffCountWithIdsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFacStaffCountWithIdsFuncRecord]
|
Example
{"results": [GetFacStaffCountWithIdsFuncRecord]}
GetFacStaffCountWithIdsFuncRecord
GetFacStaffFuncInput
Description
All input for the getFacStaffFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false
}
GetFacStaffFuncPayload
Description
The output of our getFacStaffFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFacStaffFuncRecord]
|
Example
{"results": [GetFacStaffFuncRecord]}
GetFacStaffFuncRecord
GetFactultyStaffByFocusesFuncInput
Description
All input for the getFactultyStaffByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pSortBy": "xyz789",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pFocuses": ["xyz789"],
"pToken": "xyz789"
}
GetFactultyStaffByFocusesFuncPayload
Description
The output of our getFactultyStaffByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffByFocusesFuncRecord]
|
Example
{"results": [GetFactultyStaffByFocusesFuncRecord]}
GetFactultyStaffByFocusesFuncRecord
GetFactultyStaffByProgramsfuncInput
Description
All input for the getFactultyStaffByProgramsfunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pPrograms - String
|
Specific programs associated with the activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pSortBy": "xyz789",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pFocuses": ["xyz789"],
"pTargetPopulation": "xyz789",
"pPrograms": "abc123",
"pToken": "abc123"
}
GetFactultyStaffByProgramsfuncPayload
Description
The output of our getFactultyStaffByProgramsfunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffByProgramsfuncRecord]
|
Example
{"results": [GetFactultyStaffByProgramsfuncRecord]}
GetFactultyStaffByProgramsfuncRecord
Description
The return type of our getFactultyStaffByProgramsfunc mutation.
Example
{
"totalRows": 42,
"programs": "xyz789",
"firstname": "abc123",
"lastname": "xyz789",
"email": "xyz789"
}
GetFactultyStaffByTargetFuncInput
Description
All input for the getFactultyStaffByTargetFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": false,
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pFocuses": ["abc123"],
"pTargetPopulation": "abc123",
"pToken": "abc123"
}
GetFactultyStaffByTargetFuncPayload
Description
The output of our getFactultyStaffByTargetFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffByTargetFuncRecord]
|
Example
{"results": [GetFactultyStaffByTargetFuncRecord]}
GetFactultyStaffByTargetFuncRecord
Description
The return type of our getFactultyStaffByTargetFunc mutation.
Example
{
"totalRows": 42,
"population": "xyz789",
"firstname": "abc123",
"lastname": "abc123",
"email": "abc123"
}
GetFactultyStaffByUnitFuncInput
Description
All input for the getFactultyStaffByUnitFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "xyz789",
"pFilterUnit": "abc123",
"pToken": "xyz789"
}
GetFactultyStaffByUnitFuncPayload
Description
The output of our getFactultyStaffByUnitFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffByUnitFuncRecord]
|
Example
{"results": [GetFactultyStaffByUnitFuncRecord]}
GetFactultyStaffByUnitFuncRecord
Description
The return type of our getFactultyStaffByUnitFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
userId - ID
|
|
contactName - String
|
|
email - String
|
|
workPhone - String
|
|
relationships - [String]
|
|
positions - String
|
|
personalStatement - String
|
|
resumeUrl - String
|
|
scholarlyWebsiteUrl - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
communityCnt - Int
|
|
communityName - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
Example
{
"totalRows": 42,
"userId": 4,
"contactName": "abc123",
"email": "abc123",
"workPhone": "xyz789",
"relationships": ["xyz789"],
"positions": "abc123",
"personalStatement": "abc123",
"resumeUrl": "xyz789",
"scholarlyWebsiteUrl": "abc123",
"activityCnt": 42,
"activityName": ["abc123"],
"communityCnt": 42,
"communityName": ["abc123"],
"sectionCnt": 42,
"courses": ["xyz789"]
}
GetFactultyStaffCountByFocusesFuncInput
Description
All input for the getFactultyStaffCountByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pFocuses": ["abc123"],
"pToken": "abc123"
}
GetFactultyStaffCountByFocusesFuncPayload
Description
The output of our getFactultyStaffCountByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffCountByFocusesFuncRecord]
|
Example
{"results": [GetFactultyStaffCountByFocusesFuncRecord]}
GetFactultyStaffCountByFocusesFuncRecord
GetFactultyStaffCountByProgramsFuncInput
Description
All input for the getFactultyStaffCountByProgramsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pPrograms - String
|
Specific programs associated with the activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pFocuses": ["xyz789"],
"pTargetPopulation": "xyz789",
"pPrograms": "abc123",
"pToken": "abc123"
}
GetFactultyStaffCountByProgramsFuncPayload
Description
The output of our getFactultyStaffCountByProgramsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffCountByProgramsFuncRecord]
|
Example
{"results": [GetFactultyStaffCountByProgramsFuncRecord]}
GetFactultyStaffCountByProgramsFuncRecord
GetFactultyStaffCountByTargetFuncInput
Description
All input for the getFactultyStaffCountByTargetFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": false,
"pFocuses": ["abc123"],
"pTargetPopulation": "abc123",
"pToken": "xyz789"
}
GetFactultyStaffCountByTargetFuncPayload
Description
The output of our getFactultyStaffCountByTargetFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffCountByTargetFuncRecord]
|
Example
{"results": [GetFactultyStaffCountByTargetFuncRecord]}
GetFactultyStaffCountByTargetFuncRecord
GetFactultyStaffCountByUnitsFuncInput
Description
All input for the getFactultyStaffCountByUnitsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pToken": "abc123"
}
GetFactultyStaffCountByUnitsFuncPayload
Description
The output of our getFactultyStaffCountByUnitsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffCountByUnitsFuncRecord]
|
Example
{"results": [GetFactultyStaffCountByUnitsFuncRecord]}
GetFactultyStaffCountByUnitsFuncRecord
GetFactultyStaffFuncInput
Description
All input for the getFactultyStaffFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
pCoursesInstructor - Boolean
|
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": false,
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "abc123",
"pFocuses": ["abc123"],
"pToken": "xyz789",
"pCoursesInstructor": false
}
GetFactultyStaffFuncPayload
Description
The output of our getFactultyStaffFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffFuncRecord]
|
Example
{"results": [GetFactultyStaffFuncRecord]}
GetFactultyStaffFuncRecord
Description
The return type of our getFactultyStaffFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
userId - ID
|
|
contactName - String
|
|
email - String
|
|
workPhone - String
|
|
relationships - [String]
|
|
positions - String
|
|
personalStatement - String
|
|
resumeUrl - String
|
|
scholarlyWebsiteUrl - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
communityCnt - Int
|
|
communityName - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
Example
{
"totalRows": 42,
"userId": "4",
"contactName": "xyz789",
"email": "xyz789",
"workPhone": "xyz789",
"relationships": ["xyz789"],
"positions": "xyz789",
"personalStatement": "abc123",
"resumeUrl": "abc123",
"scholarlyWebsiteUrl": "abc123",
"activityCnt": 42,
"activityName": ["xyz789"],
"communityCnt": 42,
"communityName": ["xyz789"],
"sectionCnt": 42,
"courses": ["abc123"]
}
GetFactultyStaffNestedCountByUnitsFuncInput
Description
All input for the getFactultyStaffNestedCountByUnitsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pFilterUnit": "xyz789",
"pToken": "abc123"
}
GetFactultyStaffNestedCountByUnitsFuncPayload
Description
The output of our getFactultyStaffNestedCountByUnitsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFactultyStaffNestedCountByUnitsFuncRecord]
|
Example
{
"results": [
GetFactultyStaffNestedCountByUnitsFuncRecord
]
}
GetFactultyStaffNestedCountByUnitsFuncRecord
Description
The return type of our getFactultyStaffNestedCountByUnitsFunc mutation.
Example
{
"totalRows": 42,
"childId": "4",
"childName": "xyz789",
"facultyStaffCnt": 42,
"maxDepth": 42,
"affiliated": true
}
GetFacultyByFocusesDrilldownFuncInput
Description
All input for the getFacultyByFocusesDrilldownFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pAreas - [String]
|
Array of focus areas to filter by focus areas. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pFocuses": ["xyz789"],
"pAreas": ["abc123"],
"pToken": "xyz789"
}
GetFacultyByFocusesDrilldownFuncPayload
Description
The output of our getFacultyByFocusesDrilldownFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFacultyByFocusesDrilldownFuncRecord]
|
Example
{"results": [GetFacultyByFocusesDrilldownFuncRecord]}
GetFacultyByFocusesDrilldownFuncRecord
GetFacultyCountByFocusesDrilldownFuncInput
Description
All input for the getFacultyCountByFocusesDrilldownFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pFocuses": ["xyz789"],
"pToken": "abc123"
}
GetFacultyCountByFocusesDrilldownFuncPayload
Description
The output of our getFacultyCountByFocusesDrilldownFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetFacultyCountByFocusesDrilldownFuncRecord]
|
Example
{"results": [GetFacultyCountByFocusesDrilldownFuncRecord]}
GetFacultyCountByFocusesDrilldownFuncRecord
GetFacultyPartnersTotalFuncInput
Description
All input for the getFacultyPartnersTotalFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": true,
"pToken": "xyz789"
}
GetFacultyPartnersTotalFuncPayload
Description
The output of our getFacultyPartnersTotalFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetFundersActivityFuncInput
Description
All input for the getFundersActivityFunc mutation.
Fields
| Input Field | Description |
|---|---|
pActivityId - String
|
Filter activities by ID. |
Example
{"pActivityId": "xyz789"}
GetFundersActivityFuncPayload
Description
The output of our getFundersActivityFunc mutation.
Fields
| Field Name | Description |
|---|---|
communityFunders - [String]
|
Example
{"communityFunders": ["xyz789"]}
GetImpactsCommunityActTotalsFuncInput
Description
All input for the getImpactsCommunityActTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": false,
"pFocuses": ["abc123"],
"pTargetPopulation": "xyz789",
"pToken": "xyz789"
}
GetImpactsCommunityActTotalsFuncPayload
Description
The output of our getImpactsCommunityActTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetImpactsCommunityActTotalsFuncRecord]
|
Example
{"results": [GetImpactsCommunityActTotalsFuncRecord]}
GetImpactsCommunityActTotalsFuncRecord
GetInstitutionPartnersFuncInput
Description
All input for the getInstitutionPartnersFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pToken": "abc123"
}
GetInstitutionPartnersFuncPayload
Description
The output of our getInstitutionPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetInstitutionPartnersFuncRecord]
|
Example
{"results": [GetInstitutionPartnersFuncRecord]}
GetInstitutionPartnersFuncRecord
Description
The return type of our getInstitutionPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
id - ID
|
|
name - String
|
|
street - String
|
|
street2 - String
|
|
zipcode - String
|
|
city - String
|
|
state - String
|
|
county - String
|
|
country - String
|
|
latitude - Float
|
|
longitude - Float
|
|
type - String
|
|
description - String
|
|
url - String
|
|
phone - String
|
|
email - String
|
|
archived - Boolean
|
|
status - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
contactNames - [String]
|
|
contactEmails - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
|
unitCnt - Int
|
|
unitNames - [String]
|
|
externalId - String
|
Example
{
"totalRows": 42,
"id": "4",
"name": "xyz789",
"street": "abc123",
"street2": "abc123",
"zipcode": "xyz789",
"city": "abc123",
"state": "xyz789",
"county": "xyz789",
"country": "xyz789",
"latitude": 123.45,
"longitude": 123.45,
"type": "xyz789",
"description": "abc123",
"url": "xyz789",
"phone": "abc123",
"email": "abc123",
"archived": true,
"status": "abc123",
"activityCnt": 42,
"activityName": ["abc123"],
"contactNames": ["abc123"],
"contactEmails": ["abc123"],
"sectionCnt": 42,
"courses": ["abc123"],
"unitCnt": 42,
"unitNames": ["xyz789"],
"externalId": "xyz789"
}
GetInstitutionalFuncInput
Description
All input for the getInstitutionalFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "abc123",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pFilterUnit": "xyz789",
"pToken": "xyz789"
}
GetInstitutionalFuncPayload
Description
The output of our getInstitutionalFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetInstitutionalFuncRecord]
|
Example
{"results": [GetInstitutionalFuncRecord]}
GetInstitutionalFuncRecord
Description
The return type of our getInstitutionalFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
id - ID
|
|
name - String
|
|
type - String
|
|
parentId - ID
|
|
description - String
|
|
contactName - String
|
|
contactEmail - String
|
|
contactPhone - String
|
|
url - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
|
communityCnt - Int
|
|
communityNames - [String]
|
|
reportsTo - String
|
|
prefixes - [String]
|
|
coursePrefixDescription - [String]
|
Example
{
"totalRows": 42,
"id": "4",
"name": "xyz789",
"type": "xyz789",
"parentId": 4,
"description": "abc123",
"contactName": "xyz789",
"contactEmail": "xyz789",
"contactPhone": "xyz789",
"url": "xyz789",
"activityCnt": 42,
"activityName": ["xyz789"],
"sectionCnt": 42,
"courses": ["abc123"],
"communityCnt": 42,
"communityNames": ["xyz789"],
"reportsTo": "abc123",
"prefixes": ["abc123"],
"coursePrefixDescription": ["abc123"]
}
GetInstitutionalOutcomesActTotalsFuncInput
Description
All input for the getInstitutionalOutcomesActTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pFocuses": ["abc123"],
"pTargetPopulation": "xyz789",
"pToken": "xyz789"
}
GetInstitutionalOutcomesActTotalsFuncPayload
Description
The output of our getInstitutionalOutcomesActTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetInstitutionalOutcomesActTotalsFuncRecord]
|
Example
{"results": [GetInstitutionalOutcomesActTotalsFuncRecord]}
GetInstitutionalOutcomesActTotalsFuncRecord
GetInstitutionalPartnersCountFuncInput
Description
All input for the getInstitutionalPartnersCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pToken": "abc123"
}
GetInstitutionalPartnersCountFuncPayload
Description
The output of our getInstitutionalPartnersCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetInstitutionalPartnersFuncInput
Description
All input for the getInstitutionalPartnersFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pToken": "abc123"
}
GetInstitutionalPartnersFuncPayload
Description
The output of our getInstitutionalPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetInstitutionalPartnersFuncRecord]
|
Example
{"results": [GetInstitutionalPartnersFuncRecord]}
GetInstitutionalPartnersFuncRecord
Description
The return type of our getInstitutionalPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - String
|
|
type - String
|
|
authorId - String
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
slug - String
|
|
vanity - String
|
|
name - String
|
|
description - String
|
|
latitude - Float
|
|
longitude - Float
|
|
logoId - ID
|
|
logoUrl - String
|
|
url - String
|
|
externalId - String
|
|
portal - Boolean
|
|
welcomeMessage - String
|
|
officeName - String
|
|
allowOffline - Boolean
|
|
missionStatement - String
|
|
email - String
|
|
phone - String
|
|
fax - String
|
|
disableEmailNotifications - Boolean
|
|
registrarUrl - String
|
|
courseCatalogUrl - String
|
|
street - String
|
|
street2 - String
|
|
city - String
|
|
state - String
|
|
county - String
|
|
zipcode - String
|
|
zipcodeAddon - Int
|
|
country - String
|
|
modifiedBy - String
|
|
status - String
|
|
parentId - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": "abc123",
"type": "xyz789",
"authorId": "abc123",
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": false,
"deleted": true,
"slug": "abc123",
"vanity": "xyz789",
"name": "abc123",
"description": "xyz789",
"latitude": 987.65,
"longitude": 987.65,
"logoId": 4,
"logoUrl": "abc123",
"url": "xyz789",
"externalId": "xyz789",
"portal": true,
"welcomeMessage": "xyz789",
"officeName": "xyz789",
"allowOffline": true,
"missionStatement": "xyz789",
"email": "xyz789",
"phone": "abc123",
"fax": "abc123",
"disableEmailNotifications": true,
"registrarUrl": "abc123",
"courseCatalogUrl": "xyz789",
"street": "xyz789",
"street2": "abc123",
"city": "abc123",
"state": "xyz789",
"county": "xyz789",
"zipcode": "xyz789",
"zipcodeAddon": 42,
"country": "xyz789",
"modifiedBy": "xyz789",
"status": "abc123",
"parentId": "xyz789"
}
GetInstructorsCountFuncInput
Description
All input for the getInstructorsCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pFocuses": ["xyz789"],
"pToken": "abc123"
}
GetInstructorsCountFuncPayload
Description
The output of our getInstructorsCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetInstructorsFuncInput
Description
All input for the getInstructorsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "abc123",
"pFocuses": ["abc123"],
"pToken": "xyz789"
}
GetInstructorsFuncPayload
Description
The output of our getInstructorsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetInstructorsFuncRecord]
|
Example
{"results": [GetInstructorsFuncRecord]}
GetInstructorsFuncRecord
Description
The return type of our getInstructorsFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
userId - ID
|
|
contactName - String
|
|
email - String
|
|
workPhone - String
|
|
relationships - [String]
|
|
positions - String
|
|
personalStatement - String
|
|
resumeUrl - String
|
|
scholarlyWebsiteUrl - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
communityCnt - Int
|
|
communityName - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
Example
{
"totalRows": 42,
"userId": 4,
"contactName": "abc123",
"email": "xyz789",
"workPhone": "abc123",
"relationships": ["abc123"],
"positions": "xyz789",
"personalStatement": "abc123",
"resumeUrl": "xyz789",
"scholarlyWebsiteUrl": "xyz789",
"activityCnt": 42,
"activityName": ["xyz789"],
"communityCnt": 42,
"communityName": ["abc123"],
"sectionCnt": 42,
"courses": ["xyz789"]
}
GetLocationTypeInput
Description
All input for the getLocationType mutation.
Fields
| Input Field | Description |
|---|---|
pActivityId - String
|
Filter activities by ID. |
Example
{"pActivityId": "xyz789"}
GetLocationTypePayload
Description
The output of our getLocationType mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetLocationTypeRecord]
|
Example
{"results": [GetLocationTypeRecord]}
GetLocationTypeRecord
GetNestedUnitActivitiesFuncInput
Description
All input for the getNestedUnitActivitiesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pFilterUnit": "xyz789",
"pToken": "xyz789"
}
GetNestedUnitActivitiesFuncPayload
Description
The output of our getNestedUnitActivitiesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetNestedUnitActivitiesFuncRecord]
|
Example
{"results": [GetNestedUnitActivitiesFuncRecord]}
GetNestedUnitActivitiesFuncRecord
Description
The return type of our getNestedUnitActivitiesFunc mutation.
Example
{
"totalRows": 42,
"childId": 4,
"childName": "abc123",
"activityCnt": 42,
"parentName": "xyz789",
"maxDepth": 42,
"affiliated": true
}
GetOrganizationRoleTotalsFuncInput
Description
All input for the getOrganizationRoleTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": true,
"pToken": "xyz789"
}
GetOrganizationRoleTotalsFuncPayload
Description
The output of our getOrganizationRoleTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetOrganizationRoleTotalsFuncRecord]
|
Example
{"results": [GetOrganizationRoleTotalsFuncRecord]}
GetOrganizationRoleTotalsFuncRecord
GetOutputsTotalFuncInput
Description
All input for the getOutputsTotalFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pToken": "xyz789"
}
GetOutputsTotalFuncPayload
Description
The output of our getOutputsTotalFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetOutputsTotalFuncRecord]
|
Example
{"results": [GetOutputsTotalFuncRecord]}
GetOutputsTotalFuncRecord
GetPedagogiesActivitiesTotalsFuncInput
Description
All input for the getPedagogiesActivitiesTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetPedagogiesActivitiesTotalsFuncPayload
Description
The output of our getPedagogiesActivitiesTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetPedagogiesActivitiesTotalsFuncRecord]
|
Example
{"results": [GetPedagogiesActivitiesTotalsFuncRecord]}
GetPedagogiesActivitiesTotalsFuncRecord
GetPedagogiesCoursesTotalsFuncInput
Description
All input for the getPedagogiesCoursesTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": false,
"pToken": "xyz789"
}
GetPedagogiesCoursesTotalsFuncPayload
Description
The output of our getPedagogiesCoursesTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetPedagogiesCoursesTotalsFuncRecord]
|
Example
{"results": [GetPedagogiesCoursesTotalsFuncRecord]}
GetPedagogiesCoursesTotalsFuncRecord
GetProfilesFuncInput
Description
All input for the getProfilesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
pUserId - String
|
Id of user to filter by |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pIsProjectAssociated - Boolean
|
Boolean flag. Set to True to return only user profiles associated with activities, False to return only users not associated with activities, and Null to disable the filter. |
Example
{
"pPortalId": "xyz789",
"pToken": "xyz789",
"pUserId": "abc123",
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pIsProjectAssociated": false
}
GetProfilesFuncPayload
Description
The output of our getProfilesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProfilesFuncRecord]
|
Example
{"results": [GetProfilesFuncRecord]}
GetProfilesFuncRecord
Description
The return type of our getProfilesFunc mutation.
Example
{
"userId": "4",
"firstname": "abc123",
"lastname": "xyz789",
"email": "abc123",
"edupersonPrincipalName": "xyz789",
"portalid": 4,
"profileurl": "xyz789",
"isProjectAssociated": false
}
GetProgramInitiativesByFocusesFuncInput
Description
All input for the getProgramInitiativesByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": false,
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pFocuses": ["xyz789"],
"pToken": "abc123"
}
GetProgramInitiativesByFocusesFuncPayload
Description
The output of our getProgramInitiativesByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramInitiativesByFocusesFuncRecord]
|
Example
{"results": [GetProgramInitiativesByFocusesFuncRecord]}
GetProgramInitiativesByFocusesFuncRecord
Description
The return type of our getProgramInitiativesByFocusesFunc mutation.
Example
{
"totalRows": 42,
"focuses": "xyz789",
"programId": 4,
"programName": "abc123",
"programDescription": "xyz789"
}
GetProgramInitiativesByTargetFuncInput
Description
All input for the getProgramInitiativesByTargetFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "xyz789",
"pOnlyPrograms": false,
"pPrograms": "abc123",
"pToken": "abc123"
}
GetProgramInitiativesByTargetFuncPayload
Description
The output of our getProgramInitiativesByTargetFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramInitiativesByTargetFuncRecord]
|
Example
{"results": [GetProgramInitiativesByTargetFuncRecord]}
GetProgramInitiativesByTargetFuncRecord
Description
The return type of our getProgramInitiativesByTargetFunc mutation.
Example
{
"totalRows": 42,
"population": "abc123",
"programId": 4,
"programName": "abc123",
"programDescription": "xyz789"
}
GetProgramInitiativesFuncInput
Description
All input for the getProgramInitiativesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pSortBy": "xyz789",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pOnlyPrograms": false,
"pPrograms": "xyz789",
"pFilterUnit": "xyz789",
"pToken": "xyz789"
}
GetProgramInitiativesFuncPayload
Description
The output of our getProgramInitiativesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramInitiativesFuncRecord]
|
Example
{"results": [GetProgramInitiativesFuncRecord]}
GetProgramInitiativesFuncRecord
Description
The return type of our getProgramInitiativesFunc mutation.
Example
{
"totalRows": 42,
"unitId": 4,
"unitName": "xyz789",
"programId": "4",
"programName": "xyz789",
"programDescription": "xyz789"
}
GetProgramsCountByFocusesDrilldownFuncInput
Description
All input for the getProgramsCountByFocusesDrilldownFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": true,
"pFocuses": ["xyz789"],
"pToken": "xyz789"
}
GetProgramsCountByFocusesDrilldownFuncPayload
Description
The output of our getProgramsCountByFocusesDrilldownFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramsCountByFocusesDrilldownFuncRecord]
|
Example
{
"results": [
GetProgramsCountByFocusesDrilldownFuncRecord
]
}
GetProgramsCountByFocusesDrilldownFuncRecord
GetProgramsCountByFocusesFuncInput
Description
All input for the getProgramsCountByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": true,
"pFocuses": ["xyz789"]
}
GetProgramsCountByFocusesFuncPayload
Description
The output of our getProgramsCountByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramsCountByFocusesFuncRecord]
|
Example
{"results": [GetProgramsCountByFocusesFuncRecord]}
GetProgramsCountByFocusesFuncRecord
GetProgramsCountByProgramsFuncInput
Description
All input for the getProgramsCountByProgramsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pTargetPopulation": "xyz789",
"pToken": "abc123"
}
GetProgramsCountByProgramsFuncPayload
Description
The output of our getProgramsCountByProgramsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramsCountByProgramsFuncRecord]
|
Example
{"results": [GetProgramsCountByProgramsFuncRecord]}
GetProgramsCountByProgramsFuncRecord
GetProgramsCountByTargetFuncInput
Description
All input for the getProgramsCountByTargetFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pTargetPopulation": "abc123",
"pToken": "xyz789"
}
GetProgramsCountByTargetFuncPayload
Description
The output of our getProgramsCountByTargetFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramsCountByTargetFuncRecord]
|
Example
{"results": [GetProgramsCountByTargetFuncRecord]}
GetProgramsCountByTargetFuncRecord
GetProgramsCountByUnitsFuncInput
Description
All input for the getProgramsCountByUnitsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pFilterUnit": "xyz789",
"pToken": "abc123"
}
GetProgramsCountByUnitsFuncPayload
Description
The output of our getProgramsCountByUnitsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramsCountByUnitsFuncRecord]
|
Example
{"results": [GetProgramsCountByUnitsFuncRecord]}
GetProgramsCountByUnitsFuncRecord
Description
The return type of our getProgramsCountByUnitsFunc mutation.
Example
{
"totalRows": 42,
"childId": 4,
"childName": "abc123",
"programCnt": 42,
"maxDepth": 42,
"affiliated": true
}
GetProgramsInitiativesTotalsFuncInput
Description
All input for the getProgramsInitiativesTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetProgramsInitiativesTotalsFuncPayload
Description
The output of our getProgramsInitiativesTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetProgramsInitiativesTotalsFuncRecord]
|
Example
{"results": [GetProgramsInitiativesTotalsFuncRecord]}
GetProgramsInitiativesTotalsFuncRecord
GetScholarshipTotalsFuncInput
Description
All input for the getScholarshipTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetScholarshipTotalsFuncPayload
Description
The output of our getScholarshipTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetScholarshipTotalsFuncRecord]
|
Example
{"results": [GetScholarshipTotalsFuncRecord]}
GetScholarshipTotalsFuncRecord
GetScholaryProductsTotalFuncInput
Description
All input for the getScholaryProductsTotalFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetScholaryProductsTotalFuncPayload
Description
The output of our getScholaryProductsTotalFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetScholaryProductsTotalFuncRecord]
|
Example
{"results": [GetScholaryProductsTotalFuncRecord]}
GetScholaryProductsTotalFuncRecord
GetSectionTermsTotalsFuncInput
Description
All input for the getSectionTermsTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": false,
"pFilterUnit": "abc123",
"pToken": "xyz789"
}
GetSectionTermsTotalsFuncPayload
Description
The output of our getSectionTermsTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetSectionTermsTotalsFuncRecord]
|
Example
{"results": [GetSectionTermsTotalsFuncRecord]}
GetSectionTermsTotalsFuncRecord
GetSectionTotalsFuncInput
Description
All input for the getSectionTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pFilterUnit": "abc123",
"pToken": "xyz789"
}
GetSectionTotalsFuncPayload
Description
The output of our getSectionTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetSectionTotalsFuncRecord]
|
Example
{"results": [GetSectionTotalsFuncRecord]}
GetSectionTotalsFuncRecord
GetStudentHoursPerTermCountFuncInput
Description
All input for the getStudentHoursPerTermCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pToken": "abc123"
}
GetStudentHoursPerTermCountFuncPayload
Description
The output of our getStudentHoursPerTermCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetStudentHoursPerTermCountFuncRecord]
|
Example
{"results": [GetStudentHoursPerTermCountFuncRecord]}
GetStudentHoursPerTermCountFuncRecord
GetStudentInvolmentTotalsFuncInput
Description
All input for the getStudentInvolmentTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pToken": "abc123"
}
GetStudentInvolmentTotalsFuncPayload
Description
The output of our getStudentInvolmentTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetStudentInvolmentTotalsFuncRecord]
|
Example
{"results": [GetStudentInvolmentTotalsFuncRecord]}
GetStudentInvolmentTotalsFuncRecord
GetStudentLearningObjectivesActivitiesFuncInput
Description
All input for the getStudentLearningObjectivesActivitiesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetStudentLearningObjectivesActivitiesFuncPayload
Description
The output of our getStudentLearningObjectivesActivitiesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetStudentLearningObjectivesActivitiesFuncRecord]
|
Example
{
"results": [
GetStudentLearningObjectivesActivitiesFuncRecord
]
}
GetStudentLearningObjectivesActivitiesFuncRecord
GetStudentLearningObjectivesActivitiesTotalsFuncInput
Description
All input for the getStudentLearningObjectivesActivitiesTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pToken": "abc123"
}
GetStudentLearningObjectivesActivitiesTotalsFuncPayload
Description
The output of our getStudentLearningObjectivesActivitiesTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetStudentLearningObjectivesActivitiesTotalsFuncRecord]
|
Example
{
"results": [
GetStudentLearningObjectivesActivitiesTotalsFuncRecord
]
}
GetStudentLearningObjectivesActivitiesTotalsFuncRecord
GetStudentLearningObjectivesCoursesTotalsFuncInput
Description
All input for the getStudentLearningObjectivesCoursesTotalsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": false,
"pToken": "xyz789"
}
GetStudentLearningObjectivesCoursesTotalsFuncPayload
Description
The output of our getStudentLearningObjectivesCoursesTotalsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetStudentLearningObjectivesCoursesTotalsFuncRecord]
|
Example
{
"results": [
GetStudentLearningObjectivesCoursesTotalsFuncRecord
]
}
GetStudentLearningObjectivesCoursesTotalsFuncRecord
GetTopUnitPartnersFuncInput
Description
All input for the getTopUnitPartnersFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetTopUnitPartnersFuncPayload
Description
The output of our getTopUnitPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetTopUnitPartnersFuncRecord]
|
Example
{"results": [GetTopUnitPartnersFuncRecord]}
GetTopUnitPartnersFuncRecord
GetUnitCountByFocusesDrilldownFuncInput
Description
All input for the getUnitCountByFocusesDrilldownFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pFocuses": ["abc123"],
"pToken": "xyz789"
}
GetUnitCountByFocusesDrilldownFuncPayload
Description
The output of our getUnitCountByFocusesDrilldownFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitCountByFocusesDrilldownFuncRecord]
|
Example
{"results": [GetUnitCountByFocusesDrilldownFuncRecord]}
GetUnitCountByFocusesDrilldownFuncRecord
GetUnitDatasetFuncInput
Description
All input for the getUnitDatasetFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "abc123",
"pConnectedCourse": false,
"pSortBy": "xyz789",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pTargetPopulation": "xyz789",
"pOnlyPrograms": false,
"pPrograms": "xyz789",
"pToken": "abc123"
}
GetUnitDatasetFuncPayload
Description
The output of our getUnitDatasetFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitDatasetFuncRecord]
|
Example
{"results": [GetUnitDatasetFuncRecord]}
GetUnitDatasetFuncRecord
Description
The return type of our getUnitDatasetFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
id - ID
|
|
name - String
|
|
type - String
|
|
parentId - ID
|
|
description - String
|
|
contactName - String
|
|
contactEmail - String
|
|
contactPhone - String
|
|
url - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
|
communityCnt - Int
|
|
communityNames - [String]
|
|
reportsTo - String
|
|
prefixes - [String]
|
|
coursePrefixDescription - [String]
|
Example
{
"totalRows": 42,
"id": "4",
"name": "abc123",
"type": "xyz789",
"parentId": "4",
"description": "abc123",
"contactName": "xyz789",
"contactEmail": "abc123",
"contactPhone": "xyz789",
"url": "xyz789",
"activityCnt": 42,
"activityName": ["abc123"],
"sectionCnt": 42,
"courses": ["abc123"],
"communityCnt": 42,
"communityNames": ["abc123"],
"reportsTo": "abc123",
"prefixes": ["abc123"],
"coursePrefixDescription": ["xyz789"]
}
GetUnitPartnerCountFuncInput
Description
All input for the getUnitPartnerCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pToken": "xyz789"
}
GetUnitPartnerCountFuncPayload
Description
The output of our getUnitPartnerCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetUnitPartnersCountFuncInput
Description
All input for the getUnitPartnersCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": false,
"pToken": "abc123"
}
GetUnitPartnersCountFuncPayload
Description
The output of our getUnitPartnersCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
integer - Int
|
Example
{"integer": 42}
GetUnitPartnersFuncInput
Description
All input for the getUnitPartnersFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetUnitPartnersFuncPayload
Description
The output of our getUnitPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitPartnersFuncRecord]
|
Example
{"results": [GetUnitPartnersFuncRecord]}
GetUnitPartnersFuncRecord
Description
The return type of our getUnitPartnersFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - String
|
|
authorId - String
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
type - String
|
|
name - String
|
|
description - String
|
|
logoUrl - String
|
|
url - String
|
|
externalId - String
|
|
bypassProfileModeration - Boolean
|
|
parentId - String
|
|
portalId - String
|
|
contactFirstname - String
|
|
contactLastname - String
|
|
contactPhone - String
|
|
contactEmail - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": "abc123",
"authorId": "abc123",
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": false,
"deleted": true,
"type": "abc123",
"name": "xyz789",
"description": "xyz789",
"logoUrl": "xyz789",
"url": "xyz789",
"externalId": "abc123",
"bypassProfileModeration": false,
"parentId": "abc123",
"portalId": "abc123",
"contactFirstname": "xyz789",
"contactLastname": "xyz789",
"contactPhone": "abc123",
"contactEmail": "abc123"
}
GetUnitsByFocusesCountFuncInput
Description
All input for the getUnitsByFocusesCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pFocuses": ["xyz789"],
"pToken": "xyz789"
}
GetUnitsByFocusesCountFuncPayload
Description
The output of our getUnitsByFocusesCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitsByFocusesCountFuncRecord]
|
Example
{"results": [GetUnitsByFocusesCountFuncRecord]}
GetUnitsByFocusesCountFuncRecord
GetUnitsByFocusesFuncInput
Description
All input for the getUnitsByFocusesFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pFocuses": ["abc123"],
"pToken": "xyz789"
}
GetUnitsByFocusesFuncPayload
Description
The output of our getUnitsByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitsByFocusesFuncRecord]
|
Example
{"results": [GetUnitsByFocusesFuncRecord]}
GetUnitsByFocusesFuncRecord
Description
The return type of our getUnitsByFocusesFunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
id - ID
|
|
name - String
|
|
type - String
|
|
parentId - ID
|
|
description - String
|
|
contactName - String
|
|
contactEmail - String
|
|
contactPhone - String
|
|
url - String
|
|
activityCnt - Int
|
|
activityName - [String]
|
|
sectionCnt - Int
|
|
courses - [String]
|
|
communityCnt - Int
|
|
communityNames - [String]
|
|
reportsTo - String
|
|
prefixes - [String]
|
|
coursePrefixDescription - [String]
|
Example
{
"totalRows": 42,
"id": 4,
"name": "xyz789",
"type": "xyz789",
"parentId": 4,
"description": "abc123",
"contactName": "abc123",
"contactEmail": "abc123",
"contactPhone": "abc123",
"url": "abc123",
"activityCnt": 42,
"activityName": ["xyz789"],
"sectionCnt": 42,
"courses": ["abc123"],
"communityCnt": 42,
"communityNames": ["abc123"],
"reportsTo": "xyz789",
"prefixes": ["xyz789"],
"coursePrefixDescription": ["xyz789"]
}
GetUnitsByProgramsCountFuncInput
Description
All input for the getUnitsByProgramsCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": false,
"pTargetPopulation": "xyz789",
"pToken": "xyz789"
}
GetUnitsByProgramsCountFuncPayload
Description
The output of our getUnitsByProgramsCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitsByProgramsCountFuncRecord]
|
Example
{"results": [GetUnitsByProgramsCountFuncRecord]}
GetUnitsByProgramsCountFuncRecord
GetUnitsByTargetCountFuncInput
Description
All input for the getUnitsByTargetCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pTargetPopulation": "abc123",
"pToken": "abc123"
}
GetUnitsByTargetCountFuncPayload
Description
The output of our getUnitsByTargetCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitsByTargetCountFuncRecord]
|
Example
{"results": [GetUnitsByTargetCountFuncRecord]}
GetUnitsByTargetCountFuncRecord
GetUnitsFuncInput
Description
All input for the getUnitsFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pConnectedCourse": true,
"pToken": "abc123"
}
GetUnitsFuncPayload
Description
The output of our getUnitsFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitsFuncRecord]
|
Example
{"results": [GetUnitsFuncRecord]}
GetUnitsFuncRecord
GetUnitsRelatedToUnitCountFuncInput
Description
All input for the getUnitsRelatedToUnitCountFunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFilterUnit - String
|
Filters by specific unit ID. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["xyz789"],
"pUnitId": ["abc123"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": false,
"pFilterUnit": "xyz789",
"pToken": "xyz789"
}
GetUnitsRelatedToUnitCountFuncPayload
Description
The output of our getUnitsRelatedToUnitCountFunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetUnitsRelatedToUnitCountFuncRecord]
|
Example
{"results": [GetUnitsRelatedToUnitCountFuncRecord]}
GetUnitsRelatedToUnitCountFuncRecord
Description
The return type of our getUnitsRelatedToUnitCountFunc mutation.
Example
{
"totalRows": 42,
"childId": 4,
"childName": "xyz789",
"unitCnt": 42,
"maxDepth": 42,
"affiliated": false
}
GetactivityfacstaffidsfuncInput
Description
All input for the getactivityfacstaffidsfunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": false,
"pType": "xyz789",
"pConnectedCourse": true
}
GetactivityfacstaffidsfuncPayload
Description
The output of our getactivityfacstaffidsfunc mutation.
Fields
| Field Name | Description |
|---|---|
activityIds - [String]
|
Example
{"activityIds": ["abc123"]}
GetactivityfundersActivitiesfuncInput
Description
All input for the getactivityfundersActivitiesfunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pFunderId - String
|
|
pIncludeFunders - Boolean
|
Boolean flag to include funders associated with the activities. |
pIncludeCommunities - Boolean
|
Boolean flag to include community associations related to the activities. |
pIncludeUnits - Boolean
|
Boolean flag to include information about organizational units involved in the activities. |
pIncludePrograms - Boolean
|
Boolean flag to include detailed program information for each activity. |
pIncludeFaculties - Boolean
|
Boolean flag to include faculty information associated with the activities. |
pIncludeAddress - Boolean
|
Boolean flag to determine if addresses should be included in the returned activities. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pFounderSource - String
|
|
pIncludeInstitutions - Boolean
|
Boolean flag to include institution data for activities. |
pIncludeCourses - Boolean
|
|
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pFunderId": "xyz789",
"pIncludeFunders": true,
"pIncludeCommunities": false,
"pIncludeUnits": false,
"pIncludePrograms": false,
"pIncludeFaculties": true,
"pIncludeAddress": true,
"pConnectedCourse": false,
"pFounderSource": "abc123",
"pIncludeInstitutions": true,
"pIncludeCourses": true,
"pToken": "abc123"
}
GetactivityfundersActivitiesfuncPayload
Description
The output of our getactivityfundersActivitiesfunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetactivityfundersActivitiesfuncRecord]
|
Example
{"results": [GetactivityfundersActivitiesfuncRecord]}
GetactivityfundersActivitiesfuncRecord
Description
The return type of our getactivityfundersActivitiesfunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - ID
|
|
authorId - ID
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
slug - String
|
|
name - String
|
|
description - String
|
|
startTime - AWSDateTime
|
|
endTime - AWSDateTime
|
|
latitude - Float
|
|
longitude - Float
|
|
logoId - ID
|
|
logoUrl - String
|
|
url - String
|
|
productId - Int
|
|
externalId - String
|
|
mutualBenefit - Boolean
|
|
reciprocity - Boolean
|
|
scholarship - Boolean
|
|
teaching - Boolean
|
|
scholarlyResearch - Boolean
|
|
studentParticipation - Boolean
|
|
studentMembers - Int
|
|
studentMembersActual - Boolean
|
|
studentHours - Int
|
|
facultyParticipation - Boolean
|
|
facultyMembers - Int
|
|
reflections - Boolean
|
|
reflectionDescription - String
|
|
frequency - Int
|
|
contactPhonePublic - Boolean
|
|
contactEmailPublic - Boolean
|
|
irbProtocol - Boolean
|
|
irbProtocolId - String
|
|
individualsServed - Int
|
|
communityInsight - String
|
|
goalsFeedback - String
|
|
focuses - [String]
|
|
focusAreas - AWSJSON
|
|
populations - [String]
|
|
organizingFramework - [String]
|
|
eventsServices - [String]
|
|
scholarshipTypes - [String]
|
|
expectedScholarlyOutputs - [String]
|
|
achievedScholarlyOutputs - [String]
|
|
expectedPsOutputs - [String]
|
|
achievedPsOutputs - [String]
|
|
expectedOutcomes - [String]
|
|
achievedOutcomes - [String]
|
|
expectedImpacts - [String]
|
|
achievedImpacts - [String]
|
|
researchTypes - [String]
|
|
externalPartners - Boolean
|
|
studentHoursActual - Boolean
|
|
modifiedBy - ID
|
|
status - String
|
|
contactFirstname - String
|
|
contactLastname - String
|
|
contactEmail - String
|
|
contactOffice - String
|
|
contactPhone - String
|
|
contactPrivateEmail - Boolean
|
|
contactPrivateName - Boolean
|
|
primaryActivity - String
|
|
type - String
|
|
featured - AWSDateTime
|
|
contactPrivatePhone - Boolean
|
|
portalId - ID
|
|
activityLead - ID
|
|
activityLeadStatus - String
|
|
virtualupdated - Boolean
|
|
unitsupdated - Boolean
|
|
virtualLocation - Boolean
|
|
physicalLocation - Boolean
|
|
distance - Float
|
|
address - String
|
|
funders - String
|
|
communities - String
|
|
units - String
|
|
programs - String
|
|
faculties - String
|
|
institutions - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": 4,
"authorId": 4,
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": false,
"deleted": true,
"slug": "xyz789",
"name": "xyz789",
"description": "abc123",
"startTime": AWSDateTime,
"endTime": AWSDateTime,
"latitude": 987.65,
"longitude": 987.65,
"logoId": 4,
"logoUrl": "xyz789",
"url": "xyz789",
"productId": 42,
"externalId": "abc123",
"mutualBenefit": false,
"reciprocity": true,
"scholarship": true,
"teaching": true,
"scholarlyResearch": false,
"studentParticipation": true,
"studentMembers": 42,
"studentMembersActual": true,
"studentHours": 42,
"facultyParticipation": true,
"facultyMembers": 42,
"reflections": true,
"reflectionDescription": "abc123",
"frequency": 42,
"contactPhonePublic": false,
"contactEmailPublic": false,
"irbProtocol": true,
"irbProtocolId": "abc123",
"individualsServed": 42,
"communityInsight": "abc123",
"goalsFeedback": "xyz789",
"focuses": ["abc123"],
"focusAreas": AWSJSON,
"populations": ["xyz789"],
"organizingFramework": ["xyz789"],
"eventsServices": ["abc123"],
"scholarshipTypes": ["abc123"],
"expectedScholarlyOutputs": ["abc123"],
"achievedScholarlyOutputs": ["abc123"],
"expectedPsOutputs": ["xyz789"],
"achievedPsOutputs": ["xyz789"],
"expectedOutcomes": ["abc123"],
"achievedOutcomes": ["abc123"],
"expectedImpacts": ["abc123"],
"achievedImpacts": ["xyz789"],
"researchTypes": ["xyz789"],
"externalPartners": false,
"studentHoursActual": true,
"modifiedBy": "4",
"status": "abc123",
"contactFirstname": "abc123",
"contactLastname": "xyz789",
"contactEmail": "abc123",
"contactOffice": "abc123",
"contactPhone": "abc123",
"contactPrivateEmail": true,
"contactPrivateName": true,
"primaryActivity": "abc123",
"type": "abc123",
"featured": AWSDateTime,
"contactPrivatePhone": false,
"portalId": "4",
"activityLead": 4,
"activityLeadStatus": "xyz789",
"virtualupdated": true,
"unitsupdated": false,
"virtualLocation": false,
"physicalLocation": true,
"distance": 123.45,
"address": "abc123",
"funders": "xyz789",
"communities": "abc123",
"units": "abc123",
"programs": "abc123",
"faculties": "xyz789",
"institutions": "xyz789"
}
GetactivityidsfuncInput
Description
All input for the getactivityidsfunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pTopUnits - [String]
|
Array of top unit identifiers to filter records. |
pFocuses - [String]
|
Array of focus areas to filter activities based on specific interests or fields. |
pTargetPopulation - String
|
Filter activities based on the target population they serve. |
pScholarshipConnection - String
|
String to filter activities that have a connection to scholarships. |
pScholarlyExpected - [String]
|
Array of expected scholarly outcomes from the activities. |
pScholarlyAchieved - [String]
|
Array of achieved scholarly outcomes from the activities, to compare against expectations. |
pStudentLearning - Boolean
|
Boolean flag to filter activities based on whether they contribute to student learning. |
pStudentLearningObj - String
|
Specific learning objectives of the student learning activities. |
pPedagogy - Boolean
|
Boolean flag to include activities that incorporate specific pedagogical approaches. |
pPedagogies - String
|
Detailed description of the pedagogies involved in the activities. |
pOnlyExpectedOutcomes - Boolean
|
Boolean flag to filter activities that only include expected outcomes. |
pOnlyAchievedOutcomes - Boolean
|
Boolean flag to filter activities that only include achieved outcomes. |
pExpectedOutcomes - String
|
Detailed description of expected outcomes from the activities. |
pAchievedOutcomes - String
|
Detailed description of outcomes that have been achieved by the activities. |
pOnlyExpectedImpactComm - Boolean
|
Boolean flag to filter activities that only have expected community impacts documented. |
pOnlyAchievedImpactComm - Boolean
|
Boolean flag to filter activities that only have achieved community impacts. |
pExpectedImpactComm - String
|
Expected impacts of the activities on the community. |
pAchievedImpactComm - String
|
Achieved impacts of the activities on the community. |
pAchievedPsOutputs - String
|
Description of outputs from post-secondary activities that have been achieved. |
pExpectedPsOutputs - String
|
Description of expected outputs from post-secondary activities. |
pOnlyExpectedOutputs - Boolean
|
Boolean flag to filter activities based on only expected outputs being documented. |
pOnlyAchievedOutputs - Boolean
|
Boolean flag to filter activities based on only achieved outputs. |
pCommunityIndividualServed - Boolean
|
Boolean flag to include activities that serve individuals in the community. |
pOnlyStudentInvolment - Boolean
|
Boolean flag to filter activities based on only student involvement. |
pStudentInvolment - String
|
Details of student involvement in the activities. |
pOnlyFactStaff - Boolean
|
Boolean flag to filter activities based on only faculty and staff involvement. |
pFilterByOther - Boolean
|
Boolean flag to apply additional filters specified by other criteria. |
pCollectsData - Boolean
|
Boolean flag to filter activities based on whether they collect data. |
pOnlyPrograms - Boolean
|
Boolean flag to filter activities that are only programs. |
pPrograms - String
|
Specific programs associated with the activities. |
pNonEnrParticipation - Boolean
|
Boolean flag to include activities that involve non-enrolled participants. |
pNonEnrStudentHours - Boolean
|
Flag to include data on hours spent by non-enrolled students in activities. |
pEnrStudentParticipation - Boolean
|
Boolean flag to filter activities based on enrolled student participation. |
pEnrStudentHours - Boolean
|
Details on the number of hours enrolled students spend in activities. |
pStudentParticipation - Boolean
|
Boolean flag to include activities based on student participation. |
pStudentHours - Boolean
|
Total hours students spend participating in activities. |
Example
{
"pPortalId": "abc123",
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 987.65,
"pDistance": 123.45,
"pVirtualLocation": true,
"pType": "xyz789",
"pConnectedCourse": true,
"pTopUnits": ["abc123"],
"pFocuses": ["xyz789"],
"pTargetPopulation": "abc123",
"pScholarshipConnection": "xyz789",
"pScholarlyExpected": ["xyz789"],
"pScholarlyAchieved": ["xyz789"],
"pStudentLearning": true,
"pStudentLearningObj": "xyz789",
"pPedagogy": false,
"pPedagogies": "abc123",
"pOnlyExpectedOutcomes": true,
"pOnlyAchievedOutcomes": false,
"pExpectedOutcomes": "abc123",
"pAchievedOutcomes": "xyz789",
"pOnlyExpectedImpactComm": true,
"pOnlyAchievedImpactComm": true,
"pExpectedImpactComm": "xyz789",
"pAchievedImpactComm": "xyz789",
"pAchievedPsOutputs": "abc123",
"pExpectedPsOutputs": "abc123",
"pOnlyExpectedOutputs": true,
"pOnlyAchievedOutputs": true,
"pCommunityIndividualServed": false,
"pOnlyStudentInvolment": false,
"pStudentInvolment": "xyz789",
"pOnlyFactStaff": true,
"pFilterByOther": true,
"pCollectsData": true,
"pOnlyPrograms": false,
"pPrograms": "xyz789",
"pNonEnrParticipation": false,
"pNonEnrStudentHours": false,
"pEnrStudentParticipation": false,
"pEnrStudentHours": false,
"pStudentParticipation": false,
"pStudentHours": false
}
GetactivityidsfuncPayload
Description
The output of our getactivityidsfunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetactivityidsfuncRecord]
|
Example
{"results": [GetactivityidsfuncRecord]}
GetactivityidsfuncRecord
GetactivitylocationidsfuncInput
Description
All input for the getactivitylocationidsfunc mutation.
Example
{
"pPortalId": "xyz789",
"pVirtualLocation": true
}
GetactivitylocationidsfuncPayload
Description
The output of our getactivitylocationidsfunc mutation.
Fields
| Field Name | Description |
|---|---|
actLocationIds - [String]
|
Example
{"actLocationIds": ["xyz789"]}
GetactivitytopunitidsfuncInput
Description
All input for the getactivitytopunitidsfunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pTopUnits - [String]
|
Array of top unit identifiers to filter records. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pTopUnits": ["abc123"],
"pToken": "xyz789"
}
GetactivitytopunitidsfuncPayload
Description
The output of our getactivitytopunitidsfunc mutation.
Fields
| Field Name | Description |
|---|---|
activityIds - [String]
|
Example
{"activityIds": ["abc123"]}
GetactivityunitidsfuncInput
Description
All input for the getactivityunitidsfunc mutation.
Example
{
"pPortalId": "xyz789",
"pUnitId": ["abc123"]
}
GetactivityunitidsfuncPayload
Description
The output of our getactivityunitidsfunc mutation.
Fields
| Field Name | Description |
|---|---|
activityIds - [String]
|
Example
{"activityIds": ["xyz789"]}
GetactivityunitsfuncInput
Description
All input for the getactivityunitsfunc mutation.
Fields
| Input Field | Description |
|---|---|
pActivityId - String
|
Filter activities by ID. |
Example
{"pActivityId": "xyz789"}
GetactivityunitsfuncPayload
Description
The output of our getactivityunitsfunc mutation.
Fields
| Field Name | Description |
|---|---|
units - [String]
|
Example
{"units": ["abc123"]}
GetcommunitypartnersActivitiesfuncInput
Description
All input for the getcommunitypartnersActivitiesfunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pCommunityId - String
|
|
pIncludeFunders - Boolean
|
Boolean flag to include funders associated with the activities. |
pIncludeCommunities - Boolean
|
Boolean flag to include community associations related to the activities. |
pIncludeUnits - Boolean
|
Boolean flag to include information about organizational units involved in the activities. |
pIncludePrograms - Boolean
|
Boolean flag to include detailed program information for each activity. |
pIncludeFaculties - Boolean
|
Boolean flag to include faculty information associated with the activities. |
pIncludeAddress - Boolean
|
Boolean flag to determine if addresses should be included in the returned activities. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pIncludeInstitutions - Boolean
|
Boolean flag to include institution data for activities. |
pIncludeCourses - Boolean
|
|
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "abc123",
"pCommunityId": "abc123",
"pIncludeFunders": true,
"pIncludeCommunities": false,
"pIncludeUnits": true,
"pIncludePrograms": false,
"pIncludeFaculties": true,
"pIncludeAddress": false,
"pConnectedCourse": false,
"pIncludeInstitutions": true,
"pIncludeCourses": false,
"pToken": "abc123"
}
GetcommunitypartnersActivitiesfuncPayload
Description
The output of our getcommunitypartnersActivitiesfunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetcommunitypartnersActivitiesfuncRecord]
|
Example
{"results": [GetcommunitypartnersActivitiesfuncRecord]}
GetcommunitypartnersActivitiesfuncRecord
Description
The return type of our getcommunitypartnersActivitiesfunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - ID
|
|
authorId - ID
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
slug - String
|
|
name - String
|
|
description - String
|
|
startTime - AWSDateTime
|
|
endTime - AWSDateTime
|
|
latitude - Float
|
|
longitude - Float
|
|
logoId - ID
|
|
logoUrl - String
|
|
url - String
|
|
productId - Int
|
|
externalId - String
|
|
mutualBenefit - Boolean
|
|
reciprocity - Boolean
|
|
scholarship - Boolean
|
|
teaching - Boolean
|
|
scholarlyResearch - Boolean
|
|
studentParticipation - Boolean
|
|
studentMembers - Int
|
|
studentMembersActual - Boolean
|
|
studentHours - Int
|
|
facultyParticipation - Boolean
|
|
facultyMembers - Int
|
|
reflections - Boolean
|
|
reflectionDescription - String
|
|
frequency - Int
|
|
contactPhonePublic - Boolean
|
|
contactEmailPublic - Boolean
|
|
irbProtocol - Boolean
|
|
irbProtocolId - String
|
|
individualsServed - Int
|
|
communityInsight - String
|
|
goalsFeedback - String
|
|
focuses - [String]
|
|
focusAreas - AWSJSON
|
|
populations - [String]
|
|
organizingFramework - [String]
|
|
eventsServices - [String]
|
|
scholarshipTypes - [String]
|
|
expectedScholarlyOutputs - [String]
|
|
achievedScholarlyOutputs - [String]
|
|
expectedPsOutputs - [String]
|
|
achievedPsOutputs - [String]
|
|
expectedOutcomes - [String]
|
|
achievedOutcomes - [String]
|
|
expectedImpacts - [String]
|
|
achievedImpacts - [String]
|
|
researchTypes - [String]
|
|
externalPartners - Boolean
|
|
studentHoursActual - Boolean
|
|
modifiedBy - ID
|
|
status - String
|
|
contactFirstname - String
|
|
contactLastname - String
|
|
contactEmail - String
|
|
contactOffice - String
|
|
contactPhone - String
|
|
contactPrivateEmail - Boolean
|
|
contactPrivateName - Boolean
|
|
primaryActivity - String
|
|
type - String
|
|
featured - AWSDateTime
|
|
contactPrivatePhone - Boolean
|
|
portalId - ID
|
|
activityLead - ID
|
|
activityLeadStatus - String
|
|
distance - Float
|
|
funders - String
|
|
communities - String
|
|
units - String
|
|
programs - String
|
|
faculties - String
|
|
address - String
|
|
institutions - String
|
|
coursesSection - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": "4",
"authorId": "4",
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": true,
"deleted": false,
"slug": "abc123",
"name": "xyz789",
"description": "xyz789",
"startTime": AWSDateTime,
"endTime": AWSDateTime,
"latitude": 123.45,
"longitude": 123.45,
"logoId": 4,
"logoUrl": "abc123",
"url": "abc123",
"productId": 42,
"externalId": "abc123",
"mutualBenefit": false,
"reciprocity": true,
"scholarship": false,
"teaching": false,
"scholarlyResearch": false,
"studentParticipation": false,
"studentMembers": 42,
"studentMembersActual": true,
"studentHours": 42,
"facultyParticipation": false,
"facultyMembers": 42,
"reflections": false,
"reflectionDescription": "abc123",
"frequency": 42,
"contactPhonePublic": false,
"contactEmailPublic": false,
"irbProtocol": true,
"irbProtocolId": "abc123",
"individualsServed": 42,
"communityInsight": "xyz789",
"goalsFeedback": "abc123",
"focuses": ["abc123"],
"focusAreas": AWSJSON,
"populations": ["abc123"],
"organizingFramework": ["abc123"],
"eventsServices": ["xyz789"],
"scholarshipTypes": ["abc123"],
"expectedScholarlyOutputs": ["xyz789"],
"achievedScholarlyOutputs": ["abc123"],
"expectedPsOutputs": ["xyz789"],
"achievedPsOutputs": ["xyz789"],
"expectedOutcomes": ["abc123"],
"achievedOutcomes": ["abc123"],
"expectedImpacts": ["abc123"],
"achievedImpacts": ["abc123"],
"researchTypes": ["xyz789"],
"externalPartners": true,
"studentHoursActual": true,
"modifiedBy": "4",
"status": "xyz789",
"contactFirstname": "xyz789",
"contactLastname": "xyz789",
"contactEmail": "abc123",
"contactOffice": "xyz789",
"contactPhone": "xyz789",
"contactPrivateEmail": true,
"contactPrivateName": true,
"primaryActivity": "abc123",
"type": "xyz789",
"featured": AWSDateTime,
"contactPrivatePhone": true,
"portalId": 4,
"activityLead": "4",
"activityLeadStatus": "abc123",
"distance": 987.65,
"funders": "abc123",
"communities": "abc123",
"units": "abc123",
"programs": "abc123",
"faculties": "xyz789",
"address": "xyz789",
"institutions": "abc123",
"coursesSection": "xyz789"
}
GetfacstaffActivitiesfuncInput
Description
All input for the getfacstaffActivitiesfunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pUserId - String
|
Id of user to filter by |
pIncludeFunders - Boolean
|
Boolean flag to include funders associated with the activities. |
pIncludeCommunities - Boolean
|
Boolean flag to include community associations related to the activities. |
pIncludeUnits - Boolean
|
Boolean flag to include information about organizational units involved in the activities. |
pIncludePrograms - Boolean
|
Boolean flag to include detailed program information for each activity. |
pIncludeFaculties - Boolean
|
Boolean flag to include faculty information associated with the activities. |
pIncludeAddress - Boolean
|
Boolean flag to determine if addresses should be included in the returned activities. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pIncludeInstitutions - Boolean
|
Boolean flag to include institution data for activities. |
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "xyz789",
"pSortDir": "xyz789",
"pLimit": 42,
"pOffset": 42,
"pStatus": "xyz789",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["abc123"],
"pLongitude": 123.45,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": true,
"pType": "xyz789",
"pUserId": "abc123",
"pIncludeFunders": true,
"pIncludeCommunities": true,
"pIncludeUnits": true,
"pIncludePrograms": false,
"pIncludeFaculties": true,
"pIncludeAddress": false,
"pConnectedCourse": false,
"pIncludeInstitutions": true,
"pToken": "abc123"
}
GetfacstaffActivitiesfuncPayload
Description
The output of our getfacstaffActivitiesfunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetfacstaffActivitiesfuncRecord]
|
Example
{"results": [GetfacstaffActivitiesfuncRecord]}
GetfacstaffActivitiesfuncRecord
Description
The return type of our getfacstaffActivitiesfunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - ID
|
|
authorId - ID
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
slug - String
|
|
name - String
|
|
description - String
|
|
startTime - AWSDateTime
|
|
endTime - AWSDateTime
|
|
latitude - Float
|
|
longitude - Float
|
|
logoId - ID
|
|
logoUrl - String
|
|
url - String
|
|
productId - Int
|
|
externalId - String
|
|
mutualBenefit - Boolean
|
|
reciprocity - Boolean
|
|
scholarship - Boolean
|
|
teaching - Boolean
|
|
scholarlyResearch - Boolean
|
|
studentParticipation - Boolean
|
|
studentMembers - Int
|
|
studentMembersActual - Boolean
|
|
studentHours - Int
|
|
facultyParticipation - Boolean
|
|
facultyMembers - Int
|
|
reflections - Boolean
|
|
reflectionDescription - String
|
|
frequency - Int
|
|
contactPhonePublic - Boolean
|
|
contactEmailPublic - Boolean
|
|
irbProtocol - Boolean
|
|
irbProtocolId - String
|
|
individualsServed - Int
|
|
communityInsight - String
|
|
goalsFeedback - String
|
|
focuses - [String]
|
|
focusAreas - AWSJSON
|
|
populations - [String]
|
|
organizingFramework - [String]
|
|
eventsServices - [String]
|
|
scholarshipTypes - [String]
|
|
expectedScholarlyOutputs - [String]
|
|
achievedScholarlyOutputs - [String]
|
|
expectedPsOutputs - [String]
|
|
achievedPsOutputs - [String]
|
|
expectedOutcomes - [String]
|
|
achievedOutcomes - [String]
|
|
expectedImpacts - [String]
|
|
achievedImpacts - [String]
|
|
researchTypes - [String]
|
|
externalPartners - Boolean
|
|
studentHoursActual - Boolean
|
|
modifiedBy - ID
|
|
status - String
|
|
contactFirstname - String
|
|
contactLastname - String
|
|
contactEmail - String
|
|
contactOffice - String
|
|
contactPhone - String
|
|
contactPrivateEmail - Boolean
|
|
contactPrivateName - Boolean
|
|
primaryActivity - String
|
|
type - String
|
|
featured - AWSDateTime
|
|
contactPrivatePhone - Boolean
|
|
portalId - ID
|
|
activityLead - ID
|
|
activityLeadStatus - String
|
|
distance - Float
|
|
funders - String
|
|
communities - String
|
|
units - String
|
|
programs - String
|
|
faculties - String
|
|
address - String
|
|
institutions - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": "4",
"authorId": 4,
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": false,
"deleted": true,
"slug": "xyz789",
"name": "abc123",
"description": "abc123",
"startTime": AWSDateTime,
"endTime": AWSDateTime,
"latitude": 987.65,
"longitude": 123.45,
"logoId": 4,
"logoUrl": "abc123",
"url": "xyz789",
"productId": 42,
"externalId": "xyz789",
"mutualBenefit": false,
"reciprocity": true,
"scholarship": false,
"teaching": true,
"scholarlyResearch": true,
"studentParticipation": true,
"studentMembers": 42,
"studentMembersActual": false,
"studentHours": 42,
"facultyParticipation": false,
"facultyMembers": 42,
"reflections": true,
"reflectionDescription": "xyz789",
"frequency": 42,
"contactPhonePublic": true,
"contactEmailPublic": false,
"irbProtocol": true,
"irbProtocolId": "xyz789",
"individualsServed": 42,
"communityInsight": "abc123",
"goalsFeedback": "abc123",
"focuses": ["xyz789"],
"focusAreas": AWSJSON,
"populations": ["xyz789"],
"organizingFramework": ["abc123"],
"eventsServices": ["xyz789"],
"scholarshipTypes": ["abc123"],
"expectedScholarlyOutputs": ["xyz789"],
"achievedScholarlyOutputs": ["abc123"],
"expectedPsOutputs": ["xyz789"],
"achievedPsOutputs": ["abc123"],
"expectedOutcomes": ["xyz789"],
"achievedOutcomes": ["abc123"],
"expectedImpacts": ["abc123"],
"achievedImpacts": ["abc123"],
"researchTypes": ["xyz789"],
"externalPartners": false,
"studentHoursActual": true,
"modifiedBy": "4",
"status": "xyz789",
"contactFirstname": "xyz789",
"contactLastname": "xyz789",
"contactEmail": "abc123",
"contactOffice": "xyz789",
"contactPhone": "xyz789",
"contactPrivateEmail": false,
"contactPrivateName": false,
"primaryActivity": "xyz789",
"type": "abc123",
"featured": AWSDateTime,
"contactPrivatePhone": false,
"portalId": 4,
"activityLead": "4",
"activityLeadStatus": "abc123",
"distance": 123.45,
"funders": "abc123",
"communities": "xyz789",
"units": "abc123",
"programs": "abc123",
"faculties": "xyz789",
"address": "abc123",
"institutions": "xyz789"
}
GetinstitutionalpartnersActivitiesfuncInput
Description
All input for the getinstitutionalpartnersActivitiesfunc mutation.
Fields
| Input Field | Description |
|---|---|
pPortalId - String
|
Unique identifier for the portal to filter activities specific to a portal. |
pSortBy - String
|
Specifies the field by which results should be sorted. |
pSortDir - String
|
Direction of sorting results, either 'asc' for ascending or 'desc' for descending. |
pLimit - Int
|
Limits the number of results returned in the response. Useful for pagination. |
pOffset - Int
|
The number of items to skip before starting to collect the result set. Useful for pagination. |
pStatus - String
|
Filter activities by their current status, such as 'active', 'completed', etc. |
pStartTime - AWSDateTime
|
The start time for filtering activities that begin on or after a specific date and time. |
pEndTime - AWSDateTime
|
The end time for filtering activities that end on or before a specific date and time. |
pFocusAreas - AWSJSON
|
JSON object specifying the focus areas associated with activities, allowing for complex queries. |
pProgramId - [String]
|
Array of program identifiers to filter activities that are associated with specific programs. |
pUnitId - [String]
|
Array of unit identifiers to filter activities associated with specific units. |
pLongitude - Float
|
Longitude coordinate for location-based queries, used in conjunction with latitude and distance. |
pLatitude - Float
|
Latitude coordinate for location-based queries, used in conjunction with longitude and distance. |
pDistance - Float
|
The radius in meters for proximity searches from the specified latitude and longitude. |
pVirtualLocation - Boolean
|
Boolean flag to include or exclude activities that are held at virtual locations. |
pType - String
|
Filter activities by type, such as 'workshop', 'seminar', etc. |
pInstitutionId - String
|
|
pIncludeFunders - Boolean
|
Boolean flag to include funders associated with the activities. |
pIncludeCommunities - Boolean
|
Boolean flag to include community associations related to the activities. |
pIncludeUnits - Boolean
|
Boolean flag to include information about organizational units involved in the activities. |
pIncludePrograms - Boolean
|
Boolean flag to include detailed program information for each activity. |
pIncludeFaculties - Boolean
|
Boolean flag to include faculty information associated with the activities. |
pIncludeAddress - Boolean
|
Boolean flag to determine if addresses should be included in the returned activities. |
pConnectedCourse - Boolean
|
Boolean flag to filter activities that are connected to a course. |
pIncludeInstitutions - Boolean
|
Boolean flag to include institution data for activities. |
pIncludeCourses - Boolean
|
|
pToken - String
|
Secondary authentication token. API will return null on all requests on an invalid token. |
Example
{
"pPortalId": "xyz789",
"pSortBy": "abc123",
"pSortDir": "abc123",
"pLimit": 42,
"pOffset": 42,
"pStatus": "abc123",
"pStartTime": AWSDateTime,
"pEndTime": AWSDateTime,
"pFocusAreas": AWSJSON,
"pProgramId": ["abc123"],
"pUnitId": ["xyz789"],
"pLongitude": 987.65,
"pLatitude": 123.45,
"pDistance": 987.65,
"pVirtualLocation": false,
"pType": "xyz789",
"pInstitutionId": "abc123",
"pIncludeFunders": true,
"pIncludeCommunities": true,
"pIncludeUnits": false,
"pIncludePrograms": true,
"pIncludeFaculties": true,
"pIncludeAddress": true,
"pConnectedCourse": true,
"pIncludeInstitutions": false,
"pIncludeCourses": true,
"pToken": "xyz789"
}
GetinstitutionalpartnersActivitiesfuncPayload
Description
The output of our getinstitutionalpartnersActivitiesfunc mutation.
Fields
| Field Name | Description |
|---|---|
results - [GetinstitutionalpartnersActivitiesfuncRecord]
|
Example
{
"results": [
GetinstitutionalpartnersActivitiesfuncRecord
]
}
GetinstitutionalpartnersActivitiesfuncRecord
Description
The return type of our getinstitutionalpartnersActivitiesfunc mutation.
Fields
| Field Name | Description |
|---|---|
totalRows - Int
|
|
insertTimestamp - AWSDateTime
|
|
id - ID
|
|
authorId - ID
|
|
created - AWSDateTime
|
|
modified - AWSDateTime
|
|
archived - Boolean
|
|
deleted - Boolean
|
|
slug - String
|
|
name - String
|
|
description - String
|
|
startTime - AWSDateTime
|
|
endTime - AWSDateTime
|
|
latitude - Float
|
|
longitude - Float
|
|
logoId - ID
|
|
logoUrl - String
|
|
url - String
|
|
productId - Int
|
|
externalId - String
|
|
mutualBenefit - Boolean
|
|
reciprocity - Boolean
|
|
scholarship - Boolean
|
|
teaching - Boolean
|
|
scholarlyResearch - Boolean
|
|
studentParticipation - Boolean
|
|
studentMembers - Int
|
|
studentMembersActual - Boolean
|
|
studentHours - Int
|
|
facultyParticipation - Boolean
|
|
facultyMembers - Int
|
|
reflections - Boolean
|
|
reflectionDescription - String
|
|
frequency - Int
|
|
contactPhonePublic - Boolean
|
|
contactEmailPublic - Boolean
|
|
irbProtocol - Boolean
|
|
irbProtocolId - String
|
|
individualsServed - Int
|
|
communityInsight - String
|
|
goalsFeedback - String
|
|
focuses - [String]
|
|
focusAreas - AWSJSON
|
|
populations - [String]
|
|
organizingFramework - [String]
|
|
eventsServices - [String]
|
|
scholarshipTypes - [String]
|
|
expectedScholarlyOutputs - [String]
|
|
achievedScholarlyOutputs - [String]
|
|
expectedPsOutputs - [String]
|
|
achievedPsOutputs - [String]
|
|
expectedOutcomes - [String]
|
|
achievedOutcomes - [String]
|
|
expectedImpacts - [String]
|
|
achievedImpacts - [String]
|
|
researchTypes - [String]
|
|
externalPartners - Boolean
|
|
studentHoursActual - Boolean
|
|
modifiedBy - ID
|
|
status - String
|
|
contactFirstname - String
|
|
contactLastname - String
|
|
contactEmail - String
|
|
contactOffice - String
|
|
contactPhone - String
|
|
contactPrivateEmail - Boolean
|
|
contactPrivateName - Boolean
|
|
primaryActivity - String
|
|
type - String
|
|
featured - AWSDateTime
|
|
contactPrivatePhone - Boolean
|
|
portalId - ID
|
|
activityLead - ID
|
|
activityLeadStatus - String
|
|
distance - Float
|
|
funders - String
|
|
communities - String
|
|
units - String
|
|
programs - String
|
|
faculties - String
|
|
address - String
|
|
institutions - String
|
|
coursesSection - String
|
Example
{
"totalRows": 42,
"insertTimestamp": AWSDateTime,
"id": 4,
"authorId": 4,
"created": AWSDateTime,
"modified": AWSDateTime,
"archived": true,
"deleted": false,
"slug": "xyz789",
"name": "abc123",
"description": "abc123",
"startTime": AWSDateTime,
"endTime": AWSDateTime,
"latitude": 987.65,
"longitude": 987.65,
"logoId": "4",
"logoUrl": "xyz789",
"url": "abc123",
"productId": 42,
"externalId": "xyz789",
"mutualBenefit": false,
"reciprocity": true,
"scholarship": false,
"teaching": false,
"scholarlyResearch": false,
"studentParticipation": true,
"studentMembers": 42,
"studentMembersActual": true,
"studentHours": 42,
"facultyParticipation": false,
"facultyMembers": 42,
"reflections": false,
"reflectionDescription": "abc123",
"frequency": 42,
"contactPhonePublic": false,
"contactEmailPublic": true,
"irbProtocol": true,
"irbProtocolId": "xyz789",
"individualsServed": 42,
"communityInsight": "xyz789",
"goalsFeedback": "xyz789",
"focuses": ["abc123"],
"focusAreas": AWSJSON,
"populations": ["abc123"],
"organizingFramework": ["abc123"],
"eventsServices": ["abc123"],
"scholarshipTypes": ["abc123"],
"expectedScholarlyOutputs": ["abc123"],
"achievedScholarlyOutputs": ["abc123"],
"expectedPsOutputs": ["xyz789"],
"achievedPsOutputs": ["abc123"],
"expectedOutcomes": ["abc123"],
"achievedOutcomes": ["abc123"],
"expectedImpacts": ["abc123"],
"achievedImpacts": ["abc123"],
"researchTypes": ["xyz789"],
"externalPartners": false,
"studentHoursActual": true,
"modifiedBy": 4,
"status": "xyz789",
"contactFirstname": "xyz789",
"contactLastname": "abc123",
"contactEmail": "abc123",
"contactOffice": "xyz789",
"contactPhone": "xyz789",
"contactPrivateEmail": false,
"contactPrivateName": true,
"primaryActivity": "xyz789",
"type": "abc123",
"featured": AWSDateTime,
"contactPrivatePhone": true,
"portalId": 4,
"activityLead": 4,
"activityLeadStatus": "xyz789",
"distance": 123.45,
"funders": "abc123",
"communities": "xyz789",
"units": "abc123",
"programs": "xyz789",
"faculties": "abc123",
"address": "abc123",
"institutions": "xyz789",
"coursesSection": "xyz789"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
42
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"