contentsholder/series.info

Retrieves information associated with series in your Content Owner Media Unit

URL

GET /v1.0/contentsholder/series.info

Parameters

Argument Required Default Value Example Description
series_id Required - 12345678912345 ID of the series.

Responses

{
    "ok": true,
    "series":{
        "id": "0123456",
        "title": "Series1",
        "description": "",
        "created_at": "2017-02-07T09:30:59+00:00",
        "updated_at": "2017-05-16T05:57:26+00:00",
        "cover_image":{
            "url": "https://nordot-res.cloudinary.com/ch/series/0123456/cover_2.jpg",
            "thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/ch/series/0123456/cover_2.jpg"
    },
    "unit":{
        "id": "0012345",
        "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/0012345/header_69.png",
            "url_w": 400,
            "url_h": 60,
            "thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/ch/units/0012345/header_69.png",
            "square_300": "https://nordot-res.cloudinary.com/t_square_300/ch/units/0012345/header_69.png"
        },
        "profile_image": null,
        "publisher":{
            "id": "00112233",
            "name": "Nordot 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"
    }
}

If successful, the method returns a “contentsholder series” object that meets the specified criteria. For more details, please refer to the “contentsholder series” objects.

Errors

Error Code Description
no_series_id Value for "series_id" is not specified.
invalid_series_id Value passed for “series_id" is invalid.
series_not_found The series cannot be found.

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