ClassroomServiceImpl

This group contains the following resources:

/classrooms

URI: /api/v1/classrooms

GET

Get the classrooms which the user that is using the application is enrolled in. The user must have given the application the grant READ to use these operation.

Response Body

element: classroomList
ClassroomList object with the list of classrooms the user is enrolled in. Represents a list of classrooms
Properties
Property Type Description
classrooms array of (classroom) Classroom list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <classroomList> <classrooms> <id>308961</id> <title>Proves TE aula 3</title> <color>#308961</color> <fatherId>308958</fatherId> <assignments>'CREADOR', 'RESPONSABLE'</assignments> <assignments>...</assignments> <!--...more "assignments" elements...--> <code>121_05_073_01</code> <shortTitle>TMS</shortTitle> </classrooms> <classrooms> <!--...--> </classrooms> <!--...more "classrooms" elements...--> </classroomList>
Response Example (JSON)
{ "classrooms" : [ { "id" : "308961", "title" : "Proves TE aula 3", "color" : "#308961", "fatherId" : "308958", "assignments" : [ "'CREADOR', 'RESPONSABLE'", ... ], "code" : "121_05_073_01", "shortTitle" : "TMS" }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsGet

/classrooms/{id}

URI: /api/v1/classrooms/{id}

GET

Get classroom's data. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Response Body

element: classroom
Classroom object with classrooms's data. Represents a classroom of the Virtual Campus.
Properties
Property Type Description
id string Classroom's identifier.
title string Classroom's title.
color string Color the user ha assigned to the classroom.
fatherId string Identifier of the classroom's parent.
assignments array of string Assignment list of the user inside the classroom.
code string Classroom's code.
shortTitle string Classroom's short title.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <classroom> <id>308961</id> <title>Proves TE aula 3</title> <color>#308961</color> <fatherId>308958</fatherId> <assignments>'CREADOR', 'RESPONSABLE'</assignments> <assignments>...</assignments> <!--...more "assignments" elements...--> <code>121_05_073_01</code> <shortTitle>TMS</shortTitle> </classroom>
Response Example (JSON)
{ "id" : "308961", "title" : "Proves TE aula 3", "color" : "#308961", "fatherId" : "308958", "assignments" : [ "'CREADOR', 'RESPONSABLE'", ... ], "code" : "121_05_073_01", "shortTitle" : "TMS" }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdGet

/classrooms/{id}/boards

URI: /api/v1/classrooms/{id}/boards

GET

Get the list of communication's resources (board, debate, forum) of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
id Clasrooms's identifier. path

Response Body

element: boardList
BoardList object with the list of communication's resources of the classroom. Represents a list of communication's resources.
Properties
Property Type Description
boards array of (board) Communication's resource list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <boardList> <boards> <id>545844</id> <subtype>WKGRP_FO</subtype> <title>F&amp;#242;rum</title> <code>F&amp;#242;rum</code> <domainId>308959</domainId> <unreadMessages>123</unreadMessages> <totalMessages>1024</totalMessages> </boards> <boards> <!--...--> </boards> <!--...more "boards" elements...--> </boardList>
Response Example (JSON)
{ "boards" : [ { "id" : "545844", "subtype" : "WKGRP_FO", "title" : "Fòrum", "code" : "Fòrum", "domainId" : "308959", "unreadMessages" : 123, "totalMessages" : 1024 }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsGet

/classrooms/{id}/groups

URI: /api/v1/classrooms/{id}/groups

GET

Get all the workgroups of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Response Body

element: classroomList
ClassroomList object with all the workgroups of the classroom. Represents a list of classrooms
Properties
Property Type Description
classrooms array of (classroom) Classroom list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/groups
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <classroomList> <classrooms> <id>308961</id> <title>Proves TE aula 3</title> <color>#308961</color> <fatherId>308958</fatherId> <assignments>'CREADOR', 'RESPONSABLE'</assignments> <assignments>...</assignments> <!--...more "assignments" elements...--> <code>121_05_073_01</code> <shortTitle>TMS</shortTitle> </classrooms> <classrooms> <!--...--> </classrooms> <!--...more "classrooms" elements...--> </classroomList>
Response Example (JSON)
{ "classrooms" : [ { "id" : "308961", "title" : "Proves TE aula 3", "color" : "#308961", "fatherId" : "308958", "assignments" : [ "'CREADOR', 'RESPONSABLE'", ... ], "code" : "121_05_073_01", "shortTitle" : "TMS" }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdGroupsGet

/classrooms/{id}/materials

URI: /api/v1/classrooms/{id}/materials

GET

Get the list of learning materials of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Response Body

element: teachingMaterialList
TeachingMaterialList with all the learning materias of the classroom. Represents a list of teaching materials.
Properties
Property Type Description
materials array of (teachingMaterial) Material's list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/materials
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <teachingMaterialList> <materials> <id /> <type>...</type> <title>...</title> <url>...</url> </materials> <materials> <!--...--> </materials> <!--...more "materials" elements...--> </teachingMaterialList>
Response Example (JSON)
{ "materials" : [ { "id" : "", "type" : "...", "title" : "...", "url" : "..." }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdMaterialsGet

POST

Create a new learning material inside the classroom. The user must be a lecturer of the classroom to be able to create the learning material. The user must have given the application the grant WRITE to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Request Body

element: teachingMaterial
Learning material to create.

Response Body

element: teachingMaterial
Learning material newly created. Represents a learning material.
Properties
Property Type Description
id string Material's idenfitier.
type string Material's type (PDF, WEB).
title string Material's title.
url string Material's URL.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
POST http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/materials
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <teachingMaterial> <id /> <type>...</type> <title>...</title> <url>...</url> </teachingMaterial>
Response Example (JSON)
{ "id" : "", "type" : "...", "title" : "...", "url" : "..." }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdMaterialsPost

/classrooms/{id}/people

URI: /api/v1/classrooms/{id}/people

GET

Get the list of members of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Response Body

element: userList
UserList object with the list of members of the classroom. Represents a list of users
Properties
Property Type Description
users array of (user) User list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/people
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <userList> <users> <id>130360</id> <username>xaracil</username> <name>Xavi</name> <number>411603</number> <fullName>Xavi Aracil Diaz</fullName> <photoUrl>http://cv.uoc.edu/UOC/mc-icons/fotos/xaracil.jpg</photoUrl> <language>ca</language> <sessionId>283ac5c62977a38daef52b5a43ec5273f371af839246fdc4e4c71aaf367972b16721a00fb25ca8feeb3de5012435c42218d7ae60243c7b5c3a688eb593dfbad2</sessionId> <email>xaracil@uoc.edu</email> </users> <users> <!--...--> </users> <!--...more "users" elements...--> </userList>
Response Example (JSON)
{ "users" : [ { "id" : "130360", "username" : "xaracil", "name" : "Xavi", "number" : "411603", "fullName" : "Xavi Aracil Diaz", "photoUrl" : "http://cv.uoc.edu/UOC/mc-icons/fotos/xaracil.jpg", "language" : "ca", "sessionId" : "283ac5c62977a38daef52b5a43ec5273f371af839246fdc4e4c71aaf367972b16721a00fb25ca8feeb3de5012435c42218d7ae60243c7b5c3a688eb593dfbad2", "email" : "xaracil@uoc.edu" }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdPeopleGet

/classrooms/{id}/resources

URI: /api/v1/classrooms/{id}/resources

GET

Get the resource's list of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Response Body

element: resourceList
ResourceList object with the list of resources of the classroom. Represents a list of resources of the classroom
Properties
Property Type Description
resources array of (resource) Resources list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/resources
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <resourceList> <resources> <id>545844</id> <type>Conversation</type> <subtype>WKGRP_FO</subtype> <title>F&amp;#242;rum</title> <code>uoc_demo_011_01_f01</code> <domainId>308959</domainId> </resources> <resources> <!--...--> </resources> <!--...more "resources" elements...--> </resourceList>
Response Example (JSON)
{ "resources" : [ { "id" : "545844", "type" : "Conversation", "subtype" : "WKGRP_FO", "title" : "Fòrum", "code" : "uoc_demo_011_01_f01", "domainId" : "308959" }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdResourcesGet

POST

Create a new resource inside the classroom. The user must be a lecturer of the classroom to be able to create the resource. The user must have given the application the grant WRITE to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Request Body

element: resource
Resource to create.

Response Body

element: resource
Created resource. Represents a classroom's resource, such forum, board, debate, file area, etc. The type attribute tells which type thes resource is.
Properties
Property Type Description
id string Resource's identifier.
type string
subtype string Subtype of resource.
title string Resource's title.
code string Resource's code. Used to compose the resource's URL.
domainId string Identifier of the classroom where this resource is in.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
POST http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/resources
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <resource> <id>545844</id> <type>Conversation</type> <subtype>WKGRP_FO</subtype> <title>F&amp;#242;rum</title> <code>uoc_demo_011_01_f01</code> <domainId>308959</domainId> </resource>
Response Example (JSON)
{ "id" : "545844", "type" : "Conversation", "subtype" : "WKGRP_FO", "title" : "Fòrum", "code" : "uoc_demo_011_01_f01", "domainId" : "308959" }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdResourcesPost

/classrooms/{domain_id}/boards/{id}

URI: /api/v1/classrooms/{domain_id}/boards/{id}

GET

Get the data of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
id Identifier of the communication's resource. path

Response Body

element: board
Board object with the data of the communication's resource. Represents a communication's resource.
Properties
Property Type Description
id string Identifier of the communication's resource.
subtype string Subtype of resource.
title string Title of the communication's resource.
code string Code of the communciation's resource. Used to compose the resource's URL.
domainId string Identifier of the classroom where this resource is in.
unreadMessages int Number of unread messages.
totalMessages int Number of messages.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <board> <id>545844</id> <subtype>WKGRP_FO</subtype> <title>F&amp;#242;rum</title> <code>F&amp;#242;rum</code> <domainId>308959</domainId> <unreadMessages>123</unreadMessages> <totalMessages>1024</totalMessages> </board>
Response Example (JSON)
{ "id" : "545844", "subtype" : "WKGRP_FO", "title" : "Fòrum", "code" : "Fòrum", "domainId" : "308959", "unreadMessages" : 123, "totalMessages" : 1024 }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdGet

/classrooms/{domain_id}/materials/{id}

URI: /api/v1/classrooms/{domain_id}/materials/{id}

GET

Get a learning material from the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
id Learning material's identifier. path

Response Body

element: teachingMaterial
TeachingMaterial object with the learning material or null if it doesn't exist. Represents a learning material.
Properties
Property Type Description
id string Material's idenfitier.
type string Material's type (PDF, WEB).
title string Material's title.
url string Material's URL.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/materials/13205
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <teachingMaterial> <id /> <type>...</type> <title>...</title> <url>...</url> </teachingMaterial>
Response Example (JSON)
{ "id" : "", "type" : "...", "title" : "...", "url" : "..." }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdMaterialsIdGet

/classrooms/{domain_id}/resources/{id}

URI: /api/v1/classrooms/{domain_id}/resources/{id}

GET

Get the data of a resource of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
id Resource's identifier. path

Response Body

element: resource
Resource object with resource's data. Represents a classroom's resource, such forum, board, debate, file area, etc. The type attribute tells which type thes resource is.
Properties
Property Type Description
id string Resource's identifier.
type string
subtype string Subtype of resource.
title string Resource's title.
code string Resource's code. Used to compose the resource's URL.
domainId string Identifier of the classroom where this resource is in.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/resources/545844
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <resource> <id>545844</id> <type>Conversation</type> <subtype>WKGRP_FO</subtype> <title>F&amp;#242;rum</title> <code>uoc_demo_011_01_f01</code> <domainId>308959</domainId> </resource>
Response Example (JSON)
{ "id" : "545844", "type" : "Conversation", "subtype" : "WKGRP_FO", "title" : "Fòrum", "code" : "uoc_demo_011_01_f01", "domainId" : "308959" }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdResourcesIdGet

/classrooms/{id}/people/students

URI: /api/v1/classrooms/{id}/people/students

GET

Get the list of students of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Response Body

element: userList
UserList object with all the students of the classroom. Represents a list of users
Properties
Property Type Description
users array of (user) User list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/students
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <userList> <users> <id>130360</id> <username>xaracil</username> <name>Xavi</name> <number>411603</number> <fullName>Xavi Aracil Diaz</fullName> <photoUrl>http://cv.uoc.edu/UOC/mc-icons/fotos/xaracil.jpg</photoUrl> <language>ca</language> <sessionId>283ac5c62977a38daef52b5a43ec5273f371af839246fdc4e4c71aaf367972b16721a00fb25ca8feeb3de5012435c42218d7ae60243c7b5c3a688eb593dfbad2</sessionId> <email>xaracil@uoc.edu</email> </users> <users> <!--...--> </users> <!--...more "users" elements...--> </userList>
Response Example (JSON)
{ "users" : [ { "id" : "130360", "username" : "xaracil", "name" : "Xavi", "number" : "411603", "fullName" : "Xavi Aracil Diaz", "photoUrl" : "http://cv.uoc.edu/UOC/mc-icons/fotos/xaracil.jpg", "language" : "ca", "sessionId" : "283ac5c62977a38daef52b5a43ec5273f371af839246fdc4e4c71aaf367972b16721a00fb25ca8feeb3de5012435c42218d7ae60243c7b5c3a688eb593dfbad2", "email" : "xaracil@uoc.edu" }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdPeopleStudentsGet

/classrooms/{id}/people/teachers

URI: /api/v1/classrooms/{id}/people/teachers

GET

Get the list of the lecturers of the classroom. The user must have given the application the grant READ to use these operation.

Parameters

Name Description Type Default Value
id Clasroom's identifier. path

Response Body

element: userList
UserList object with all the lecturers of the classroom. Represents a list of users
Properties
Property Type Description
users array of (user) User list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/teachers
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <userList> <users> <id>130360</id> <username>xaracil</username> <name>Xavi</name> <number>411603</number> <fullName>Xavi Aracil Diaz</fullName> <photoUrl>http://cv.uoc.edu/UOC/mc-icons/fotos/xaracil.jpg</photoUrl> <language>ca</language> <sessionId>283ac5c62977a38daef52b5a43ec5273f371af839246fdc4e4c71aaf367972b16721a00fb25ca8feeb3de5012435c42218d7ae60243c7b5c3a688eb593dfbad2</sessionId> <email>xaracil@uoc.edu</email> </users> <users> <!--...--> </users> <!--...more "users" elements...--> </userList>
Response Example (JSON)
{ "users" : [ { "id" : "130360", "username" : "xaracil", "name" : "Xavi", "number" : "411603", "fullName" : "Xavi Aracil Diaz", "photoUrl" : "http://cv.uoc.edu/UOC/mc-icons/fotos/xaracil.jpg", "language" : "ca", "sessionId" : "283ac5c62977a38daef52b5a43ec5273f371af839246fdc4e4c71aaf367972b16721a00fb25ca8feeb3de5012435c42218d7ae60243c7b5c3a688eb593dfbad2", "email" : "xaracil@uoc.edu" }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdPeopleTeachersGet

/classrooms/{domain_id}/boards/{id}/folders

URI: /api/v1/classrooms/{domain_id}/boards/{id}/folders

GET

Get the list of folders of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
id Identifier of the communication's resource. path

Response Body

element: folderList
FolderList object with the list of folders of the communication's resource. Represents a list of folders.
Properties
Property Type Description
folders array of (folder) Folder list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <folderList> <folders> <id>602574</id> <name>Rebuts</name> <unreadMessages>2901</unreadMessages> <totalMessages>3283</totalMessages> </folders> <folders> <!--...--> </folders> <!--...more "folders" elements...--> </folderList>
Response Example (JSON)
{ "folders" : [ { "id" : "602574", "name" : "Rebuts", "unreadMessages" : 2901, "totalMessages" : 3283 }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersGet

/classrooms/{domain_id}/boards/{id}/messages

URI: /api/v1/classrooms/{domain_id}/boards/{id}/messages

GET

Get the list of messages of the Inbox folder of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
start First element to return. query 0
end Last element to return (all elements to return if this field is greater than the total number of elements). query -1
q Search criteria. If no fields are specified the search is done in all the fields of the message (metadata + body). If you want a more advanced search, search can be restringed using the following fields:
  • to: Search by recipients.
  • from: Search by sender.
  • subject: Search by subject.
  • before: Search by date, beign earlier than the date given. Date format is dd/MM/yyyy HH:mm:ss
  • after: Search by date, beign later than the date given. Date format is dd/MM/yyyy HH:mm:ss
  • recurse: (yes | no) Search in subfolders or not.
For instance:
  • &q=Xavi search all messages that contains Xavi either in the body of the message or in its metadata.
  • &q=to:openapi subject:TFC search messages sent to openapi where its subject contains TFC.
query

Response Body

element: messageList
MessageList object with the messages of the Inbox folder of the communication's resource. Represents a list of messages.
Properties
Property Type Description
messages array of (message) Message list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/messages
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <messageList> <messages> <id>398069376</id> <subject>Re: Que hi ha alg&amp;#250;?</subject> <snippet /> <date>30.06.2012 01:57</date> <color>0</color> <status>0</status> <from>Francesc Santanach Delisau</from> <to>Francesc Santanach Delisau</to> <cc>Francesc Santanach Delisau</cc> <body>Lorem ipsum ...</body> </messages> <messages> <!--...--> </messages> <!--...more "messages" elements...--> </messageList>
Response Example (JSON)
{ "messages" : [ { "id" : "398069376", "subject" : "Re: Que hi ha algú?", "snippet" : "", "date" : "30.06.2012 01:57", "color" : 0, "status" : 0, "from" : "Francesc Santanach Delisau", "to" : "Francesc Santanach Delisau", "cc" : "Francesc Santanach Delisau", "body" : "Lorem ipsum ..." }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdMessagesGet

POST

Send a new mail message to a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant SEND_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id (no documentation provided) path
id (no documentation provided) path

Request Body

element: message
(no documentation provided)

Response Body

element: message
Message object with the created message. Represents a mail message.
Properties
Property Type Description
id string Message's identifier.
subject string Message's subject.
snippet string First characters of the message.
date string Message's date.
color long Color mark of the message.
status long Message's status.
from string Message's sender.
to string Message's recipients.
cc string Message's copy recipients.
body string Message's body.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
POST http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/messages
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <message> <id>398069376</id> <subject>Re: Que hi ha alg&amp;#250;?</subject> <snippet /> <date>30.06.2012 01:57</date> <color>0</color> <status>0</status> <from>Francesc Santanach Delisau</from> <to>Francesc Santanach Delisau</to> <cc>Francesc Santanach Delisau</cc> <body>Lorem ipsum ...</body> </message>
Response Example (JSON)
{ "id" : "398069376", "subject" : "Re: Que hi ha algú?", "snippet" : "", "date" : "30.06.2012 01:57", "color" : 0, "status" : 0, "from" : "Francesc Santanach Delisau", "to" : "Francesc Santanach Delisau", "cc" : "Francesc Santanach Delisau", "body" : "Lorem ipsum ..." }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdMessagesPost

/classrooms/{domain_id}/boards/{board_id}/folders/inbox

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/folders/inbox

GET

Get the data of the Inbox folder of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path

Response Body

element: folder
Folder object with the Inbox folder of the communication's resource. Represents a folder.
Properties
Property Type Description
id string Folder's identifier.
name string Folder's name.
unreadMessages long Number of unread messages.
totalMessages long Number of messages.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders/inbox
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <folder> <id>602574</id> <name>Rebuts</name> <unreadMessages>2901</unreadMessages> <totalMessages>3283</totalMessages> </folder>
Response Example (JSON)
{ "id" : "602574", "name" : "Rebuts", "unreadMessages" : 2901, "totalMessages" : 3283 }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersInboxGet

/classrooms/{domain_id}/boards/{board_id}/folders/{id}

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/folders/{id}

GET

Get the data of a folder of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
id Folder's identifier. path

Response Body

element: folder
Folder object with the data of the folder of the communication's resource. Represents a folder.
Properties
Property Type Description
id string Folder's identifier.
name string Folder's name.
unreadMessages long Number of unread messages.
totalMessages long Number of messages.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders/602574
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <folder> <id>602574</id> <name>Rebuts</name> <unreadMessages>2901</unreadMessages> <totalMessages>3283</totalMessages> </folder>
Response Example (JSON)
{ "id" : "602574", "name" : "Rebuts", "unreadMessages" : 2901, "totalMessages" : 3283 }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersIdGet

/classrooms/{domain_id}/boards/{board_id}/messages/{id}

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/messages/{id}

GET

Get message's metadata of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
id Message's identifier. path

Response Body

element: message
Message object with the message's metadata. Represents a mail message.
Properties
Property Type Description
id string Message's identifier.
subject string Message's subject.
snippet string First characters of the message.
date string Message's date.
color long Color mark of the message.
status long Message's status.
from string Message's sender.
to string Message's recipients.
cc string Message's copy recipients.
body string Message's body.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/messages/398069376
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <message> <id>398069376</id> <subject>Re: Que hi ha alg&amp;#250;?</subject> <snippet /> <date>30.06.2012 01:57</date> <color>0</color> <status>0</status> <from>Francesc Santanach Delisau</from> <to>Francesc Santanach Delisau</to> <cc>Francesc Santanach Delisau</cc> <body>Lorem ipsum ...</body> </message>
Response Example (JSON)
{ "id" : "398069376", "subject" : "Re: Que hi ha algú?", "snippet" : "", "date" : "30.06.2012 01:57", "color" : 0, "status" : 0, "from" : "Francesc Santanach Delisau", "to" : "Francesc Santanach Delisau", "cc" : "Francesc Santanach Delisau", "body" : "Lorem ipsum ..." }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdMessagesIdGet

/classrooms/{domain_id}/boards/{id}/messages/unread

URI: /api/v1/classrooms/{domain_id}/boards/{id}/messages/unread

GET

Get the list of unread messages of the Inbox folder of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
start First element to return. query 0
end Last element to return (all elements to return if this field is greater than the total number of elements). query -1
q Search criteria. If no fields are specified the search is done in all the fields of the message (metadata + body). If you want a more advanced search, search can be restringed using the following fields:
  • to: Search by recipients.
  • from: Search by sender.
  • subject: Search by subject.
  • before: Search by date, beign earlier than the date given. Date format is dd/MM/yyyy HH:mm:ss
  • after: Search by date, beign later than the date given. Date format is dd/MM/yyyy HH:mm:ss
  • recurse: (yes | no) Search in subfolders or not.
For instance:
  • &q=Xavi search all messages that contains Xavi either in the body of the message or in its metadata.
  • &q=to:openapi subject:TFC search messages sent to openapi where its subject contains TFC.
query

Response Body

element: messageList
MessageList object with the unread messages of the Inbox folder of the communication's resource. Represents a list of messages.
Properties
Property Type Description
messages array of (message) Message list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/messages/unread
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <messageList> <messages> <id>398069376</id> <subject>Re: Que hi ha alg&amp;#250;?</subject> <snippet /> <date>30.06.2012 01:57</date> <color>0</color> <status>0</status> <from>Francesc Santanach Delisau</from> <to>Francesc Santanach Delisau</to> <cc>Francesc Santanach Delisau</cc> <body>Lorem ipsum ...</body> </messages> <messages> <!--...--> </messages> <!--...more "messages" elements...--> </messageList>
Response Example (JSON)
{ "messages" : [ { "id" : "398069376", "subject" : "Re: Que hi ha algú?", "snippet" : "", "date" : "30.06.2012 01:57", "color" : 0, "status" : 0, "from" : "Francesc Santanach Delisau", "to" : "Francesc Santanach Delisau", "cc" : "Francesc Santanach Delisau", "body" : "Lorem ipsum ..." }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdMessagesUnreadGet

/classrooms/{domain_id}/boards/{board_id}/folders/{id}/messages

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/folders/{id}/messages

GET

Get the list of messages of a folder from a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
id Folder's identifier. path
start First element to return. query 0
end Last element to return (all elements to return if this field is greater than the total number of elements). query -1
q Search criteria. If no fields are specified the search is done in all the fields of the message (metadata + body). If you want a more advanced search, search can be restringed using the following fields:
  • to: Search by recipients.
  • from: Search by sender.
  • subject: Search by subject.
  • before: Search by date, beign earlier than the date given. Date format is dd/MM/yyyy HH:mm:ss
  • after: Search by date, beign later than the date given. Date format is dd/MM/yyyy HH:mm:ss
  • recurse: (yes | no) Search in subfolders or not.
For instance:
  • &q=Xavi search all messages that contains Xavi either in the body of the message or in its metadata.
  • &q=to:openapi subject:TFC search messages sent to openapi where its subject contains TFC.
query

Response Body

element: messageList
MessageList object with the messages of the given folder of the communication's resource. Represents a list of messages.
Properties
Property Type Description
messages array of (message) Message list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders/602574/messages
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <messageList> <messages> <id>398069376</id> <subject>Re: Que hi ha alg&amp;#250;?</subject> <snippet /> <date>30.06.2012 01:57</date> <color>0</color> <status>0</status> <from>Francesc Santanach Delisau</from> <to>Francesc Santanach Delisau</to> <cc>Francesc Santanach Delisau</cc> <body>Lorem ipsum ...</body> </messages> <messages> <!--...--> </messages> <!--...more "messages" elements...--> </messageList>
Response Example (JSON)
{ "messages" : [ { "id" : "398069376", "subject" : "Re: Que hi ha algú?", "snippet" : "", "date" : "30.06.2012 01:57", "color" : 0, "status" : 0, "from" : "Francesc Santanach Delisau", "to" : "Francesc Santanach Delisau", "cc" : "Francesc Santanach Delisau", "body" : "Lorem ipsum ..." }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersIdMessagesGet

/classrooms/{domain_id}/boards/{board_id}/folders/{folder_id}/messages/{id}

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/folders/{folder_id}/messages/{id}

GET

Get the message's metadata from a folder of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
folder_id Folder's identifier. path
id Message's identifier. path

Response Body

element: message
Message object with the message's metadata. Represents a mail message.
Properties
Property Type Description
id string Message's identifier.
subject string Message's subject.
snippet string First characters of the message.
date string Message's date.
color long Color mark of the message.
status long Message's status.
from string Message's sender.
to string Message's recipients.
cc string Message's copy recipients.
body string Message's body.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders/602574/messages/398069376
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <message> <id>398069376</id> <subject>Re: Que hi ha alg&amp;#250;?</subject> <snippet /> <date>30.06.2012 01:57</date> <color>0</color> <status>0</status> <from>Francesc Santanach Delisau</from> <to>Francesc Santanach Delisau</to> <cc>Francesc Santanach Delisau</cc> <body>Lorem ipsum ...</body> </message>
Response Example (JSON)
{ "id" : "398069376", "subject" : "Re: Que hi ha algú?", "snippet" : "", "date" : "30.06.2012 01:57", "color" : 0, "status" : 0, "from" : "Francesc Santanach Delisau", "to" : "Francesc Santanach Delisau", "cc" : "Francesc Santanach Delisau", "body" : "Lorem ipsum ..." }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersIdMessagesIdGet

/classrooms/{domain_id}/boards/{board_id}/folders/{id}/messages/unread

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/folders/{id}/messages/unread

GET

Get the list of unread messages of a folder from a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
id Folder's identifier. path
start First element to return. query 0
end Last element to return (all elements to return if this field is greater than the total number of elements). query -1
q Search criteria. If no fields are specified the search is done in all the fields of the message (metadata + body). If you want a more advanced search, search can be restringed using the following fields:
  • to: Search by recipients.
  • from: Search by sender.
  • subject: Search by subject.
  • before: Search by date, beign earlier than the date given. Date format is dd/MM/yyyy HH:mm:ss
  • after: Search by date, beign later than the date given. Date format is dd/MM/yyyy HH:mm:ss
  • recurse: (yes | no) Search in subfolders or not.
For instance:
  • &q=Xavi search all messages that contains Xavi either in the body of the message or in its metadata.
  • &q=to:openapi subject:TFC search messages sent to openapi where its subject contains TFC.
query

Response Body

element: messageList
MessageList object with the messages of the given folder of the communication's resource. Represents a list of messages.
Properties
Property Type Description
messages array of (message) Message list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders/602574/messages/unread
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <messageList> <messages> <id>398069376</id> <subject>Re: Que hi ha alg&amp;#250;?</subject> <snippet /> <date>30.06.2012 01:57</date> <color>0</color> <status>0</status> <from>Francesc Santanach Delisau</from> <to>Francesc Santanach Delisau</to> <cc>Francesc Santanach Delisau</cc> <body>Lorem ipsum ...</body> </messages> <messages> <!--...--> </messages> <!--...more "messages" elements...--> </messageList>
Response Example (JSON)
{ "messages" : [ { "id" : "398069376", "subject" : "Re: Que hi ha algú?", "snippet" : "", "date" : "30.06.2012 01:57", "color" : 0, "status" : 0, "from" : "Francesc Santanach Delisau", "to" : "Francesc Santanach Delisau", "cc" : "Francesc Santanach Delisau", "body" : "Lorem ipsum ..." }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersIdMessagesUnreadGet

/classrooms/{domain_id}/boards/{board_id}/messages/{id}/move/{folder_id}

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/messages/{id}/move/{folder_id}

POST

Move the message to a folder. The user must have given the application the grant WRITE to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
id Message's identifier. path
folder_id Folder identifier to move the message to. path

Response Body

element: folder
Folder where the message has been moved to (null if folder doesn't exist or the user doesn't have the grant to write onto the folder). Represents a folder.
Properties
Property Type Description
id string Folder's identifier.
name string Folder's name.
unreadMessages long Number of unread messages.
totalMessages long Number of messages.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
POST http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/messages/398069376/move/602574
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <folder> <id>602574</id> <name>Rebuts</name> <unreadMessages>2901</unreadMessages> <totalMessages>3283</totalMessages> </folder>
Response Example (JSON)
{ "id" : "602574", "name" : "Rebuts", "unreadMessages" : 2901, "totalMessages" : 3283 }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdMessagesIdMoveIdPost

/classrooms/{domain_id}/boards/{board_id}/folders/{folder_id}/messages/{id}/body

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/folders/{folder_id}/messages/{id}/body

GET

Get body of a message from a folder of a communication's resource (board, debate, forum) of the subject. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
folder_id Folder's identifier. path
id Message's identifier. path

Response Body

element: messageBody
MessageBody object with the body of the message. Represents the body of a mail message.
Properties
Property Type Description
id string Message's identifier
body string Message's body.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders/602574/messages/398069376/body
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <messageBody> <id>398069376</id> <body>Lorem ipsum ...</body> </messageBody>
Response Example (JSON)
{ "id" : "398069376", "body" : "Lorem ipsum ..." }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersIdMessagesIdBodyGet

/classrooms/{domain_id}/boards/{board_id}/folders/{folder_id}/messages/{id}/history

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/folders/{folder_id}/messages/{id}/history

GET

Get message's historic actions from a folder of a communication's resource (board, debate, forum) of the classroom. The user must have given the application the grant READ_BOARD to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
folder_id Folder's identifier. path
id Message's identifier. path

Response Body

element: messageHistory
MessageHistory object with message's historic actions. Represents the historic actions of a mail message.
Properties
Property Type Description
id string Message's identifier.
details array of (messageHistoryDetail) Action list.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
GET http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders/602574/messages/398069376/history
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <messageHistory> <id>398069376</id> <details> <action>...</action> <date>...</date> <name>...</name> <time>...</time> </details> <details> <!--...--> </details> <!--...more "details" elements...--> </messageHistory>
Response Example (JSON)
{ "id" : "398069376", "details" : [ { "action" : "...", "date" : "...", "name" : "...", "time" : "..." }, ... ] }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersIdMessagesIdHistoryGet

/classrooms/{domain_id}/boards/{board_id}/folders/{source_id}/messages/{id}/move/{destination_id}

URI: /api/v1/classrooms/{domain_id}/boards/{board_id}/folders/{source_id}/messages/{id}/move/{destination_id}

POST

Move the message to a folder. The user must have given the application the grant WRITE to use these operation.

Parameters

Name Description Type Default Value
domain_id Clasrooms's identifier. path
board_id Identifier of the communication's resource. path
source_id Folder identifier where the message is located. path
id Message's identifier. path
destination_id Folder identifier to move the message to. path

Response Body

element: folder
Folder where the message has been moved to (null if folder doesn't exist or the user doesn't have the grant to write onto the folder). Represents a folder.
Properties
Property Type Description
id string Folder's identifier.
name string Folder's name.
unreadMessages long Number of unread messages.
totalMessages long Number of messages.

Status Codes - Errors

The HTTP call return a status code depending on the result of the operation. These codes are listed below
Code Description
200 Success Call
401 Not authorized. Maybe you have to authorize the user o the OAuth token has expired

Example

HTTP Call Example
POST http://denver.uoc.es:8080/webapps/uocapi/v1/classrooms/308961/boards/545844/folders/602574/messages/398069376/move/602574
Response Example (XML)
<?xml version="1.0" encoding="UTF-8"?> <folder> <id>602574</id> <name>Rebuts</name> <unreadMessages>2901</unreadMessages> <totalMessages>3283</totalMessages> </folder>
Response Example (JSON)
{ "id" : "602574", "name" : "Rebuts", "unreadMessages" : 2901, "totalMessages" : 3283 }

Links

iOS: https://github.com/UOC/openapidemos/tree/master/Exemple%20ClassroomsIdBoardsIdFoldersIdMessagesIdMoveIdPost