Entity
Entidade representante os Alunos, Funcionários e Administradores




POST at this target:

https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE


Entity

ParamsDescription
idThe ID of an object
dbIdIdentifies the primary key from the database.
fullnameEntity fullname
typeThe type of entity is an ENUM: STUDENT, STAFF, ADMIN
eidExternal ID to identify an entity
externalDataExternal data
descriptionRole person has in organization
invisibleInvisible for student entity
seeAllCan see all groups
unreachablePending messages are not read
disabledDisabled for communication
scopePermission scope for staff
ntfStartTimetime that the entity starts to receive notifications
ntfEndTimetime that the entity starts to receive notifications
ntfWeekDaysweek days that the entity receives notifications
ntfWeekDaysArraydays of the week to receive notification
isChannelIs communication channel
statusStatus number
statusTextStatus text
replyTimeTime between message sent to this entity and their first reply, in minutes
noRepliesMessageCountNumber of messages not replied
organizationIdWhich organization does it belong to
shortnameFirst and last name
codeGood random code
liveDate invitations were sent
hasViewerIf this entity belongs to the current viewer
configurationConfiguration related to the user-entity relationship
organizationOrganization the entity belongs to
pictureEntity picture
contractsEntity contracts
defaulterIf this entity has overdue charges from an invoice
conciergesConcierges related to this entity
messageGet individual message for entity
commitmentGet individual commitment for entity
paymentGet individual payment for entity
replyTimeStatsAverage time it takes for entity to reply to messages
replyStats
conversationStats
messageStats
usersEntity has many users
tagsTags associated with the entity and the current user
organizationTagsTags from the entity's organization
messageStatusMessage status
addressesOne or multiple addresses can associate in this mutation
rolesWhich groups the entity is part of
groupsAll groups that entity is able to interact with
groupRecipientsRecipients inside group
staffRecipientsstaff recipients
notificationsNotifications of entity
messagesGet messages of the Entity
momentsGet moments of the Entity
messageDraftsMessage drafts that belongs to entity
messageDraftLogsMessage draft logs that belongs to entity
mediasAll medias that belongs to entity
surveyssurveys from entity
commitmentscommitments from entity
chargescharges from entity
recipientsRecipients of entity
reportsReports available for entity
formsForms available for entity
paymentsentity payments
invoicesinvoices created for entity
overdueInvoicesStatsOverdue invoices stats of entity
dailyMessagesMetricsMetrics related to messages from the entity (empty if entity is not a channel)
externalChannelsExternal Channels of the entity
arrivalsEntity arrivals
createdAn ISO-8601 encoded UTC date string of when record was created
modifiedAn ISO-8601 encoded UTC date string of when record was updated
deletedAn ISO-8601 encoded UTC date string of when record was deleted
keyRandom ID to differentiate from others
selectedHelper field for clients
highlightedHelper field for clients
expandedHelper field for clients
loadedHelper field for clients
loadingHelper field for clients

CreateEntityInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that entity is
fullname
Not Null
Entity fullname
type
Not Null
The type of entity is an ENUM: STUDENT, STAFF, ADMIN
eid
String
SCALAR
External ID to identify an entity
externalData
JSONObject
SCALAR
External data to access External Access
description
String
SCALAR
Role person has in organization
invisible
Boolean
SCALAR
Invisible for student entity
seeAll
Boolean
SCALAR
See all for staff entity
unreachable
Boolean
SCALAR
Pending messages are not read
disabled
Boolean
SCALAR
Disabled for communication
scope
LIST
EntityScope
Permission scope for staff
ntfStartTime
String
SCALAR
time that the entity starts to receive notifications
ntfEndTime
String
SCALAR
time that the entity starts to receive notifications
ntfWeekDays
Int
SCALAR
week days that the entity receives notifications
ntfWeekDaysArray
LIST
String
days of the week to receive notification
addresses
LIST
EntityAddressesInput
groups
LIST
EntityGroupsInput
invite
InviteEnum
ENUM
Send invitations
attach
LIST
String
Attach related rather than replace
updateIfExists
Boolean
SCALAR
If fullname or eid exists update Entity
defaultFeatures
LIST
EntityDefaultFeatures
Features that should have default items
clientMutationId
String
SCALAR

UpdateEntityInput

ArgumentsTypeDescription
id
Not Null
The ID of an entity object
fullname
String
SCALAR
Entity fullname
type
EntityType
ENUM
The type of entity is an ENUM: STUDENT, STAFF, ADMIN
eid
String
SCALAR
External ID to identify an entity
externalData
JSONObject
SCALAR
External data to access External Access
description
String
SCALAR
Role person has in organization
invisible
Boolean
SCALAR
Invisible for student entity
seeAll
Boolean
SCALAR
See all for staff entity
unreachable
Boolean
SCALAR
Pending messages are not read
disabled
Boolean
SCALAR
Disabled for communication
scope
LIST
EntityScope
Permission scope for staff
ntfStartTime
String
SCALAR
time that the entity starts to receive notifications
ntfEndTime
String
SCALAR
time that the entity starts to receive notifications
ntfWeekDays
Int
SCALAR
week days that the entity receives notifications
ntfWeekDaysArray
LIST
String
days of the week to receive notification
addresses
LIST
EntityAddressesInput
groups
LIST
EntityGroupsInput
invite
InviteEnum
ENUM
Send invitations
attach
LIST
String
Attach related rather than replace
updateIfExists
Boolean
SCALAR
If fullname or eid exists update Entity
clientMutationId
String
SCALAR

DeleteEntityInput

ArgumentsTypeDescription
id
Not Null
The ID of an entity object
clientMutationId
String
SCALAR

ImportEntityInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that entity is
id
ID
SCALAR
The ID of an entity object
fullname
String
SCALAR
Entity fullname
type
EntityType
ENUM
The type of entity is an ENUM: STUDENT, STAFF, ADMIN
eid
String
SCALAR
External ID to identify an entity
externalData
JSONObject
SCALAR
External data to access External Access
description
String
SCALAR
Role person has in organization
invisible
Boolean
SCALAR
Invisible for student entity
seeAll
Boolean
SCALAR
See all for staff entity
unreachable
Boolean
SCALAR
Pending messages are not read
disabled
Boolean
SCALAR
Disabled for communication
scope
LIST
EntityScope
Permission scope for staff
ntfStartTime
String
SCALAR
time that the entity starts to receive notifications
ntfEndTime
String
SCALAR
time that the entity starts to receive notifications
ntfWeekDays
Int
SCALAR
week days that the entity receives notifications
ntfWeekDaysArray
LIST
String
days of the week to receive notification
addresses
LIST
EntityAddressesInput
groups
LIST
EntityGroupsInput
invite
InviteEnum
ENUM
Send invitations
attach
LIST
String
Attach related rather than replace
defaultFeatures
LIST
EntityDefaultFeatures
Features that should have default items
clientMutationId
String
SCALAR