{"_id":"5d47c8eea77b930030f730d4","project":"56439dfe9eebf70d00490d54","version":{"_id":"5864d2df79ce642d00f0fec7","project":"56439dfe9eebf70d00490d54","__v":17,"createdAt":"2016-12-29T09:09:51.074Z","releaseDate":"2016-12-29T09:09:51.074Z","categories":["5864d2df79ce642d00f0fec8","5864d2df79ce642d00f0fec9","5864d2df79ce642d00f0feca","5864d2df79ce642d00f0fecb","5864d2df79ce642d00f0fecc","5864d2df79ce642d00f0fecd","5864d2df79ce642d00f0fece","5864d2df79ce642d00f0fecf","5864d2df79ce642d00f0fed0","5864d2df79ce642d00f0fed1","5864d2df79ce642d00f0fed2","5864d2df79ce642d00f0fed3","5864d2df79ce642d00f0fed4","5864d2df79ce642d00f0fed5","5864d2df79ce642d00f0fed6","5864d2df79ce642d00f0fed7","5864d2df79ce642d00f0fed8","5864d2df79ce642d00f0fed9","5864d2df79ce642d00f0feda","5864d2df79ce642d00f0fedb","5864d2df79ce642d00f0fedc","5864d2df79ce642d00f0fedd","5864d2df79ce642d00f0fede","598aa64f4b6e990019b7a2d2","599bc76bc03fa2000f83db2a","599bcc3c3c5bf7000f3434fc","5d427dc9fa56fa0011135058","5d429c616863d5003af785a7","5d429e0889418f00c5e95d3f","5d42b5f098b05e003acb08b4","5d43c16985775c00ebeede3b","5d43d15446d584003da91e6d","5d43d61a5bdac50011b6f234","5d43d7c2db365100640dbc58","5d43d954bffa8400ff7efa78","5d43e414cf4f03005944344c","5d43eb42db365100640dbe4a","5d43ee6c78121b0057bc1dbf","5d9a18b4afc33400126c4e6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"5864d2df79ce642d00f0feda","project":"56439dfe9eebf70d00490d54","__v":0,"version":"5864d2df79ce642d00f0fec7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-22T10:24:58.776Z","from_sync":false,"order":18,"slug":"new-search-api","title":"Search API"},"user":"5d411a29005b9600113731fd","__v":0,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-08-05T06:13:02.875Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"To\tget\tFeatured\tCourses\t: \t\ncurl -i\t-H \"Authorization:\tTokenMjoxNDkxNDg2NjMwNjYyOmFub255bW91czo6YmE5NTZhOTctYWUxNS0xMWU1LWEzMDItZjhhOTYzMDY1OTc2\"\t-XGET\t'\thttp://nile-dev.gooru.org/gooru-search/rest/v2/search/course?q=*&startAt=1&length=10\t &flt.courseType=featured\t '\t\n\t\nPublished\tCourse\tSearch\t:\t\t\ncurl\t-i\t-H\t\"Authorization:TokenMjoxNDkxNDg2NjMwNjYyOmFub255bW91czo6YmE5NTZhOTctYWUxNS0xMWU1LWEzMDItZjhOTYzMDY1OTc2\"-XGET'http://nile-dev.gooru.org/gooru-search/rest/v2/search/course?q=*&startAt=1&length=10\t' \t","language":"json"}]},"settings":"","results":{"codes":[{"name":"","code":"{\t\n\"executionTime\"\t: 12,\t\n\"query\"\t: {\n\t \t\n\"rewrittenQueryString\": \"*\",\t\n\"userQueryString\"\t: \"*\"\t\n},\t\n\"resultCount\"\t: 1,\n\"searchCount\": 0,\n\"searchResults\"\t: [\n\t \t\n{\t\n\"addDate\"\t: \"2016-09-26T16:42:38Z\",\t\n\"assessmentCount\"\t: 10,\t\n\"collaboratorCount\"\t: 0,\n\"collectionCount\"\t: 33,\t\n\"collectionIds\": [\n\t \t\n\"86db5d31-b1fa-4f20-a081-f81337630320\",\t\n\"282781cf-1717-40e2-bc34-0228065a1d76\",\t\n\"6769007a-5d90-4156-a6fc-ff855a6cf551\",\t\n\"543f5655-abef-4135-859d-64f582abe181\",\t\n\"20b59cdc-a93c-4c33-989d-b6933e741091\",\t\n \"b65ab715-e263-4866-bc1a-aa29d4e7f774\",\t\n\"ce8a5800-265d-4d9f-a5ac-82fdadd9d122\",\t\n\"df354733-ee5b-49d7-aeca-06a91077addb\",\n\"d9f97589-bada-467f-bff3-e312f4c07624\",\t\n\"edaa5405-8b48-48dc-82e3-72b4116e750e\",\t\n\"8a6b4e4c-9c23-4c59-9ba8-f3521f7eea8a\",\t\n\"2cc4891f-cbf0-4338-b96f-ed8316a2736d\",\t\n\"6db63b71-0f2c-4d4a-aea7-21296543b5b5\",\t\n\"c25f0f75-25fa-421a-9529-4555a3a192b6\",\t\n\"50f9f32d-c84c-4069-9654-b37dfc8839cc\",\t\n\"f93e6d47-404e-43c2-9901-00086a2262a3\",\t\n\"7ee52967-2e88-4573-a042-b27a25fc4d7c\",\t\n\"5ba50b7f-bb93-4b5f-b6bb-27428a37964f\",\t\n\"f1421a4b-b314-4f5e-9085-94bd0ba8d8fd\",\t\n\"73eb5f0c-981c-4ffd-a49f-3a90b7470a88\",\t\n\"25f0fbe5-9e97-45e7-9c4d-32c326466eff\",\t\n\"63300545-ff4d-4a39-8a95-5e3a7aaec009\",\t\n\"e198ceed-cbe5-4019-bf26-2ce3a5bbdeed\",\t\n\"1bf91247-d4d7-401d-a7e9-337c55138800\",\t\n\"c45903da-ed26-467f-b070-b57662c56c3c\",\t\n\"e7e292ff-33c7-4ef1-b8aa-45bd9448d008\",\t\n\"bebeb63d-503e-4b8b-91d9-2539fe76b0ed\",\t\n\"a9c403fe-69f3-4e75-9fd9-6943810731f1\",\t\n\"18252f48-7ec2-4f92-8553-8bd4f2259f1d\",\t\n\"4451df07-bd54-484b-9851-3f663adf06c6\",\t\n\"5a298722-4d35-4f93-9a9b-921380ce90e8\",\t\n\"eecd3edb-ede3-4f7a-a757-df33fd7fc392\",\t\n\"fb131964-4f95-4092-bb90-a49cae45937b\",\t\n\"1150cfef-22d5-4508-a278-362c2caa663f\",\t\n\"a07e1a69-cf61-4f65-916b-1afd1b2e8be5\",\t\n\"fe7e52d7-d956-43f6-9599-377a9ce2f94f\",\t\n\"47a0d2ea-d2c0-437e-811c-3ed2d22d3d69\",\t\n\"584ade59-16c3-49ee-8706-ad51d8004479\",\t\n\"ec81d91a-6ff5-4119-a4d2-5f071e695a2c\",\t\n\"6b16be8a-43a8-4f5c-80dd-979c17a24e45\",\t\n\"53a49a88-1145-4e8b-aecb-374a8c127f12\",\t\n\"53ec005f-5980-41cc-a2d8-196d27c4592a\",\t\n\"21820665-c323-4fef-9172-f86ffa1634c1\"\t\n]\t,\t\n\"containingCollectionCount\"\t: 43,\t\n\"courseRemixCount\": 13,\t\n\"creator\"\t:{\t\n\"firstname\"\t: \"Meaghan\",\t\n\"id\": \"d701fa59-d1ef-4a27-815c-280f98a478ba\",\t\n\"lastname\": \"Pattani\",\t\n\"profileImage\": null,\t\n\"usernameDisplay\"\t:\" MPattani\"\t\n},\t\n\"description\"\t: \" This\tcourse\tencourages\tstudent\tlearning\tabout\tthe\tscience\tof\tMarine\tBiology,\tthe\timportance\tof\tMarine\tConservation,\tand\tthe\timpact\tof\tMarine\tSciences\ton\thuman\tlives.\"\t,\n\"externalAssessmentCount\"\t: 0,\n\"format\": \"course\",\t\n\"id\": \"1d91657f-694b-43dc-9306-bca17b107c7d\",\t\n\"isFeatured\": true,\t\n\"lastModified\": \"2017-04-10T08:49:08Z\",\t\n\"lastModifiedBy\": \"d701fa59-d1ef-4a27-815c-280f98a478ba\",\t\n\"lessonCount\": 34,\t\n\"lessonIds\": [\n\t\"853ea553-8d16-4f65-9f8b-70de26b48e5c\",\t\n\"08761e4c-7c71-4e98-b4d1-b86e1301cbe3\",\t\n\"08b0bc42-462e-4b18-b8de-4e0097dd1d71\",\t\n\"4382b00c-13dd-4441-b318-66e6deaa958e\",\t\n\"a50f906f-c7cf-48e2-83e7-68f9f9459dd3\",\t\n\"51640b15-0ff1-4e65-b787-f2fa74d88ce0\",\t\n\"d56311ea-0194-428a-830a-ebf87d1dad9e\",\t\n\"9d76d7ce-5e96-4632-af0a-8736e672c8cf\",\t\n\"436f66b3-1e9e-4e63-a232-40b9fb3e13f5\",\t\n\"8b2fc6c0-bc9b-4510-8464-f4a231a0fbd6\",\t\n\"a1737774-49c5-4ab3-971a-3d73d33388f7\",\t\n\"ce0277c0-2875-4c8a-93d3-cae50aa9350d\",\t\n\"5c764422-93a2-4152-ae86-339c658c89fd\",\t\n\"f2accafa-2b32-4f9b-91ab-53145d6ad3a6\",\t\n\"b90ef3c1-7f01-437b-94bb-b385b62ff336\",\t\n\"6137976e-8b13-4fbd-ad04-c779bd9112e3\",\t\n\"165dff14-4852-4f58-8ed4-73dde6673d21\",\t\n\"003ee3c4-5df2-403f-87dd-6535a418c94e\",\t\n\"c3ef2e14-33d4-46ad-8fb0-ff514228e0af\",\n\"6094634f-4037-43a7-9e1e-9fd1f766f4a5\",\n\"d1103cf7-848b-4ac2-b35d-b512b19f1f92\",\n\"7655a051-9080-489a-95b6-11f1cfce7f07\",\t\n\"23ff2d6f-a0d5-4c00-8db1-001ed9ab96f0\",\t\n\"9ddf9cb1-92b0-4906-82a9-491526e25f95\",\t\n\"4505fb34-f500-4ec5-a266-e1006809f859\",\t\n\"70896a62-cc5c-40cd-b3be-1229cc7fd52d\",\t\n\"ca072886-fb4c-4c80-951f-1b98c9353ebe\",\t\n\"b3154ca0-76a9-42b1-aa49-f3a743a386c9\",\t\n\"0e59ea06-8936-41dd-8387-de61f9d6f384\",\t\n\"0a7a2b66-c834-421b-b68f-c8412b7925b5\",\t\n\"9792827d-4f32-499c-bb8e-d48557b692e6\",\t\n\"ebe24ac5-9271-4197-ab28-f6c7235ec604\",\t\n\"435bfa72-ccca-4f5b-a732-ad87499bfb79\",\t\n\"9ecfc782-e16d-41e4-8869-6d128c79f10c\"\t\n],\t\n\"license\":{\t\n\"code\": \"PDM\",\t\n\"definition\": \"This\twork\thas\tbeen\tidentified\tas\tbeing\tfree\tof\tknown\trestrictions\tunder\tcopyright\tlaw,\tincluding\tall\trelated\tand\tneighboring\trights.\",\t\n\"icon\"\t: \"license/pdm.png\",\t\n\"name\"\t: \"Public\tDomain\",\t\n\"url\": \"http://creativecommons.org/publicdomain/mark/1.0/\"\t\n},\t\n\"originalCreator\": null,\t\n\"owner\"\t:{\t\n\"firstname\"\t: \"Meaghan\",\t\n\"id\": \"d701fa59-d1ef-4a27-815c-280f98a478ba\",\t\n\"lastname\": \"Pattani\",\t\n\"profileImage\"\t: null,\t\n\"usernameDisplay\": \"MPattani\"\t\n},\t\n\"publishStatus\": \"published\",\t\n\"remixedInClassCount\"\t: 0,\n\"sequence\"\t: 11,\t\n\"subjectBucket\": \"NGSS.K12.SC\",\t\n\"subjectSequence\": 3,\n\"taxonomy\"\t:{\t\n\"subject\": [\n\t \t\"Science\"\t\n]\n\"course\"\t: [\n\t \t\"High\tSchool\"\t\n],\t\n\"curriculum\"\t:{\t\n\"curriculumCode\": [\n\"NGSS.K12.SC-HS\"\t\n]\t,\t\n\"curriculumDesc\": [\n\"High\tSchool\"\t\n]\t,\t\n\"curriculumName\"\t: [\n\"NGSS\"\t\n]\t,\t\n\"curriculumInfo\": [\n\t \t\n{\t\n\"id\": \"NGSS.K12.SC-HS\",\t\n\"code\"\t: \"NGSS.K12.SC-HS\",\t\n\"title\": \"High\tSchool\",\t\n\"frameworkCode\": \"NGSS\",\t\n\"parentTitle\": \"Science\"\t\n}\t\n]\t\n}\t\n},\t\n\"thumbnail\": \"6707ea9e-9cbb-446c-873b-9a6102d0ce04.PNG\",\t\n\"title\"\t: \" Marine\tBiology\tand\tConservation\",\t\n\"unitCount\": 9,\n\t \t\n\"unitIds\"\t: [\n\t \t\n\"10903408-cad5-4072-af8e-df1e65977195\",\t\n\"a5fda670-8973-4669-8429-34d7b26c52a3\",\t\n\"9121e82f-2ea0-4cce-9b43-e8edce2dc41a\",\t\n\"51287b22-c146-4b69-bd1c-81d3b089140b\",\t\n\"0e22aeea-4d30-4c79-bfa8-e5657a2a17b6\",\t\n\"8d90114b-456f-484b-9ff9-9878373725a8\",\t\n\"57ca6d37-235b-4faa-a662-49b043a22a80\",\t\n\"214cc45d-e557-44d1-ac22-181c1e7fa93f\",\t\n\"3875d42f-4271-4a9c-b5b1-805064ba9426\"\t\n],\n\"usedByStudentCount\": 0,\n\"viewCount\": 0,\n\"visibleOnProfile\": false\t\n}\t\n]\t,\t\n\"stats\"\t: {\n\t \t\"pageSize\"\t: 1,\n\t \t\"totalHitCount\"\t: 40,\t\n  \t\"pageNumber\"\t: 1\n\t \t}\t,\t\n\"totalHitCount\"\t:  40\t\n\t \t","language":"json","status":200}]},"auth":"required","params":[{"_id":"5d43cab486a18b004c270701","ref":"","in":"path","required":true,"desc":"course","default":"Nil","type":"string","name":"type"},{"_id":"5d43cab486a18b004c270700","ref":"","in":"body","required":true,"desc":"","default":"Nil","type":"string","name":"sessionToken"},{"_id":"5d43cab486a18b004c2706ff","ref":"","in":"body","required":false,"desc":"only integer values","default":"1","type":"int","name":"startAt"},{"_id":"5d43cab486a18b004c2706fe","ref":"","in":"body","required":false,"desc":"only integer values","default":"8","type":"int","name":"length"},{"_id":"5d43cab486a18b004c2706fd","ref":"","in":"body","required":true,"desc":"","default":"Nil","type":"string","name":"q"},{"_id":"5d43cab486a18b004c2706fc","ref":"","in":"body","required":false,"desc":"featured","default":"Nil","type":"string","name":"flt.courseType"},{"_id":"5d47c5a7576cb1001adf4324","ref":"","in":"query","required":false,"desc":"Filter using taxonomy subjectName      Allowed Values:Gooru subject names math,Science,English language arts, social science  Example:flt.subjectName=science~~math","default":"","type":"string","name":"flt.subjectName"},{"_id":"5d47c5a7576cb1001adf4323","ref":"","in":"query","required":false,"desc":"Filter using taxonomy courseName Allowed values: Gooru taxonomy course names Examples:flt.courseName=Astronomy","default":"","type":"string","name":"flt.courseName"},{"_id":"5d47c75e3c20700024080e16","ref":"","in":"query","required":false,"desc":"Filter using creator  firstname or lastName  or  userName or userFullname  Examples:flt.creator=John","default":"","type":"string","name":"flt.creator"},{"_id":"5d47c75e3c20700024080e15","ref":"","in":"query","required":false,"desc":"Filter by standards Examples:flt.standard=CCSS. M.6.SP.A","default":"","type":"string","name":"flt.standard"},{"_id":"5d47c75e3c20700024080e14","ref":"","in":"query","required":false,"desc":"Filter by standard’s display code Example:flt.standardDisplay=  CA.SCI.5.PS.1g","default":"","type":"string","name":"flt.standardDisplay"},{"_id":"5d47c75e3c20700024080e13","ref":"","in":"query","required":false,"desc":"Filter by grade Examples: flt.grade=K-4,12,11","default":"","type":"string","name":"flt.grade"},{"_id":"5d47c75e3c20700024080e12","ref":"","in":"query","required":false,"desc":"Filter content  by content\tformat\tAllowed values:resource,question\tExample:flt.contentFormat=resource","default":"","type":"string","name":"flt.contentFormat"},{"_id":"5d47c75e3c20700024080e11","ref":"","in":"query","required":false,"desc":"Filter resource by Format Allowed values:video_resource,webpage_resource,interactive_resource,image_resource,text_resource,\taudio_resource,multiple_choice_question,\t\t\t\tmultiple_answer_question,\t \t\t\t\ttrue_false_question,\t \t\t\t\tfill_in_the_blank_question,\t \t\t\t\topen_ended_question,\t \t\t\t\thot_text_reorder_question,hot_text_highlight_question,hot_spot_image_question,hot_spot_text_question,","default":"","type":"string","name":"flt.resourceFormat"},{"_id":"5d47c75e3c20700024080e10","ref":"","in":"query","required":false,"desc":"Filter by info.language\tAllowed values:eng,spa,nor,nld Examples:flt.language=eng","default":"","type":"string","name":"flt.language"},{"_id":"5d47c75e3c20700024080e0f","ref":"","in":"query","required":false,"desc":"Filter by publisher\t Examples:flt.publisher=The  Metropolitan Museum of Art","default":"","type":"string","name":"flt.publisher"},{"_id":"5d47c75e3c20700024080e0e","ref":"","in":"query","required":false,"desc":"Filter by owner  firstname  or lastName  or  userName  or userFullname Example:flt.owner=Rocky","default":"","type":"string","name":"flt.owner"},{"_id":"5d47c75e3c20700024080e0d","ref":"","in":"query","required":false,"desc":"Filter by  info.countryCode\t Example:flt.countryCode=US","default":"","type":"string","name":"flt.countryCode"},{"_id":"5d47c75e3c20700024080e0c","ref":"","in":"query","required":false,"desc":"Filter using taxonomy domainName Examples:flt.domainName=Physical\tSciences","default":"","type":"string","name":"flt.domainName"},{"_id":"5d47c75e3c20700024080e0b","ref":"","in":"query","required":false,"desc":"Filter using taxonomy  subject classification\t Example:flt.subjectClassification-k_12","default":"","type":"string","name":"flt.subjectClassification"},{"_id":"5d47c75e3c20700024080e0a","ref":"","in":"query","required":false,"desc":"Filter  by twentyone CenturySkills Example:flt.21CenturySkills= critical\t thinking~~creativity","default":"","type":"string","name":"flt.21CenturySkills"},{"_id":"5d47c75e3c20700024080e09","ref":"","in":"query","required":false,"desc":"Filter using  taxonomy subject code \t Example:flt.subject=K12.SC  Allowed values:Gooru \t subject \t codes \t -  K12.MA,  K12.SC,  K12.ELA,\tK12.SS","default":"","type":"string","name":"flt.subject"},{"_id":"5d47c75e3c20700024080e08","ref":"","in":"query","required":false,"desc":"Filter  using taxonomy  course code Example: flt.course=K12.SC- CH  Allowed values:Gooru course codes-K12.SC-CH","default":"","type":"string","name":"flt.course"}],"url":"/:type"},"isReference":false,"order":999,"body":"","excerpt":"","slug":"search-course-1","type":"endpoint","title":"Search Course"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

