{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/access-catalog/","auth":"required","examples":{"codes":[{"code":"curl -i  -H \"Content-Type: application/json\" -H \"Authorization:k4/foWLjBSwFJeug9gvzkfR9ieI=\" -X GET 'http://gooru.org/api/nucleus-index-tracker/v1/access-catalog/resource","language":"curl"}]},"method":"get","params":[{"name":"type","type":"string","default":"","desc":"resource/collection","required":false,"in":"path","ref":"","_id":"582c0dd6d2e3680f00df40d2"},{"name":"Authorization","type":"string","default":"","desc":"API Key should be passed in authorization header. Contact support:::at:::gooru.org for API Key","required":false,"in":"header","ref":"","_id":"582c0dd6d2e3680f00df40d1"}],"results":{"codes":[{"name":"In Progress Response","status":202,"language":"json","code":"{\n\"status\":\"in-progress\",\n\"message\":\"Requested file is being generated and will take about 30 minutes approximately. Please check back.\"\n}\n"},{"language":"json","status":200,"name":"Completion Response","code":"{\n\"status\":\"ready\",\n\"message\":\"https://gooru-itsl-org.s3.amazonaws.com/ac7f638f-7c74-314c-b054-c83c1824e329-catalog.json?AWSAccessKeyId=AKIAJJL4EZAFEY3ZQTIA&Expires=1478672500&Signature=z8y7iHZpSFjwL32aFH7pMegsvTg%3D\"\n}\n"},{"code":"{\n\"status\":\"unavailable\",\n\"message\":\"Requested catalog is unavailable for your request. Please contact our support@gooru.org\"\n}\n","language":"json","status":404,"name":"Unavailable Response"}]},"settings":"582c0d1ad2e3680f00df40cf"},"next":{"description":"","pages":[]},"title":"Download Catalog","type":"endpoint","slug":"download-catalog","excerpt":"Given a content type, catalog export starts and returns the status and message to check back after sometime. When user checks back again after sometime using the same API, returns the current status and message. If file is ready, message will include download URL to download the exported catalog file.","body":"Once you get the \"ready\" status in response, you can use the URL contained in \"message\" field and download the file.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5864d2e079ce642d00f0ff57","parentDoc":null,"user":"5706dce42138ed0e0060f8ab","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5dc4f96dbb5da3006c8f5660"],"_id":"5864d2df79ce642d00f0fec7","createdAt":"2016-12-29T09:09:51.074Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2016-12-29T09:09:51.074Z","__v":18},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Access Catalog","slug":"access-catalog","order":25,"from_sync":false,"reference":false,"_id":"5864d2df79ce642d00f0fede","__v":0,"version":"5864d2df79ce642d00f0fec7","createdAt":"2016-11-16T07:30:00.442Z","project":"56439dfe9eebf70d00490d54"},"project":"56439dfe9eebf70d00490d54","__v":1,"createdAt":"2016-11-16T07:30:14.049Z","githubsync":""}

getDownload Catalog

Given a content type, catalog export starts and returns the status and message to check back after sometime. When user checks back again after sometime using the same API, returns the current status and message. If file is ready, message will include download URL to download the exported catalog file.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

type:
string
resource/collection

Headers

Authorization:
string
API Key should be passed in authorization header. Contact support@gooru.org for API Key

Examples


Result Format


Documentation

Once you get the "ready" status in response, you can use the URL contained in "message" field and download the file.

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 }}