DeveloperPOST at this target:
https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE
EntityEntidade representante os Alunos, Funcionários e Administradores
Entity
| Params | Description |
|---|---|
| id | The ID of an object |
| dbId | Identifies the primary key from the database. |
| fullname | Entity fullname |
| type | The type of entity is an ENUM: STUDENT, STAFF, ADMIN |
| eid | External ID to identify an entity |
| externalData | External data |
| description | Role person has in organization |
| invisible | Invisible for student entity |
| seeAll | Can see all groups |
| unreachable | Pending messages are not read |
| disabled | Disabled for communication |
| scope | Permission scope for staff |
| ntfStartTime | time that the entity starts to receive notifications |
| ntfEndTime | time that the entity starts to receive notifications |
| ntfWeekDays | week days that the entity receives notifications |
| ntfWeekDaysArray | days of the week to receive notification |
| isChannel | Is communication channel |
| status | Status number |
| statusText | Status text |
| replyTime | Time between message sent to this entity and their first reply, in minutes |
| noRepliesMessageCount | Number of messages not replied |
| organizationId | Which organization does it belong to |
| shortname | First and last name |
| code | Good random code |
| live | Date invitations were sent |
| hasViewer | If this entity belongs to the current viewer |
| configuration | |
| organization | Organization the entity belongs to |
| confChargeList | Use user.concierges instead |
| picture | Entity picture |
| contracts | Entity contracts |
| defaulter | If this entity has overdue charges from an invoice |
| concierges | Concierges related to this entity |
| message | Get individual message for entity |
| commitment | Get individual commitment for entity |
| payment | Get individual payment for entity |
| replyTimeStats | Average time it takes for entity to reply to messages |
| replyStats | |
| conversationStats | |
| messageStats | |
| users | Entity has many users |
| tags | Tags associated with the entity and the current user |
| organizationTags | Tags from the entity's organization |
| messageStatus | Message status |
| addresses | One or multiple addresses can associate in this mutation |
| roles | Which groups the entity is part of |
| groups | All groups that entity is able to interact with |
| groupRecipients | Recipients inside group |
| staffRecipients | staff recipients |
| notifications | Notifications of entity |
| messages | Get messages of the Entity |
| moments | Get moments of the Entity |
| messageDrafts | Message drafts that belongs to entity |
| messageDraftLogs | Message draft logs that belongs to entity |
| medias | All medias that belongs to entity |
| surveys | surveys from entity |
| commitments | commitments from entity |
| charges | charges from entity |
| recipients | Recipients of entity |
| reports | Reports available for entity |
| forms | Forms available for entity |
| payments | entity payments |
| invoices | invoices created for entity |
| overdueInvoicesStats | Overdue invoices stats of entity |
| dailyMessagesMetrics | Metrics related to messages from the entity (empty if entity is not a channel) |
| externalChannels | External Channels of the entity |
| arrivals | Entity arrivals |
| created | An ISO-8601 encoded UTC date string of when record was created |
| modified | An ISO-8601 encoded UTC date string of when record was updated |
| deleted | An ISO-8601 encoded UTC date string of when record was deleted |
| key | Random ID to differentiate from others |
| selected | Helper field for clients |
| highlighted | Helper field for clients |
| expanded | Helper field for clients |
| loaded | Helper field for clients |
| loading | Helper field for clients |
CreateEntityInput
| Arguments | Type | Description |
|---|---|---|
| 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
| Arguments | Type | Description |
|---|---|---|
| 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
| Arguments | Type | Description |
|---|---|---|
| id | Not Null | The ID of an entity object |
| clientMutationId | String SCALAR |
ImportEntityInput
| Arguments | Type | Description |
|---|---|---|
| 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 |