|
BlueMelon API 1.0 : bluemelon.collections.getitems PDF Print E-mail

bluemelon.collections.getitems

retrieves the items in the specified collection

Authentication:

Yes (see here for details)

Arguments:

(required) long : collectionid - the id of the collection
(optional) string : fmd - the fileModifiedDate will be included in the response if this is set to "1"
(optional) string : fcd - the fileCreatedDate will be included in the response if this is set to "1"
(optional) string : accessmode - the accessmode will be included in the response if this is set to "1"
(optional) string : ownerid - the id of each item owner will be included in the response if this is set to "1"
(optional) string : ownerurl - the url of each item owner's homepage will be included in the response if this is set to "1"
(optional) string : ownernickname - the nickname of each item owner will be included in the response if this is set to "1"
(optional) string : subviewurl - the url for the photo in a resolution specified by subviewext will be included in the response if this is set to "1"
(required if subviewurl = "1") string : subviewext - the resolution for subviewurl with the possible values:  "T75", "T100", "T150", "T400300", (default) "T800600"
(optional) string : originalurl - the fileModifiedDate will be included in the response if this is set to "1"
(optional) int : batch - used for paging of items ;  the number of items to be returned, set to 0 (default) to get all items
(optional) int : first - used for paging of items ;  the number of items to skip ( default = 0 )
(required) string : publickey - the public key of an application
(required) string : token - the access token

Request Example:

http://www.bluemelon.com/api/rest/{api_sign}/
?method=bluemelon.collections.getitems&collectionid=1&fcd=1&subviewurl=1&subviewext=
T800600&originalurl=1&fmd=1
&publickey={publickey}&token={token}

Response Example:

<rsp status="ok" onrequest="bluemelon.collections.getitems">
<content>
<item id="62522" filemodifieddate="2009-04-05 11:13:13 CEST" filecreateddate="2009-04-05 11:13:13 CEST"
subviewurl="/photo/62522/Lili(2)-T800600.jpg" subviewwidth="800" subviewheight="530" originalurl="/photo/62522/Lili(2).jpg"
filename="Lili(2).jpg" size="925653" etag="727e77582cb8a2280b5fa1485902dd4d" type="IMAGE" subtype="JPEG" title="Lili+%282%29.jpg" />
<item id="62515" filemodifieddate="2009-04-05 11:09:34 CEST" filecreateddate="2009-04-05 11:09:34 CEST"
subviewurl="/photo/62515/Lili(3)-T800600.jpg" subviewwidth="800" subviewheight="530" originalurl="/photo/62515/Lili(3).jpg"
filename="Lili(3).jpg" size="928892" etag="5db3f080e2b9e6173a0400d794df8e11" type="IMAGE" subtype="JPEG" title="Lili+%283%29.jpg" />
<item id="62511" filemodifieddate="2009-04-05 11:07:50 CEST" filecreateddate="2009-04-05 11:07:50 CEST"
subviewurl="/photo/62511/Lili(4)-T800600.jpg" subviewwidth="800" subviewheight="530" originalurl="/photo/62511/Lili(4).jpg"
filename="Lili(4).jpg" size="930080" etag="0265e53c961bc76c34afc77269aadc3c" type="IMAGE" subtype="JPEG" title="Lili+%284%29.jpg" />
</content>
</rsp>

Error Codes:

4 - "Missing parameter"
5 - "Invalid parameter"
12 - "Application not found"
14 - "Invalid accessToken"
16 - "Access token timed out.You must relogin."
17 - "Invalid call signature size"
18 - "Invalid call signature"
20 - "Missing api_sign"
35 - "Folder not found"
602 - "No read permissions"
603 - "Account recently expired or deleted"