Japanese

English

contentsholder/series.list

Retrieves a list of series in your Content Owner Media Unit

URL

GET /v1.0/contentsholder/series.list

Parameters

Argument Required Default Value Example Description
unit_id Required - 12345678912345 ID of your Content Owner Media Unit
offset Optional 0 0 Defines the start position for retrieving items. Use a number between 0 to 5000 for this argument.
limit Optional 10 10 The argument indicates the maximum number of items to retrieve. Use a number between 1 to 100 for this argument.

Responses

{
    "ok": true,
    "series": [
        {
            "id": "0122345",
            "title": "Sakura Blooming Trend",
            "description": "",
            "created_at": "2018-03-05T05:40:04+00:00",
            "updated_at": "2018-03-05T05:40:04+00:00",
            "cover_image": null,
            "unit":{
                "id": "0123456",
                "name": "Nordot Post",
                "status": "public",
                "signature_color": "0f0f0f",
                "header_type": "background",
                "header_position": "center",
                "copyright_owner": "Nordot Post Inc.",
                "default_post_expire_days": 0,
                "created_at": "2015-11-16T19:06:46+00:00",
                "updated_at": "2018-03-05T05:45:25+00:00",
                "header_image":{
                    "url": "https://nordot-res.cloudinary.com/ch/units/0123456/header_69.png",
                    "url_w": 400,
                    "url_h": 60,
                    "thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/ch/units/0123456/header_69.png",
                    "square_300": "https://nordot-res.cloudinary.com/t_square_300/ch/units/0123456/header_69.png"
                },
                "profile_image": null,
                "publisher":{
                    "id": "0012345",
                    "name": "Nordot Post Inc.",
                    "created_at": "2015-11-16T19:02:38+00:00",
                    "updated_at": "2018-02-06T17:29:41+00:00"
                },
                "language": "en-US",
                "timezone": "Asia/Tokyo"
            }
        },
        ...
    ],
    "paging": {
      "count": 5,
      "offset": 0,
      "limit": 10,
      "has_next": false
    }
}

If successful, the method returns an array list of “contentsholder series” object that meets the specified criteria. For more details, please refer to the “paging” and “contentsholder series” objects.

Errors

Error Code Description
no_unit_id Value for "unit_id" is not specified.
invalid_unit_id Value passed for “unit_id" is invalid.
unit_not_found The Media Unit cannot be found.
invalid_offset Value passed for “offset" is invalid.
invalid_limit Value passed for “limit" is invalid.

For other error codes, refer to the Common Errors section of this document.