type:
required
stringNil
course

Query Params

flt.subjectName:
string
Filter using taxonomy subjectName Allowed Values:Gooru subject names math,Science,English language arts, social science Example:flt.subjectName=science~~math
flt.courseName:
string
Filter using taxonomy courseName Allowed values: Gooru taxonomy course names Examples:flt.courseName=Astronomy
flt.creator:
string
Filter using creator firstname or lastName or userName or userFullname Examples:flt.creator=John
flt.standard:
string
Filter by standards Examples:flt.standard=CCSS. M.6.SP.A
flt.standardDisplay:
string
Filter by standard’s display code Example:flt.standardDisplay= CA.SCI.5.PS.1g
flt.grade:
string
Filter by grade Examples: flt.grade=K-4,12,11
flt.contentFormat:
string
Filter content by content format Allowed values:resource,question Example:flt.contentFormat=resource
flt.resourceFormat:
string
Filter resource by Format Allowed values:video_resource,webpage_resource,interactive_resource,image_resource,text_resource, audio_resource,multiple_choice_question, multiple_answer_question, true_false_question, fill_in_the_blank_question, open_ended_question, hot_text_reorder_question,hot_text_highlight_question,hot_spot_image_question,hot_spot_text_question,
flt.language:
string
Filter by info.language Allowed values:eng,spa,nor,nld Examples:flt.language=eng
flt.publisher:
string
Filter by publisher Examples:flt.publisher=The Metropolitan Museum of Art
flt.owner:
string
Filter by owner firstname or lastName or userName or userFullname Example:flt.owner=Rocky
flt.countryCode:
string
Filter by info.countryCode Example:flt.countryCode=US
flt.domainName:
string
Filter using taxonomy domainName Examples:flt.domainName=Physical Sciences
flt.subjectClassification:
string
Filter using taxonomy subject classification Example:flt.subjectClassification-k_12
flt.21CenturySkills:
string
Filter by twentyone CenturySkills Example:flt.21CenturySkills= critical thinking~~creativity
flt.subject:
string
Filter using taxonomy subject code Example:flt.subject=K12.SC Allowed values:Gooru subject codes - K12.MA, K12.SC, K12.ELA, K12.SS
flt.course:
string
Filter using taxonomy course code Example: flt.course=K12.SC- CH Allowed values:Gooru course codes-K12.SC-CH

Body Params

sessionToken:
required
stringNil
startAt:
integer1
only integer values
length:
integer8
only integer values
q:
required
stringNil
flt.courseType:
stringNil
featured

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}