Minor documentation correctio: Imatch web services: collections/files

Started by ubacher, February 09, 2018, 06:08:58 PM

Previous topic - Next topic

ubacher

Imatch web sercvices documentation:

For v1/collections/files it does not show the parameter path.
And the list of keywords to specify what collection is missing.
(How do I specify REJECTS ?)



Mario

categories.id should be collections.id

You specify the id of the collection you want to retrieve files for. To get the id of any collection, use the /collections endpoint.
-- Mario
IMatch Developer
Forum Administrator
http://www.photools.com  -  Contact & Support - Follow me on 𝕏 - Like photools.com on Facebook

ubacher

From the collections sample app:
$('#btn-get-bookmarks').click(function() {
                   
                    IMWS.get('v1/collections/files',{
                        path : 'Bookmarks',


1. path is missing in the docu.
2. What are the proper names of the collections that I can specify?

Mario

Don't use path. Use the fixed collection ids declared in IMWSLib: IMWS.COLLECTIONS.ratingReject should do just fine.

If you want to use the path, first get all collections via the /collections endpoint, then you know the name you can use for path.
You can use id/idlist/path, as usual, also with this endpoint. I have updated the schema for the next release.
-- Mario
IMatch Developer
Forum Administrator
http://www.photools.com  -  Contact & Support - Follow me on 𝕏 - Like photools.com on Facebook