mediatype/

A complete list of all the possible Companion Resource media types in alphabetical order.

Extra Parameters:

Parameter	none
Example	https://api.agclassroom.org/api/mediatype/

HTTP Method

GET

Requires authentication:

Return Format:

JSON

Return Example:

{

success:true

message:Found 9 media types.

resultcount:9

result: [...]

0 {...}

id:2

description:Activity

constant:ACTIVITY

1 {...}

id:5

description:Book

constant:BOOK

2 {...}

id:6

description:Kit

constant:KIT

. . .

}

Back to list

mediatype/id/{id}/

Return all the information on one specific media type.

Extra Parameters:

Parameter	id
Type	number
Description	This identifier must be known previously or be pulled from the mediatype call.
Example	https://api.agclassroom.org/api/mediatype/id/4/

HTTP Method

GET

Requires authentication:

Return Format:

JSON

Return Example:

{

success:true

message:Found 1 mediatype.

resultcount:1

result: [...]

0 {...}

id:4

description:Movie/Video

constant:MOVIE

}

Back to list

mediatype/constant/{constant}/

Return one specific media type by searching by its "constant".

Extra Parameters:

Parameter	constant
Type	string (all caps)
Description	The constant is used to quickly identify a media type without punctuation. It should be known previously or pulled from the mediatype call.
Examples	https://api.agclassroom.org/api/mediatype/constant/MOVIE/

HTTP Method

GET

Requires authentication:

Return Format:

JSON

Return Example:

{

success:true

message:Found 1 mediatype.

resultcount:1

result: [...]

0 {...}

id:4

description:Movie/Video

constant:MOVIE

}