Portfolio

Get lists data publish portfolio

HTTP Request

GET /api/v1/portfolio

Example Header

GET /api/v1/portfolio?orderBy=createdTime,projectTitle-&pageSize=10&filter=projectTitle:Art,category:Architecture,memberBarcode:123456&field=portfolioId,projectTitle,cover.fileId,cover.data HTTP/1.1
Host: {{DOMAIN}}
Content-Type: application/json
Accept: application/json
Authorization: {{sessionId}}

Info

Require sessionId

Parameters

Parameters Type Require Default Description
orderBy string createdTime+ A comma-separated list of sort keys.
Valid keys are 'createdTime', 'modifiedTime', 'projectTitle', 'category', 'staffPick'. Each key sorts ascending by default, but may be reversed with the '-' modifier.
Example usage: ?orderBy=createdTime,projectTitle-,category-
filter string A comma-separated list of filter keys.
Valid keys are 'memberBarcode', 'category', 'relativeCategory', 'readyToBuy', 'certificateByTCDC', 'staffPick'.
Example usage: ?filter=category:Architecture,memberBarcode:123456
pageSize integer 100 The maximum number of files to return per page. Acceptable values are 1 to 1000
pageToken string The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
field string Specific return field.
Valid keys are 'portfolioId', 'projectTitle', 'cover.fileId', 'cover.originalFilename', 'cover.fullFileExtension', 'cover.mimeType', 'cover.description', 'cover.createdTime', 'cover.modifiedTime', 'cover.md5Checksum', 'cover.size', 'cover.data', 'cover.dimention.width', 'cover.dimention.height'.

Response

{
    "lists": [
        {
            "portfolioId": "59a93a6d6ad1da55fd5127e5",
            "projectTitle": "projectTitle 652",
            "cover": {
                "fileId": "59a93a756ad1da6aa4406b97",
                "originalFilename": "Screen Shot 2017-08-31 at 20.02.39.png",
                "fullFileExtension": "png",
                "mimeType": "image/png",
                "description": "description data",
                "createdTime": 1504262773,
                "modifiedTime": 1504262773,
                "md5Checksum": "4ab97f2391d80ce913e31fea6a11be18",
                "size": 307879,
                "data": "BASE64-OF-FILE",
                "dimention": {
                    "width": 545,
                    "height": 295
                }
            }
        },
        {
            "portfolioId": "59a9373a6ad1da55fb4acc85",
            "projectTitle": "projectTitle 991",
            "cover": {
                "fileId": "59a937536ad1da55fa510325",
                "originalFilename": "Screen Shot 2017-09-01 at 17.31.21.png",
                "fullFileExtension": "png",
                "mimeType": "image/png",
                "description": "",
                "createdTime": 1504261971,
                "modifiedTime": 1504261971,
                "md5Checksum": "ab428c31997f792e744cd6331228e9bd",
                "size": 96458,
                "data": "BASE64-OF-FILE",
                "dimention": {
                    "width": 220,
                    "height": 190
                }
            }
        }
    ],
    "result": 2,
    "total": 2,
    "nextPageToken": ""
}

Response Code

Code Result Description
200 success Response to a successful request.
400 error The request is malformed or missing some required parameters.
401 error Unauthorized token or the sessionId was expired.