ADMIN API

Download OpenAPI specification:

adhoc

adhoc_app-ott-banner-update-order_partial_update

A view that can accept PATCH requests with ID list to changes into the order of App/OTT banners to wp_all. If you don't send the entire pk list in request body for all App/OTT banners, the order of banners that not included in it won't be deterministic. Include all banners data in the request body or the request will throw an error.

Authorizations:

token

Request Body schema: application/json
required

pk_list

required

Array of integers

Each element is wp_all.id same as legacy_id from IO. ex) [1, 2, 3]

Responses

Response Schema: application/json

pk_list

required

Array of integers

Each element is wp_all.id same as legacy_id from IO. ex) [1, 2, 3]

Request samples

Payload

Content type

application/json

{"pk_list": [0
]
}

Response samples

200

Content type

application/json

{"pk_list": [0
]
}

adhoc_app-ott-banner_list

Authorizations:

token

query Parameters

service_content_type	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (AppOTTBanner)

Array

id	integer (Id) Primary keys for this table
cat_name	string (Cat name) non-empty Programs' names
post_title_kr	string (Post title kr) non-empty Title Korean version
service_content_type	string (Service content type) non-empty
ios_featured	string or null (Ios featured) <= 20 characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) <= 20 characters The order of banners. ex) 1, 2, 3, ...
ios_background_image_value	string or null (Ios background image value) <= 200 characters Banner image URL Korean ver.
ios_background_image_value_en	string or null (Ios background image value en) <= 200 characters Banner image URL English ver.
ios_featured_desc_en_line1	string or null (Ios featured desc en line1) <= 200 characters Introduction or summary of program. English ver.
ios_featured_desc_en_line2	string or null (Ios featured desc en line2) <= 200 characters Days of week for air date. English ver.
ios_featured_desc_kr_line1	string or null (Ios featured desc kr line1) <= 200 characters Introduction or summary of program. Korean ver.
ios_featured_desc_kr_line2	string or null (Ios featured desc kr line2) <= 200 characters Days of week for air date. Korean ver.

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"cat_name": "string",
"post_title_kr": "string",
"service_content_type": "string",
"ios_featured": "string",
"ios_featured_order": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"ios_featured_desc_en_line1": "string",
"ios_featured_desc_en_line2": "string",
"ios_featured_desc_kr_line1": "string",
"ios_featured_desc_kr_line2": "string"
}
]
}

adhoc_app-ott-banner_create

Authorizations:

token

Request Body schema: application/json
required

id required	integer (Id) wp_all.id same as legacy_id from IO
ios_featured	string or null (Ios featured) [ 1 .. 20 ] characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) [ 1 .. 20 ] characters The order of banners. ex) 1, 2, 3, ...
ios_background_image_value required	string or null (Ios background image value) [ 1 .. 200 ] characters Banner image URL Korean ver.
ios_background_image_value_en required	string or null (Ios background image value en) [ 1 .. 200 ] characters Banner image URL English ver.
ios_featured_desc_en_line1 required	string or null (Ios featured desc en line1) [ 1 .. 200 ] characters Introduction or summary of program. English ver.
ios_featured_desc_en_line2	string or null (Ios featured desc en line2) [ 1 .. 200 ] characters Days of week for air date. English ver.
ios_featured_desc_kr_line1 required	string or null (Ios featured desc kr line1) [ 1 .. 200 ] characters Introduction or summary of program. Korean ver.
ios_featured_desc_kr_line2	string or null (Ios featured desc kr line2) [ 1 .. 200 ] characters Days of week for air date. Korean ver.

Responses

Response Schema: application/json

id required	integer (Id) wp_all.id same as legacy_id from IO
ios_featured	string or null (Ios featured) [ 1 .. 20 ] characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) [ 1 .. 20 ] characters The order of banners. ex) 1, 2, 3, ...
ios_background_image_value required	string or null (Ios background image value) [ 1 .. 200 ] characters Banner image URL Korean ver.
ios_background_image_value_en required	string or null (Ios background image value en) [ 1 .. 200 ] characters Banner image URL English ver.
ios_featured_desc_en_line1 required	string or null (Ios featured desc en line1) [ 1 .. 200 ] characters Introduction or summary of program. English ver.
ios_featured_desc_en_line2	string or null (Ios featured desc en line2) [ 1 .. 200 ] characters Days of week for air date. English ver.
ios_featured_desc_kr_line1 required	string or null (Ios featured desc kr line1) [ 1 .. 200 ] characters Introduction or summary of program. Korean ver.
ios_featured_desc_kr_line2	string or null (Ios featured desc kr line2) [ 1 .. 200 ] characters Days of week for air date. Korean ver.

Request samples

Payload

Content type

application/json

{"id": 0,
"ios_featured": "string",
"ios_featured_order": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"ios_featured_desc_en_line1": "string",
"ios_featured_desc_en_line2": "string",
"ios_featured_desc_kr_line1": "string",
"ios_featured_desc_kr_line2": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"ios_featured": "string",
"ios_featured_order": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"ios_featured_desc_en_line1": "string",
"ios_featured_desc_en_line2": "string",
"ios_featured_desc_kr_line1": "string",
"ios_featured_desc_kr_line2": "string"
}

adhoc_app-ott-banner_read

Authorizations:

token

path Parameters

id

required

string

Responses

Response Schema: application/json

id	integer (Id) Primary keys for this table
cat_name	string (Cat name) non-empty Programs' names
post_title_kr	string (Post title kr) non-empty Title Korean version
service_content_type	string (Service content type) non-empty
ios_featured	string or null (Ios featured) <= 20 characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) <= 20 characters The order of banners. ex) 1, 2, 3, ...
ios_background_image_value	string or null (Ios background image value) <= 200 characters Banner image URL Korean ver.
ios_background_image_value_en	string or null (Ios background image value en) <= 200 characters Banner image URL English ver.
ios_featured_desc_en_line1	string or null (Ios featured desc en line1) <= 200 characters Introduction or summary of program. English ver.
ios_featured_desc_en_line2	string or null (Ios featured desc en line2) <= 200 characters Days of week for air date. English ver.
ios_featured_desc_kr_line1	string or null (Ios featured desc kr line1) <= 200 characters Introduction or summary of program. Korean ver.
ios_featured_desc_kr_line2	string or null (Ios featured desc kr line2) <= 200 characters Days of week for air date. Korean ver.

Response samples

200

Content type

application/json

{"id": 0,
"cat_name": "string",
"post_title_kr": "string",
"service_content_type": "string",
"ios_featured": "string",
"ios_featured_order": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"ios_featured_desc_en_line1": "string",
"ios_featured_desc_en_line2": "string",
"ios_featured_desc_kr_line1": "string",
"ios_featured_desc_kr_line2": "string"
}

adhoc_app-ott-banner_update

Authorizations:

token

path Parameters

id

required

string

Request Body schema: application/json
required

ios_featured	string or null (Ios featured) <= 20 characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) <= 20 characters The order of banners. ex) 1, 2, 3, ...
ios_background_image_value required	string or null (Ios background image value) <= 200 characters Banner image URL Korean ver.
ios_background_image_value_en required	string or null (Ios background image value en) <= 200 characters Banner image URL English ver.
ios_featured_desc_en_line1 required	string or null (Ios featured desc en line1) <= 200 characters Introduction or summary of program. English ver.
ios_featured_desc_en_line2	string or null (Ios featured desc en line2) <= 200 characters Days of week for air date. English ver.
ios_featured_desc_kr_line1 required	string or null (Ios featured desc kr line1) <= 200 characters Introduction or summary of program. Korean ver.
ios_featured_desc_kr_line2	string or null (Ios featured desc kr line2) <= 200 characters Days of week for air date. Korean ver.

Responses

Response Schema: application/json

id	integer (Id) Primary keys for this table
cat_name	string (Cat name) non-empty Programs' names
post_title_kr	string (Post title kr) non-empty Title Korean version
service_content_type	string (Service content type) non-empty
ios_featured	string or null (Ios featured) <= 20 characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) <= 20 characters The order of banners. ex) 1, 2, 3, ...
ios_background_image_value required	string or null (Ios background image value) <= 200 characters Banner image URL Korean ver.
ios_background_image_value_en required	string or null (Ios background image value en) <= 200 characters Banner image URL English ver.
ios_featured_desc_en_line1 required	string or null (Ios featured desc en line1) <= 200 characters Introduction or summary of program. English ver.
ios_featured_desc_en_line2	string or null (Ios featured desc en line2) <= 200 characters Days of week for air date. English ver.
ios_featured_desc_kr_line1 required	string or null (Ios featured desc kr line1) <= 200 characters Introduction or summary of program. Korean ver.
ios_featured_desc_kr_line2	string or null (Ios featured desc kr line2) <= 200 characters Days of week for air date. Korean ver.

Request samples

Payload

Content type

application/json

{"ios_featured": "string",
"ios_featured_order": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"ios_featured_desc_en_line1": "string",
"ios_featured_desc_en_line2": "string",
"ios_featured_desc_kr_line1": "string",
"ios_featured_desc_kr_line2": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"cat_name": "string",
"post_title_kr": "string",
"service_content_type": "string",
"ios_featured": "string",
"ios_featured_order": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"ios_featured_desc_en_line1": "string",
"ios_featured_desc_en_line2": "string",
"ios_featured_desc_kr_line1": "string",
"ios_featured_desc_kr_line2": "string"
}

adhoc_app-ott-banner_delete

Authorizations:

token

path Parameters

id

required

string

Responses

adhoc_app-ott-banner_partial_update

Authorizations:

token

path Parameters

id

required

string

Request Body schema: application/json
required

ios_featured	string or null (Ios featured) <= 20 characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) <= 20 characters The order of banners. ex) 1, 2, 3, ...
ios_background_image_value	string or null (Ios background image value) <= 200 characters Banner image URL Korean ver.
ios_background_image_value_en	string or null (Ios background image value en) <= 200 characters Banner image URL English ver.
ios_featured_desc_en_line1	string or null (Ios featured desc en line1) <= 200 characters Introduction or summary of program. English ver.
ios_featured_desc_en_line2	string or null (Ios featured desc en line2) <= 200 characters Days of week for air date. English ver.
ios_featured_desc_kr_line1	string or null (Ios featured desc kr line1) <= 200 characters Introduction or summary of program. Korean ver.
ios_featured_desc_kr_line2	string or null (Ios featured desc kr line2) <= 200 characters Days of week for air date. Korean ver.

Responses

Response Schema: application/json

id	integer (Id) Primary keys for this table
cat_name	string (Cat name) non-empty Programs' names
post_title_kr	string (Post title kr) non-empty Title Korean version
service_content_type	string (Service content type) non-empty
ios_featured	string or null (Ios featured) <= 20 characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) <= 20 characters The order of banners. ex) 1, 2, 3, ...
ios_background_image_value	string or null (Ios background image value) <= 200 characters Banner image URL Korean ver.
ios_background_image_value_en	string or null (Ios background image value en) <= 200 characters Banner image URL English ver.
ios_featured_desc_en_line1	string or null (Ios featured desc en line1) <= 200 characters Introduction or summary of program. English ver.
ios_featured_desc_en_line2	string or null (Ios featured desc en line2) <= 200 characters Days of week for air date. English ver.
ios_featured_desc_kr_line1	string or null (Ios featured desc kr line1) <= 200 characters Introduction or summary of program. Korean ver.
ios_featured_desc_kr_line2	string or null (Ios featured desc kr line2) <= 200 characters Days of week for air date. Korean ver.

Request samples

Payload

Content type

application/json

{"ios_featured": "string",
"ios_featured_order": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"ios_featured_desc_en_line1": "string",
"ios_featured_desc_en_line2": "string",
"ios_featured_desc_kr_line1": "string",
"ios_featured_desc_kr_line2": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"cat_name": "string",
"post_title_kr": "string",
"service_content_type": "string",
"ios_featured": "string",
"ios_featured_order": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"ios_featured_desc_en_line1": "string",
"ios_featured_desc_en_line2": "string",
"ios_featured_desc_kr_line1": "string",
"ios_featured_desc_kr_line2": "string"
}

adhoc_check-episode-ids-by-video-id_read

Authorizations:

token

path Parameters

video_id

required

string

Responses

Response Schema: application/json

ids

required

Array of integers

Response samples

200

Content type

application/json

{"ids": [0
]
}

adhoc_coupon-group_list

Authorizations:

token

query Parameters

name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (CouponGroupList)

Array

id	integer (Id)
name required	string (Name) [ 1 .. 100 ] characters
type required	string (Type) Enum: "standard" "premium" "family" "pay_per_view"
description required	string (Description) [ 1 .. 200 ] characters
begin required	string <date> (Begin)
end required	string <date> (End)
unique required	boolean (Unique)
duration	integer (Duration) [ 1 .. 2147483647 ] This value is not require when type is pay_per_view
created_timestamp	string <date-time> (Created timestamp)
num_of_issued	integer (Num of issued) The number of coupons issued
num_of_redeemed	integer (Num of redeemed) The number of coupons redeemed

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"name": "string",
"type": "standard",
"description": "string",
"begin": "2019-08-24",
"end": "2019-08-24",
"unique": true,
"duration": 1,
"created_timestamp": "2019-08-24T14:15:22Z",
"num_of_issued": 0,
"num_of_redeemed": 0
}
]
}

adhoc_coupon-group_create

Authorizations:

token

Request Body schema: application/json
required

name required	string (Name) [ 1 .. 100 ] characters
description required	string (Description) [ 1 .. 200 ] characters
type required	string (Type) Enum: "standard" "premium" "family" "pay_per_view"
begin required	string <date> (Begin)
end required	string <date> (End)
unique required	boolean (Unique)
duration	integer (Duration) [ 1 .. 2147483647 ] This value is not require when type is pay_per_view
num_to_issue required	integer (Num to issue) The number of coupons to be issued. This is used for request only.

Responses

Response Schema: application/json

name required	string (Name) [ 1 .. 100 ] characters
description required	string (Description) [ 1 .. 200 ] characters
type required	string (Type) Enum: "standard" "premium" "family" "pay_per_view"
begin required	string <date> (Begin)
end required	string <date> (End)
unique required	boolean (Unique)
duration	integer (Duration) [ 1 .. 2147483647 ] This value is not require when type is pay_per_view
created_timestamp	string <date-time> (Created timestamp)
num_to_issue required	integer (Num to issue) The number of coupons to be issued. This is used for request only.

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "standard",
"begin": "2019-08-24",
"end": "2019-08-24",
"unique": true,
"duration": 1,
"num_to_issue": 0
}

Response samples

201

Content type

application/json

{"name": "string",
"description": "string",
"type": "standard",
"begin": "2019-08-24",
"end": "2019-08-24",
"unique": true,
"duration": 1,
"created_timestamp": "2019-08-24T14:15:22Z",
"num_to_issue": 0
}

adhoc_coupon-group_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this coupon group.

Responses

Response Schema: application/json

id	integer (Id)
name required	string (Name) [ 1 .. 100 ] characters
type required	string (Type) Enum: "standard" "premium" "family" "pay_per_view"
description required	string (Description) [ 1 .. 200 ] characters
begin required	string <date> (Begin)
end required	string <date> (End)
unique required	boolean (Unique)
duration	integer (Duration) [ 1 .. 2147483647 ] This value is not require when type is pay_per_view
created_timestamp	string <date-time> (Created timestamp)
num_of_issued	integer (Num of issued) The number of coupons issued
num_of_redeemed	integer (Num of redeemed) The number of coupons redeemed

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"type": "standard",
"description": "string",
"begin": "2019-08-24",
"end": "2019-08-24",
"unique": true,
"duration": 1,
"created_timestamp": "2019-08-24T14:15:22Z",
"num_of_issued": 0,
"num_of_redeemed": 0
}

adhoc_coupon-group_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this coupon group.

Request Body schema: application/json
required

name required	string (Name) [ 1 .. 100 ] characters
description required	string (Description) [ 1 .. 200 ] characters
type required	string (Type) Enum: "standard" "premium" "family" "pay_per_view"
begin required	string <date> (Begin)
end required	string <date> (End)
unique required	boolean (Unique)
duration	integer (Duration) [ 1 .. 2147483647 ] This value is not require when type is pay_per_view

Responses

Response Schema: application/json

id	integer (Id)
name required	string (Name) [ 1 .. 100 ] characters
description required	string (Description) [ 1 .. 200 ] characters
type required	string (Type) Enum: "standard" "premium" "family" "pay_per_view"
begin required	string <date> (Begin)
end required	string <date> (End)
unique required	boolean (Unique)
duration	integer (Duration) [ 1 .. 2147483647 ] This value is not require when type is pay_per_view
created_timestamp	string <date-time> (Created timestamp)

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "standard",
"begin": "2019-08-24",
"end": "2019-08-24",
"unique": true,
"duration": 1
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"type": "standard",
"begin": "2019-08-24",
"end": "2019-08-24",
"unique": true,
"duration": 1,
"created_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_coupon-group_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this coupon group.

Responses

adhoc_coupon-group_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this coupon group.

Request Body schema: application/json
required

name required	string (Name) [ 1 .. 100 ] characters
description required	string (Description) [ 1 .. 200 ] characters
type required	string (Type) Enum: "standard" "premium" "family" "pay_per_view"
begin required	string <date> (Begin)
end required	string <date> (End)
unique required	boolean (Unique)
duration	integer (Duration) [ 1 .. 2147483647 ] This value is not require when type is pay_per_view

Responses

Response Schema: application/json

id	integer (Id)
name required	string (Name) [ 1 .. 100 ] characters
description required	string (Description) [ 1 .. 200 ] characters
type required	string (Type) Enum: "standard" "premium" "family" "pay_per_view"
begin required	string <date> (Begin)
end required	string <date> (End)
unique required	boolean (Unique)
duration	integer (Duration) [ 1 .. 2147483647 ] This value is not require when type is pay_per_view
created_timestamp	string <date-time> (Created timestamp)

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "standard",
"begin": "2019-08-24",
"end": "2019-08-24",
"unique": true,
"duration": 1
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"type": "standard",
"begin": "2019-08-24",
"end": "2019-08-24",
"unique": true,
"duration": 1,
"created_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_coupon-list_list

Authorizations:

token

query Parameters

coupon_group__id	number
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (CouponListList)

Array

id	integer (Id)
coupon_group required	integer (Coupon group)
user	integer or null (User)
code required	string (Code) [ 1 .. 30 ] characters
validated	boolean (Validated)
validated_time	string or null <date-time> (Validated time)
ip	string or null (Ip) <= 50 characters
expire_time	string or null <date-time> (Expire time)
amount	number (Amount)
created_timestamp	string <date-time> (Created timestamp)
updated_timestamp	string <date-time> (Updated timestamp)
group_name	string (Group name)
email	string (Email)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"coupon_group": 0,
"user": 0,
"code": "string",
"validated": true,
"validated_time": "2019-08-24T14:15:22Z",
"ip": "string",
"expire_time": "2019-08-24T14:15:22Z",
"amount": 0,
"created_timestamp": "2019-08-24T14:15:22Z",
"updated_timestamp": "2019-08-24T14:15:22Z",
"group_name": "string",
"email": "string"
}
]
}

adhoc_coupon-list_create

Authorizations:

token

Request Body schema: application/json
required

coupon_group required	integer (Coupon group)
user	integer or null (User)
code required	string (Code) [ 1 .. 30 ] characters
validated	boolean (Validated)
validated_time	string or null <date-time> (Validated time)
ip	string or null (Ip) <= 50 characters
expire_time	string or null <date-time> (Expire time)
amount	number (Amount)

Responses

Response Schema: application/json

id	integer (Id)
coupon_group required	integer (Coupon group)
user	integer or null (User)
code required	string (Code) [ 1 .. 30 ] characters
validated	boolean (Validated)
validated_time	string or null <date-time> (Validated time)
ip	string or null (Ip) <= 50 characters
expire_time	string or null <date-time> (Expire time)
amount	number (Amount)
created_timestamp	string <date-time> (Created timestamp)
updated_timestamp	string <date-time> (Updated timestamp)

Request samples

Payload

Content type

application/json

{"coupon_group": 0,
"user": 0,
"code": "string",
"validated": true,
"validated_time": "2019-08-24T14:15:22Z",
"ip": "string",
"expire_time": "2019-08-24T14:15:22Z",
"amount": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"coupon_group": 0,
"user": 0,
"code": "string",
"validated": true,
"validated_time": "2019-08-24T14:15:22Z",
"ip": "string",
"expire_time": "2019-08-24T14:15:22Z",
"amount": 0,
"created_timestamp": "2019-08-24T14:15:22Z",
"updated_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_coupon-list_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this coupon list.

Responses

Response Schema: application/json

id	integer (Id)
coupon_group required	integer (Coupon group)
user	integer or null (User)
code required	string (Code) [ 1 .. 30 ] characters
validated	boolean (Validated)
validated_time	string or null <date-time> (Validated time)
ip	string or null (Ip) <= 50 characters
expire_time	string or null <date-time> (Expire time)
amount	number (Amount)
created_timestamp	string <date-time> (Created timestamp)
updated_timestamp	string <date-time> (Updated timestamp)

Response samples

200

Content type

application/json

{"id": 0,
"coupon_group": 0,
"user": 0,
"code": "string",
"validated": true,
"validated_time": "2019-08-24T14:15:22Z",
"ip": "string",
"expire_time": "2019-08-24T14:15:22Z",
"amount": 0,
"created_timestamp": "2019-08-24T14:15:22Z",
"updated_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_coupon-list_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this coupon list.

Request Body schema: application/json
required

coupon_group required	integer (Coupon group)
user	integer or null (User)
code required	string (Code) [ 1 .. 30 ] characters
validated	boolean (Validated)
validated_time	string or null <date-time> (Validated time)
ip	string or null (Ip) <= 50 characters
expire_time	string or null <date-time> (Expire time)
amount	number (Amount)

Responses

Response Schema: application/json

id	integer (Id)
coupon_group required	integer (Coupon group)
user	integer or null (User)
code required	string (Code) [ 1 .. 30 ] characters
validated	boolean (Validated)
validated_time	string or null <date-time> (Validated time)
ip	string or null (Ip) <= 50 characters
expire_time	string or null <date-time> (Expire time)
amount	number (Amount)
created_timestamp	string <date-time> (Created timestamp)
updated_timestamp	string <date-time> (Updated timestamp)

Request samples

Payload

Content type

application/json

{"coupon_group": 0,
"user": 0,
"code": "string",
"validated": true,
"validated_time": "2019-08-24T14:15:22Z",
"ip": "string",
"expire_time": "2019-08-24T14:15:22Z",
"amount": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"coupon_group": 0,
"user": 0,
"code": "string",
"validated": true,
"validated_time": "2019-08-24T14:15:22Z",
"ip": "string",
"expire_time": "2019-08-24T14:15:22Z",
"amount": 0,
"created_timestamp": "2019-08-24T14:15:22Z",
"updated_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_coupon-list_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this coupon list.

Responses

adhoc_coupon-list_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this coupon list.

Request Body schema: application/json
required

coupon_group required	integer (Coupon group)
user	integer or null (User)
code required	string (Code) [ 1 .. 30 ] characters
validated	boolean (Validated)
validated_time	string or null <date-time> (Validated time)
ip	string or null (Ip) <= 50 characters
expire_time	string or null <date-time> (Expire time)
amount	number (Amount)

Responses

Response Schema: application/json

id	integer (Id)
coupon_group required	integer (Coupon group)
user	integer or null (User)
code required	string (Code) [ 1 .. 30 ] characters
validated	boolean (Validated)
validated_time	string or null <date-time> (Validated time)
ip	string or null (Ip) <= 50 characters
expire_time	string or null <date-time> (Expire time)
amount	number (Amount)
created_timestamp	string <date-time> (Created timestamp)
updated_timestamp	string <date-time> (Updated timestamp)

Request samples

Payload

Content type

application/json

{"coupon_group": 0,
"user": 0,
"code": "string",
"validated": true,
"validated_time": "2019-08-24T14:15:22Z",
"ip": "string",
"expire_time": "2019-08-24T14:15:22Z",
"amount": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"coupon_group": 0,
"user": 0,
"code": "string",
"validated": true,
"validated_time": "2019-08-24T14:15:22Z",
"ip": "string",
"expire_time": "2019-08-24T14:15:22Z",
"amount": 0,
"created_timestamp": "2019-08-24T14:15:22Z",
"updated_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_episode_count_list_list

Authorizations:

token

Responses

Response Schema: application/json

Array

program_page_id required	integer (Program page id) Program(legacy db's row of type page)'s id
episodes_count required	integer (Episodes count) The number of episodes the program has

Response samples

200

Content type

application/json

[{"program_page_id": 0,
"episodes_count": 0
}
]

adhoc_main-banner_list

Authorizations:

token

query Parameters

lang	string
for_plus	string
archive	string
valid	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (MainBanner)

Array

id	integer (Id)
banner_type	integer (Banner type) This is used for response only.
valid	boolean (Valid) This is used for response only.
lang required	string (Lang) Enum: "kr" "en"
for_plus required	integer (For plus)
archive required	integer (Archive)
cat_id required	integer (Cat id) [ -2147483648 .. 2147483647 ]
cat_name required	string (Cat name) [ 1 .. 255 ] characters
ordering required	integer (Ordering) [ -2147483648 .. 2147483647 ]
image_url required	string (Image url) [ 1 .. 255 ] characters
landing_url	string or null (Landing url) <= 255 characters
start_timestamp required	string <date-time> (Start timestamp)
end_timestamp required	string <date-time> (End timestamp)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"banner_type": 0,
"valid": true,
"lang": "kr",
"for_plus": 0,
"archive": 0,
"cat_id": -2147483648,
"cat_name": "string",
"ordering": -2147483648,
"image_url": "string",
"landing_url": "string",
"start_timestamp": "2019-08-24T14:15:22Z",
"end_timestamp": "2019-08-24T14:15:22Z"
}
]
}

adhoc_main-banner_create

Authorizations:

token

Request Body schema: application/json
required

lang required	string (Lang) Enum: "kr" "en"
for_plus required	integer (For plus)
archive required	integer (Archive)
cat_id required	integer (Cat id) [ -2147483648 .. 2147483647 ]
cat_name required	string (Cat name) [ 1 .. 255 ] characters
ordering required	integer (Ordering) [ -2147483648 .. 2147483647 ]
image_url required	string (Image url) [ 1 .. 255 ] characters
landing_url	string or null (Landing url) <= 255 characters
start_timestamp required	string <date-time> (Start timestamp)
end_timestamp required	string <date-time> (End timestamp)

Responses

Response Schema: application/json

id	integer (Id)
banner_type	integer (Banner type) This is used for response only.
valid	boolean (Valid) This is used for response only.
lang required	string (Lang) Enum: "kr" "en"
for_plus required	integer (For plus)
archive required	integer (Archive)
cat_id required	integer (Cat id) [ -2147483648 .. 2147483647 ]
cat_name required	string (Cat name) [ 1 .. 255 ] characters
ordering required	integer (Ordering) [ -2147483648 .. 2147483647 ]
image_url required	string (Image url) [ 1 .. 255 ] characters
landing_url	string or null (Landing url) <= 255 characters
start_timestamp required	string <date-time> (Start timestamp)
end_timestamp required	string <date-time> (End timestamp)

Request samples

Payload

Content type

application/json

{"lang": "kr",
"for_plus": 0,
"archive": 0,
"cat_id": -2147483648,
"cat_name": "string",
"ordering": -2147483648,
"image_url": "string",
"landing_url": "string",
"start_timestamp": "2019-08-24T14:15:22Z",
"end_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": 0,
"banner_type": 0,
"valid": true,
"lang": "kr",
"for_plus": 0,
"archive": 0,
"cat_id": -2147483648,
"cat_name": "string",
"ordering": -2147483648,
"image_url": "string",
"landing_url": "string",
"start_timestamp": "2019-08-24T14:15:22Z",
"end_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_main-banner_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this schedule banner.

Responses

Response Schema: application/json

id	integer (Id)
banner_type	integer (Banner type) This is used for response only.
valid	boolean (Valid) This is used for response only.
lang required	string (Lang) Enum: "kr" "en"
for_plus required	integer (For plus)
archive required	integer (Archive)
cat_id required	integer (Cat id) [ -2147483648 .. 2147483647 ]
cat_name required	string (Cat name) [ 1 .. 255 ] characters
ordering required	integer (Ordering) [ -2147483648 .. 2147483647 ]
image_url required	string (Image url) [ 1 .. 255 ] characters
landing_url	string or null (Landing url) <= 255 characters
start_timestamp required	string <date-time> (Start timestamp)
end_timestamp required	string <date-time> (End timestamp)

Response samples

200

Content type

application/json

{"id": 0,
"banner_type": 0,
"valid": true,
"lang": "kr",
"for_plus": 0,
"archive": 0,
"cat_id": -2147483648,
"cat_name": "string",
"ordering": -2147483648,
"image_url": "string",
"landing_url": "string",
"start_timestamp": "2019-08-24T14:15:22Z",
"end_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_main-banner_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this schedule banner.

Request Body schema: application/json
required

lang required	string (Lang) Enum: "kr" "en"
for_plus required	integer (For plus)
archive required	integer (Archive)
cat_id required	integer (Cat id) [ -2147483648 .. 2147483647 ]
cat_name required	string (Cat name) [ 1 .. 255 ] characters
ordering required	integer (Ordering) [ -2147483648 .. 2147483647 ]
image_url required	string (Image url) [ 1 .. 255 ] characters
landing_url	string or null (Landing url) <= 255 characters
start_timestamp required	string <date-time> (Start timestamp)
end_timestamp required	string <date-time> (End timestamp)

Responses

Response Schema: application/json

id	integer (Id)
banner_type	integer (Banner type) This is used for response only.
valid	boolean (Valid) This is used for response only.
lang required	string (Lang) Enum: "kr" "en"
for_plus required	integer (For plus)
archive required	integer (Archive)
cat_id required	integer (Cat id) [ -2147483648 .. 2147483647 ]
cat_name required	string (Cat name) [ 1 .. 255 ] characters
ordering required	integer (Ordering) [ -2147483648 .. 2147483647 ]
image_url required	string (Image url) [ 1 .. 255 ] characters
landing_url	string or null (Landing url) <= 255 characters
start_timestamp required	string <date-time> (Start timestamp)
end_timestamp required	string <date-time> (End timestamp)

Request samples

Payload

Content type

application/json

{"lang": "kr",
"for_plus": 0,
"archive": 0,
"cat_id": -2147483648,
"cat_name": "string",
"ordering": -2147483648,
"image_url": "string",
"landing_url": "string",
"start_timestamp": "2019-08-24T14:15:22Z",
"end_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"banner_type": 0,
"valid": true,
"lang": "kr",
"for_plus": 0,
"archive": 0,
"cat_id": -2147483648,
"cat_name": "string",
"ordering": -2147483648,
"image_url": "string",
"landing_url": "string",
"start_timestamp": "2019-08-24T14:15:22Z",
"end_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_main-banner_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this schedule banner.

Responses

adhoc_main-banner_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this schedule banner.

Request Body schema: application/json
required

lang required	string (Lang) Enum: "kr" "en"
for_plus required	integer (For plus)
archive required	integer (Archive)
cat_id required	integer (Cat id) [ -2147483648 .. 2147483647 ]
cat_name required	string (Cat name) [ 1 .. 255 ] characters
ordering required	integer (Ordering) [ -2147483648 .. 2147483647 ]
image_url required	string (Image url) [ 1 .. 255 ] characters
landing_url	string or null (Landing url) <= 255 characters
start_timestamp required	string <date-time> (Start timestamp)
end_timestamp required	string <date-time> (End timestamp)

Responses

Response Schema: application/json

id	integer (Id)
banner_type	integer (Banner type) This is used for response only.
valid	boolean (Valid) This is used for response only.
lang required	string (Lang) Enum: "kr" "en"
for_plus required	integer (For plus)
archive required	integer (Archive)
cat_id required	integer (Cat id) [ -2147483648 .. 2147483647 ]
cat_name required	string (Cat name) [ 1 .. 255 ] characters
ordering required	integer (Ordering) [ -2147483648 .. 2147483647 ]
image_url required	string (Image url) [ 1 .. 255 ] characters
landing_url	string or null (Landing url) <= 255 characters
start_timestamp required	string <date-time> (Start timestamp)
end_timestamp required	string <date-time> (End timestamp)

Request samples

Payload

Content type

application/json

{"lang": "kr",
"for_plus": 0,
"archive": 0,
"cat_id": -2147483648,
"cat_name": "string",
"ordering": -2147483648,
"image_url": "string",
"landing_url": "string",
"start_timestamp": "2019-08-24T14:15:22Z",
"end_timestamp": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"banner_type": 0,
"valid": true,
"lang": "kr",
"for_plus": 0,
"archive": 0,
"cat_id": -2147483648,
"cat_name": "string",
"ordering": -2147483648,
"image_url": "string",
"landing_url": "string",
"start_timestamp": "2019-08-24T14:15:22Z",
"end_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_odk-episodes_list

Authorizations:

token

query Parameters

search	string A search term.
ordering	string Which field to use when ordering the results.
cat_name	string
post_title_kr	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ODKEpisode)

Array

id	integer (Id) Primary keys for this table
post_title_kr required	string (Post title kr) non-empty
post_title_en required	string (Post title en) non-empty
post_name	string (Post name) non-empty English full name of program or episode
thumbnail_image_value required	string (Thumbnail image value)
cat_name	string (Cat name) non-empty Programs' names
target_program required	string (Target program) non-empty
parent_name required	string (Parent name) non-empty
episode_no required	string (Episode no) non-empty
episode_ids required	Array of strings or null
service_content_type required	string (Service content type) non-empty
post_status required	string (Post status) non-empty

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"post_title_kr": "string",
"post_title_en": "string",
"post_name": "string",
"thumbnail_image_value": "string",
"cat_name": "string",
"target_program": "string",
"parent_name": "string",
"episode_no": "string",
"episode_ids": ["string"
],
"service_content_type": "string",
"post_status": "string"
}
]
}

adhoc_odk-episodes_create

Yau can create a relay episode on legacy db using this api.

Authorizations:

token

Request Body schema: application/json
required

post_title_kr required	string (Post title kr) non-empty
post_title_en required	string (Post title en) non-empty
thumbnail_image_value required	string (Thumbnail image value)
target_program required	string (Target program) non-empty
parent_name required	string (Parent name) non-empty
episode_no required	string (Episode no) non-empty
episode_ids required	Array of strings or null
service_content_type required	string (Service content type) non-empty
post_status required	string (Post status) non-empty

Responses

Response Schema: application/json

id	integer (Id) Primary keys for this table
post_title_kr required	string (Post title kr) non-empty
post_title_en required	string (Post title en) non-empty
post_name	string (Post name) non-empty English full name of program or episode
thumbnail_image_value required	string (Thumbnail image value)
cat_name	string (Cat name) non-empty Programs' names
target_program required	string (Target program) non-empty
parent_name required	string (Parent name) non-empty
episode_no required	string (Episode no) non-empty
episode_ids required	Array of strings or null
service_content_type required	string (Service content type) non-empty
post_status required	string (Post status) non-empty

Request samples

Payload

Content type

application/json

{"post_title_kr": "string",
"post_title_en": "string",
"thumbnail_image_value": "string",
"target_program": "string",
"parent_name": "string",
"episode_no": "string",
"episode_ids": ["string"
],
"service_content_type": "string",
"post_status": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"post_title_kr": "string",
"post_title_en": "string",
"post_name": "string",
"thumbnail_image_value": "string",
"cat_name": "string",
"target_program": "string",
"parent_name": "string",
"episode_no": "string",
"episode_ids": ["string"
],
"service_content_type": "string",
"post_status": "string"
}

adhoc_odk-episodes_read

Authorizations:

token

path Parameters

id

required

integer

Primary keys for this table

Responses

Response Schema: application/json

id	integer (Id) Primary keys for this table
post_title_kr required	string (Post title kr) non-empty
post_title_en required	string (Post title en) non-empty
post_name	string (Post name) non-empty English full name of program or episode
thumbnail_image_value required	string (Thumbnail image value)
cat_name	string (Cat name) non-empty Programs' names
target_program required	string (Target program) non-empty
parent_name required	string (Parent name) non-empty
episode_no required	string (Episode no) non-empty
episode_ids required	Array of strings or null
service_content_type required	string (Service content type) non-empty
post_status required	string (Post status) non-empty

Response samples

200

Content type

application/json

{"id": 0,
"post_title_kr": "string",
"post_title_en": "string",
"post_name": "string",
"thumbnail_image_value": "string",
"cat_name": "string",
"target_program": "string",
"parent_name": "string",
"episode_no": "string",
"episode_ids": ["string"
],
"service_content_type": "string",
"post_status": "string"
}

adhoc_odk-programs_list

Authorizations:

token

query Parameters

search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ODKProgram)

Array

id required	integer (Id) [ -2147483648 .. 2147483647 ] Primary keys for this table
post_title_kr	string or null (Post title kr) <= 200 characters Title Korean version
post_title_en	string or null (Post title en) <= 200 characters Title English version
post_name	string or null (Post name) <= 200 characters English full name of program or episode
main_poster_kr required	string (Main poster kr)
cat_name	string or null (Cat name) <= 200 characters Programs' names
service_content_type	string or null (Service content type) <= 20 characters
post_status	string or null (Post status) <= 20 characters Status that users see with Publish, Private, Trash or NULL
parent_name	string or null (Parent name) <= 200 characters Categories' names

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": -2147483648,
"post_title_kr": "string",
"post_title_en": "string",
"post_name": "string",
"main_poster_kr": "string",
"cat_name": "string",
"service_content_type": "string",
"post_status": "string",
"parent_name": "string"
}
]
}

adhoc_odk-programs_read

Authorizations:

token

path Parameters

id

required

integer

Primary keys for this table

Responses

Response Schema: application/json

id required	integer (Id) [ -2147483648 .. 2147483647 ] Primary keys for this table
post_title_kr	string or null (Post title kr) <= 200 characters Title Korean version
post_title_en	string or null (Post title en) <= 200 characters Title English version
post_name	string or null (Post name) <= 200 characters English full name of program or episode
main_poster_kr required	string (Main poster kr)
cat_name	string or null (Cat name) <= 200 characters Programs' names
service_content_type	string or null (Service content type) <= 20 characters
post_status	string or null (Post status) <= 20 characters Status that users see with Publish, Private, Trash or NULL
parent_name	string or null (Parent name) <= 200 characters Categories' names

Response samples

200

Content type

application/json

{"id": -2147483648,
"post_title_kr": "string",
"post_title_en": "string",
"post_name": "string",
"main_poster_kr": "string",
"cat_name": "string",
"service_content_type": "string",
"post_status": "string",
"parent_name": "string"
}

adhoc_odk-video-metadata-update_partial_update

A view that can accept PATCH requests with JSON content to update meta of video to wp_all. If the status is 51 and video url are updated all, the response will be shown as request data. If the status is not 51, there is no transcoded_videos field in request data.

Authorizations:

token

Request Body schema: application/json
required

episode_id

required

string (Episode id) non-empty

status

required

string (Status)

Enum: "0" "10" "40" "51" -1 -2 -3 -4 -8 -12

Array of objects (SegmentedVideo)

Array

type required	string (Type) Enum: "file" "hls"
url required	string (Url) non-empty
preset	string or null (Preset) non-empty

duration

required

integer (Duration)

video_id

integer (Video id)

Responses

Response Schema: application/json

episode_id

required

string (Episode id) non-empty

status

required

string (Status)

Enum: "0" "10" "40" "51" -1 -2 -3 -4 -8 -12

Array of objects (SegmentedVideo)

Array

type required	string (Type) Enum: "file" "hls"
url required	string (Url) non-empty
preset	string or null (Preset) non-empty

duration

required

integer (Duration)

video_id

integer (Video id)

Request samples

Payload

Content type

application/json

{"episode_id": "string",
"status": "0",
"transcoded_videos": [{"type": "file",
"url": "string",
"preset": "string"
}
],
"duration": 0,
"video_id": 0
}

Response samples

200

Content type

application/json

{"episode_id": "string",
"status": "0",
"transcoded_videos": [{"type": "file",
"url": "string",
"preset": "string"
}
],
"duration": 0,
"video_id": 0
}

adhoc_odkbox_categories_list

Authorizations:

token

Responses

Response Schema: application/json

Array

section_id required	integer (Section id)
title required	string (Title) non-empty
title_kr required	string (Title kr) non-empty

Response samples

200

Content type

application/json

[{"section_id": 0,
"title": "string",
"title_kr": "string"
}
]

adhoc_odkbox_episode_read

Authorizations:

token

path Parameters

id

required

string

Responses

Response Schema: application/json

Array

asset_id required	integer (Asset id) wp_all.id
item_id required	integer (Item id) wp_all.id
page_id required	integer (Page id) wp_all.cat_id
no required	string (No) non-empty wp_all.episode_no
name required	string (Name) non-empty
name_kr required	string (Name kr) non-empty
thumbnail_url required	string (Thumbnail url) non-empty
vod_url required	string (Vod url) non-empty
air_date required	string (Air date) non-empty
runtime required	string (Runtime) non-empty
subtitle_url_en required	string (Subtitle url en) non-empty
subtitle_url_chs required	string (Subtitle url chs) non-empty
subtitle_url_cht required	string (Subtitle url cht) non-empty
subtitle_url_es required	string (Subtitle url es) non-empty
subtitle_url_ko required	string (Subtitle url ko) non-empty
subtitle_url_pt required	string (Subtitle url pt) non-empty
updated_at required	string (Updated at) non-empty
guid required	string (Guid) non-empty

Response samples

200

Content type

application/json

[{"asset_id": 0,
"item_id": 0,
"page_id": 0,
"no": "string",
"name": "string",
"name_kr": "string",
"thumbnail_url": "string",
"vod_url": "string",
"air_date": "string",
"runtime": "string",
"subtitle_url_en": "string",
"subtitle_url_chs": "string",
"subtitle_url_cht": "string",
"subtitle_url_es": "string",
"subtitle_url_ko": "string",
"subtitle_url_pt": "string",
"updated_at": "string",
"guid": "string"
}
]

adhoc_odkbox_episodes_list

Authorizations:

token

Responses

Response Schema: application/json

Array

asset_id required	integer (Asset id) wp_all.id
item_id required	integer (Item id) wp_all.id
page_id required	integer (Page id) wp_all.cat_id
no required	string (No) non-empty wp_all.episode_no
name required	string (Name) non-empty
name_kr required	string (Name kr) non-empty
thumbnail_url required	string (Thumbnail url) non-empty
vod_url required	string (Vod url) non-empty
air_date required	string (Air date) non-empty
runtime required	string (Runtime) non-empty
subtitle_url_en required	string (Subtitle url en) non-empty
subtitle_url_chs required	string (Subtitle url chs) non-empty
subtitle_url_cht required	string (Subtitle url cht) non-empty
subtitle_url_es required	string (Subtitle url es) non-empty
subtitle_url_ko required	string (Subtitle url ko) non-empty
subtitle_url_pt required	string (Subtitle url pt) non-empty
updated_at required	string (Updated at) non-empty
guid required	string (Guid) non-empty

Response samples

200

Content type

application/json

[{"asset_id": 0,
"item_id": 0,
"page_id": 0,
"no": "string",
"name": "string",
"name_kr": "string",
"thumbnail_url": "string",
"vod_url": "string",
"air_date": "string",
"runtime": "string",
"subtitle_url_en": "string",
"subtitle_url_chs": "string",
"subtitle_url_cht": "string",
"subtitle_url_es": "string",
"subtitle_url_ko": "string",
"subtitle_url_pt": "string",
"updated_at": "string",
"guid": "string"
}
]

adhoc_odkbox_program_read

Authorizations:

token

path Parameters

id

required

string

Responses

Response Schema: application/json

Array

asset_id required	integer (Asset id) wp_all.id
section_id required	integer (Section id)
poster_url required	string (Poster url) non-empty
title required	string (Title) non-empty
title_kr required	string (Title kr) non-empty
synopsis required	string (Synopsis) non-empty
synopsis_kr required	string (Synopsis kr) non-empty
provider required	string (Provider) non-empty
is_kocowa required	boolean (Is kocowa)
guid required	string (Guid) non-empty

Response samples

200

Content type

application/json

[{"asset_id": 0,
"section_id": 0,
"poster_url": "string",
"title": "string",
"title_kr": "string",
"synopsis": "string",
"synopsis_kr": "string",
"provider": "string",
"is_kocowa": true,
"guid": "string"
}
]

adhoc_odkbox_programs_list

Authorizations:

token

Responses

Response Schema: application/json

Array

asset_id required	integer (Asset id) wp_all.id
section_id required	integer (Section id)
poster_url required	string (Poster url) non-empty
title required	string (Title) non-empty
title_kr required	string (Title kr) non-empty
synopsis required	string (Synopsis) non-empty
synopsis_kr required	string (Synopsis kr) non-empty
provider required	string (Provider) non-empty
is_kocowa required	boolean (Is kocowa)
guid required	string (Guid) non-empty

Response samples

200

Content type

application/json

[{"asset_id": 0,
"section_id": 0,
"poster_url": "string",
"title": "string",
"title_kr": "string",
"synopsis": "string",
"synopsis_kr": "string",
"provider": "string",
"is_kocowa": true,
"guid": "string"
}
]

adhoc_title-automation_list

Authorizations:

token

query Parameters

cat_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (TitleAutomation)

Array

id	integer (Id)
cat_name required	string (Cat name) [ 1 .. 200 ] characters
automation_type	string (Automation type) Enum: "private" "episode_no" "date" "subtitle"
note	string or null (Note) <= 200 characters
updated_timestamp	string <date-time> (Updated timestamp)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"cat_name": "string",
"automation_type": "private",
"note": "string",
"updated_timestamp": "2019-08-24T14:15:22Z"
}
]
}

adhoc_title-automation_create

Authorizations:

token

Request Body schema: application/json
required

cat_name required	string (Cat name) [ 1 .. 200 ] characters
automation_type	string (Automation type) Enum: "private" "episode_no" "date" "subtitle"
note	string or null (Note) <= 200 characters

Responses

Response Schema: application/json

id	integer (Id)
cat_name required	string (Cat name) [ 1 .. 200 ] characters
automation_type	string (Automation type) Enum: "private" "episode_no" "date" "subtitle"
note	string or null (Note) <= 200 characters
updated_timestamp	string <date-time> (Updated timestamp)

Request samples

Payload

Content type

application/json

{"cat_name": "string",
"automation_type": "private",
"note": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"cat_name": "string",
"automation_type": "private",
"note": "string",
"updated_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_title-automation_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this title automation.

Responses

Response Schema: application/json

id	integer (Id)
cat_name required	string (Cat name) [ 1 .. 200 ] characters
automation_type	string (Automation type) Enum: "private" "episode_no" "date" "subtitle"
note	string or null (Note) <= 200 characters
updated_timestamp	string <date-time> (Updated timestamp)

Response samples

200

Content type

application/json

{"id": 0,
"cat_name": "string",
"automation_type": "private",
"note": "string",
"updated_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_title-automation_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this title automation.

Request Body schema: application/json
required

cat_name required	string (Cat name) [ 1 .. 200 ] characters
automation_type	string (Automation type) Enum: "private" "episode_no" "date" "subtitle"
note	string or null (Note) <= 200 characters

Responses

Response Schema: application/json

id	integer (Id)
cat_name required	string (Cat name) [ 1 .. 200 ] characters
automation_type	string (Automation type) Enum: "private" "episode_no" "date" "subtitle"
note	string or null (Note) <= 200 characters
updated_timestamp	string <date-time> (Updated timestamp)

Request samples

Payload

Content type

application/json

{"cat_name": "string",
"automation_type": "private",
"note": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"cat_name": "string",
"automation_type": "private",
"note": "string",
"updated_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_title-automation_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this title automation.

Responses

adhoc_title-automation_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this title automation.

Request Body schema: application/json
required

cat_name required	string (Cat name) [ 1 .. 200 ] characters
automation_type	string (Automation type) Enum: "private" "episode_no" "date" "subtitle"
note	string or null (Note) <= 200 characters

Responses

Response Schema: application/json

id	integer (Id)
cat_name required	string (Cat name) [ 1 .. 200 ] characters
automation_type	string (Automation type) Enum: "private" "episode_no" "date" "subtitle"
note	string or null (Note) <= 200 characters
updated_timestamp	string <date-time> (Updated timestamp)

Request samples

Payload

Content type

application/json

{"cat_name": "string",
"automation_type": "private",
"note": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"cat_name": "string",
"automation_type": "private",
"note": "string",
"updated_timestamp": "2019-08-24T14:15:22Z"
}

adhoc_widget-order-update-order_partial_update

A view that can accept PATCH requests with ID list to changes into the order of Widgets for ODK Home. If you don't send the entire pk list in request body for all widgets, the order of widgets that not included in it won't be deterministic. Include all widgets data in the request body or the request will throw an error.

Authorizations:

token

Request Body schema: application/json
required

pk_list

required

Array of integers

Each element is wp_index_widget_order.id ex) [1, 2, 3]

Responses

Response Schema: application/json

pk_list

required

Array of integers

Each element is wp_index_widget_order.id ex) [1, 2, 3]

Request samples

Payload

Content type

application/json

{"pk_list": [0
]
}

Response samples

200

Content type

application/json

{"pk_list": [0
]
}

adhoc_widget-order_list

Authorizations:

token

query Parameters

ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (Widget)

Array

id	integer (ID)
widget	string or null (Widget) <= 200 characters
position	integer or null (Position) [ -2147483648 .. 2147483647 ]
timestamp	string <date-time> (Timestamp)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"widget": "string",
"position": -2147483648,
"timestamp": "2019-08-24T14:15:22Z"
}
]
}

adhoc_widget-order_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this wp index widget order.

Responses

Response Schema: application/json

id	integer (ID)
widget	string or null (Widget) <= 200 characters
position	integer or null (Position) [ -2147483648 .. 2147483647 ]
timestamp	string <date-time> (Timestamp)

Response samples

200

Content type

application/json

{"id": 0,
"widget": "string",
"position": -2147483648,
"timestamp": "2019-08-24T14:15:22Z"
}

admin-coupon-group

admin-coupon-group_list

Authorizations:

token

query Parameters

code	string
ordering	string Which field to use when ordering the results.
search	string A search term. search_fields = ('code', 'description')
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

results

required

Array of arrays

object (AdminCouponGroupList)

id	integer (ID)
code required	string (Code) [ 3 .. 100 ] characters
description	string or null (Description) <= 200 characters
valid_from required	string <date-time> (Valid from)
valid_to required	string <date-time> (Valid to) Last day to redeem the coupon in group
coupon_unique	boolean (Coupon unique) Each coupon is unique or not
coupon_duration required	integer (Coupon duration) [ 1 .. 2147483647 ] Time period the coupon is for. Unit: day
created	string <date-time> (Created)
num_of_issued	integer (Num of issued) The number of coupons issued
num_of_redeemed	integer (Num of redeemed) The number of coupons redeemed

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [ ],
"items": {"id": 0,
"code": "string",
"description": "string",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z",
"coupon_unique": true,
"coupon_duration": 1,
"created": "2019-08-24T14:15:22Z",
"num_of_issued": 0,
"num_of_redeemed": 0
}
}

admin-coupon-group_create

Authorizations:

token

Request Body schema: application/json
required

code required	string (Code) [ 3 .. 100 ] characters
description	string or null (Description) <= 200 characters
valid_from required	string <date-time> (Valid from)
valid_to required	string <date-time> (Valid to) Last day to redeem the coupon in group
coupon_unique	boolean (Coupon unique) Each coupon is unique or not
coupon_duration required	integer (Coupon duration) [ 1 .. 2147483647 ] Time period the coupon is for. Unit: day
created_by	integer or null (Created by)
modified_by	integer or null (Modified by)
num_to_issue required	integer (Num to issue) [ 1 .. 100 ] The number of coupons to be issued.

Responses

Response Schema: application/json

id	integer (ID)
code required	string (Code) [ 3 .. 100 ] characters
description	string or null (Description) <= 200 characters
valid_from required	string <date-time> (Valid from)
valid_to required	string <date-time> (Valid to) Last day to redeem the coupon in group
coupon_unique	boolean (Coupon unique) Each coupon is unique or not
coupon_duration required	integer (Coupon duration) [ 1 .. 2147483647, ] Time period the coupon is for. Unit: day
created_by	integer or null (Created by)
modified_by	integer or null (Modified by)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"code": "string",
"description": "string",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z",
"coupon_unique": true,
"coupon_duration": 1,
"created_by": 0,
"modified_by": 0,
"num_to_issue": 1
}

Response samples

201

Content type

application/json

{"id": 0,
"code": "string",
"description": "string",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z",
"coupon_unique": true,
"coupon_duration": 1,
"created_by": 0,
"modified_by": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

admin-coupon-group_read

Authorizations:

token

Responses

Response Schema: application/json

id	integer (ID)
code required	string (Code) [ 3 .. 100 ] characters
description	string or null (Description) <= 200 characters
valid_from required	string <date-time> (Valid from)
valid_to required	string <date-time> (Valid to) Last day to redeem the coupon in group
coupon_unique	boolean (Coupon unique) Each coupon is unique or not
coupon_duration required	integer (Coupon duration) [ 1 .. 2147483647 ] Time period the coupon is for. Unit: day
created	string <date-time> (Created)
num_of_issued	integer (Num of issued) The number of coupons issued
num_of_redeemed	integer (Num of redeemed) The number of coupons redeemed
created_by	integer (Created by)
modified_by	integer (Modified by)
modified	string <date-time> (Modified)
creator	string (Creator)
modifier	string (Modifier)

Response samples

200

Content type

application/json

{"id": 0,
"code": "string",
"description": "string",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z",
"coupon_unique": true,
"coupon_duration": 1,
"created": "2019-08-24T14:15:22Z",
"num_of_issued": 0,
"num_of_redeemed": 0,
"created_by": 0,
"modified_by": 0,
"modified": "2019-08-24T14:15:22Z",
"creator": "string",
"modifier": "string"
}

admin-coupon

admin-coupon_list

Authorizations:

token

query Parameters

group_code	any AdminCouponGroup.code
auth_uid	any User's email address to sign-in
search	any A search term. search_fields = ('code', 'user__email')
page	any A page number within the paginated result set.
page_size	any Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (AdminCoupon)

Array

id	integer (ID)
group required	integer (Group)
group_code	string (Group code)
user	integer or null (User)
user_email	string (User email)
code required	string (Code) [ 1 .. 150 ] characters The code the customer enters to redeem the coupon.
redeemed_at	string or null <date-time> (Redeemed at) When the user redeemed this coupon.
valid_from	string or null <date-time> (Valid from) Time the coupon starts to be applied since
valid_to	string or null <date-time> (Valid to) calculated by adding coupon_duration to valid_from
ip_address	string or null (Ip address) <= 255 characters
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"group": 0,
"group_code": "string",
"user": 0,
"user_email": "string",
"code": "string",
"redeemed_at": "2019-08-24T14:15:22Z",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z",
"ip_address": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

admin-coupon_update

Authorizations:

token

path Parameters

id

required

string

Request Body schema: application/json
required

group required	integer (Group) Primary key of AdminCouponGroup object
code required	string (Code) [ 1 .. 150 ] characters The code the customer enters to redeem the coupon.
valid_to	string or null <date-time> (Valid to) calculated by adding coupon_duration to valid_from

Responses

Response Schema: application/json

id	integer (ID)
group required	integer (Group)
group_code	string (Group code)
user	integer or null (User)
user_email	string (User email)
code required	string (Code) [ 1 .. 150 ] characters The code the customer enters to redeem the coupon.
redeemed_at	string or null <date-time> (Redeemed at) When the user redeemed this coupon.
valid_from	string or null <date-time> (Valid from) Time the coupon starts to be applied since
valid_to	string or null <date-time> (Valid to) calculated by adding coupon_duration to valid_from
ip_address	string or null (Ip address) <= 255 characters
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"group": 0,
"code": "string",
"valid_to": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"group": 0,
"group_code": "string",
"user": 0,
"user_email": "string",
"code": "string",
"redeemed_at": "2019-08-24T14:15:22Z",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z",
"ip_address": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

admin-coupon_partial_update

Authorizations:

token

path Parameters

id

required

string

Request Body schema: application/json
required

group	integer (Group) Primary key of AdminCouponGroup object
user	integer or null (User) Primary key of AuthUser object
code	string (Code) [ 1 .. 150 ] characters The code the customer enters to redeem the coupon.
redeemed_at	string or null <date-time> (Redeemed at) When the user redeemed this coupon.
valid_from	string or null <date-time> (Valid from) Time the coupon starts to be applied since
valid_to	string or null <date-time> (Valid to) calculated by adding coupon_duration to valid_from
ip_address	string or null (Ip address) <= 255 characters

Responses

Response Schema: application/json

id	integer (ID)
group required	integer (Group)
group_code	string (Group code)
user	integer or null (User)
user_email	string (User email)
code required	string (Code) [ 1 .. 150 ] characters The code the customer enters to redeem the coupon.
redeemed_at	string or null <date-time> (Redeemed at) When the user redeemed this coupon.
valid_from	string or null <date-time> (Valid from) Time the coupon starts to be applied since
valid_to	string or null <date-time> (Valid to) calculated by adding coupon_duration to valid_from
ip_address	string or null (Ip address) <= 255 characters
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"group": 0,
"user": 0,
"code": "string",
"redeemed_at": "2019-08-24T14:15:22Z",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z",
"ip_address": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"group": 0,
"group_code": "string",
"user": 0,
"user_email": "string",
"code": "string",
"redeemed_at": "2019-08-24T14:15:22Z",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z",
"ip_address": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

admin-coupon_export-coupon-list-as-csv

Authorizations:

token

query Parameters

group_code

required

string

Responses

Response Headers
Content-Disposition	string attachment; filename="admin_coupon_group_{group_code}_coupon_list.csv"

Response Schema: text/csv

string

banner_plans

banner_plans_list

Authorizations:

token

query Parameters

title	string
start__gte	string
start__lte	string
end__gte	string
end__lte	string
active	string
description	string
service_name	string
user_types	string Multiple values may be separated by commas.
placement	string
weight	number
live	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (BannerPlan)

Array

id	integer (ID)
live	string (Live) Whether Banner Plan is live or not
title required	string (Title) [ 1 .. 255 ] characters
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
description	string (Description) <= 1000 characters
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
placement required	string (Placement) [ 1 .. 20 ] characters ex) One of `main`, `player_side`, `player_overlay`, `site_floating` or etc.
user_types	Array of strings (User Type) [ items [ 1 .. 20 ] characters ] ex) A list using `all`, `guest`, `free`, `plus`, `ppv`, `adult` as values / Blank means do not exposure to any users
weight	integer (Weight) [ 0 .. 32767 ] Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.
required	object (Target) Target of the Banner Plan
required	Array of objects (Banner) Banner list of the Banner Plan
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"live": "string",
"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

banner_plans_create

Authorizations:

token

Request Body schema: application/json
required

title

required

string (Title) [ 1 .. 255 ] characters

start

string or null <date-time> (Start)

end

string or null <date-time> (End)

active

boolean (Active)

description

string (Description) <= 1000 characters

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

placement

required

string (Placement) [ 1 .. 20 ] characters

ex) One of main, player_side, player_overlay, site_floating or etc.

user_types

Array of strings (User Type) [ items [ 1 .. 20 ] characters ]

ex) A list using all, guest, free, plus, ppv, adult as values / Blank means do not exposure to any users

weight

integer (Weight) [ 0 .. 32767 ]

Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.

required

object (Target)

Target of the Banner Plan

programs required	Array of strings[ items non-empty ] Target program list
counties required	Array of strings[ items non-empty ] Target county list
categories required	Array of strings[ items non-empty ] Target category list

required

Array of objects (Banner)

Banner list of the Banner Plan

Array

language required	string (Language) non-empty Language of the banner
platform required	string (Platform) non-empty Platform of the banner
type	string (Type) non-empty Type of the banner
landing_url required	string (Landing url) non-empty Landing URL of the banner
landing_type required	string (Landing type) non-empty Landing type of the banner
image	string (Image) Image path of the banner
markdown	string (Markdown) Markdown contents of the banner
alt	string (Alt) Alt text of the banner
theme	string (Theme) Theme name of the banner

Responses

Response Schema: application/json

id

integer (ID)

live

string (Live)

Whether Banner Plan is live or not

title

required

string (Title) [ 1 .. 255 ] characters

start

string or null <date-time> (Start)

end

string or null <date-time> (End)

active

boolean (Active)

description

string (Description) <= 1000 characters

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

placement

required

string (Placement) [ 1 .. 20 ] characters

ex) One of main, player_side, player_overlay, site_floating or etc.

user_types

Array of strings (User Type) [ items [ 1 .. 20 ] characters ]

ex) A list using all, guest, free, plus, ppv, adult as values / Blank means do not exposure to any users

weight

integer (Weight) [ 0 .. 32767 ]

Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.

required

object (Target)

Target of the Banner Plan

programs required	Array of strings[ items non-empty ] Target program list
counties required	Array of strings[ items non-empty ] Target county list
categories required	Array of strings[ items non-empty ] Target category list

required

Array of objects (Banner)

Banner list of the Banner Plan

Array

language required	string (Language) non-empty Language of the banner
platform required	string (Platform) non-empty Platform of the banner
type	string (Type) non-empty Type of the banner
landing_url required	string (Landing url) non-empty Landing URL of the banner
landing_type required	string (Landing type) non-empty Landing type of the banner
image	string (Image) Image path of the banner
markdown	string (Markdown) Markdown contents of the banner
alt	string (Alt) Alt text of the banner
theme	string (Theme) Theme name of the banner

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
]
}

Response samples

201

Content type

application/json

{"id": 0,
"live": "string",
"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

banner_plans_clear_cache

Authorizations:

token

query Parameters

title	string
start__gte	string
start__lte	string
end__gte	string
end__lte	string
active	string
description	string
service_name	string
user_types	string Multiple values may be separated by commas.
placement	string
weight	number
live	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (BannerPlan)

Array

id	integer (ID)
live	string (Live) Whether Banner Plan is live or not
title required	string (Title) [ 1 .. 255 ] characters
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
description	string (Description) <= 1000 characters
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
placement required	string (Placement) [ 1 .. 20 ] characters ex) One of `main`, `player_side`, `player_overlay`, `site_floating` or etc.
user_types	Array of strings (User Type) [ items [ 1 .. 20 ] characters ] ex) A list using `all`, `guest`, `free`, `plus`, `ppv`, `adult` as values / Blank means do not exposure to any users
weight	integer (Weight) [ 0 .. 32767 ] Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.
required	object (Target) Target of the Banner Plan
required	Array of objects (Banner) Banner list of the Banner Plan
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"live": "string",
"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

banner_plans_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Banner Plan.

Responses

Response Schema: application/json

id

integer (ID)

live

string (Live)

Whether Banner Plan is live or not

title

required

string (Title) [ 1 .. 255 ] characters

start

string or null <date-time> (Start)

end

string or null <date-time> (End)

active

boolean (Active)

description

string (Description) <= 1000 characters

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

placement

required

string (Placement) [ 1 .. 20 ] characters

ex) One of main, player_side, player_overlay, site_floating or etc.

user_types

Array of strings (User Type) [ items [ 1 .. 20 ] characters ]

ex) A list using all, guest, free, plus, ppv, adult as values / Blank means do not exposure to any users

weight

integer (Weight) [ 0 .. 32767 ]

Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.

required

object (Target)

Target of the Banner Plan

programs required	Array of strings[ items non-empty ] Target program list
counties required	Array of strings[ items non-empty ] Target county list
categories required	Array of strings[ items non-empty ] Target category list

required

Array of objects (Banner)

Banner list of the Banner Plan

Array

language required	string (Language) non-empty Language of the banner
platform required	string (Platform) non-empty Platform of the banner
type	string (Type) non-empty Type of the banner
landing_url required	string (Landing url) non-empty Landing URL of the banner
landing_type required	string (Landing type) non-empty Landing type of the banner
image	string (Image) Image path of the banner
markdown	string (Markdown) Markdown contents of the banner
alt	string (Alt) Alt text of the banner
theme	string (Theme) Theme name of the banner

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"live": "string",
"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

banner_plans_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Banner Plan.

Request Body schema: application/json
required

title

required

string (Title) [ 1 .. 255 ] characters

start

string or null <date-time> (Start)

end

string or null <date-time> (End)

active

boolean (Active)

description

string (Description) <= 1000 characters

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

placement

required

string (Placement) [ 1 .. 20 ] characters

ex) One of main, player_side, player_overlay, site_floating or etc.

user_types

Array of strings (User Type) [ items [ 1 .. 20 ] characters ]

ex) A list using all, guest, free, plus, ppv, adult as values / Blank means do not exposure to any users

weight

integer (Weight) [ 0 .. 32767 ]

Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.

required

object (Target)

Target of the Banner Plan

programs required	Array of strings[ items non-empty ] Target program list
counties required	Array of strings[ items non-empty ] Target county list
categories required	Array of strings[ items non-empty ] Target category list

required

Array of objects (Banner)

Banner list of the Banner Plan

Array

language required	string (Language) non-empty Language of the banner
platform required	string (Platform) non-empty Platform of the banner
type	string (Type) non-empty Type of the banner
landing_url required	string (Landing url) non-empty Landing URL of the banner
landing_type required	string (Landing type) non-empty Landing type of the banner
image	string (Image) Image path of the banner
markdown	string (Markdown) Markdown contents of the banner
alt	string (Alt) Alt text of the banner
theme	string (Theme) Theme name of the banner

Responses

Response Schema: application/json

id

integer (ID)

live

string (Live)

Whether Banner Plan is live or not

title

required

string (Title) [ 1 .. 255 ] characters

start

string or null <date-time> (Start)

end

string or null <date-time> (End)

active

boolean (Active)

description

string (Description) <= 1000 characters

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

placement

required

string (Placement) [ 1 .. 20 ] characters

ex) One of main, player_side, player_overlay, site_floating or etc.

user_types

Array of strings (User Type) [ items [ 1 .. 20 ] characters ]

ex) A list using all, guest, free, plus, ppv, adult as values / Blank means do not exposure to any users

weight

integer (Weight) [ 0 .. 32767 ]

Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.

required

object (Target)

Target of the Banner Plan

programs required	Array of strings[ items non-empty ] Target program list
counties required	Array of strings[ items non-empty ] Target county list
categories required	Array of strings[ items non-empty ] Target category list

required

Array of objects (Banner)

Banner list of the Banner Plan

Array

language required	string (Language) non-empty Language of the banner
platform required	string (Platform) non-empty Platform of the banner
type	string (Type) non-empty Type of the banner
landing_url required	string (Landing url) non-empty Landing URL of the banner
landing_type required	string (Landing type) non-empty Landing type of the banner
image	string (Image) Image path of the banner
markdown	string (Markdown) Markdown contents of the banner
alt	string (Alt) Alt text of the banner
theme	string (Theme) Theme name of the banner

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"live": "string",
"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

banner_plans_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Banner Plan.

Responses

banner_plans_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Banner Plan.

Request Body schema: application/json
required

title

required

string (Title) [ 1 .. 255 ] characters

start

string or null <date-time> (Start)

end

string or null <date-time> (End)

active

boolean (Active)

description

string (Description) <= 1000 characters

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

placement

required

string (Placement) [ 1 .. 20 ] characters

ex) One of main, player_side, player_overlay, site_floating or etc.

user_types

Array of strings (User Type) [ items [ 1 .. 20 ] characters ]

ex) A list using all, guest, free, plus, ppv, adult as values / Blank means do not exposure to any users

weight

integer (Weight) [ 0 .. 32767 ]

Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.

required

object (Target)

Target of the Banner Plan

programs required	Array of strings[ items non-empty ] Target program list
counties required	Array of strings[ items non-empty ] Target county list
categories required	Array of strings[ items non-empty ] Target category list

required

Array of objects (Banner)

Banner list of the Banner Plan

Array

language required	string (Language) non-empty Language of the banner
platform required	string (Platform) non-empty Platform of the banner
type	string (Type) non-empty Type of the banner
landing_url required	string (Landing url) non-empty Landing URL of the banner
landing_type required	string (Landing type) non-empty Landing type of the banner
image	string (Image) Image path of the banner
markdown	string (Markdown) Markdown contents of the banner
alt	string (Alt) Alt text of the banner
theme	string (Theme) Theme name of the banner

Responses

Response Schema: application/json

id

integer (ID)

live

string (Live)

Whether Banner Plan is live or not

title

required

string (Title) [ 1 .. 255 ] characters

start

string or null <date-time> (Start)

end

string or null <date-time> (End)

active

boolean (Active)

description

string (Description) <= 1000 characters

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

placement

required

string (Placement) [ 1 .. 20 ] characters

ex) One of main, player_side, player_overlay, site_floating or etc.

user_types

Array of strings (User Type) [ items [ 1 .. 20 ] characters ]

ex) A list using all, guest, free, plus, ppv, adult as values / Blank means do not exposure to any users

weight

integer (Weight) [ 0 .. 32767 ]

Range: 1 ~ 10 (integer only) / To refer to the size of the audience reached by an banner plan.

required

object (Target)

Target of the Banner Plan

programs required	Array of strings[ items non-empty ] Target program list
counties required	Array of strings[ items non-empty ] Target county list
categories required	Array of strings[ items non-empty ] Target category list

required

Array of objects (Banner)

Banner list of the Banner Plan

Array

language required	string (Language) non-empty Language of the banner
platform required	string (Platform) non-empty Platform of the banner
type	string (Type) non-empty Type of the banner
landing_url required	string (Landing url) non-empty Landing URL of the banner
landing_type required	string (Landing type) non-empty Landing type of the banner
image	string (Image) Image path of the banner
markdown	string (Markdown) Markdown contents of the banner
alt	string (Alt) Alt text of the banner
theme	string (Theme) Theme name of the banner

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
]
}

Response samples

200

Content type

application/json

{"id": 0,
"live": "string",
"title": "string",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"description": "string",
"service_name": "odk",
"placement": "string",
"user_types": ["string"
],
"weight": 32767,
"target": {"programs": ["string"
],
"counties": ["string"
],
"categories": ["string"
]
},
"banners": [{"language": "string",
"platform": "string",
"type": "string",
"landing_url": "string",
"landing_type": "string",
"image": "string",
"markdown": "string",
"alt": "string",
"theme": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

categories

categories_create

Authorizations:

token

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

Request samples

Payload

Content type

application/json

{"slug": "string",
"parent": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"service_name": "odk",
"kind": "category",
"link": "string",
"background_image": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}

categories_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this category.

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}

categories_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this category.

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

Request samples

Payload

Content type

application/json

{"slug": "string",
"parent": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"service_name": "odk",
"kind": "category",
"link": "string",
"background_image": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}

categories_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this category.

Responses

categories_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this category.

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

Request samples

Payload

Content type

application/json

{"slug": "string",
"parent": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"service_name": "odk",
"kind": "category",
"link": "string",
"background_image": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}

channel

channel_list

Authorizations:

token

query Parameters

service_name	string
provider	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (Channel)

Array

id	integer (ID)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title required	string (Title) <= 255 characters
stream_url required	string <uri> (Stream URL) <= 2048 characters
order required	integer (Order, not Channel number.) [ 0 .. 32767 ]
epg_url required	string <uri> (EPG URL) <= 255 characters
provider	string (Provider) Enum: "amagi" "yonhab"
enable	boolean (Enable) Default: false
logo required	string <uri> (Logo) <= 255 characters
required	object or null (ProgramImages)
genres	Array of integers unique
content_provider	integer or null (Content provider) content.provider, not contract.provider
default_epg_title	string or null (Default EPG Title) <= 255 characters
created	string <date-time> (Created)
modified	string <date-time> (Modified)
number required	integer (Number) Channel's number only, not ordering
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
default_epg_title_ko	string or null (Default EPG Title (KO)) <= 255 characters
default_epg_title_en	string or null (Default EPG Title (EN)) <= 255 characters
default_epg_title_es	string or null (Default EPG Title (ES)) <= 255 characters
default_epg_title_zh_Hans	string or null (Default EPG Title (ZH-HANS)) <= 255 characters
default_epg_title_zh_Hant	string or null (Default EPG Title (ZH-HANT)) <= 255 characters
default_epg_title_zh_hans	string or null (Default EPG Title (ZH-HANS)) <= 255 characters
default_epg_title_zh_hant	string or null (Default EPG Title (ZH-HANT)) <= 255 characters
default_epg_title_pt	string or null (Default EPG Title (PT)) <= 255 characters

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"service_name": "odk",
"title": "string",
"stream_url": "http://example.com",
"order": 32767,
"epg_url": "http://example.com",
"provider": "amagi",
"enable": false,
"logo": "http://example.com",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"genres": [0
],
"content_provider": 0,
"default_epg_title": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"number": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"default_epg_title_ko": "string",
"default_epg_title_en": "string",
"default_epg_title_es": "string",
"default_epg_title_zh_Hans": "string",
"default_epg_title_zh_Hant": "string",
"default_epg_title_zh_hans": "string",
"default_epg_title_zh_hant": "string",
"default_epg_title_pt": "string"
}
]
}

channel_create

Authorizations:

token

Request Body schema: application/json
required

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

title

required

string (Title) <= 255 characters

stream_url

required

string <uri> (Stream URL) <= 2048 characters

order

required

integer (Order, not Channel number.) [ 0 .. 32767 ]

epg_url

required

string <uri> (EPG URL) <= 255 characters

provider

string (Provider)

Enum: "amagi" "yonhab"

enable

boolean (Enable)

Default: false

logo

required

string <uri> (Logo) <= 255 characters

required

object or null (ProgramImages)

poster	string or null <uri> (Poster)
poster_landscape	string or null <uri> (Poster landscape)
poster_portrait	string or null <uri> (Poster portrait)

genres

Array of integers unique

content_provider

integer or null (Content provider)

content.provider, not contract.provider

default_epg_title

string or null (Default EPG Title) <= 255 characters

number

required

integer (Number)

Channel's number only, not ordering

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

default_epg_title_ko

string or null (Default EPG Title (KO)) <= 255 characters

default_epg_title_en

string or null (Default EPG Title (EN)) <= 255 characters

default_epg_title_es

string or null (Default EPG Title (ES)) <= 255 characters

default_epg_title_zh_Hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_Hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_zh_hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_pt

string or null (Default EPG Title (PT)) <= 255 characters

Responses

Response Schema: application/json

id

integer (ID)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

title

required

string (Title) <= 255 characters

stream_url

required

string <uri> (Stream URL) <= 2048 characters

order

required

integer (Order, not Channel number.) [ 0 .. 32767 ]

epg_url

required

string <uri> (EPG URL) <= 255 characters

provider

string (Provider)

Enum: "amagi" "yonhab"

enable

boolean (Enable)

Default: false

logo

required

string <uri> (Logo) <= 255 characters

required

object or null (ProgramImages)

poster	string or null <uri> (Poster)
poster_landscape	string or null <uri> (Poster landscape)
poster_portrait	string or null <uri> (Poster portrait)

genres

Array of integers unique

content_provider

integer or null (Content provider)

content.provider, not contract.provider

default_epg_title

string or null (Default EPG Title) <= 255 characters

created

string <date-time> (Created)

modified

string <date-time> (Modified)

number

required

integer (Number)

Channel's number only, not ordering

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

default_epg_title_ko

string or null (Default EPG Title (KO)) <= 255 characters

default_epg_title_en

string or null (Default EPG Title (EN)) <= 255 characters

default_epg_title_es

string or null (Default EPG Title (ES)) <= 255 characters

default_epg_title_zh_Hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_Hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_zh_hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_pt

string or null (Default EPG Title (PT)) <= 255 characters

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"title": "string",
"stream_url": "http://example.com",
"order": 32767,
"epg_url": "http://example.com",
"provider": "amagi",
"enable": false,
"logo": "http://example.com",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"genres": [0
],
"content_provider": 0,
"default_epg_title": "string",
"number": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"default_epg_title_ko": "string",
"default_epg_title_en": "string",
"default_epg_title_es": "string",
"default_epg_title_zh_Hans": "string",
"default_epg_title_zh_Hant": "string",
"default_epg_title_zh_hans": "string",
"default_epg_title_zh_hant": "string",
"default_epg_title_pt": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"service_name": "odk",
"title": "string",
"stream_url": "http://example.com",
"order": 32767,
"epg_url": "http://example.com",
"provider": "amagi",
"enable": false,
"logo": "http://example.com",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"genres": [0
],
"content_provider": 0,
"default_epg_title": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"number": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"default_epg_title_ko": "string",
"default_epg_title_en": "string",
"default_epg_title_es": "string",
"default_epg_title_zh_Hans": "string",
"default_epg_title_zh_Hant": "string",
"default_epg_title_zh_hans": "string",
"default_epg_title_zh_hant": "string",
"default_epg_title_pt": "string"
}

channel_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this channel.

Responses

Response Schema: application/json

id

integer (ID)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

title

required

string (Title) <= 255 characters

stream_url

required

string <uri> (Stream URL) <= 2048 characters

order

required

integer (Order, not Channel number.) [ 0 .. 32767 ]

epg_url

required

string <uri> (EPG URL) <= 255 characters

provider

string (Provider)

Enum: "amagi" "yonhab"

enable

boolean (Enable)

Default: false

logo

required

string <uri> (Logo) <= 255 characters

required

object or null (ProgramImages)

poster	string or null <uri> (Poster)
poster_landscape	string or null <uri> (Poster landscape)
poster_portrait	string or null <uri> (Poster portrait)

genres

Array of integers unique

content_provider

integer or null (Content provider)

content.provider, not contract.provider

default_epg_title

string or null (Default EPG Title) <= 255 characters

created

string <date-time> (Created)

modified

string <date-time> (Modified)

number

required

integer (Number)

Channel's number only, not ordering

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

default_epg_title_ko

string or null (Default EPG Title (KO)) <= 255 characters

default_epg_title_en

string or null (Default EPG Title (EN)) <= 255 characters

default_epg_title_es

string or null (Default EPG Title (ES)) <= 255 characters

default_epg_title_zh_Hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_Hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_zh_hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_pt

string or null (Default EPG Title (PT)) <= 255 characters

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"title": "string",
"stream_url": "http://example.com",
"order": 32767,
"epg_url": "http://example.com",
"provider": "amagi",
"enable": false,
"logo": "http://example.com",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"genres": [0
],
"content_provider": 0,
"default_epg_title": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"number": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"default_epg_title_ko": "string",
"default_epg_title_en": "string",
"default_epg_title_es": "string",
"default_epg_title_zh_Hans": "string",
"default_epg_title_zh_Hant": "string",
"default_epg_title_zh_hans": "string",
"default_epg_title_zh_hant": "string",
"default_epg_title_pt": "string"
}

channel_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this channel.

Request Body schema: application/json
required

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

title

required

string (Title) <= 255 characters

stream_url

required

string <uri> (Stream URL) <= 2048 characters

order

required

integer (Order, not Channel number.) [ 0 .. 32767 ]

epg_url

required

string <uri> (EPG URL) <= 255 characters

provider

string (Provider)

Enum: "amagi" "yonhab"

enable

boolean (Enable)

Default: false

logo

required

string <uri> (Logo) <= 255 characters

required

object or null (ProgramImages)

poster	string or null <uri> (Poster)
poster_landscape	string or null <uri> (Poster landscape)
poster_portrait	string or null <uri> (Poster portrait)

genres

Array of integers unique

content_provider

integer or null (Content provider)

content.provider, not contract.provider

default_epg_title

string or null (Default EPG Title) <= 255 characters

number

required

integer (Number)

Channel's number only, not ordering

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

default_epg_title_ko

string or null (Default EPG Title (KO)) <= 255 characters

default_epg_title_en

string or null (Default EPG Title (EN)) <= 255 characters

default_epg_title_es

string or null (Default EPG Title (ES)) <= 255 characters

default_epg_title_zh_Hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_Hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_zh_hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_pt

string or null (Default EPG Title (PT)) <= 255 characters

Responses

Response Schema: application/json

id

integer (ID)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

title

required

string (Title) <= 255 characters

stream_url

required

string <uri> (Stream URL) <= 2048 characters

order

required

integer (Order, not Channel number.) [ 0 .. 32767 ]

epg_url

required

string <uri> (EPG URL) <= 255 characters

provider

string (Provider)

Enum: "amagi" "yonhab"

enable

boolean (Enable)

Default: false

logo

required

string <uri> (Logo) <= 255 characters

required

object or null (ProgramImages)

poster	string or null <uri> (Poster)
poster_landscape	string or null <uri> (Poster landscape)
poster_portrait	string or null <uri> (Poster portrait)

genres

Array of integers unique

content_provider

integer or null (Content provider)

content.provider, not contract.provider

default_epg_title

string or null (Default EPG Title) <= 255 characters

created

string <date-time> (Created)

modified

string <date-time> (Modified)

number

required

integer (Number)

Channel's number only, not ordering

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

default_epg_title_ko

string or null (Default EPG Title (KO)) <= 255 characters

default_epg_title_en

string or null (Default EPG Title (EN)) <= 255 characters

default_epg_title_es

string or null (Default EPG Title (ES)) <= 255 characters

default_epg_title_zh_Hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_Hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_zh_hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_pt

string or null (Default EPG Title (PT)) <= 255 characters

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"title": "string",
"stream_url": "http://example.com",
"order": 32767,
"epg_url": "http://example.com",
"provider": "amagi",
"enable": false,
"logo": "http://example.com",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"genres": [0
],
"content_provider": 0,
"default_epg_title": "string",
"number": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"default_epg_title_ko": "string",
"default_epg_title_en": "string",
"default_epg_title_es": "string",
"default_epg_title_zh_Hans": "string",
"default_epg_title_zh_Hant": "string",
"default_epg_title_zh_hans": "string",
"default_epg_title_zh_hant": "string",
"default_epg_title_pt": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"title": "string",
"stream_url": "http://example.com",
"order": 32767,
"epg_url": "http://example.com",
"provider": "amagi",
"enable": false,
"logo": "http://example.com",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"genres": [0
],
"content_provider": 0,
"default_epg_title": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"number": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"default_epg_title_ko": "string",
"default_epg_title_en": "string",
"default_epg_title_es": "string",
"default_epg_title_zh_Hans": "string",
"default_epg_title_zh_Hant": "string",
"default_epg_title_zh_hans": "string",
"default_epg_title_zh_hant": "string",
"default_epg_title_pt": "string"
}

channel_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this channel.

Responses

channel_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this channel.

Request Body schema: application/json
required

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

title

required

string (Title) <= 255 characters

stream_url

required

string <uri> (Stream URL) <= 2048 characters

order

required

integer (Order, not Channel number.) [ 0 .. 32767 ]

epg_url

required

string <uri> (EPG URL) <= 255 characters

provider

string (Provider)

Enum: "amagi" "yonhab"

enable

boolean (Enable)

Default: false

logo

required

string <uri> (Logo) <= 255 characters

required

object or null (ProgramImages)

poster	string or null <uri> (Poster)
poster_landscape	string or null <uri> (Poster landscape)
poster_portrait	string or null <uri> (Poster portrait)

genres

Array of integers unique

content_provider

integer or null (Content provider)

content.provider, not contract.provider

default_epg_title

string or null (Default EPG Title) <= 255 characters

number

required

integer (Number)

Channel's number only, not ordering

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

default_epg_title_ko

string or null (Default EPG Title (KO)) <= 255 characters

default_epg_title_en

string or null (Default EPG Title (EN)) <= 255 characters

default_epg_title_es

string or null (Default EPG Title (ES)) <= 255 characters

default_epg_title_zh_Hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_Hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_zh_hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_pt

string or null (Default EPG Title (PT)) <= 255 characters

Responses

Response Schema: application/json

id

integer (ID)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

title

required

string (Title) <= 255 characters

stream_url

required

string <uri> (Stream URL) <= 2048 characters

order

required

integer (Order, not Channel number.) [ 0 .. 32767 ]

epg_url

required

string <uri> (EPG URL) <= 255 characters

provider

string (Provider)

Enum: "amagi" "yonhab"

enable

boolean (Enable)

Default: false

logo

required

string <uri> (Logo) <= 255 characters

required

object or null (ProgramImages)

poster	string or null <uri> (Poster)
poster_landscape	string or null <uri> (Poster landscape)
poster_portrait	string or null <uri> (Poster portrait)

genres

Array of integers unique

content_provider

integer or null (Content provider)

content.provider, not contract.provider

default_epg_title

string or null (Default EPG Title) <= 255 characters

created

string <date-time> (Created)

modified

string <date-time> (Modified)

number

required

integer (Number)

Channel's number only, not ordering

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

default_epg_title_ko

string or null (Default EPG Title (KO)) <= 255 characters

default_epg_title_en

string or null (Default EPG Title (EN)) <= 255 characters

default_epg_title_es

string or null (Default EPG Title (ES)) <= 255 characters

default_epg_title_zh_Hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_Hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_zh_hans

string or null (Default EPG Title (ZH-HANS)) <= 255 characters

default_epg_title_zh_hant

string or null (Default EPG Title (ZH-HANT)) <= 255 characters

default_epg_title_pt

string or null (Default EPG Title (PT)) <= 255 characters

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"title": "string",
"stream_url": "http://example.com",
"order": 32767,
"epg_url": "http://example.com",
"provider": "amagi",
"enable": false,
"logo": "http://example.com",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"genres": [0
],
"content_provider": 0,
"default_epg_title": "string",
"number": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"default_epg_title_ko": "string",
"default_epg_title_en": "string",
"default_epg_title_es": "string",
"default_epg_title_zh_Hans": "string",
"default_epg_title_zh_Hant": "string",
"default_epg_title_zh_hans": "string",
"default_epg_title_zh_hant": "string",
"default_epg_title_pt": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"title": "string",
"stream_url": "http://example.com",
"order": 32767,
"epg_url": "http://example.com",
"provider": "amagi",
"enable": false,
"logo": "http://example.com",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"genres": [0
],
"content_provider": 0,
"default_epg_title": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"number": 0,
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"default_epg_title_ko": "string",
"default_epg_title_en": "string",
"default_epg_title_es": "string",
"default_epg_title_zh_Hans": "string",
"default_epg_title_zh_Hant": "string",
"default_epg_title_zh_hans": "string",
"default_epg_title_zh_hant": "string",
"default_epg_title_pt": "string"
}

channel_refresh-epg-data

Authorizations:

token

Request Body schema: application/json
required

channel_id required	integer (Channel ID)
target_date	string <date> (Target Date) The format should be `YYYY-MM-DD`.

Responses

Response Schema: application/json

__detail

string

Error details

Response Schema: application/json

detail

required

string

Error details

Response Schema: application/json

__detail

string

Error details

Request samples

Payload

Content type

application/json

{"channel_id": 0,
"target_date": "2001-01-01"
}

Response samples

200
400
404

Content type

application/json

{"__detail": "Channel:News Live EPG for the date:2023-06-12 loaded successfully."
}

channel_switch-order

A view that can accept PATCH requests with ID list to change into the order of ODK Channels. If you don't send the entire pk list in request body for all enabled ODK Channels, the order of banners that not included in it won't be deterministic. Include all enabled channels data in the request body. If not, the request will throw an error.

Authorizations:

token

Request Body schema: application/json
required

pk_list

required

Array of integers

Each element is Channel.id. ex) [9, 10, 11]

Responses

Response Schema: application/json

pk_list

required

Array of integers

Each element is Channel.id. ex) [9, 10, 11]

Request samples

Payload

Content type

application/json

{"pk_list": [0
]
}

Response samples

200

Content type

application/json

{"pk_list": [0
]
}

client_config

client_config_list

Authorizations:

token

query Parameters

service_name	string
platform	string
group	string
key	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ClientConfigListRetrieveAdmin)

Array

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
group required	string (Group) [ 1 .. 50 ] characters
key required	string (Key) [ 1 .. 50 ] characters
label	string (Label) <= 100 characters
value_type required	string (Value Type) Enum: "str" "int" "float" "json" "bool"
value	string (Value) This value is not just string.The type of this value is one of str, int, float, json, bool.
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"service_name": "odk",
"platform": "web",
"group": "string",
"key": "string",
"label": "string",
"value_type": "str",
"value": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

client_config_create

Authorizations:

token

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
group required	string (Group) [ 1 .. 50 ] characters
key required	string (Key) [ 1 .. 50 ] characters
label	string (Label) <= 100 characters
value_type required	string (Value Type) Enum: "str" "int" "float" "json" "bool"
value_text required	string (Value Text) non-empty This text should be able to interpreted in value_type.

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
group required	string (Group) [ 1 .. 50 ] characters
key required	string (Key) [ 1 .. 50 ] characters
label	string (Label) <= 100 characters
value_type required	string (Value Type) Enum: "str" "int" "float" "json" "bool"
value_text required	string (Value Text) non-empty This text should be able to interpreted in value_type.
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"group": "string",
"key": "string",
"label": "string",
"value_type": "str",
"value_text": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"service_name": "odk",
"platform": "web",
"group": "string",
"key": "string",
"label": "string",
"value_type": "str",
"value_text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

client_config_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Client Config.

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
group required	string (Group) [ 1 .. 50 ] characters
key required	string (Key) [ 1 .. 50 ] characters
label	string (Label) <= 100 characters
value_type required	string (Value Type) Enum: "str" "int" "float" "json" "bool"
value	string (Value) This value is not just string.The type of this value is one of str, int, float, json, bool.
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"platform": "web",
"group": "string",
"key": "string",
"label": "string",
"value_type": "str",
"value": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

client_config_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Client Config.

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
group required	string (Group) [ 1 .. 50 ] characters
key required	string (Key) [ 1 .. 50 ] characters
label	string (Label) <= 100 characters
value_type required	string (Value Type) Enum: "str" "int" "float" "json" "bool"
value_text required	string (Value Text) non-empty This text should be able to interpreted in value_type.

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
group required	string (Group) [ 1 .. 50 ] characters
key required	string (Key) [ 1 .. 50 ] characters
label	string (Label) <= 100 characters
value_type required	string (Value Type) Enum: "str" "int" "float" "json" "bool"
value_text required	string (Value Text) non-empty This text should be able to interpreted in value_type.
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"group": "string",
"key": "string",
"label": "string",
"value_type": "str",
"value_text": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"platform": "web",
"group": "string",
"key": "string",
"label": "string",
"value_type": "str",
"value_text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

client_config_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Client Config.

Responses

client_config_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Client Config.

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
group required	string (Group) [ 1 .. 50 ] characters
key required	string (Key) [ 1 .. 50 ] characters
label	string (Label) <= 100 characters
value_type required	string (Value Type) Enum: "str" "int" "float" "json" "bool"
value_text required	string (Value Text) non-empty This text should be able to interpreted in value_type.

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
group required	string (Group) [ 1 .. 50 ] characters
key required	string (Key) [ 1 .. 50 ] characters
label	string (Label) <= 100 characters
value_type required	string (Value Type) Enum: "str" "int" "float" "json" "bool"
value_text required	string (Value Text) non-empty This text should be able to interpreted in value_type.
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"group": "string",
"key": "string",
"label": "string",
"value_type": "str",
"value_text": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"platform": "web",
"group": "string",
"key": "string",
"label": "string",
"value_type": "str",
"value_text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

client_version

client_version_list

Authorizations:

token

query Parameters

platform	string
package_name	string
force_update	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ClientVersion)

Array

id	integer (ID)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
client_version required	string (Client Version) [ 1 .. 50 ] characters
package_name required	string (Package Name) [ 1 .. 100 ] characters
min_os_version required	string (Minimum OS version) [ 1 .. 50 ] characters
store_link required	string <uri> (Store Link) [ 1 .. 200 ] characters
release_date required	string <date-time> (Release Datetime)
force_update	boolean (Force Update)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"platform": "web",
"client_version": "string",
"package_name": "string",
"min_os_version": "string",
"store_link": "http://example.com",
"release_date": "2019-08-24T14:15:22Z",
"force_update": true
}
]
}

client_version_create

Authorizations:

token

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
client_version required	string (Client Version) [ 1 .. 50 ] characters
package_name required	string (Package Name) [ 1 .. 100 ] characters
min_os_version required	string (Minimum OS version) [ 1 .. 50 ] characters
store_link required	string <uri> (Store Link) [ 1 .. 200 ] characters
release_date required	string <date-time> (Release Datetime)
force_update	boolean (Force Update)

Responses

Response Schema: application/json

id	integer (ID)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
client_version required	string (Client Version) [ 1 .. 50 ] characters
package_name required	string (Package Name) [ 1 .. 100 ] characters
min_os_version required	string (Minimum OS version) [ 1 .. 50 ] characters
store_link required	string <uri> (Store Link) [ 1 .. 200 ] characters
release_date required	string <date-time> (Release Datetime)
force_update	boolean (Force Update)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"client_version": "string",
"package_name": "string",
"min_os_version": "string",
"store_link": "http://example.com",
"release_date": "2019-08-24T14:15:22Z",
"force_update": true
}

Response samples

201

Content type

application/json

{"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"platform": "web",
"client_version": "string",
"package_name": "string",
"min_os_version": "string",
"store_link": "http://example.com",
"release_date": "2019-08-24T14:15:22Z",
"force_update": true
}

client_version_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Client Version.

Responses

Response Schema: application/json

id	integer (ID)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
client_version required	string (Client Version) [ 1 .. 50 ] characters
package_name required	string (Package Name) [ 1 .. 100 ] characters
min_os_version required	string (Minimum OS version) [ 1 .. 50 ] characters
store_link required	string <uri> (Store Link) [ 1 .. 200 ] characters
release_date required	string <date-time> (Release Datetime)
force_update	boolean (Force Update)

Response samples

200

Content type

application/json

{"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"platform": "web",
"client_version": "string",
"package_name": "string",
"min_os_version": "string",
"store_link": "http://example.com",
"release_date": "2019-08-24T14:15:22Z",
"force_update": true
}

client_version_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Client Version.

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
client_version required	string (Client Version) [ 1 .. 50 ] characters
package_name required	string (Package Name) [ 1 .. 100 ] characters
min_os_version required	string (Minimum OS version) [ 1 .. 50 ] characters
store_link required	string <uri> (Store Link) [ 1 .. 200 ] characters
release_date required	string <date-time> (Release Datetime)
force_update	boolean (Force Update)

Responses

Response Schema: application/json

id	integer (ID)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
client_version required	string (Client Version) [ 1 .. 50 ] characters
package_name required	string (Package Name) [ 1 .. 100 ] characters
min_os_version required	string (Minimum OS version) [ 1 .. 50 ] characters
store_link required	string <uri> (Store Link) [ 1 .. 200 ] characters
release_date required	string <date-time> (Release Datetime)
force_update	boolean (Force Update)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"client_version": "string",
"package_name": "string",
"min_os_version": "string",
"store_link": "http://example.com",
"release_date": "2019-08-24T14:15:22Z",
"force_update": true
}

Response samples

200

Content type

application/json

{"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"platform": "web",
"client_version": "string",
"package_name": "string",
"min_os_version": "string",
"store_link": "http://example.com",
"release_date": "2019-08-24T14:15:22Z",
"force_update": true
}

client_version_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Client Version.

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
client_version required	string (Client Version) [ 1 .. 50 ] characters
package_name required	string (Package Name) [ 1 .. 100 ] characters
min_os_version required	string (Minimum OS version) [ 1 .. 50 ] characters
store_link required	string <uri> (Store Link) [ 1 .. 200 ] characters
release_date required	string <date-time> (Release Datetime)
force_update	boolean (Force Update)

Responses

Response Schema: application/json

id	integer (ID)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
client_version required	string (Client Version) [ 1 .. 50 ] characters
package_name required	string (Package Name) [ 1 .. 100 ] characters
min_os_version required	string (Minimum OS version) [ 1 .. 50 ] characters
store_link required	string <uri> (Store Link) [ 1 .. 200 ] characters
release_date required	string <date-time> (Release Datetime)
force_update	boolean (Force Update)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"client_version": "string",
"package_name": "string",
"min_os_version": "string",
"store_link": "http://example.com",
"release_date": "2019-08-24T14:15:22Z",
"force_update": true
}

Response samples

200

Content type

application/json

{"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"platform": "web",
"client_version": "string",
"package_name": "string",
"min_os_version": "string",
"store_link": "http://example.com",
"release_date": "2019-08-24T14:15:22Z",
"force_update": true
}

constants

constants_list

Authorizations:

token

Responses

Response Schema: application/json

required

object (ChoiceItemByService)

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

object (ChoiceItemByService)

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

Array of objects (ChoiceItem)

Array

label required	string (Label) non-empty
value required	string (Value) non-empty

required

object (ODKEnv)

video_api required	string (Video api) non-empty
media_io required	string (Media io) non-empty
media_io_db required	string (Media io db) non-empty
odk_web required	string (Odk web) non-empty odk only
rsync_manual_on required	string (Rsync manual on) non-empty odk only
sync_create_on required	string (Sync create on) non-empty odk only
sync_update_on required	string (Sync update on) non-empty odk only

Response samples

200

Content type

application/json

{"sales_type": {"odk": [{"label": "string",
"value": "string"
}
],
"odc": [{"label": "string",
"value": "string"
}
],
"odl": [{"label": "string",
"value": "string"
}
]
},
"subscription_plan": {"odk": [{"label": "string",
"value": "string"
}
],
"odc": [{"label": "string",
"value": "string"
}
],
"odl": [{"label": "string",
"value": "string"
}
]
},
"service": [{"label": "string",
"value": "string"
}
],
"cc_language": [{"label": "string",
"value": "string"
}
],
"country": [{"label": "string",
"value": "string"
}
],
"env": {"video_api": "string",
"media_io": "string",
"media_io_db": "string",
"odk_web": "string",
"rsync_manual_on": "string",
"sync_create_on": "string",
"sync_update_on": "string"
}
}

content_ingest

content_ingest_list

Authorizations:

token

query Parameters

source	string
status	string
meta__status	string
meta__enable	string
meta__source_content_type	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ContentIngestList)

Array

id	integer (Id)
source required	string (Source) Enum: "kcp" "mediahold" "internal"
file_path required	string (File path) [ 1 .. 255 ] characters
status	string (Status) Enum: "start" "processing" "end"
ingest_at required	string <date-time> (Ingest at)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
required	object (ContentIngestMetaInfo)
	object (ContentIngestMappingODX) If mapping data does not exist, this field is empty object.

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"source": "kcp",
"file_path": "string",
"status": "start",
"ingest_at": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"meta": {"source_content_type": "series",
"status": "start",
"enable": true
},
"odx": {"content_type": "string",
"id": 0,
"slug": "string"
}
}
]
}

content_ingest_delete_candidates_list

Authorizations:

token

query Parameters

status	string Enum: `"start"` `"processing"` `"end"`
meta__status	string Enum: `"start"` `"ingest_meta_start"` `"ingest_meta_end"` `"generate_base_info"` `"ingest_assets_start"` `"ingest_asset_poster"` `"ingest_asset_thumbnail"` `"ingest_asset_subtitle"` `"ingest_asset_video_ready"` `"ingest_asset_video_fail"` `"ingest_asset_video"` `"ingest_asset_video_processing"` `"ingest_assets_end"` `"ingest_assets_skip"` `"generate_io_program"` `"generate_io_episode"` `"ready_for_mapping"` `"end_of_mapping"` `"confirmed"` `"ready_for_generate_disabled_targets"` `"generate_disabled_targets"` `"confirmed_disabled_targets"` `"end_of_targets_disabled"` `"report_to_kcp_start"` `"report_to_kcp_meta"` `"report_to_kcp_asset_video"` `"report_to_kcp_asset_poster"` `"report_to_kcp_asset_thumbnail"` `"report_to_kcp_asset_subtitle"` `"report_to_kcp_end"` `"end"`
meta__source_content_type	string Enum: `"series"` `"season"` `"episode"` `"teaser"` `"pilot"` `"special"` `"behind scenes"` `"music video"`
deletion__deletion_type	string Enum: `"active"` `"inactive"` `"delete"`
deletion__deleted_at__isnull	boolean
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ContentIngestDeleteCandidate)

Array

id	integer (Id)
source required	string (Source) Enum: "kcp" "mediahold" "internal"
file_path required	string (File path) [ 1 .. 255 ] characters
status	string (Status) Enum: "start" "processing" "end"
ingest_at required	string <date-time> (Ingest at)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
required	object (ContentIngestMetaBase)
	object (ContentIngestMappingODX) If mapping data does not exist, this field is empty object.
required	object (KCPContentDeletion)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"source": "kcp",
"file_path": "string",
"status": "start",
"ingest_at": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"meta": {"source_content_type": "series",
"status": "start"
},
"odx": {"content_type": "string",
"id": 0,
"slug": "string"
},
"deletion": {"deletion_type": "active",
"deleted_at": "2019-08-24T14:15:22Z"
}
}
]
}

content_ingest_kcp_episode_list

Authorizations:

token

query Parameters

status	string
season__id	number
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (KCPEpisodeList)

Array

id required	integer (Id) [ 0 .. 2147483647 ]
season	integer or null (Season)
content_ingest	integer or null (Content ingest)
number required	integer (Number) [ 0 .. 32767 ]
status required	string (Status) [ 1 .. 20 ] characters
vod_type	string or null (Vod type) <= 10 characters
start_date required	string <date-time> (Start date)
end_date required	string <date-time> (End date)
title required	string (Title) [ 1 .. 255 ] characters
title_ko	string or null (Title (KO)) <= 255 characters

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 2147483647,
"season": 0,
"content_ingest": 0,
"number": 32767,
"status": "string",
"vod_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"title": "string",
"title_ko": "string"
}
]
}

content_ingest_kcp_episode_read

Authorizations:

token

path Parameters

id

required

integer

A unique value identifying this kcp episode.

Responses

Response Schema: application/json

id required	integer (Id) [ 0 .. 2147483647 ]
season	integer or null (Season)
content_ingest	integer or null (Content ingest)
number required	integer (Number) [ 0 .. 32767 ]
status required	string (Status) [ 1 .. 20 ] characters
vod_type	string or null (Vod type) <= 10 characters
start_date required	string <date-time> (Start date)
end_date required	string <date-time> (End date)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
summary	string or null (Summary)
description	string or null (Description)
ad_cue_points	Array of integers or null (Ad cue points) [ items [ 0 .. 2147483647 ] ]
running_time	integer or null (Running time) [ 0 .. 2147483647 ]
language	string or null (Language) <= 30 characters
thumbnail	object or null (Thumbnail)
video	object or null (Video)
subtitles	object or null (Subtitles)
subtitle_languages	Array of strings or null (Subtitle languages) [ items [ 1 .. 30 ] characters ]
casts	Array of strings or null (Casts) [ items [ 1 .. 100 ] characters ]
directors	Array of strings or null (Directors) [ items [ 1 .. 100 ] characters ]
writers	Array of strings or null (Writers) [ items [ 1 .. 100 ] characters ]

Response samples

200

Content type

application/json

{"id": 2147483647,
"season": 0,
"content_ingest": 0,
"number": 32767,
"status": "string",
"vod_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"summary": "string",
"description": "string",
"ad_cue_points": [2147483647
],
"running_time": 2147483647,
"language": "string",
"thumbnail": { },
"video": { },
"subtitles": { },
"subtitle_languages": ["string"
],
"casts": ["string"
],
"directors": ["string"
],
"writers": ["string"
]
}

content_ingest_kcp_episode_odx_episode_read

Authorizations:

token

path Parameters

id

required

string

Responses

Response Schema: application/json

id

integer (ID)

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

uuid

string <uuid> (Uuid)

This value is not editable.

cp

string (Cp)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

publish_status

string (Publish status)

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

created

string <date-time> (Created)

modified

string <date-time> (Modified)

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Response Schema: application/json

detail

required

string

Error details

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
400
404

Content type

application/json

{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

content_ingest_kcp_season_list

Authorizations:

token

query Parameters

status	string
series__id	number
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (KCPSeasonList)

Array

id required	integer (Id) [ 0 .. 2147483647 ]
series	integer or null (Series)
content_ingest	integer or null (Content ingest)
number	integer or null (Number) [ 0 .. 32767 ]
status required	string (Status) [ 1 .. 20 ] characters
service_type	string or null (Service type) <= 20 characters
start_date required	string <date-time> (Start date)
end_date required	string <date-time> (End date)
title required	string (Title) [ 1 .. 255 ] characters
title_ko	string or null (Title (KO)) <= 255 characters

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 2147483647,
"series": 0,
"content_ingest": 0,
"number": 32767,
"status": "string",
"service_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"title": "string",
"title_ko": "string"
}
]
}

content_ingest_kcp_season_read

Authorizations:

token

path Parameters

id

required

integer

A unique value identifying this kcp season.

Responses

Response Schema: application/json

id required	integer (Id) [ 0 .. 2147483647 ]
series	integer or null (Series)
content_ingest	integer or null (Content ingest)
number	integer or null (Number) [ 0 .. 32767 ]
status required	string (Status) [ 1 .. 20 ] characters
service_type	string or null (Service type) <= 20 characters
start_date required	string <date-time> (Start date)
end_date required	string <date-time> (End date)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
on_air_status required	string (On air status) [ 1 .. 10 ] characters
rating	string or null (Rating) <= 10 characters
summary	string or null (Summary)
description	string or null (Description)
language	string or null (Language) <= 30 characters
subtitle_languages	Array of strings or null (Subtitle languages) [ items [ 1 .. 30 ] characters ]
posters	object or null (Posters)
casts	Array of strings or null (Casts) [ items [ 1 .. 100 ] characters ]
directors	Array of strings or null (Directors) [ items [ 1 .. 100 ] characters ]
writers	Array of strings or null (Writers) [ items [ 1 .. 100 ] characters ]

Response samples

200

Content type

application/json

{"id": 2147483647,
"series": 0,
"content_ingest": 0,
"number": 32767,
"status": "string",
"service_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"on_air_status": "string",
"rating": "string",
"summary": "string",
"description": "string",
"language": "string",
"subtitle_languages": ["string"
],
"posters": { },
"casts": ["string"
],
"directors": ["string"
],
"writers": ["string"
]
}

content_ingest_kcp_season_odx_episodes_list

Authorizations:

token

path Parameters

id

required

string

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (EpisodeAdmin)

Array

id	integer (ID)
kind required	string or null (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number required	integer or null (Number) [ 0 .. 2147483647 ]
part	integer or null (Part) [ 0 .. 2147483647 ]
release_date	string or null <date> (Recently broadcast date)
	object (images)
uuid	string <uuid> (Uuid) This value is not editable.
cp	string (Cp)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
synopsis_ko	string or null (Synopsis (KO))
synopsis_en	string (Synopsis en)
synopsis_es	string or null (Synopsis (ES))
synopsis_zh_Hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_Hant	string or null (Synopsis (ZH-HANT))
synopsis_zh_hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_hant	string or null (Synopsis (ZH-HANT))
synopsis_pt	string or null (Synopsis (PT))
seo_title_ko	string or null (Title(SEO) (KO)) <= 255 characters
seo_title_en	string or null (Title(SEO) (EN)) <= 255 characters
seo_title_es	string or null (Title(SEO) (ES)) <= 255 characters
seo_title_zh_Hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_Hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_zh_hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_pt	string or null (Title(SEO) (PT)) <= 255 characters
seo_synopsis_ko	string or null (Synopsis(SEO) (KO))
seo_synopsis_en	string or null (Synopsis(SEO) (EN))
seo_synopsis_es	string or null (Synopsis(SEO) (ES))
seo_synopsis_zh_Hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_Hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_zh_hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_pt	string or null (Synopsis(SEO) (PT))
seo_keyword_ko	string or null (Keyword(SEO) (KO))
seo_keyword_en	string or null (Keyword(SEO) (EN))
seo_keyword_es	string or null (Keyword(SEO) (ES))
seo_keyword_zh_Hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_Hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_zh_hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_pt	string or null (Keyword(SEO) (PT))
	object (episode meta)
content_type	string or null (Content Type) Enum: "free" "plus" "premium" "ppv" Content type for services by user type
sales_type	string or null (Sales Type) Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" Sales Type needed to watch this episode
program	integer (Program)
	object (ProgramSimple)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
season	integer or null (Season) [ -2147483648 .. 2147483647 ]
publish_status	string (Publish status)
enable	boolean (Enable)
publish_start	string or null <date-time> (Publish Start)
publish_end	string or null <date-time> (Publish End)
in_review	boolean (In Review)
allowed_countries	Array of strings (Allowed countries) Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" Allowed Countries(ISO-3166 Alpha-2 code)
	object (video)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
is_notice	boolean (Episode for notice)
old_id	integer or null (Old id) [ 0 .. 2147483647 ]
migrated	string or null <date-time> (Migrated) If put FUTURE time into this field, migration cron WILL NOT WORK well.
age_rating	string or null (Age rating) Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
region_age_ratings	Array of strings or null

Response Schema: application/json

detail

required

string

Error details

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
400
404

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}
]
}

content_ingest_kcp_season_odx_program_read

Authorizations:

token

path Parameters

id

required

string

Responses

Response Schema: application/json

id

integer (ID)

uuid

string <uuid> (Uuid)

This value is not editable.

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

publish_status

string (Publish status)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

release_status

string (Release status)

produce_year

integer (Produce year)

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

genres

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

number_of_episodes

integer (Number of episodes)

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Response Schema: application/json

detail

required

string

Error details

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
400
404

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

content_ingest_kcp_series_list

Authorizations:

token

query Parameters

status	string
provider	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (KCPSeriesList)

Array

id required	integer (Id) [ 0 .. 2147483647 ]
content_ingest	integer or null (Content ingest)
status required	string (Status) [ 1 .. 20 ] characters
title required	string (Title) [ 1 .. 255 ] characters
title_ko	string or null (Title (KO)) <= 255 characters
provider required	string (Provider) [ 1 .. 50 ] characters
start_date required	string <date-time> (Start date)
end_date required	string <date-time> (End date)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 2147483647,
"content_ingest": 0,
"status": "string",
"title": "string",
"title_ko": "string",
"provider": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z"
}
]
}

content_ingest_kcp_series_read

Authorizations:

token

path Parameters

id

required

integer

A unique value identifying this kcp series.

Responses

Response Schema: application/json

id required	integer (Id) [ 0 .. 2147483647 ]
content_ingest	integer or null (Content ingest)
brand_name	string or null (Brand name) <= 100 characters
copyright	string or null (Copyright) <= 30 characters
category required	string (Category) [ 1 .. 255 ] characters
genres	Array of strings or null (Genres) [ items [ 1 .. 50 ] characters ]
status required	string (Status) [ 1 .. 20 ] characters
summary	string or null (Summary)
description	string or null (Description)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
provider required	string (Provider) [ 1 .. 50 ] characters
language	string or null (Language) <= 30 characters
owner	string or null (Owner) <= 30 characters
season_count	integer or null (Season count) [ 0 .. 32767 ]
start_date required	string <date-time> (Start date)
end_date required	string <date-time> (End date)
re_enable	boolean (Re enable)

Response samples

200

Content type

application/json

{"id": 2147483647,
"content_ingest": 0,
"brand_name": "string",
"copyright": "string",
"category": "string",
"genres": ["string"
],
"status": "string",
"summary": "string",
"description": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"provider": "string",
"language": "string",
"owner": "string",
"season_count": 32767,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"re_enable": true
}

content_ingest_kcp_series_odx_programs_list

Authorizations:

token

path Parameters

id

required

string

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ProgramAdmin)

Array

id	integer (ID)
uuid	string <uuid> (Uuid) This value is not editable.
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
	object (images)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
secondary_title_ko	string or null (Secondary Title (KO)) <= 255 characters
secondary_title_en	string or null (Secondary Title (EN)) <= 255 characters
secondary_title_es	string or null (Secondary Title (ES)) <= 255 characters
secondary_title_zh_Hans	string or null (Secondary Title (ZH-HANS)) <= 255 characters
secondary_title_zh_Hant	string or null (Secondary Title (ZH-HANT)) <= 255 characters
secondary_title_zh_hans	string or null (Secondary Title (ZH-HANS)) <= 255 characters
secondary_title_zh_hant	string or null (Secondary Title (ZH-HANT)) <= 255 characters
secondary_title_pt	string or null (Secondary Title (PT)) <= 255 characters
synopsis_ko	string or null (Synopsis (KO))
synopsis_en	string (Synopsis en)
synopsis_es	string or null (Synopsis (ES))
synopsis_zh_Hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_Hant	string or null (Synopsis (ZH-HANT))
synopsis_zh_hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_hant	string or null (Synopsis (ZH-HANT))
synopsis_pt	string or null (Synopsis (PT))
enable	boolean (Enable)
publish_start	string or null <date-time> (Publish Start)
publish_end	string or null <date-time> (Publish End)
publish_status	string (Publish status)
allowed_countries	Array of strings (Allowed countries) Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" Allowed Countries(ISO-3166 Alpha-2 code)
release_start	string or null <date-time> (Release Start)
release_end	string or null <date-time> (Release End)
release_weekday	Array of strings or null (WeekDay) <= 7 items Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" Set the day of the week to release.
release_status	string (Release status)
produce_year	integer (Produce year)
	object (program meta)
content_type	string or null (Content Type) Enum: "free" "plus" "premium" "ppv" Content type for services by user type
default_sales_type	string or null (Default Sales Type) Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" Default SalesType value for episode of program
age_rating	string or null (Age rating) Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
seo_title_ko	string or null (Title(SEO) (KO)) <= 255 characters
seo_title_en	string or null (Title(SEO) (EN)) <= 255 characters
seo_title_es	string or null (Title(SEO) (ES)) <= 255 characters
seo_title_zh_Hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_Hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_zh_hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_pt	string or null (Title(SEO) (PT)) <= 255 characters
seo_synopsis_ko	string or null (Synopsis(SEO) (KO))
seo_synopsis_en	string or null (Synopsis(SEO) (EN))
seo_synopsis_es	string or null (Synopsis(SEO) (ES))
seo_synopsis_zh_Hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_Hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_zh_hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_pt	string or null (Synopsis(SEO) (PT))
seo_keyword_ko	string or null (Keyword(SEO) (KO))
seo_keyword_en	string or null (Keyword(SEO) (EN))
seo_keyword_es	string or null (Keyword(SEO) (ES))
seo_keyword_zh_Hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_Hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_zh_hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_pt	string or null (Keyword(SEO) (PT))
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)
old_id	integer or null (Old id) [ 0 .. 2147483647 ]
migrated	string or null <date-time> (Migrated) If put FUTURE time into this field, migration cron WILL NOT WORK well.
categories	Array of integers unique
	Array of objects (CategoryAdmin)
genres	Array of integers unique
	Array of objects (CategoryAdmin)
number_of_episodes	integer (Number of episodes)
latest_episode	integer or null (Latest episode)
region_age_ratings	Array of strings or null
content_provider	integer or null (Content provider)
	object (ContentProviderDisplay)
in_review	boolean (In Review)

Response Schema: application/json

detail

required

string

Error details

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
400
404

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}
]
}

content_ingest_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this content ingest.

Responses

Response Schema: application/json

id

integer (Id)

source

required

string (Source)

Enum: "kcp" "mediahold" "internal"

file_path

required

string (File path) [ 1 .. 255 ] characters

status

string (Status)

Enum: "start" "processing" "end"

ingest_at

required

string <date-time> (Ingest at)

created

string <date-time> (Created)

modified

string <date-time> (Modified)

required

object (ContentIngestMetaInfo)

source_content_type	string or null (Source content type) Enum: "series" "season" "episode" "teaser" "pilot" "special" "behind scenes" "music video"
status	string (Status) Enum: "start" "ingest_meta_start" "ingest_meta_end" "generate_base_info" "ingest_assets_start" "ingest_asset_poster" "ingest_asset_thumbnail" "ingest_asset_subtitle" "ingest_asset_video_ready" "ingest_asset_video_fail" "ingest_asset_video" "ingest_asset_video_processing" "ingest_assets_end" "ingest_assets_skip" "generate_io_program" "generate_io_episode" "ready_for_mapping" "end_of_mapping" "confirmed" "ready_for_generate_disabled_targets" "generate_disabled_targets" "confirmed_disabled_targets" "end_of_targets_disabled" "report_to_kcp_start" "report_to_kcp_meta" "report_to_kcp_asset_video" "report_to_kcp_asset_poster" "report_to_kcp_asset_thumbnail" "report_to_kcp_asset_subtitle" "report_to_kcp_end" "end"
enable	boolean (Enable)

object (ContentIngestMappingODX)

If mapping data does not exist, this field is empty object.

content_type	string (Content type) non-empty
id	integer (Id)
slug	string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Response samples

200

Content type

application/json

{"id": 0,
"source": "kcp",
"file_path": "string",
"status": "start",
"ingest_at": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"meta": {"source_content_type": "series",
"status": "start",
"enable": true
},
"odx": {"content_type": "string",
"id": 0,
"slug": "string"
}
}

content_ingest_assets

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this content ingest.

Responses

Response Schema: application/json

Array

id	integer (ID)
asset_type	string (Asset type) Enum: "metadata" "poster" "thumbnail" "video" "subtitle"
status	string (Status) Enum: "ready" "processing" "fail" "success"
source	object (Source)
result	object or null (Result)
reported_at	string or null <date-time> (Reported at)

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
404

Content type

application/json

[{"id": 0,
"asset_type": "metadata",
"status": "ready",
"source": { },
"result": { },
"reported_at": "2019-08-24T14:15:22Z"
}
]

content_ingest_delete_candidate

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this content ingest.

Responses

Response Schema: application/json

id

integer (Id)

source

required

string (Source)

Enum: "kcp" "mediahold" "internal"

file_path

required

string (File path) [ 1 .. 255 ] characters

status

string (Status)

Enum: "start" "processing" "end"

ingest_at

required

string <date-time> (Ingest at)

created

string <date-time> (Created)

modified

string <date-time> (Modified)

required

object (ContentIngestMetaBase)

source_content_type

string or null (Source content type)

Enum: "series" "season" "episode" "teaser" "pilot" "special" "behind scenes" "music video"

status

string (Status)

Enum: "start" "ingest_meta_start" "ingest_meta_end" "generate_base_info" "ingest_assets_start" "ingest_asset_poster" "ingest_asset_thumbnail" "ingest_asset_subtitle" "ingest_asset_video_ready" "ingest_asset_video_fail" "ingest_asset_video" "ingest_asset_video_processing" "ingest_assets_end" "ingest_assets_skip" "generate_io_program" "generate_io_episode" "ready_for_mapping" "end_of_mapping" "confirmed" "ready_for_generate_disabled_targets" "generate_disabled_targets" "confirmed_disabled_targets" "end_of_targets_disabled" "report_to_kcp_start" "report_to_kcp_meta" "report_to_kcp_asset_video" "report_to_kcp_asset_poster" "report_to_kcp_asset_thumbnail" "report_to_kcp_asset_subtitle" "report_to_kcp_end" "end"

object (ContentIngestMappingODX)

If mapping data does not exist, this field is empty object.

content_type	string (Content type) non-empty
id	integer (Id)
slug	string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

required

object (KCPContentDeletion)

deletion_type	string or null (Deletion type) Enum: "active" "inactive" "delete"
deleted_at	string or null <date-time> (Deleted at)

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
404

Content type

application/json

{"id": 0,
"source": "kcp",
"file_path": "string",
"status": "start",
"ingest_at": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"meta": {"source_content_type": "series",
"status": "start"
},
"odx": {"content_type": "string",
"id": 0,
"slug": "string"
},
"deletion": {"deletion_type": "active",
"deleted_at": "2019-08-24T14:15:22Z"
}
}

content_ingest_disable_contents

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this content ingest.

Request Body schema: application/json
required

source

required

string (Source)

Enum: "kcp" "mediahold" "internal"

file_path

required

string (File path) [ 1 .. 255 ] characters

status

string (Status)

Enum: "start" "processing" "end"

ingest_at

required

string <date-time> (Ingest at)

required

object (ContentIngestMetaInfo)

source_content_type	string or null (Source content type) Enum: "series" "season" "episode" "teaser" "pilot" "special" "behind scenes" "music video"
status	string (Status) Enum: "start" "ingest_meta_start" "ingest_meta_end" "generate_base_info" "ingest_assets_start" "ingest_asset_poster" "ingest_asset_thumbnail" "ingest_asset_subtitle" "ingest_asset_video_ready" "ingest_asset_video_fail" "ingest_asset_video" "ingest_asset_video_processing" "ingest_assets_end" "ingest_assets_skip" "generate_io_program" "generate_io_episode" "ready_for_mapping" "end_of_mapping" "confirmed" "ready_for_generate_disabled_targets" "generate_disabled_targets" "confirmed_disabled_targets" "end_of_targets_disabled" "report_to_kcp_start" "report_to_kcp_meta" "report_to_kcp_asset_video" "report_to_kcp_asset_poster" "report_to_kcp_asset_thumbnail" "report_to_kcp_asset_subtitle" "report_to_kcp_end" "end"
enable	boolean (Enable)

object (ContentIngestMappingODX)

If mapping data does not exist, this field is empty object.

content_type	string (Content type) non-empty
id	integer (Id)
slug	string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Responses

Response Schema: application/json

detail

required

string (Detail) non-empty

Request samples

Payload

Content type

application/json

{"source": "kcp",
"file_path": "string",
"status": "start",
"ingest_at": "2019-08-24T14:15:22Z",
"meta": {"source_content_type": "series",
"status": "start",
"enable": true
},
"odx": {"content_type": "string",
"id": 0,
"slug": "string"
}
}

Response samples

404

Content type

application/json

{"detail": "string"
}

content_ingest_meta

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this content ingest.

Responses

Response Schema: application/json

source_content_type	string or null (Source content type) Enum: "series" "season" "episode" "teaser" "pilot" "special" "behind scenes" "music video"
status	string (Status) Enum: "start" "ingest_meta_start" "ingest_meta_end" "generate_base_info" "ingest_assets_start" "ingest_asset_poster" "ingest_asset_thumbnail" "ingest_asset_subtitle" "ingest_asset_video_ready" "ingest_asset_video_fail" "ingest_asset_video" "ingest_asset_video_processing" "ingest_assets_end" "ingest_assets_skip" "generate_io_program" "generate_io_episode" "ready_for_mapping" "end_of_mapping" "confirmed" "ready_for_generate_disabled_targets" "generate_disabled_targets" "confirmed_disabled_targets" "end_of_targets_disabled" "report_to_kcp_start" "report_to_kcp_meta" "report_to_kcp_asset_video" "report_to_kcp_asset_poster" "report_to_kcp_asset_thumbnail" "report_to_kcp_asset_subtitle" "report_to_kcp_end" "end"
enable	boolean (Enable)
id	integer (Id)
content_type	string or null (Content type) Enum: "program" "episode"
meta	object (Meta)
target_assets	Array of strings or null (Target assets) Enum: "metadata" "poster" "thumbnail" "video" "subtitle"

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
404

Content type

application/json

{"source_content_type": "series",
"status": "start",
"enable": true,
"id": 0,
"content_type": "program",
"meta": { },
"target_assets": ["metadata"
]
}

content_ingest_processing

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this content ingest.

Responses

Response Schema: application/json

Array

processing

string (Processing)

Enum: "start" "ingest_meta_start" "ingest_meta_end" "generate_base_info" "ingest_assets_start" "ingest_asset_poster" "ingest_asset_thumbnail" "ingest_asset_subtitle" "ingest_asset_video_ready" "ingest_asset_video_fail" "ingest_asset_video" "ingest_asset_video_processing" "ingest_assets_end" "ingest_assets_skip" "generate_io_program" "generate_io_episode" "ready_for_mapping" "end_of_mapping" "confirmed" "ready_for_generate_disabled_targets" "generate_disabled_targets" "confirmed_disabled_targets" "end_of_targets_disabled" "report_to_kcp_start" "report_to_kcp_meta" "report_to_kcp_asset_video" "report_to_kcp_asset_poster" "report_to_kcp_asset_thumbnail" "report_to_kcp_asset_subtitle" "report_to_kcp_end" "end"

created

string <date-time> (Created)

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
404

Content type

application/json

[{"processing": "start",
"created": "2019-08-24T14:15:22Z"
}
]

content_ingest_video

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this content ingest.

Responses

Response Schema: application/json

id	integer (ID)
video_id	integer (Video id) [ 0 .. 9223372036854776000 ]
status	string (Status) Enum: "created" "processing" "completed"
video	object (Video)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response Schema: application/json

detail

required

string (Detail) non-empty

Response samples

200
404

Content type

application/json

{"id": 0,
"video_id": 9223372036854776000,
"status": "created",
"video": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

content_providers

content_providers_list

Use Provider API for the cp list of ODK service.

Authorizations:

token

query Parameters

country	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ContentProviderAdmin)

Array

id	integer (ID)
code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
managers	Array of integers unique
	Array of objects (UserSimple)
memo	string (Memo)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"code": "string",
"name": "string",
"country": "KR",
"managers": [0
],
"managers_display": [{"id": 0,
"username": "string",
"email": "user@example.com",
"service_name": "odk"
}
],
"memo": "string"
}
]
}

content_providers_create

Use Provider API for the cp list of ODK service.

Authorizations:

token

Request Body schema: application/json
required

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
managers	Array of integers unique
memo	string (Memo)

Responses

Response Schema: application/json

id

integer (ID)

code

required

string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Only a-z, A-Z, 0-9, _ allowed

name

required

string (Name) [ 1 .. 200 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

managers

Array of integers unique

Array of objects (UserSimple)

Array

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

memo

string (Memo)

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"country": "KR",
"managers": [0
],
"memo": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"code": "string",
"name": "string",
"country": "KR",
"managers": [0
],
"managers_display": [{"id": 0,
"username": "string",
"email": "user@example.com",
"service_name": "odk"
}
],
"memo": "string"
}

content_providers_read

Use Provider API for the cp list of ODK service.

Authorizations:

token

path Parameters

id

required

string

Responses

Response Schema: application/json

id

integer (ID)

code

required

string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Only a-z, A-Z, 0-9, _ allowed

name

required

string (Name) [ 1 .. 200 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

managers

Array of integers unique

Array of objects (UserSimple)

Array

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

memo

string (Memo)

Response samples

200

Content type

application/json

{"id": 0,
"code": "string",
"name": "string",
"country": "KR",
"managers": [0
],
"managers_display": [{"id": 0,
"username": "string",
"email": "user@example.com",
"service_name": "odk"
}
],
"memo": "string"
}

content_providers_update

Use Provider API for the cp list of ODK service.

Authorizations:

token

path Parameters

id

required

string

Request Body schema: application/json
required

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
managers	Array of integers unique
memo	string (Memo)

Responses

Response Schema: application/json

id

integer (ID)

code

required

string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Only a-z, A-Z, 0-9, _ allowed

name

required

string (Name) [ 1 .. 200 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

managers

Array of integers unique

Array of objects (UserSimple)

Array

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

memo

string (Memo)

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"country": "KR",
"managers": [0
],
"memo": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"code": "string",
"name": "string",
"country": "KR",
"managers": [0
],
"managers_display": [{"id": 0,
"username": "string",
"email": "user@example.com",
"service_name": "odk"
}
],
"memo": "string"
}

content_providers_delete

Use Provider API for the cp list of ODK service.

Authorizations:

token

path Parameters

id

required

string

Responses

content_providers_partial_update

Use Provider API for the cp list of ODK service.

Authorizations:

token

path Parameters

id

required

string

Request Body schema: application/json
required

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
managers	Array of integers unique
memo	string (Memo)

Responses

Response Schema: application/json

id

integer (ID)

code

required

string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Only a-z, A-Z, 0-9, _ allowed

name

required

string (Name) [ 1 .. 200 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

managers

Array of integers unique

Array of objects (UserSimple)

Array

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

memo

string (Memo)

Request samples

Payload

Content type

application/json

{"code": "string",
"name": "string",
"country": "KR",
"managers": [0
],
"memo": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"code": "string",
"name": "string",
"country": "KR",
"managers": [0
],
"managers_display": [{"id": 0,
"username": "string",
"email": "user@example.com",
"service_name": "odk"
}
],
"memo": "string"
}

contract_documents

contract_documents_list

Authorizations:

token

query Parameters

service_name	string
service_region	string
contract_type	string
licence_type	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ContractDocumentAdmin)

Array

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters
contract_types	Array of strings or null (Contract types) Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"
content_provider	integer or null (Content provider)
	object (ContentProviderSimpleAdmin)
parent	integer or null (Parent contract document)
	object (ParentDisplayAdmin)
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
source_file	string or null <uri> (Source file)
tax	string or null (Tax) Enum: "NET" "GROSS"
exclusive	boolean (Exclusive)
sublicense	boolean (Sublicense)
licence_types	Array of strings or null (Licence types) Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"
royalties	Array of integers or null (Royalties) [ items [ 0 .. 32767 ] ]
services	Array of strings or null (Service Name) Enum: "odk" "odc" "odv" "odl"
service_regions	Array of strings or null (Service regions) Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"
total_price	integer or null (Total onetime_price) [ 0 .. 2147483647 ] Enter dollar units
num_of_programs	integer or null (Number of Programs) [ 0 .. 32767 ]
num_of_episodes	integer or null (Number of Episodes) [ 0 .. 32767 ]
unit_price	integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ] Enter dollar units
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)
memo	string or null (Memo)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"content_provider": 0,
"content_provider_display": {"id": 0,
"code": "string",
"name": "string",
"country": "KR"
},
"parent": 0,
"parent_display": {"id": 0,
"date": "2019-08-24",
"name": "string"
},
"country": "KR",
"source_file": "http://example.com",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"licence_types": ["FLAT-PLUS-RS"
],
"royalties": [32767
],
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}
]
}

contract_documents_create

Authorizations:

token

Request Body schema: application/json
required

date

string or null <date> (Contract date)

name

required

string (Name) [ 1 .. 255 ] characters

contract_types

Array of strings or null (Contract types)

Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"

content_provider

integer or null (Content provider)

object (ContentProviderSimpleAdmin)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

parent

integer or null (Parent contract document)

object (ParentDisplayAdmin)

date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

tax

string or null (Tax)

Enum: "NET" "GROSS"

exclusive

boolean (Exclusive)

sublicense

boolean (Sublicense)

licence_types

Array of strings or null (Licence types)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalties

Array of integers or null (Royalties) [ items [ 0 .. 32767 ] ]

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Responses

Response Schema: application/json

id

integer (ID)

date

string or null <date> (Contract date)

name

required

string (Name) [ 1 .. 255 ] characters

contract_types

Array of strings or null (Contract types)

Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"

content_provider

integer or null (Content provider)

object (ContentProviderSimpleAdmin)

id	integer (ID)
code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

parent

integer or null (Parent contract document)

object (ParentDisplayAdmin)

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

source_file

string or null <uri> (Source file)

tax

string or null (Tax)

Enum: "NET" "GROSS"

exclusive

boolean (Exclusive)

sublicense

boolean (Sublicense)

licence_types

Array of strings or null (Licence types)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalties

Array of integers or null (Royalties) [ items [ 0 .. 32767 ] ]

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Request samples

Payload

Content type

application/json

{"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"parent": 0,
"parent_display": {"date": "2019-08-24",
"name": "string"
},
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"licence_types": ["FLAT-PLUS-RS"
],
"royalties": [32767
],
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"content_provider": 0,
"content_provider_display": {"id": 0,
"code": "string",
"name": "string",
"country": "KR"
},
"parent": 0,
"parent_display": {"id": 0,
"date": "2019-08-24",
"name": "string"
},
"country": "KR",
"source_file": "http://example.com",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"licence_types": ["FLAT-PLUS-RS"
],
"royalties": [32767
],
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

contract_documents_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Contract document.

Responses

Response Schema: application/json

id

integer (ID)

date

string or null <date> (Contract date)

name

required

string (Name) [ 1 .. 255 ] characters

contract_types

Array of strings or null (Contract types)

Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"

content_provider

integer or null (Content provider)

object (ContentProviderSimpleAdmin)

id	integer (ID)
code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

parent

integer or null (Parent contract document)

object (ParentDisplayAdmin)

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

source_file

string or null <uri> (Source file)

tax

string or null (Tax)

Enum: "NET" "GROSS"

exclusive

boolean (Exclusive)

sublicense

boolean (Sublicense)

licence_types

Array of strings or null (Licence types)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalties

Array of integers or null (Royalties) [ items [ 0 .. 32767 ] ]

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Response samples

200

Content type

application/json

{"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"content_provider": 0,
"content_provider_display": {"id": 0,
"code": "string",
"name": "string",
"country": "KR"
},
"parent": 0,
"parent_display": {"id": 0,
"date": "2019-08-24",
"name": "string"
},
"country": "KR",
"source_file": "http://example.com",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"licence_types": ["FLAT-PLUS-RS"
],
"royalties": [32767
],
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

contract_documents_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Contract document.

Request Body schema: application/json
required

date

string or null <date> (Contract date)

name

required

string (Name) [ 1 .. 255 ] characters

contract_types

Array of strings or null (Contract types)

Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"

content_provider

integer or null (Content provider)

object (ContentProviderSimpleAdmin)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

parent

integer or null (Parent contract document)

object (ParentDisplayAdmin)

date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

tax

string or null (Tax)

Enum: "NET" "GROSS"

exclusive

boolean (Exclusive)

sublicense

boolean (Sublicense)

licence_types

Array of strings or null (Licence types)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalties

Array of integers or null (Royalties) [ items [ 0 .. 32767 ] ]

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Responses

Response Schema: application/json

id

integer (ID)

date

string or null <date> (Contract date)

name

required

string (Name) [ 1 .. 255 ] characters

contract_types

Array of strings or null (Contract types)

Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"

content_provider

integer or null (Content provider)

object (ContentProviderSimpleAdmin)

id	integer (ID)
code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

parent

integer or null (Parent contract document)

object (ParentDisplayAdmin)

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

source_file

string or null <uri> (Source file)

tax

string or null (Tax)

Enum: "NET" "GROSS"

exclusive

boolean (Exclusive)

sublicense

boolean (Sublicense)

licence_types

Array of strings or null (Licence types)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalties

Array of integers or null (Royalties) [ items [ 0 .. 32767 ] ]

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Request samples

Payload

Content type

application/json

{"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"parent": 0,
"parent_display": {"date": "2019-08-24",
"name": "string"
},
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"licence_types": ["FLAT-PLUS-RS"
],
"royalties": [32767
],
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"content_provider": 0,
"content_provider_display": {"id": 0,
"code": "string",
"name": "string",
"country": "KR"
},
"parent": 0,
"parent_display": {"id": 0,
"date": "2019-08-24",
"name": "string"
},
"country": "KR",
"source_file": "http://example.com",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"licence_types": ["FLAT-PLUS-RS"
],
"royalties": [32767
],
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

contract_documents_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Contract document.

Responses

contract_documents_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Contract document.

Request Body schema: application/json
required

date

string or null <date> (Contract date)

name

required

string (Name) [ 1 .. 255 ] characters

contract_types

Array of strings or null (Contract types)

Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"

content_provider

integer or null (Content provider)

object (ContentProviderSimpleAdmin)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

parent

integer or null (Parent contract document)

object (ParentDisplayAdmin)

date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

tax

string or null (Tax)

Enum: "NET" "GROSS"

exclusive

boolean (Exclusive)

sublicense

boolean (Sublicense)

licence_types

Array of strings or null (Licence types)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalties

Array of integers or null (Royalties) [ items [ 0 .. 32767 ] ]

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Responses

Response Schema: application/json

id

integer (ID)

date

string or null <date> (Contract date)

name

required

string (Name) [ 1 .. 255 ] characters

contract_types

Array of strings or null (Contract types)

Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"

content_provider

integer or null (Content provider)

object (ContentProviderSimpleAdmin)

id	integer (ID)
code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

parent

integer or null (Parent contract document)

object (ParentDisplayAdmin)

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters

country

string or null (Country)

Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

ISO-3166 Alpha-2 code

source_file

string or null <uri> (Source file)

tax

string or null (Tax)

Enum: "NET" "GROSS"

exclusive

boolean (Exclusive)

sublicense

boolean (Sublicense)

licence_types

Array of strings or null (Licence types)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalties

Array of integers or null (Royalties) [ items [ 0 .. 32767 ] ]

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Request samples

Payload

Content type

application/json

{"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"parent": 0,
"parent_display": {"date": "2019-08-24",
"name": "string"
},
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"licence_types": ["FLAT-PLUS-RS"
],
"royalties": [32767
],
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"content_provider": 0,
"content_provider_display": {"id": 0,
"code": "string",
"name": "string",
"country": "KR"
},
"parent": 0,
"parent_display": {"id": 0,
"date": "2019-08-24",
"name": "string"
},
"country": "KR",
"source_file": "http://example.com",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"licence_types": ["FLAT-PLUS-RS"
],
"royalties": [32767
],
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

contracts

contracts_list

Authorizations:

token

query Parameters

service_name	string
service_region	string
licence_type	string
document	string
programs	string
episodes	string
monthly_payment	string
auto_episode_update	string
subtitle	string
vod_right	string
dubbing	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ContractAdmin)

Array

id	integer (ID)
title required	string or null (Title) <= 255 characters
licence_type	string or null (Licence type) Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"
royalty	integer or null (Royalty) [ 0 .. 32767 ]
service_start	string or null <date> (Service start date)
service_end	string or null <date> (Service end date)
document	integer or null (Contract document)
	object (DocumentDisplayAdmin)
programs	Array of integers unique
episodes	Array of integers unique
monthly_payment	boolean (Monthly payment)
auto_episode_update	boolean (Auto episode update) If this field is 'True', the new episode of this contract's programs will be added.
subtitles	Array of strings or null (Subtitles) Enum: "en" "ko" "chs" "cht" "cn" "ja" "vi" "es" "po"
vod_rights	Array of strings or null (Vod rights) Enum: "SVOD" "AVOD" "TVOD"
dubbing	boolean (Dubbing)
services	Array of strings or null (Service Name) Enum: "odk" "odc" "odv" "odl"
service_regions	Array of strings or null (Service regions) Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"
total_price	integer or null (Total onetime_price) [ 0 .. 2147483647 ] Enter dollar units
num_of_programs	integer or null (Number of Programs) [ 0 .. 32767 ]
num_of_episodes	integer or null (Number of Episodes) [ 0 .. 32767 ]
unit_price	integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ] Enter dollar units
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)
memo	string or null (Memo)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"title": "string",
"licence_type": "FLAT-PLUS-RS",
"royalty": 32767,
"service_start": "2019-08-24",
"service_end": "2019-08-24",
"document": 0,
"document_display": {"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true
},
"programs": [0
],
"episodes": [0
],
"monthly_payment": true,
"auto_episode_update": true,
"subtitles": ["en"
],
"vod_rights": ["SVOD"
],
"dubbing": true,
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}
]
}

contracts_create

Authorizations:

token

Request Body schema: application/json
required

title

required

string or null (Title) <= 255 characters

licence_type

string or null (Licence type)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalty

integer or null (Royalty) [ 0 .. 32767 ]

service_start

string or null <date> (Service start date)

service_end

string or null <date> (Service end date)

document

integer or null (Contract document)

object (DocumentDisplayAdmin)

date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters
contract_types	Array of strings or null (Contract types) Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
tax	string or null (Tax) Enum: "NET" "GROSS"
exclusive	boolean (Exclusive)
sublicense	boolean (Sublicense)
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)

programs

Array of integers unique

episodes

Array of integers unique

monthly_payment

boolean (Monthly payment)

auto_episode_update

boolean (Auto episode update)

If this field is 'True', the new episode of this contract's programs will be added.

subtitles

Array of strings or null (Subtitles)

Enum: "en" "ko" "chs" "cht" "cn" "ja" "vi" "es" "po"

vod_rights

Array of strings or null (Vod rights)

Enum: "SVOD" "AVOD" "TVOD"

dubbing

boolean (Dubbing)

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Responses

Response Schema: application/json

id

integer (ID)

title

required

string or null (Title) <= 255 characters

licence_type

string or null (Licence type)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalty

integer or null (Royalty) [ 0 .. 32767 ]

service_start

string or null <date> (Service start date)

service_end

string or null <date> (Service end date)

document

integer or null (Contract document)

object (DocumentDisplayAdmin)

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters
contract_types	Array of strings or null (Contract types) Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
tax	string or null (Tax) Enum: "NET" "GROSS"
exclusive	boolean (Exclusive)
sublicense	boolean (Sublicense)
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)

programs

Array of integers unique

episodes

Array of integers unique

monthly_payment

boolean (Monthly payment)

auto_episode_update

boolean (Auto episode update)

If this field is 'True', the new episode of this contract's programs will be added.

subtitles

Array of strings or null (Subtitles)

Enum: "en" "ko" "chs" "cht" "cn" "ja" "vi" "es" "po"

vod_rights

Array of strings or null (Vod rights)

Enum: "SVOD" "AVOD" "TVOD"

dubbing

boolean (Dubbing)

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Request samples

Payload

Content type

application/json

{"title": "string",
"licence_type": "FLAT-PLUS-RS",
"royalty": 32767,
"service_start": "2019-08-24",
"service_end": "2019-08-24",
"document": 0,
"document_display": {"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true
},
"programs": [0
],
"episodes": [0
],
"monthly_payment": true,
"auto_episode_update": true,
"subtitles": ["en"
],
"vod_rights": ["SVOD"
],
"dubbing": true,
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"title": "string",
"licence_type": "FLAT-PLUS-RS",
"royalty": 32767,
"service_start": "2019-08-24",
"service_end": "2019-08-24",
"document": 0,
"document_display": {"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true
},
"programs": [0
],
"episodes": [0
],
"monthly_payment": true,
"auto_episode_update": true,
"subtitles": ["en"
],
"vod_rights": ["SVOD"
],
"dubbing": true,
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

contracts_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Contract.

Responses

Response Schema: application/json

id

integer (ID)

title

required

string or null (Title) <= 255 characters

licence_type

string or null (Licence type)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalty

integer or null (Royalty) [ 0 .. 32767 ]

service_start

string or null <date> (Service start date)

service_end

string or null <date> (Service end date)

document

integer or null (Contract document)

object (DocumentDisplayAdmin)

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters
contract_types	Array of strings or null (Contract types) Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
tax	string or null (Tax) Enum: "NET" "GROSS"
exclusive	boolean (Exclusive)
sublicense	boolean (Sublicense)
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)

programs

Array of integers unique

episodes

Array of integers unique

monthly_payment

boolean (Monthly payment)

auto_episode_update

boolean (Auto episode update)

If this field is 'True', the new episode of this contract's programs will be added.

subtitles

Array of strings or null (Subtitles)

Enum: "en" "ko" "chs" "cht" "cn" "ja" "vi" "es" "po"

vod_rights

Array of strings or null (Vod rights)

Enum: "SVOD" "AVOD" "TVOD"

dubbing

boolean (Dubbing)

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Response samples

200

Content type

application/json

{"id": 0,
"title": "string",
"licence_type": "FLAT-PLUS-RS",
"royalty": 32767,
"service_start": "2019-08-24",
"service_end": "2019-08-24",
"document": 0,
"document_display": {"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true
},
"programs": [0
],
"episodes": [0
],
"monthly_payment": true,
"auto_episode_update": true,
"subtitles": ["en"
],
"vod_rights": ["SVOD"
],
"dubbing": true,
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

contracts_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Contract.

Request Body schema: application/json
required

title

required

string or null (Title) <= 255 characters

licence_type

string or null (Licence type)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalty

integer or null (Royalty) [ 0 .. 32767 ]

service_start

string or null <date> (Service start date)

service_end

string or null <date> (Service end date)

document

integer or null (Contract document)

object (DocumentDisplayAdmin)

date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters
contract_types	Array of strings or null (Contract types) Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
tax	string or null (Tax) Enum: "NET" "GROSS"
exclusive	boolean (Exclusive)
sublicense	boolean (Sublicense)
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)

programs

Array of integers unique

episodes

Array of integers unique

monthly_payment

boolean (Monthly payment)

auto_episode_update

boolean (Auto episode update)

If this field is 'True', the new episode of this contract's programs will be added.

subtitles

Array of strings or null (Subtitles)

Enum: "en" "ko" "chs" "cht" "cn" "ja" "vi" "es" "po"

vod_rights

Array of strings or null (Vod rights)

Enum: "SVOD" "AVOD" "TVOD"

dubbing

boolean (Dubbing)

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Responses

Response Schema: application/json

id

integer (ID)

title

required

string or null (Title) <= 255 characters

licence_type

string or null (Licence type)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalty

integer or null (Royalty) [ 0 .. 32767 ]

service_start

string or null <date> (Service start date)

service_end

string or null <date> (Service end date)

document

integer or null (Contract document)

object (DocumentDisplayAdmin)

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters
contract_types	Array of strings or null (Contract types) Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
tax	string or null (Tax) Enum: "NET" "GROSS"
exclusive	boolean (Exclusive)
sublicense	boolean (Sublicense)
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)

programs

Array of integers unique

episodes

Array of integers unique

monthly_payment

boolean (Monthly payment)

auto_episode_update

boolean (Auto episode update)

If this field is 'True', the new episode of this contract's programs will be added.

subtitles

Array of strings or null (Subtitles)

Enum: "en" "ko" "chs" "cht" "cn" "ja" "vi" "es" "po"

vod_rights

Array of strings or null (Vod rights)

Enum: "SVOD" "AVOD" "TVOD"

dubbing

boolean (Dubbing)

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Request samples

Payload

Content type

application/json

{"title": "string",
"licence_type": "FLAT-PLUS-RS",
"royalty": 32767,
"service_start": "2019-08-24",
"service_end": "2019-08-24",
"document": 0,
"document_display": {"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true
},
"programs": [0
],
"episodes": [0
],
"monthly_payment": true,
"auto_episode_update": true,
"subtitles": ["en"
],
"vod_rights": ["SVOD"
],
"dubbing": true,
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"title": "string",
"licence_type": "FLAT-PLUS-RS",
"royalty": 32767,
"service_start": "2019-08-24",
"service_end": "2019-08-24",
"document": 0,
"document_display": {"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true
},
"programs": [0
],
"episodes": [0
],
"monthly_payment": true,
"auto_episode_update": true,
"subtitles": ["en"
],
"vod_rights": ["SVOD"
],
"dubbing": true,
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

contracts_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Contract.

Responses

contracts_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Contract.

Request Body schema: application/json
required

title

required

string or null (Title) <= 255 characters

licence_type

string or null (Licence type)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalty

integer or null (Royalty) [ 0 .. 32767 ]

service_start

string or null <date> (Service start date)

service_end

string or null <date> (Service end date)

document

integer or null (Contract document)

object (DocumentDisplayAdmin)

date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters
contract_types	Array of strings or null (Contract types) Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
tax	string or null (Tax) Enum: "NET" "GROSS"
exclusive	boolean (Exclusive)
sublicense	boolean (Sublicense)
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)

programs

Array of integers unique

episodes

Array of integers unique

monthly_payment

boolean (Monthly payment)

auto_episode_update

boolean (Auto episode update)

If this field is 'True', the new episode of this contract's programs will be added.

subtitles

Array of strings or null (Subtitles)

Enum: "en" "ko" "chs" "cht" "cn" "ja" "vi" "es" "po"

vod_rights

Array of strings or null (Vod rights)

Enum: "SVOD" "AVOD" "TVOD"

dubbing

boolean (Dubbing)

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Responses

Response Schema: application/json

id

integer (ID)

title

required

string or null (Title) <= 255 characters

licence_type

string or null (Licence type)

Enum: "FLAT-PLUS-RS" "RS_PLUS_MATERIAL_FEE" "BARTER" "MG_PLUS_RS" "FLAT" "RS"

royalty

integer or null (Royalty) [ 0 .. 32767 ]

service_start

string or null <date> (Service start date)

service_end

string or null <date> (Service end date)

document

integer or null (Contract document)

object (DocumentDisplayAdmin)

id	integer (ID)
date	string or null <date> (Contract date)
name required	string (Name) [ 1 .. 255 ] characters
contract_types	Array of strings or null (Contract types) Enum: "ANNUAL-CONTRACT" "MULTIPLE-CONTRACT" "VOLUME-CONTRACT" "SINGLE_CONTRACT" "THIRD-PARTY-CONTRACT" "ATTACHED-AGREEMENT" "TERMINATION-AGREEMENT" "COOPERATION-AGREEMENT"
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code
tax	string or null (Tax) Enum: "NET" "GROSS"
exclusive	boolean (Exclusive)
sublicense	boolean (Sublicense)
start	string or null <date> (Contract start date)
end	string or null <date> (Contract end date)
enable	boolean (Contract enable)

programs

Array of integers unique

episodes

Array of integers unique

monthly_payment

boolean (Monthly payment)

auto_episode_update

boolean (Auto episode update)

If this field is 'True', the new episode of this contract's programs will be added.

subtitles

Array of strings or null (Subtitles)

Enum: "en" "ko" "chs" "cht" "cn" "ja" "vi" "es" "po"

vod_rights

Array of strings or null (Vod rights)

Enum: "SVOD" "AVOD" "TVOD"

dubbing

boolean (Dubbing)

services

Array of strings or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

service_regions

Array of strings or null (Service regions)

Enum: "OC" "EU" "SEA" "SA" "NA" "USA" "ALL" "ALL-EX-JP" "ALL-EX-CN"

total_price

integer or null (Total onetime_price) [ 0 .. 2147483647 ]

Enter dollar units

num_of_programs

integer or null (Number of Programs) [ 0 .. 32767 ]

num_of_episodes

integer or null (Number of Episodes) [ 0 .. 32767 ]

unit_price

integer or null (Unit onetime_price(per episode)) [ 0 .. 2147483647 ]

Enter dollar units

start

string or null <date> (Contract start date)

end

string or null <date> (Contract end date)

enable

boolean (Contract enable)

memo

string or null (Memo)

Request samples

Payload

Content type

application/json

{"title": "string",
"licence_type": "FLAT-PLUS-RS",
"royalty": 32767,
"service_start": "2019-08-24",
"service_end": "2019-08-24",
"document": 0,
"document_display": {"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true
},
"programs": [0
],
"episodes": [0
],
"monthly_payment": true,
"auto_episode_update": true,
"subtitles": ["en"
],
"vod_rights": ["SVOD"
],
"dubbing": true,
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"title": "string",
"licence_type": "FLAT-PLUS-RS",
"royalty": 32767,
"service_start": "2019-08-24",
"service_end": "2019-08-24",
"document": 0,
"document_display": {"id": 0,
"date": "2019-08-24",
"name": "string",
"contract_types": ["ANNUAL-CONTRACT"
],
"country": "KR",
"tax": "NET",
"exclusive": true,
"sublicense": true,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true
},
"programs": [0
],
"episodes": [0
],
"monthly_payment": true,
"auto_episode_update": true,
"subtitles": ["en"
],
"vod_rights": ["SVOD"
],
"dubbing": true,
"services": ["odk"
],
"service_regions": ["OC"
],
"total_price": 2147483647,
"num_of_programs": 32767,
"num_of_episodes": 32767,
"unit_price": 2147483647,
"start": "2019-08-24",
"end": "2019-08-24",
"enable": true,
"memo": "string"
}

cover

cover_list

Authorizations:

token

query Parameters

service_name	string
slug	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (CoverAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

cover_create

Authorizations:

token

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": { },
"service_name": "odk"
}

Response samples

201

Content type

application/json

{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

cover_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

cover_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": { },
"service_name": "odk"
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

cover_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Responses

cover_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": { },
"service_name": "odk"
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

curation

curation_list

Authorizations:

token

query Parameters

service_name	string
slug	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (CurationAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
required	object (CurationContents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{"id": 0,
"slug": "string",
"title": "string"
}
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

curation_create

Authorizations:

token

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Home slug for url

required

object (CurationContents)

slug

string (Slug)

type

string (Type)

Enum: "episode" "program"

ratio

string (Ratio)

Enum: "portrait" "landscape"

title

string or null (Title)

title_url

string or null (Title url)

max

integer or null (Max)

manual_ids

Array of integers or null

program_direct_play

boolean or null (Program direct play)

logic_category

integer or null (Logic category)

logic_ordering

string or null (Logic ordering)

Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"

Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"

object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

url	integer
image	string image url
tracking	string or null tracking url

(Array of Carousels (EpisodeList (object) or any)) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) (Carousels)

type == episode: Carousels.EpisodeList
type == program: Carousels.ProgramList
logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
logic_ordering == episode-continue-watching: CarouselsForContinueWatching

One of

Array

One of

id	integer (ID)
	object (CurationProgramForEpisodeList)
kind	string (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number	integer (Number)
part	integer (Part)
title	string (Title)
	object or null (EpisodeImages)
video	string (Video) A URL of video preview (the highest preset video's m3u8 file)
video_cc_languages	Array of strings or null Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
age_rating	any Deprecated Age rating's label. this field's value is always `null`. It will be removed.
	object (Badges)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Home slug for url

required

object (CurationContents)

slug

string (Slug)

type

string (Type)

Enum: "episode" "program"

ratio

string (Ratio)

Enum: "portrait" "landscape"

title

string or null (Title)

title_url

string or null (Title url)

max

integer or null (Max)

manual_ids

Array of integers or null

program_direct_play

boolean or null (Program direct play)

logic_category

integer or null (Logic category)

logic_ordering

string or null (Logic ordering)

Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"

Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"

object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

url	integer
image	string image url
tracking	string or null tracking url

(Array of Carousels (EpisodeList (object) or any)) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) (Carousels)

type == episode: Carousels.EpisodeList
type == program: Carousels.ProgramList
logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
logic_ordering == episode-continue-watching: CarouselsForContinueWatching

One of

Array

One of

id	integer (ID)
	object (CurationProgramForEpisodeList)
kind	string (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number	integer (Number)
part	integer (Part)
title	string (Title)
	object or null (EpisodeImages)
video	string (Video) A URL of video preview (the highest preset video's m3u8 file)
video_cc_languages	Array of strings or null Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
age_rating	any Deprecated Age rating's label. this field's value is always `null`. It will be removed.
	object (Badges)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{ }
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk"
}

Response samples

201

Content type

application/json

{"id": 0,
"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{"id": 0,
"slug": "string",
"title": "string"
}
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

curation_cache_clear_all

Authorizations:

token

query Parameters

service_name	string
slug	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (CurationAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
required	object (CurationContents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{"id": 0,
"slug": "string",
"title": "string"
}
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

curation_cache_clear_list

Authorizations:

token

query Parameters

service_name	string
slug	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (CurationAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
required	object (CurationContents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{"id": 0,
"slug": "string",
"title": "string"
}
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

curation_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Home slug for url

required

object (CurationContents)

slug

string (Slug)

type

string (Type)

Enum: "episode" "program"

ratio

string (Ratio)

Enum: "portrait" "landscape"

title

string or null (Title)

title_url

string or null (Title url)

max

integer or null (Max)

manual_ids

Array of integers or null

program_direct_play

boolean or null (Program direct play)

logic_category

integer or null (Logic category)

logic_ordering

string or null (Logic ordering)

Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"

Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"

object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

url	integer
image	string image url
tracking	string or null tracking url

(Array of Carousels (EpisodeList (object) or any)) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) (Carousels)

type == episode: Carousels.EpisodeList
type == program: Carousels.ProgramList
logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
logic_ordering == episode-continue-watching: CarouselsForContinueWatching

One of

Array

One of

id	integer (ID)
	object (CurationProgramForEpisodeList)
kind	string (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number	integer (Number)
part	integer (Part)
title	string (Title)
	object or null (EpisodeImages)
video	string (Video) A URL of video preview (the highest preset video's m3u8 file)
video_cc_languages	Array of strings or null Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
age_rating	any Deprecated Age rating's label. this field's value is always `null`. It will be removed.
	object (Badges)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{"id": 0,
"slug": "string",
"title": "string"
}
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

curation_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Home slug for url

required

object (CurationContents)

slug

string (Slug)

type

string (Type)

Enum: "episode" "program"

ratio

string (Ratio)

Enum: "portrait" "landscape"

title

string or null (Title)

title_url

string or null (Title url)

max

integer or null (Max)

manual_ids

Array of integers or null

program_direct_play

boolean or null (Program direct play)

logic_category

integer or null (Logic category)

logic_ordering

string or null (Logic ordering)

Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"

Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"

object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

url	integer
image	string image url
tracking	string or null tracking url

(Array of Carousels (EpisodeList (object) or any)) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) (Carousels)

type == episode: Carousels.EpisodeList
type == program: Carousels.ProgramList
logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
logic_ordering == episode-continue-watching: CarouselsForContinueWatching

One of

Array

One of

id	integer (ID)
	object (CurationProgramForEpisodeList)
kind	string (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number	integer (Number)
part	integer (Part)
title	string (Title)
	object or null (EpisodeImages)
video	string (Video) A URL of video preview (the highest preset video's m3u8 file)
video_cc_languages	Array of strings or null Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
age_rating	any Deprecated Age rating's label. this field's value is always `null`. It will be removed.
	object (Badges)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Home slug for url

required

object (CurationContents)

slug

string (Slug)

type

string (Type)

Enum: "episode" "program"

ratio

string (Ratio)

Enum: "portrait" "landscape"

title

string or null (Title)

title_url

string or null (Title url)

max

integer or null (Max)

manual_ids

Array of integers or null

program_direct_play

boolean or null (Program direct play)

logic_category

integer or null (Logic category)

logic_ordering

string or null (Logic ordering)

Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"

Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"

object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

url	integer
image	string image url
tracking	string or null tracking url

(Array of Carousels (EpisodeList (object) or any)) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) (Carousels)

type == episode: Carousels.EpisodeList
type == program: Carousels.ProgramList
logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
logic_ordering == episode-continue-watching: CarouselsForContinueWatching

One of

Array

One of

id	integer (ID)
	object (CurationProgramForEpisodeList)
kind	string (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number	integer (Number)
part	integer (Part)
title	string (Title)
	object or null (EpisodeImages)
video	string (Video) A URL of video preview (the highest preset video's m3u8 file)
video_cc_languages	Array of strings or null Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
age_rating	any Deprecated Age rating's label. this field's value is always `null`. It will be removed.
	object (Badges)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{ }
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk"
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{"id": 0,
"slug": "string",
"title": "string"
}
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

curation_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Responses

curation_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Home slug for url

required

object (CurationContents)

slug

string (Slug)

type

string (Type)

Enum: "episode" "program"

ratio

string (Ratio)

Enum: "portrait" "landscape"

title

string or null (Title)

title_url

string or null (Title url)

max

integer or null (Max)

manual_ids

Array of integers or null

program_direct_play

boolean or null (Program direct play)

logic_category

integer or null (Logic category)

logic_ordering

string or null (Logic ordering)

Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"

Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"

object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

url	integer
image	string image url
tracking	string or null tracking url

(Array of Carousels (EpisodeList (object) or any)) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) (Carousels)

type == episode: Carousels.EpisodeList
type == program: Carousels.ProgramList
logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
logic_ordering == episode-continue-watching: CarouselsForContinueWatching

One of

Array

One of

id	integer (ID)
	object (CurationProgramForEpisodeList)
kind	string (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number	integer (Number)
part	integer (Part)
title	string (Title)
	object or null (EpisodeImages)
video	string (Video) A URL of video preview (the highest preset video's m3u8 file)
video_cc_languages	Array of strings or null Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
age_rating	any Deprecated Age rating's label. this field's value is always `null`. It will be removed.
	object (Badges)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Home slug for url

required

object (CurationContents)

slug

string (Slug)

type

string (Type)

Enum: "episode" "program"

ratio

string (Ratio)

Enum: "portrait" "landscape"

title

string or null (Title)

title_url

string or null (Title url)

max

integer or null (Max)

manual_ids

Array of integers or null

program_direct_play

boolean or null (Program direct play)

logic_category

integer or null (Logic category)

logic_ordering

string or null (Logic ordering)

Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"

Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"

object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

url	integer
image	string image url
tracking	string or null tracking url

(Array of Carousels (EpisodeList (object) or any)) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) (Carousels)

type == episode: Carousels.EpisodeList
type == program: Carousels.ProgramList
logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
logic_ordering == episode-continue-watching: CarouselsForContinueWatching

One of

Array

One of

id	integer (ID)
	object (CurationProgramForEpisodeList)
kind	string (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number	integer (Number)
part	integer (Part)
title	string (Title)
	object or null (EpisodeImages)
video	string (Video) A URL of video preview (the highest preset video's m3u8 file)
video_cc_languages	Array of strings or null Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
age_rating	any Deprecated Age rating's label. this field's value is always `null`. It will be removed.
	object (Badges)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{ }
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk"
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{"id": 0,
"slug": "string",
"title": "string"
}
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

curation_cache_clear

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$

Home slug for url

required

object (CurationContents)

slug

string (Slug)

type

string (Type)

Enum: "episode" "program"

ratio

string (Ratio)

Enum: "portrait" "landscape"

title

string or null (Title)

title_url

string or null (Title url)

max

integer or null (Max)

manual_ids

Array of integers or null

program_direct_play

boolean or null (Program direct play)

logic_category

integer or null (Logic category)

logic_ordering

string or null (Logic ordering)

Enum: "episode-recent-updated" "episode-recent-updated-in-24h" "episode-recent-updated-except-news-and-daily-life" "episode-24h-free" "episode-recent-updated-by-date" "episode-popular-by-data" "episode-recommendation" "episode-continue-watching" "program-recent-updated" "program-popular" "program-custom-drama" "program-custom-variety" "program-custom-documentary" "program-custom-movie" "program-custom-news" "program-custom-kids" "program-favorite"

Available in ODK: "program-recent-updated", "program-popular", "program-favorite", "episode-continue-watching", "episode-recent-updated", "episode-recent-updated-in-24h", "episode-recent-updated-except-news-and-daily-life", "episode-24h-free", "episode-popular-by-data", "episode-recommendation", , "episode-recent-updated-by-date", "featured-collection"
Available in ODC: "program-recent-updated", "program-popular", "program-custom-drama", "program-custom-variety", "program-custom-movie", "program-custom-documentary", "program-custom-news", "program-custom-kids", "episode-continue-watching", "episode-recent-updated"
Available in ODL: "program-recent-updated", "program-popular", "episode-continue-watching", "episode-recent-updated"

object or null

The carousel banner's information(e.g. Featured Collection banner). If there's no banner info in DB, it returns null

url	integer
image	string image url
tracking	string or null tracking url

(Array of Carousels (EpisodeList (object) or any)) or CarouselsForWhatsNew (object) or (Array of CarouselsForContinueWatching (objects or null)) (Carousels)

type == episode: Carousels.EpisodeList
type == program: Carousels.ProgramList
logic_ordering == episode-recent-updated-by-date: CarouselsForWhatsNew
logic_ordering == episode-continue-watching: CarouselsForContinueWatching

One of

Array

One of

id	integer (ID)
	object (CurationProgramForEpisodeList)
kind	string (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number	integer (Number)
part	integer (Part)
title	string (Title)
	object or null (EpisodeImages)
video	string (Video) A URL of video preview (the highest preset video's m3u8 file)
video_cc_languages	Array of strings or null Enum: "ko" "en" "es" "zh-Hans" "zh-Hant" "zh-hans" "zh-hant" "pt"
age_rating	any Deprecated Age rating's label. this field's value is always `null`. It will be removed.
	object (Badges)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": {"slug": "string",
"type": "episode",
"ratio": "portrait",
"title": "string",
"title_url": "string",
"max": 0,
"manual_ids": [0
],
"program_direct_play": true,
"logic_category": 0,
"logic_ordering": "episode-recent-updated",
"cover": {"url": "https://test.com",
"image": "https://image-url.com",
"tracking": "https://tracking-url.com"
},
"carousels": [{"id": 0,
"program": {"id": 0,
"slug": "string",
"title": "string",
"images": {"poster": "http://example.com",
"poster_landscape": "http://example.com",
"poster_portrait": "http://example.com"
},
"categories": [{"id": 0,
"slug": "string",
"title": "string"
}
]
},
"kind": "series",
"number": 0,
"part": 0,
"title": "string",
"images": {"thumbnail": "http://example.com"
},
"video": "string",
"video_cc_languages": ["ko"
],
"age_rating": null,
"badges": {"top_left": "content-premium",
"top_right": "content-live",
"bottom_left": "content-new-episode",
"bottom_right": "string"
}
}
]
},
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

episodes

episodes_list

ordering fields
- id, number, modified
  - ex) {host}/admin/api/episodes/?ordering=-modified&search=hero
- see details about hyphen

Authorizations:

token

query Parameters

slug	string
kind	string
number	number
part	number
enable	string
video__id	number
video__brightcove_id	string
program	string
program__slug	string
program__service_name	string
sales_type	string
publish_status	string
program__publish_status	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (EpisodeAdmin)

Array

id	integer (ID)
kind required	string or null (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number required	integer or null (Number) [ 0 .. 2147483647 ]
part	integer or null (Part) [ 0 .. 2147483647 ]
release_date	string or null <date> (Recently broadcast date)
	object (images)
uuid	string <uuid> (Uuid) This value is not editable.
cp	string (Cp)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
synopsis_ko	string or null (Synopsis (KO))
synopsis_en	string (Synopsis en)
synopsis_es	string or null (Synopsis (ES))
synopsis_zh_Hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_Hant	string or null (Synopsis (ZH-HANT))
synopsis_zh_hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_hant	string or null (Synopsis (ZH-HANT))
synopsis_pt	string or null (Synopsis (PT))
seo_title_ko	string or null (Title(SEO) (KO)) <= 255 characters
seo_title_en	string or null (Title(SEO) (EN)) <= 255 characters
seo_title_es	string or null (Title(SEO) (ES)) <= 255 characters
seo_title_zh_Hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_Hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_zh_hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_pt	string or null (Title(SEO) (PT)) <= 255 characters
seo_synopsis_ko	string or null (Synopsis(SEO) (KO))
seo_synopsis_en	string or null (Synopsis(SEO) (EN))
seo_synopsis_es	string or null (Synopsis(SEO) (ES))
seo_synopsis_zh_Hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_Hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_zh_hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_pt	string or null (Synopsis(SEO) (PT))
seo_keyword_ko	string or null (Keyword(SEO) (KO))
seo_keyword_en	string or null (Keyword(SEO) (EN))
seo_keyword_es	string or null (Keyword(SEO) (ES))
seo_keyword_zh_Hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_Hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_zh_hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_pt	string or null (Keyword(SEO) (PT))
	object (episode meta)
content_type	string or null (Content Type) Enum: "free" "plus" "premium" "ppv" Content type for services by user type
sales_type	string or null (Sales Type) Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" Sales Type needed to watch this episode
program	integer (Program)
	object (ProgramSimple)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
season	integer or null (Season) [ -2147483648 .. 2147483647 ]
publish_status	string (Publish status)
enable	boolean (Enable)
publish_start	string or null <date-time> (Publish Start)
publish_end	string or null <date-time> (Publish End)
in_review	boolean (In Review)
allowed_countries	Array of strings (Allowed countries) Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" Allowed Countries(ISO-3166 Alpha-2 code)
	object (video)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
is_notice	boolean (Episode for notice)
old_id	integer or null (Old id) [ 0 .. 2147483647 ]
migrated	string or null <date-time> (Migrated) If put FUTURE time into this field, migration cron WILL NOT WORK well.
age_rating	string or null (Age rating) Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
region_age_ratings	Array of strings or null

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}
]
}

episodes_create

Authorizations:

token

Request Body schema: application/json
required

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Responses

Response Schema: application/json

id

integer (ID)

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

uuid

string <uuid> (Uuid)

This value is not editable.

cp

string (Cp)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

publish_status

string (Publish status)

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

created

string <date-time> (Created)

modified

string <date-time> (Modified)

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Request samples

Payload

Content type

application/json

{"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"slug": "string",
"season": -2147483648,
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

Response samples

201

Content type

application/json

{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

episodes_cache_clear_all

Authorizations:

token

query Parameters

slug	string
kind	string
number	number
part	number
enable	string
video__id	number
video__brightcove_id	string
program	string
program__slug	string
program__service_name	string
sales_type	string
publish_status	string
program__publish_status	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (EpisodeAdmin)

Array

id	integer (ID)
kind required	string or null (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number required	integer or null (Number) [ 0 .. 2147483647 ]
part	integer or null (Part) [ 0 .. 2147483647 ]
release_date	string or null <date> (Recently broadcast date)
	object (images)
uuid	string <uuid> (Uuid) This value is not editable.
cp	string (Cp)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
synopsis_ko	string or null (Synopsis (KO))
synopsis_en	string (Synopsis en)
synopsis_es	string or null (Synopsis (ES))
synopsis_zh_Hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_Hant	string or null (Synopsis (ZH-HANT))
synopsis_zh_hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_hant	string or null (Synopsis (ZH-HANT))
synopsis_pt	string or null (Synopsis (PT))
seo_title_ko	string or null (Title(SEO) (KO)) <= 255 characters
seo_title_en	string or null (Title(SEO) (EN)) <= 255 characters
seo_title_es	string or null (Title(SEO) (ES)) <= 255 characters
seo_title_zh_Hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_Hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_zh_hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_pt	string or null (Title(SEO) (PT)) <= 255 characters
seo_synopsis_ko	string or null (Synopsis(SEO) (KO))
seo_synopsis_en	string or null (Synopsis(SEO) (EN))
seo_synopsis_es	string or null (Synopsis(SEO) (ES))
seo_synopsis_zh_Hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_Hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_zh_hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_pt	string or null (Synopsis(SEO) (PT))
seo_keyword_ko	string or null (Keyword(SEO) (KO))
seo_keyword_en	string or null (Keyword(SEO) (EN))
seo_keyword_es	string or null (Keyword(SEO) (ES))
seo_keyword_zh_Hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_Hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_zh_hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_pt	string or null (Keyword(SEO) (PT))
	object (episode meta)
content_type	string or null (Content Type) Enum: "free" "plus" "premium" "ppv" Content type for services by user type
sales_type	string or null (Sales Type) Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" Sales Type needed to watch this episode
program	integer (Program)
	object (ProgramSimple)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
season	integer or null (Season) [ -2147483648 .. 2147483647 ]
publish_status	string (Publish status)
enable	boolean (Enable)
publish_start	string or null <date-time> (Publish Start)
publish_end	string or null <date-time> (Publish End)
in_review	boolean (In Review)
allowed_countries	Array of strings (Allowed countries) Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" Allowed Countries(ISO-3166 Alpha-2 code)
	object (video)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
is_notice	boolean (Episode for notice)
old_id	integer or null (Old id) [ 0 .. 2147483647 ]
migrated	string or null <date-time> (Migrated) If put FUTURE time into this field, migration cron WILL NOT WORK well.
age_rating	string or null (Age rating) Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
region_age_ratings	Array of strings or null

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}
]
}

episodes_cache_clear_list

Authorizations:

token

query Parameters

slug	string
kind	string
number	number
part	number
enable	string
video__id	number
video__brightcove_id	string
program	string
program__slug	string
program__service_name	string
sales_type	string
publish_status	string
program__publish_status	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (EpisodeAdmin)

Array

id	integer (ID)
kind required	string or null (Kind) Enum: "series" "main" "trailer" "additional" "clip"
number required	integer or null (Number) [ 0 .. 2147483647 ]
part	integer or null (Part) [ 0 .. 2147483647 ]
release_date	string or null <date> (Recently broadcast date)
	object (images)
uuid	string <uuid> (Uuid) This value is not editable.
cp	string (Cp)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
synopsis_ko	string or null (Synopsis (KO))
synopsis_en	string (Synopsis en)
synopsis_es	string or null (Synopsis (ES))
synopsis_zh_Hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_Hant	string or null (Synopsis (ZH-HANT))
synopsis_zh_hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_hant	string or null (Synopsis (ZH-HANT))
synopsis_pt	string or null (Synopsis (PT))
seo_title_ko	string or null (Title(SEO) (KO)) <= 255 characters
seo_title_en	string or null (Title(SEO) (EN)) <= 255 characters
seo_title_es	string or null (Title(SEO) (ES)) <= 255 characters
seo_title_zh_Hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_Hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_zh_hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_pt	string or null (Title(SEO) (PT)) <= 255 characters
seo_synopsis_ko	string or null (Synopsis(SEO) (KO))
seo_synopsis_en	string or null (Synopsis(SEO) (EN))
seo_synopsis_es	string or null (Synopsis(SEO) (ES))
seo_synopsis_zh_Hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_Hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_zh_hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_pt	string or null (Synopsis(SEO) (PT))
seo_keyword_ko	string or null (Keyword(SEO) (KO))
seo_keyword_en	string or null (Keyword(SEO) (EN))
seo_keyword_es	string or null (Keyword(SEO) (ES))
seo_keyword_zh_Hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_Hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_zh_hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_pt	string or null (Keyword(SEO) (PT))
	object (episode meta)
content_type	string or null (Content Type) Enum: "free" "plus" "premium" "ppv" Content type for services by user type
sales_type	string or null (Sales Type) Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" Sales Type needed to watch this episode
program	integer (Program)
	object (ProgramSimple)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
season	integer or null (Season) [ -2147483648 .. 2147483647 ]
publish_status	string (Publish status)
enable	boolean (Enable)
publish_start	string or null <date-time> (Publish Start)
publish_end	string or null <date-time> (Publish End)
in_review	boolean (In Review)
allowed_countries	Array of strings (Allowed countries) Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" Allowed Countries(ISO-3166 Alpha-2 code)
	object (video)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
is_notice	boolean (Episode for notice)
old_id	integer or null (Old id) [ 0 .. 2147483647 ]
migrated	string or null <date-time> (Migrated) If put FUTURE time into this field, migration cron WILL NOT WORK well.
age_rating	string or null (Age rating) Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
region_age_ratings	Array of strings or null

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}
]
}

episodes_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Episode.

Responses

Response Schema: application/json

id

integer (ID)

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

uuid

string <uuid> (Uuid)

This value is not editable.

cp

string (Cp)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

publish_status

string (Publish status)

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

created

string <date-time> (Created)

modified

string <date-time> (Modified)

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Response samples

200

Content type

application/json

{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

episodes_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Episode.

Request Body schema: application/json
required

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Responses

Response Schema: application/json

id

integer (ID)

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

uuid

string <uuid> (Uuid)

This value is not editable.

cp

string (Cp)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

publish_status

string (Publish status)

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

created

string <date-time> (Created)

modified

string <date-time> (Modified)

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Request samples

Payload

Content type

application/json

{"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"slug": "string",
"season": -2147483648,
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

episodes_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Episode.

Responses

episodes_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Episode.

Request Body schema: application/json
required

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Responses

Response Schema: application/json

id

integer (ID)

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

uuid

string <uuid> (Uuid)

This value is not editable.

cp

string (Cp)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

publish_status

string (Publish status)

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

created

string <date-time> (Created)

modified

string <date-time> (Modified)

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Request samples

Payload

Content type

application/json

{"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"slug": "string",
"season": -2147483648,
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

episodes_cache_clear

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Episode.

Responses

Response Schema: application/json

id

integer (ID)

kind

required

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

required

integer or null (Number) [ 0 .. 2147483647 ]

part

integer or null (Part) [ 0 .. 2147483647 ]

release_date

string or null <date> (Recently broadcast date)

object (images)

thumbnail

string <uri>

landscape image for episode thumbnail

uuid

string <uuid> (Uuid)

This value is not editable.

cp

string (Cp)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

object (episode meta)

object

tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
is_kcp	boolean This episode from KCP or not
is_created_on_io	boolean Whether the episode is created on IO
modified_on_io	string <date-time> The datetime that the episode is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the episode is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the episode is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

sales_type

string or null (Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Sales Type needed to watch this episode

program

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

publish_status

string (Publish status)

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

in_review

boolean (In Review)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

object (video)

duration

integer or null <float>

video's duration info (millisecond)

source

string or null

Enum: "brightcove" "inhouse" "relay" "mediahold"

asset type of video source

required

Array of objects

If asset_type (source) is brightcove, there is one source. If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), there are sources for each preset.

Array

type required	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url required	string
preset	string or null preset is only used when asset_type is one of `inhouse`, `relay`, `mediahold`.

Array of objects

If the asset_type is one of inhouse, relay, mediahold (the asset stored in s3), text_tracks is required. If asset_type (source) is brightcove, text_tracks is not required

Array

language required	string key for text_tracks
label	string or null display name of text_tracks
url required	string
codec	string or null Enum: "ass" "srt" "vtt"
default	boolean or null

id

integer or null <int64>

ID of video.api object

brightcove_id

integer or null <int64>

ID of brightcove object

Array of objects

Array

metadata	string or null
name required	string ex: intro-start, intro-end, start, end, ...
type required	string ex: AD, CODE, ...
timecode required	string

object

	Array of objects
	Array of objects

name

string or null

status

string or null

Enum: "created" "processing" "completed" "trashed" "deleted" "failed"

thumbnail

string or null

bumper_duration

integer or null

video's bumper duration info

bumper

string or null

Value: "kcp"

Array of objects

Array

m3u8	string or null Storyboard url for Roku.
vtt	string or null Storyboard url for JWPlayer.

Array of objects

sources(video) + text_tracks(subtitles) = manifests

Array

type	string Enum: "hls" "file" "mpd+widevine" "hls+fairplay"
url	string
preset	string or null preset is used when asset_type is one of `inhouse`, `relay`, `mediahold` except for `brightcove`.

cc_languages

Array of strings

only language codes for subtitles in manifests

created

string <date-time> (Created)

modified

string <date-time> (Modified)

is_notice

boolean (Episode for notice)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

region_age_ratings

Array of strings or null

Response samples

200

Content type

application/json

{"id": 0,
"kind": "series",
"number": 2147483647,
"part": 2147483647,
"release_date": "2019-08-24",
"images": {"thumbnail": "http://example.com"
},
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"cp": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"meta": {"odk": {"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"is_kcp": true,
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z"
}
},
"content_type": "free",
"sales_type": "GUEST",
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"slug": "string",
"season": -2147483648,
"publish_status": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"in_review": true,
"allowed_countries": ["KR"
],
"video": {"duration": 7267798,
"source": "brightcove",
"sources": [{"type": "hls",
"url": "https://hls.ondemandkorea.com/v1/201711/drama/2017-kbs-drama-special/2017-kbs-drama-special-e10/playlist_1080.m3u8",
"preset": "1080p"
}
],
"text_tracks": [{"language": "English",
"label": "en-US",
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"codec": "ass",
"default": true
}
],
"id": 123,
"brightcove_id": 6195401476001,
"cue_points": [{"metadata": "string",
"name": "intro-start",
"type": "CODE",
"timecode": "123.456"
}
],
"legacy": {"original_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"label": "English"
}
],
"transcoded_admindir_subtitles": [{"language": "en",
"codec": "ass",
"active": true,
"url": "https://hls.ondemandchina.com/media/v1/text/vtt/clear/5742226948001/8d73c90f-a7b2-48a4-8cfb-8e4b1cbdb1b8/41b8d9e5-56fb-4162-b565-1a5ff9c299a2/text.vtt",
"original_admindir_subtitle": "string",
"label": "English"
}
]
},
"name": "string",
"status": "created",
"thumbnail": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/5742226948001/6744c1ad-130a-4abc-8a98-0bea0cc85dc8/main/160x90/29m25s867ms/match/image.jpg",
"bumper_duration": 3540,
"bumper": "kcp",
"storyboards": [{"m3u8": "s3://odk-hls-seg/some_prefix/storyboard.m3u8",
"vtt": "s3://odk-hls-seg/some_prefix/storyboard.vtt"
}
],
"manifests": [{"type": "hls",
"url": "s3://odk-hls-seg/v1/202307/variety/indie-movie-theater/indie-movie-theater-e20230714/HLS/manifest_1080p.m3u8",
"preset": "1080p"
}
],
"cc_languages": ["en",
"ko",
"zh-hans",
"zh-hant",
"es",
"pt"
]
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"is_notice": true,
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"age_rating": "All",
"region_age_ratings": ["string"
]
}

episodes_update_slug

Update episode's slug only

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Episode.

Request Body schema: application/json
required

slug

required

string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Responses

Response Schema: application/json

slug

required

string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Request samples

Payload

Content type

application/json

{"slug": "string"
}

Response samples

200

Content type

application/json

{"slug": "string"
}

favorites

favorites_list

Authorizations:

token

query Parameters

user__username	string
program__slug	string
program__service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (Favorites)

Array

id	integer (ID)
user required	integer (User)
	object (UserSimple)
program required	integer (Program)
	object (ProgramSimple)
modified	string <date-time> (Modified)
created	string <date-time> (Created)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"user": 0,
"user_display": {"id": 0,
"username": "string",
"email": "user@example.com",
"service_name": "odk"
},
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"modified": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z"
}
]
}

favorites_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Favorites.

Responses

Response Schema: application/json

id

integer (ID)

user

required

integer (User)

object (UserSimple)

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

program

required

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

modified

string <date-time> (Modified)

created

string <date-time> (Created)

Response samples

200

Content type

application/json

{"id": 0,
"user": 0,
"user_display": {"id": 0,
"username": "string",
"email": "user@example.com",
"service_name": "odk"
},
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"modified": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z"
}

images

images_list

Authorizations:

token

query Parameters

used_by	string
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (Image)

Array

id	integer (ID)
image	string <uri> (Image)
name	string (Name)
path	string (Path)
host	string (Host)
sample_url	string (Sample url)
used_by	string or null (Used By) <= 20 characters
description	string (Description) <= 1024 characters
width	integer or null (Width) [ 0 .. 2147483647 ]
height	integer or null (Height) [ 0 .. 2147483647 ]
created	string <date-time> (Created)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"image": "http://example.com",
"name": "string",
"path": "string",
"host": "string",
"sample_url": "string",
"used_by": "string",
"description": "string",
"width": 2147483647,
"height": 2147483647,
"created": "2019-08-24T14:15:22Z"
}
]
}

images_create

Authorizations:

token

Request Body schema: application/json
required

used_by	string or null (Used By) <= 20 characters
description	string (Description) <= 1024 characters
width	integer or null (Width) [ 0 .. 2147483647 ]
height	integer or null (Height) [ 0 .. 2147483647 ]

Responses

Response Schema: application/json

id	integer (ID)
image	string <uri> (Image)
name	string (Name)
path	string (Path)
host	string (Host)
sample_url	string (Sample url)
used_by	string or null (Used By) <= 20 characters
description	string (Description) <= 1024 characters
width	integer or null (Width) [ 0 .. 2147483647 ]
height	integer or null (Height) [ 0 .. 2147483647 ]
created	string <date-time> (Created)

Request samples

Payload

Content type

application/json

{"used_by": "string",
"description": "string",
"width": 2147483647,
"height": 2147483647
}

Response samples

201

Content type

application/json

{"id": 0,
"image": "http://example.com",
"name": "string",
"path": "string",
"host": "string",
"sample_url": "string",
"used_by": "string",
"description": "string",
"width": 2147483647,
"height": 2147483647,
"created": "2019-08-24T14:15:22Z"
}

images_upload_by_url

Authorizations:

token

Request Body schema: application/json
required

used_by	string or null (Used By) <= 20 characters
description	string (Description) <= 1024 characters
width	integer or null (Width) [ 0 .. 2147483647 ]
height	integer or null (Height) [ 0 .. 2147483647 ]

Responses

Response Schema: application/json

id	integer (ID)
image	string <uri> (Image)
name	string (Name)
path	string (Path)
host	string (Host)
sample_url	string (Sample url)
used_by	string or null (Used By) <= 20 characters
description	string (Description) <= 1024 characters
width	integer or null (Width) [ 0 .. 2147483647 ]
height	integer or null (Height) [ 0 .. 2147483647 ]
created	string <date-time> (Created)

Request samples

Payload

Content type

application/json

{"used_by": "string",
"description": "string",
"width": 2147483647,
"height": 2147483647
}

Response samples

201

Content type

application/json

{"id": 0,
"image": "http://example.com",
"name": "string",
"path": "string",
"host": "string",
"sample_url": "string",
"used_by": "string",
"description": "string",
"width": 2147483647,
"height": 2147483647,
"created": "2019-08-24T14:15:22Z"
}

images_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Image.

Responses

Response Schema: application/json

id	integer (ID)
image	string <uri> (Image)
name	string (Name)
path	string (Path)
host	string (Host)
sample_url	string (Sample url)
used_by	string or null (Used By) <= 20 characters
description	string (Description) <= 1024 characters
width	integer or null (Width) [ 0 .. 2147483647 ]
height	integer or null (Height) [ 0 .. 2147483647 ]
created	string <date-time> (Created)

Response samples

200

Content type

application/json

{"id": 0,
"image": "http://example.com",
"name": "string",
"path": "string",
"host": "string",
"sample_url": "string",
"used_by": "string",
"description": "string",
"width": 2147483647,
"height": 2147483647,
"created": "2019-08-24T14:15:22Z"
}

images_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Image.

Responses

legacy

legacy_copy_episode_attributes_create

Authorizations:

token

Request Body schema: application/json
required

target_id required	integer (Target id)
source_id required	integer (Source id)

Responses

Response Schema: application/json

id required	integer (Id) [ -2147483648 .. 2147483647 ] Primary keys for this table
post_content	string or null (Post content) Description for program / episode. Consisted of kr, en, cn, tw
post_content_kr	string or null (Post content kr) Synopsis Korean version
post_content_en	string or null (Post content en) Synopsis English version
post_content_cn	string or null (Post content cn) Synopsis Chinese(Simplified) version
post_content_tw	string or null (Post content tw) Synopsis Chinese(Traditional) version
post_title	string or null (Post title) Titles with all kinds of languages that we serve
post_title_kr	string or null (Post title kr) <= 200 characters Title Korean version
post_title_en	string or null (Post title en) <= 200 characters Title English version
post_title_cn	string or null (Post title cn) <= 200 characters Title Chinese(Simplified) version
post_title_tw	string or null (Post title tw) <= 200 characters Title Chinese(Traditional) version
post_status	string or null (Post status) <= 20 characters Status that users see with Publish, Private, Trash or NULL
post_name	string or null (Post name) <= 200 characters English full name of program or episode
post_date	string or null <date-time> (Post date) Uploaded timestamp yyyy-MM-dd HH:mm:ss. Timezone is maybe Pacific Time (only when post_type is 'page')
background_image_value	string or null (Background image value) <= 200 characters Location of basic background image on Apple TV
segmented_aka_300	string or null (Segmented aka 300)
segmented_aka_360	string or null (Segmented aka 360)
segmented_aka_480	string or null (Segmented aka 480)
segmented_aka_720	string or null (Segmented aka 720)
segmented_aka_1080	string or null (Segmented aka 1080)
v300	string or null (V300) <= 200 characters mp4 files for 300p
v360	string or null (V360) <= 200 characters mp4 files for 360p
v480	string or null (V480) <= 200 characters mp4 files for 480p
v720	string or null (V720) <= 200 characters mp4 files for 720p
v1080	string or null (V1080) <= 200 characters mp4 files for 1080p
sub_chs	string or null (Sub chs) <= 200 characters Subtitle Chinese(Simplified) version
sub_cht	string or null (Sub cht) <= 200 characters Subtitle Chinese(Traditional) version
sub_src_en	string or null (Sub src en) <= 200 characters Source files of subtitles English version
subtitles	string (Subtitles)
background_image_value_cn	string or null (Background image value cn) <= 200 characters Location of background image Chinese(Simplified) version on Apple TV
background_image_value_tw	string or null (Background image value tw) <= 200 characters Location of background image Chinese(Traditional) version on Apple TV
ios_background_image_value	string or null (Ios background image value) <= 200 characters Banner image URL Korean ver.
ios_background_image_value_en	string or null (Ios background image value en) <= 200 characters Banner image URL English ver.
main_poster_kr	string or null (Main poster kr) <= 200 characters Location of main poster Korean version
main_poster_en	string or null (Main poster en) <= 200 characters Location of main poster English version
dayofweek	string or null (Dayofweek) <= 20 characters Days that program or episode airs
_duration	string or null (duration) <= 20 characters Video duration in seconds
enabled	string or null (Enabled) <= 20 characters Flag that shows whether program is playing or not
episode_no	string or null (Episode no) <= 200 characters Basic Episode number
episode_no_en	string or null (Episode no en) <= 200 characters Episode number English version
featured	string or null (Featured) <= 20 characters Recommedation index for banner
featured_order	string or null (Featured order) <= 20 characters Recommendation order
ios_featured	string or null (Ios featured) <= 20 characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) <= 20 characters The order of banners. ex) 1, 2, 3, ...
kr_featured	string or null (Kr featured) <= 20 characters Recommendation mark as 'kr' for Korean users
kr_featured_order	string or null (Kr featured order) <= 20 characters Recommendation order for Korean users
en_featured	string or null (En featured) <= 20 characters Recommendation mark as 'en' for English users
en_featured_order	string or null (En featured order) <= 20 characters Recommendation order for English users
cn_featured	string or null (Cn featured) <= 20 characters Recommendation mark as 'cn' for Chinese users
cn_featured_order	string or null (Cn featured order) <= 20 characters Recommendation order for Chinese users
tw_featured	string or null (Tw featured) <= 20 characters Recommendation mark as 'tw' for Taiwanese users
tw_featured_order	string or null (Tw featured order) <= 20 characters Recommendation order for Taiwanese users
genre	string or null (Genre) <= 20 characters Genre of program or episode
header1	string or null (Header1) <= 200 characters First Korean introduction of program or episode
header1cn	string or null (Header1cn) <= 200 characters First Chinese introduction of program or episode
header1en	string or null (Header1en) <= 200 characters First English introduction of program or episode
header1tw	string or null (Header1tw) <= 200 characters First Taiwanese introduction of program or episode
header2	string or null (Header2) <= 200 characters Second Korean introduction of program or episode
header2en	string or null (Header2en) <= 200 characters Second English introduction of program or episode
header2cn	string or null (Header2cn) <= 200 characters Second Chinese introduction of program or episode
header2tw	string or null (Header2tw) <= 200 characters Second Taiwanese introduction of program or episode
onair	string or null (Onair) <= 20 characters Flag showing whether program is on air or not
on_air_date	string or null (On air date) <= 20 characters Broadcasting date
owner	string or null (Owner) <= 20 characters Copyright holder
poster_image_value	string or null (Poster image value) <= 200 characters Posters on program list pages
subcat	string or null (Subcat) <= 200 characters Subordinate category
subgenre_en	string or null (Subgenre en) <= 255 characters Subgenre English version
subgenre_kr	string or null (Subgenre kr) <= 255 characters Subgenre Korean version
subgenre_cn	string or null (Subgenre cn) <= 255 characters Subgenre Chinese version
subgenre_tw	string or null (Subgenre tw) <= 255 characters Subgenre Taiwanese version
sub_en	string or null (Sub en) <= 200 characters Subtitle English version
sub_src_chs	string or null (Sub src chs) <= 200 characters Source files of subtitles Chinese(Simplfied) version
sub_src_cht	string or null (Sub src cht) <= 200 characters Source files of subtitles Chinese(Traditional) version
sub_src_es	string or null (Sub src es) <= 200 characters Source files of subtitles Espanol version
sub_src_ko	string or null (Sub src ko) <= 200 characters Source files of subtitles Korean version
sub_src_pt	string or null (Sub src pt) <= 200 characters Source files of subtitles Portuguese version
smil300	string or null (Smil300)
smil360	string or null (Smil360)
smil480	string or null (Smil480)
smil720	string or null (Smil720)
smil1080	string or null (Smil1080)
tags_cn	string or null (Tags cn) <= 200 characters Tags Chinese version
tags_en	string or null (Tags en) <= 200 characters Tags English version
tags_kr	string or null (Tags kr) <= 200 characters Tags Korean version
tags_tw	string or null (Tags tw) <= 200 characters Tags Taiwanese version
thumbnail_image_value	string or null (Thumbnail image value) <= 200 characters Thumbnail images path on ondemandkorea.com
thumbnail_location	string or null (Thumbnail location) <= 20 characters Location of thumbnail images such as odk and limelight
trailer	string or null (Trailer) <= 200 characters Teaser files
v180	string or null (V180) <= 200 characters mp4 files for 180p
v240	string or null (V240) <= 200 characters mp4 files for 240p
video_url_value	string or null (Video url value) <= 200 characters Source mp4 files for 480p
cat_id	string (Cat id)
cat_name	string or null (Cat name) <= 200 characters Programs' names
parent_id	string (Parent id)
parent_name	string or null (Parent name) <= 200 characters Categories' names
timestamp	string or null <date-time> (Timestamp) Recorded data time
ad_enable	integer or null (Ad enable) [ -2147483648 .. 2147483647 ] To show whether this program or episode can have ads or not
guid	string or null (Guid) <= 36 characters Globally unique identifiers, now using for PPV
year	integer or null (Year) [ -2147483648 .. 2147483647 ] Year that broadcasted the first episode
plus_only	integer or null (Plus only) [ -2147483648 .. 2147483647 ] Flag for plus only users as value 1
is_coming_soon	integer (Is coming soon) [ -2147483648 .. 2147483647 ] To show whether this program or episode is coming soon or not
ppv_type	string or null (Ppv type) <= 200 characters Flag for PPV services
movie_year	integer or null (Movie year) [ -2147483648 .. 2147483647 ] Year that released this movie
age_rating	string or null (Age rating) <= 5 characters Ages as motion picture content rating system for movies
rating	number or null (Rating) Ratings for movies from Naver Movies
running_time	integer or null (Running time) [ -2147483648 .. 2147483647 ] Running time for movies
play_date	string or null <date> (Play date) First episode date
director_kr	string or null (Director kr) <= 200 characters Directors information of movies Korean version
director_en	string or null (Director en) <= 200 characters Directors information of movies English version
director_cn	string or null (Director cn) <= 200 characters Directors information of movies Chinese version
director_tw	string or null (Director tw) <= 200 characters Directors information of movies Taiwanese version
actor_kr	string or null (Actor kr) <= 200 characters Actors information of movies Korean version
actor_en	string or null (Actor en) <= 200 characters Actors information of movies English version
actor_cn	string or null (Actor cn) <= 200 characters Actors information of movies Chinese version
actor_tw	string or null (Actor tw) <= 200 characters Actors information of movies Taiwanese version
movie_genre_kr	string or null (Movie genre kr) <= 200 characters Genre for movies Korean version
movie_genre_en	string or null (Movie genre en) <= 200 characters Genre for movies English version
movie_genre_cn	string or null (Movie genre cn) <= 200 characters Genre for movies Chinese version
movie_genre_tw	string or null (Movie genre tw) <= 200 characters Genre for movies Taiwanese version
broadcast_time	string or null (Broadcast time) Broadcasted time
mediahold	integer (Mediahold) [ -2147483648 .. 2147483647 ] Flag whether Mediahold serves program or episode or not
segmented_300	string or null (Segmented 300) Location of m3u8 playlist for HLS with 300p
segmented_360	string or null (Segmented 360) Location of m3u8 playlist for HLS with 360p
segmented_480	string or null (Segmented 480) Location of m3u8 playlist for HLS with 480p
segmented_720	string or null (Segmented 720) Location of m3u8 playlist for HLS with 720p
segmented_1080	string or null (Segmented 1080) Location of m3u8 playlist for HLS with 1080p
backedup	integer (Backedup) [ -2147483648 .. 2147483647 ] 0 is not processed
backedup_segmented	integer (Backedup segmented) [ -2147483648 .. 2147483647 ] Status code of segmented for backup
emergency	integer or null (Emergency) [ -2147483648 .. 2147483647 ] To be updated by someone who knows about this
segmented_s3 required	integer (Segmented s3) [ -2147483648 .. 2147483647 ] Status code of segmented for s3
segmented_s3_300	string or null (Segmented s3 300)
segmented_s3_360	string or null (Segmented s3 360)
segmented_s3_480	string or null (Segmented s3 480)
segmented_s3_720	string or null (Segmented s3 720)
segmented_s3_1080	string or null (Segmented s3 1080)
segmented_cdnet required	integer (Segmented cdnet) [ -2147483648 .. 2147483647 ] Status code of segmented for cdnet endpoint
segmented_akamai required	integer (Segmented akamai) [ -2147483648 .. 2147483647 ] Status code of segmented for akamai endpoint
segmented_aka required	integer (Segmented aka) [ -2147483648 .. 2147483647 ]
popularity_adjust	integer or null (Popularity adjust) [ -2147483648 .. 2147483647 ]
popularity_adjust_from	string or null <date-time> (Popularity adjust from)
popularity_adjust_to	string or null <date-time> (Popularity adjust to)
postmeta	string (Postmeta)

Request samples

Payload

Content type

application/json

{"target_id": 0,
"source_id": 0
}

Response samples

200

Content type

application/json

{"id": -2147483648,
"post_content": "string",
"post_content_kr": "string",
"post_content_en": "string",
"post_content_cn": "string",
"post_content_tw": "string",
"post_title": "string",
"post_title_kr": "string",
"post_title_en": "string",
"post_title_cn": "string",
"post_title_tw": "string",
"post_status": "string",
"post_name": "string",
"post_date": "2019-08-24T14:15:22Z",
"background_image_value": "string",
"segmented_aka_300": "string",
"segmented_aka_360": "string",
"segmented_aka_480": "string",
"segmented_aka_720": "string",
"segmented_aka_1080": "string",
"v300": "string",
"v360": "string",
"v480": "string",
"v720": "string",
"v1080": "string",
"sub_chs": "string",
"sub_cht": "string",
"sub_src_en": "string",
"subtitles": "string",
"background_image_value_cn": "string",
"background_image_value_tw": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"main_poster_kr": "string",
"main_poster_en": "string",
"dayofweek": "string",
"_duration": "string",
"enabled": "string",
"episode_no": "string",
"episode_no_en": "string",
"featured": "string",
"featured_order": "string",
"ios_featured": "string",
"ios_featured_order": "string",
"kr_featured": "string",
"kr_featured_order": "string",
"en_featured": "string",
"en_featured_order": "string",
"cn_featured": "string",
"cn_featured_order": "string",
"tw_featured": "string",
"tw_featured_order": "string",
"genre": "string",
"header1": "string",
"header1cn": "string",
"header1en": "string",
"header1tw": "string",
"header2": "string",
"header2en": "string",
"header2cn": "string",
"header2tw": "string",
"onair": "string",
"on_air_date": "string",
"owner": "string",
"poster_image_value": "string",
"subcat": "string",
"subgenre_en": "string",
"subgenre_kr": "string",
"subgenre_cn": "string",
"subgenre_tw": "string",
"sub_en": "string",
"sub_src_chs": "string",
"sub_src_cht": "string",
"sub_src_es": "string",
"sub_src_ko": "string",
"sub_src_pt": "string",
"smil300": "string",
"smil360": "string",
"smil480": "string",
"smil720": "string",
"smil1080": "string",
"tags_cn": "string",
"tags_en": "string",
"tags_kr": "string",
"tags_tw": "string",
"thumbnail_image_value": "string",
"thumbnail_location": "string",
"trailer": "string",
"v180": "string",
"v240": "string",
"video_url_value": "string",
"cat_id": "string",
"cat_name": "string",
"parent_id": "string",
"parent_name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"ad_enable": -2147483648,
"guid": "string",
"year": -2147483648,
"plus_only": -2147483648,
"is_coming_soon": -2147483648,
"ppv_type": "string",
"movie_year": -2147483648,
"age_rating": "strin",
"rating": 0,
"running_time": -2147483648,
"play_date": "2019-08-24",
"director_kr": "string",
"director_en": "string",
"director_cn": "string",
"director_tw": "string",
"actor_kr": "string",
"actor_en": "string",
"actor_cn": "string",
"actor_tw": "string",
"movie_genre_kr": "string",
"movie_genre_en": "string",
"movie_genre_cn": "string",
"movie_genre_tw": "string",
"broadcast_time": "string",
"mediahold": -2147483648,
"segmented_300": "string",
"segmented_360": "string",
"segmented_480": "string",
"segmented_720": "string",
"segmented_1080": "string",
"backedup": -2147483648,
"backedup_segmented": -2147483648,
"emergency": -2147483648,
"segmented_s3": -2147483648,
"segmented_s3_300": "string",
"segmented_s3_360": "string",
"segmented_s3_480": "string",
"segmented_s3_720": "string",
"segmented_s3_1080": "string",
"segmented_cdnet": -2147483648,
"segmented_akamai": -2147483648,
"segmented_aka": -2147483648,
"popularity_adjust": -2147483648,
"popularity_adjust_from": "2019-08-24T14:15:22Z",
"popularity_adjust_to": "2019-08-24T14:15:22Z",
"postmeta": "string"
}

legacy_episodes_read

Authorizations:

token

path Parameters

id

required

integer

Primary keys for this table

Responses

Response Schema: application/json

id required	integer (Id) [ -2147483648 .. 2147483647 ] Primary keys for this table
post_content	string or null (Post content) Description for program / episode. Consisted of kr, en, cn, tw
post_content_kr	string or null (Post content kr) Synopsis Korean version
post_content_en	string or null (Post content en) Synopsis English version
post_content_cn	string or null (Post content cn) Synopsis Chinese(Simplified) version
post_content_tw	string or null (Post content tw) Synopsis Chinese(Traditional) version
post_title	string or null (Post title) Titles with all kinds of languages that we serve
post_title_kr	string or null (Post title kr) <= 200 characters Title Korean version
post_title_en	string or null (Post title en) <= 200 characters Title English version
post_title_cn	string or null (Post title cn) <= 200 characters Title Chinese(Simplified) version
post_title_tw	string or null (Post title tw) <= 200 characters Title Chinese(Traditional) version
post_status	string or null (Post status) <= 20 characters Status that users see with Publish, Private, Trash or NULL
post_name	string or null (Post name) <= 200 characters English full name of program or episode
post_date	string or null <date-time> (Post date) Uploaded timestamp yyyy-MM-dd HH:mm:ss. Timezone is maybe Pacific Time (only when post_type is 'page')
background_image_value	string or null (Background image value) <= 200 characters Location of basic background image on Apple TV
segmented_aka_300	string or null (Segmented aka 300)
segmented_aka_360	string or null (Segmented aka 360)
segmented_aka_480	string or null (Segmented aka 480)
segmented_aka_720	string or null (Segmented aka 720)
segmented_aka_1080	string or null (Segmented aka 1080)
v300	string or null (V300) <= 200 characters mp4 files for 300p
v360	string or null (V360) <= 200 characters mp4 files for 360p
v480	string or null (V480) <= 200 characters mp4 files for 480p
v720	string or null (V720) <= 200 characters mp4 files for 720p
v1080	string or null (V1080) <= 200 characters mp4 files for 1080p
sub_chs	string or null (Sub chs) <= 200 characters Subtitle Chinese(Simplified) version
sub_cht	string or null (Sub cht) <= 200 characters Subtitle Chinese(Traditional) version
sub_src_en	string or null (Sub src en) <= 200 characters Source files of subtitles English version
subtitles	string (Subtitles)
background_image_value_cn	string or null (Background image value cn) <= 200 characters Location of background image Chinese(Simplified) version on Apple TV
background_image_value_tw	string or null (Background image value tw) <= 200 characters Location of background image Chinese(Traditional) version on Apple TV
ios_background_image_value	string or null (Ios background image value) <= 200 characters Banner image URL Korean ver.
ios_background_image_value_en	string or null (Ios background image value en) <= 200 characters Banner image URL English ver.
main_poster_kr	string or null (Main poster kr) <= 200 characters Location of main poster Korean version
main_poster_en	string or null (Main poster en) <= 200 characters Location of main poster English version
dayofweek	string or null (Dayofweek) <= 20 characters Days that program or episode airs
_duration	string or null (duration) <= 20 characters Video duration in seconds
enabled	string or null (Enabled) <= 20 characters Flag that shows whether program is playing or not
episode_no	string or null (Episode no) <= 200 characters Basic Episode number
episode_no_en	string or null (Episode no en) <= 200 characters Episode number English version
featured	string or null (Featured) <= 20 characters Recommedation index for banner
featured_order	string or null (Featured order) <= 20 characters Recommendation order
ios_featured	string or null (Ios featured) <= 20 characters 1 means a banner exists. The others(0 or NULL) means not existing.
ios_featured_order	string or null (Ios featured order) <= 20 characters The order of banners. ex) 1, 2, 3, ...
kr_featured	string or null (Kr featured) <= 20 characters Recommendation mark as 'kr' for Korean users
kr_featured_order	string or null (Kr featured order) <= 20 characters Recommendation order for Korean users
en_featured	string or null (En featured) <= 20 characters Recommendation mark as 'en' for English users
en_featured_order	string or null (En featured order) <= 20 characters Recommendation order for English users
cn_featured	string or null (Cn featured) <= 20 characters Recommendation mark as 'cn' for Chinese users
cn_featured_order	string or null (Cn featured order) <= 20 characters Recommendation order for Chinese users
tw_featured	string or null (Tw featured) <= 20 characters Recommendation mark as 'tw' for Taiwanese users
tw_featured_order	string or null (Tw featured order) <= 20 characters Recommendation order for Taiwanese users
genre	string or null (Genre) <= 20 characters Genre of program or episode
header1	string or null (Header1) <= 200 characters First Korean introduction of program or episode
header1cn	string or null (Header1cn) <= 200 characters First Chinese introduction of program or episode
header1en	string or null (Header1en) <= 200 characters First English introduction of program or episode
header1tw	string or null (Header1tw) <= 200 characters First Taiwanese introduction of program or episode
header2	string or null (Header2) <= 200 characters Second Korean introduction of program or episode
header2en	string or null (Header2en) <= 200 characters Second English introduction of program or episode
header2cn	string or null (Header2cn) <= 200 characters Second Chinese introduction of program or episode
header2tw	string or null (Header2tw) <= 200 characters Second Taiwanese introduction of program or episode
onair	string or null (Onair) <= 20 characters Flag showing whether program is on air or not
on_air_date	string or null (On air date) <= 20 characters Broadcasting date
owner	string or null (Owner) <= 20 characters Copyright holder
poster_image_value	string or null (Poster image value) <= 200 characters Posters on program list pages
subcat	string or null (Subcat) <= 200 characters Subordinate category
subgenre_en	string or null (Subgenre en) <= 255 characters Subgenre English version
subgenre_kr	string or null (Subgenre kr) <= 255 characters Subgenre Korean version
subgenre_cn	string or null (Subgenre cn) <= 255 characters Subgenre Chinese version
subgenre_tw	string or null (Subgenre tw) <= 255 characters Subgenre Taiwanese version
sub_en	string or null (Sub en) <= 200 characters Subtitle English version
sub_src_chs	string or null (Sub src chs) <= 200 characters Source files of subtitles Chinese(Simplfied) version
sub_src_cht	string or null (Sub src cht) <= 200 characters Source files of subtitles Chinese(Traditional) version
sub_src_es	string or null (Sub src es) <= 200 characters Source files of subtitles Espanol version
sub_src_ko	string or null (Sub src ko) <= 200 characters Source files of subtitles Korean version
sub_src_pt	string or null (Sub src pt) <= 200 characters Source files of subtitles Portuguese version
smil300	string or null (Smil300)
smil360	string or null (Smil360)
smil480	string or null (Smil480)
smil720	string or null (Smil720)
smil1080	string or null (Smil1080)
tags_cn	string or null (Tags cn) <= 200 characters Tags Chinese version
tags_en	string or null (Tags en) <= 200 characters Tags English version
tags_kr	string or null (Tags kr) <= 200 characters Tags Korean version
tags_tw	string or null (Tags tw) <= 200 characters Tags Taiwanese version
thumbnail_image_value	string or null (Thumbnail image value) <= 200 characters Thumbnail images path on ondemandkorea.com
thumbnail_location	string or null (Thumbnail location) <= 20 characters Location of thumbnail images such as odk and limelight
trailer	string or null (Trailer) <= 200 characters Teaser files
v180	string or null (V180) <= 200 characters mp4 files for 180p
v240	string or null (V240) <= 200 characters mp4 files for 240p
video_url_value	string or null (Video url value) <= 200 characters Source mp4 files for 480p
cat_id	string (Cat id)
cat_name	string or null (Cat name) <= 200 characters Programs' names
parent_id	string (Parent id)
parent_name	string or null (Parent name) <= 200 characters Categories' names
timestamp	string or null <date-time> (Timestamp) Recorded data time
ad_enable	integer or null (Ad enable) [ -2147483648 .. 2147483647 ] To show whether this program or episode can have ads or not
guid	string or null (Guid) <= 36 characters Globally unique identifiers, now using for PPV
year	integer or null (Year) [ -2147483648 .. 2147483647 ] Year that broadcasted the first episode
plus_only	integer or null (Plus only) [ -2147483648 .. 2147483647 ] Flag for plus only users as value 1
is_coming_soon	integer (Is coming soon) [ -2147483648 .. 2147483647 ] To show whether this program or episode is coming soon or not
ppv_type	string or null (Ppv type) <= 200 characters Flag for PPV services
movie_year	integer or null (Movie year) [ -2147483648 .. 2147483647 ] Year that released this movie
age_rating	string or null (Age rating) <= 5 characters Ages as motion picture content rating system for movies
rating	number or null (Rating) Ratings for movies from Naver Movies
running_time	integer or null (Running time) [ -2147483648 .. 2147483647 ] Running time for movies
play_date	string or null <date> (Play date) First episode date
director_kr	string or null (Director kr) <= 200 characters Directors information of movies Korean version
director_en	string or null (Director en) <= 200 characters Directors information of movies English version
director_cn	string or null (Director cn) <= 200 characters Directors information of movies Chinese version
director_tw	string or null (Director tw) <= 200 characters Directors information of movies Taiwanese version
actor_kr	string or null (Actor kr) <= 200 characters Actors information of movies Korean version
actor_en	string or null (Actor en) <= 200 characters Actors information of movies English version
actor_cn	string or null (Actor cn) <= 200 characters Actors information of movies Chinese version
actor_tw	string or null (Actor tw) <= 200 characters Actors information of movies Taiwanese version
movie_genre_kr	string or null (Movie genre kr) <= 200 characters Genre for movies Korean version
movie_genre_en	string or null (Movie genre en) <= 200 characters Genre for movies English version
movie_genre_cn	string or null (Movie genre cn) <= 200 characters Genre for movies Chinese version
movie_genre_tw	string or null (Movie genre tw) <= 200 characters Genre for movies Taiwanese version
broadcast_time	string or null (Broadcast time) Broadcasted time
mediahold	integer (Mediahold) [ -2147483648 .. 2147483647 ] Flag whether Mediahold serves program or episode or not
segmented_300	string or null (Segmented 300) Location of m3u8 playlist for HLS with 300p
segmented_360	string or null (Segmented 360) Location of m3u8 playlist for HLS with 360p
segmented_480	string or null (Segmented 480) Location of m3u8 playlist for HLS with 480p
segmented_720	string or null (Segmented 720) Location of m3u8 playlist for HLS with 720p
segmented_1080	string or null (Segmented 1080) Location of m3u8 playlist for HLS with 1080p
backedup	integer (Backedup) [ -2147483648 .. 2147483647 ] 0 is not processed
backedup_segmented	integer (Backedup segmented) [ -2147483648 .. 2147483647 ] Status code of segmented for backup
emergency	integer or null (Emergency) [ -2147483648 .. 2147483647 ] To be updated by someone who knows about this
segmented_s3 required	integer (Segmented s3) [ -2147483648 .. 2147483647 ] Status code of segmented for s3
segmented_s3_300	string or null (Segmented s3 300)
segmented_s3_360	string or null (Segmented s3 360)
segmented_s3_480	string or null (Segmented s3 480)
segmented_s3_720	string or null (Segmented s3 720)
segmented_s3_1080	string or null (Segmented s3 1080)
segmented_cdnet required	integer (Segmented cdnet) [ -2147483648 .. 2147483647 ] Status code of segmented for cdnet endpoint
segmented_akamai required	integer (Segmented akamai) [ -2147483648 .. 2147483647 ] Status code of segmented for akamai endpoint
segmented_aka required	integer (Segmented aka) [ -2147483648 .. 2147483647 ]
popularity_adjust	integer or null (Popularity adjust) [ -2147483648 .. 2147483647 ]
popularity_adjust_from	string or null <date-time> (Popularity adjust from)
popularity_adjust_to	string or null <date-time> (Popularity adjust to)
postmeta	string (Postmeta)

Response samples

200

Content type

application/json

{"id": -2147483648,
"post_content": "string",
"post_content_kr": "string",
"post_content_en": "string",
"post_content_cn": "string",
"post_content_tw": "string",
"post_title": "string",
"post_title_kr": "string",
"post_title_en": "string",
"post_title_cn": "string",
"post_title_tw": "string",
"post_status": "string",
"post_name": "string",
"post_date": "2019-08-24T14:15:22Z",
"background_image_value": "string",
"segmented_aka_300": "string",
"segmented_aka_360": "string",
"segmented_aka_480": "string",
"segmented_aka_720": "string",
"segmented_aka_1080": "string",
"v300": "string",
"v360": "string",
"v480": "string",
"v720": "string",
"v1080": "string",
"sub_chs": "string",
"sub_cht": "string",
"sub_src_en": "string",
"subtitles": "string",
"background_image_value_cn": "string",
"background_image_value_tw": "string",
"ios_background_image_value": "string",
"ios_background_image_value_en": "string",
"main_poster_kr": "string",
"main_poster_en": "string",
"dayofweek": "string",
"_duration": "string",
"enabled": "string",
"episode_no": "string",
"episode_no_en": "string",
"featured": "string",
"featured_order": "string",
"ios_featured": "string",
"ios_featured_order": "string",
"kr_featured": "string",
"kr_featured_order": "string",
"en_featured": "string",
"en_featured_order": "string",
"cn_featured": "string",
"cn_featured_order": "string",
"tw_featured": "string",
"tw_featured_order": "string",
"genre": "string",
"header1": "string",
"header1cn": "string",
"header1en": "string",
"header1tw": "string",
"header2": "string",
"header2en": "string",
"header2cn": "string",
"header2tw": "string",
"onair": "string",
"on_air_date": "string",
"owner": "string",
"poster_image_value": "string",
"subcat": "string",
"subgenre_en": "string",
"subgenre_kr": "string",
"subgenre_cn": "string",
"subgenre_tw": "string",
"sub_en": "string",
"sub_src_chs": "string",
"sub_src_cht": "string",
"sub_src_es": "string",
"sub_src_ko": "string",
"sub_src_pt": "string",
"smil300": "string",
"smil360": "string",
"smil480": "string",
"smil720": "string",
"smil1080": "string",
"tags_cn": "string",
"tags_en": "string",
"tags_kr": "string",
"tags_tw": "string",
"thumbnail_image_value": "string",
"thumbnail_location": "string",
"trailer": "string",
"v180": "string",
"v240": "string",
"video_url_value": "string",
"cat_id": "string",
"cat_name": "string",
"parent_id": "string",
"parent_name": "string",
"timestamp": "2019-08-24T14:15:22Z",
"ad_enable": -2147483648,
"guid": "string",
"year": -2147483648,
"plus_only": -2147483648,
"is_coming_soon": -2147483648,
"ppv_type": "string",
"movie_year": -2147483648,
"age_rating": "strin",
"rating": 0,
"running_time": -2147483648,
"play_date": "2019-08-24",
"director_kr": "string",
"director_en": "string",
"director_cn": "string",
"director_tw": "string",
"actor_kr": "string",
"actor_en": "string",
"actor_cn": "string",
"actor_tw": "string",
"movie_genre_kr": "string",
"movie_genre_en": "string",
"movie_genre_cn": "string",
"movie_genre_tw": "string",
"broadcast_time": "string",
"mediahold": -2147483648,
"segmented_300": "string",
"segmented_360": "string",
"segmented_480": "string",
"segmented_720": "string",
"segmented_1080": "string",
"backedup": -2147483648,
"backedup_segmented": -2147483648,
"emergency": -2147483648,
"segmented_s3": -2147483648,
"segmented_s3_300": "string",
"segmented_s3_360": "string",
"segmented_s3_480": "string",
"segmented_s3_720": "string",
"segmented_s3_1080": "string",
"segmented_cdnet": -2147483648,
"segmented_akamai": -2147483648,
"segmented_aka": -2147483648,
"popularity_adjust": -2147483648,
"popularity_adjust_from": "2019-08-24T14:15:22Z",
"popularity_adjust_to": "2019-08-24T14:15:22Z",
"postmeta": "string"
}

get odk program's meta.odk.cp list

Authorizations:

token

Responses

Response Schema: application/json

cp_list

required

Array of strings or null

Response samples

200

Content type

application/json

{"cp_list": ["string"
]
}

migrate

migrate_with_odk

Constants

action:
- pull : migrate odk legacy's data to media.io
- push : migrate media.io's data to odk legacy
model_name:
- pull : program episode category provider
- push : program episode

Authorizations:

token

Request Body schema: application/json
required

action required	string (Action) Enum: "pull" "push"
model_name required	string (Model name) Enum: "program" "episode" "category" "provider"
pk required	integer (Pk)

Responses

Response Schema: application/json

action required	string (Action) Enum: "pull" "push"
model_name required	string (Model name) Enum: "program" "episode" "category" "provider"
pk required	integer (Pk)

Request samples

Payload

Content type

application/json

{"action": "pull",
"model_name": "program",
"pk": 0
}

Response samples

201

Content type

application/json

{"action": "pull",
"model_name": "program",
"pk": 0
}

validate_with_odk

Constants

model_name: program episode category provider person

Authorizations:

token

query Parameters

model_name required	string Enum: "program" "episode" "category" "provider"
is_only_diff	boolean
modified_from	string <date-time>

Responses

user/accounts

migrate_user_data_with_odk

Authorizations:

token

Request Body schema: application/json
required

id

required

integer (Id)

username

required

string (Username) [ 1 .. 150 ] characters

guid

required

string (Guid) [ 1 .. 255 ] characters

last_login

required

string or null <date-time> (Last login)

gender

required

string (Gender) [ 1 .. 2 ] characters

first_name

required

string (First name) <= 150 characters

last_name

required

string (Last name) <= 150 characters

user_registered

required

string <date-time> (User registered)

birthday

required

string or null <date> (Birthday)

is_email_verified

required

boolean (Is email verified)

optin

required

boolean (Optin)

facebook_uid

required

string or null (Facebook uid) [ 1 .. 255 ] characters

is_active

required

boolean (Is active)

password

required

string (Password) <= 128 characters

object or null (LegacySocialUsers)

object or null (LegacySocialUsersItem)

uid required	string (Uid) [ 1 .. 255 ] characters
extra_data	object or null (Extra data)

object or null (LegacySocialUsersItem)

uid required	string (Uid) [ 1 .. 255 ] characters
extra_data	object or null (Extra data)

Responses

Response Schema: application/json

id

required

integer (Id)

username

required

string (Username) [ 1 .. 150 ] characters

guid

required

string (Guid) [ 1 .. 255 ] characters

last_login

required

string or null <date-time> (Last login)

gender

required

string (Gender) [ 1 .. 2 ] characters

first_name

required

string (First name) <= 150 characters

last_name

required

string (Last name) <= 150 characters

user_registered

required

string <date-time> (User registered)

birthday

required

string or null <date> (Birthday)

is_email_verified

required

boolean (Is email verified)

optin

required

boolean (Optin)

facebook_uid

required

string or null (Facebook uid) [ 1 .. 255 ] characters

is_active

required

boolean (Is active)

password

required

string (Password) <= 128 characters

object or null (LegacySocialUsers)

object or null (LegacySocialUsersItem)

uid required	string (Uid) [ 1 .. 255 ] characters
extra_data	object or null (Extra data)

object or null (LegacySocialUsersItem)

uid required	string (Uid) [ 1 .. 255 ] characters
extra_data	object or null (Extra data)

Request samples

Payload

Content type

application/json

{"id": 0,
"username": "string",
"guid": "string",
"last_login": "2019-08-24T14:15:22Z",
"gender": "st",
"first_name": "string",
"last_name": "string",
"user_registered": "2019-08-24T14:15:22Z",
"birthday": "2019-08-24",
"is_email_verified": true,
"optin": true,
"facebook_uid": "string",
"is_active": true,
"password": "string",
"social_users": {"apple": {"uid": "string",
"extra_data": { }
},
"roku": {"uid": "string",
"extra_data": { }
}
}
}

Response samples

201

Content type

application/json

{"id": 0,
"username": "string",
"guid": "string",
"last_login": "2019-08-24T14:15:22Z",
"gender": "st",
"first_name": "string",
"last_name": "string",
"user_registered": "2019-08-24T14:15:22Z",
"birthday": "2019-08-24",
"is_email_verified": true,
"optin": true,
"facebook_uid": "string",
"is_active": true,
"password": "string",
"social_users": {"apple": {"uid": "string",
"extra_data": { }
},
"roku": {"uid": "string",
"extra_data": { }
}
}
}

migrate_user_with_odk

Authorizations:

token

Request Body schema: application/json
required

old_id

required

integer (Old id)

Responses

Response Schema: application/json

old_id

required

integer (Old id)

Request samples

Payload

Content type

application/json

{"old_id": 0
}

Response samples

201

Content type

application/json

{"old_id": 0
}

user-pay-per-view_list

Authorizations:

token

query Parameters

user__uuid	string
pay_per_view__episode__uuid	string
pay_per_view__payment_platform	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (UserPayPerViewAdmin)

Array

id	integer (ID)
user	integer (User)
pay_per_view	integer (Pay per view)
expired_at required	string <date-time> (Expired at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters
episode_uuid required	string (Episode uuid) [ 1 .. 36 ] characters
ppv_payment_platform required	string (Ppv payment platform) [ 1 .. 15 ] characters

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"user": 0,
"pay_per_view": 0,
"expired_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_uuid": "string",
"episode_uuid": "string",
"ppv_payment_platform": "string"
}
]
}

user-pay-per-view_create

Authorizations:

token

Request Body schema: application/json
required

expired_at required	string <date-time> (Expired at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters
episode_uuid required	string (Episode uuid) [ 1 .. 36 ] characters
ppv_payment_platform required	string (Ppv payment platform) [ 1 .. 15 ] characters

Responses

Response Schema: application/json

id	integer (ID)
user	integer (User)
pay_per_view	integer (Pay per view)
expired_at required	string <date-time> (Expired at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters
episode_uuid required	string (Episode uuid) [ 1 .. 36 ] characters
ppv_payment_platform required	string (Ppv payment platform) [ 1 .. 15 ] characters

Request samples

Payload

Content type

application/json

{"expired_at": "2019-08-24T14:15:22Z",
"user_uuid": "string",
"episode_uuid": "string",
"ppv_payment_platform": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"user": 0,
"pay_per_view": 0,
"expired_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_uuid": "string",
"episode_uuid": "string",
"ppv_payment_platform": "string"
}

user-pay-per-view_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user pay per view.

Responses

Response Schema: application/json

id	integer (ID)
user	integer (User)
pay_per_view	integer (Pay per view)
expired_at required	string <date-time> (Expired at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters
episode_uuid required	string (Episode uuid) [ 1 .. 36 ] characters
ppv_payment_platform required	string (Ppv payment platform) [ 1 .. 15 ] characters

Response samples

200

Content type

application/json

{"id": 0,
"user": 0,
"pay_per_view": 0,
"expired_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_uuid": "string",
"episode_uuid": "string",
"ppv_payment_platform": "string"
}

user-pay-per-view_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user pay per view.

Request Body schema: application/json
required

expired_at

required

string <date-time> (Expired at)

Responses

Response Schema: application/json

id	integer (ID)
user	integer (User)
pay_per_view	integer (Pay per view)
expired_at required	string <date-time> (Expired at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Request samples

Payload

Content type

application/json

{"expired_at": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"user": 0,
"pay_per_view": 0,
"expired_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

user-pay-per-view_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user pay per view.

Request Body schema: application/json
required

expired_at

required

string <date-time> (Expired at)

Responses

Response Schema: application/json

id	integer (ID)
user	integer (User)
pay_per_view	integer (Pay per view)
expired_at required	string <date-time> (Expired at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Request samples

Payload

Content type

application/json

{"expired_at": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"user": 0,
"pay_per_view": 0,
"expired_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

user_admin_list

Authorizations:

token

query Parameters

is_active	string
is_superuser	string
service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (AdminUser)

Array

id	integer (ID)
username	string (Username) non-empty Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) non-empty
last_login	string <date-time> (Last login)
date_joined	string <date-time> (Date joined)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
	object (UserInfo)
is_staff	boolean (Staff status) Designates whether the user can log into this admin site.
is_superuser	boolean (Superuser status) Designates that this user has all permissions without explicitly assigning them.
is_active	boolean (Active) Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
groups	Array of integers unique The groups this user belongs to. A user will get all permissions granted to each of their groups.
admin_menus required	Array of strings or null

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true,
"groups": [0
],
"admin_menus": ["string"
]
}
]
}

user_admin_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user.

Responses

Response Schema: application/json

id

integer (ID)

username

string (Username) non-empty

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) non-empty

last_login

string <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

groups

Array of integers unique

The groups this user belongs to. A user will get all permissions granted to each of their groups.

admin_menus

required

Array of strings or null

Response samples

200

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true,
"groups": [0
],
"admin_menus": ["string"
]
}

user_admin_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user.

Request Body schema: application/json
required

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

groups

Array of integers unique

The groups this user belongs to. A user will get all permissions granted to each of their groups.

admin_menus

required

Array of strings or null

Responses

Response Schema: application/json

id

integer (ID)

username

string (Username) non-empty

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) non-empty

last_login

string <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

groups

Array of integers unique

The groups this user belongs to. A user will get all permissions granted to each of their groups.

admin_menus

required

Array of strings or null

Request samples

Payload

Content type

application/json

{"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"groups": [0
],
"admin_menus": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true,
"groups": [0
],
"admin_menus": ["string"
]
}

user_admin_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user.

Request Body schema: application/json
required

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

groups

Array of integers unique

The groups this user belongs to. A user will get all permissions granted to each of their groups.

admin_menus

required

Array of strings or null

Responses

Response Schema: application/json

id

integer (ID)

username

string (Username) non-empty

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) non-empty

last_login

string <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

groups

Array of integers unique

The groups this user belongs to. A user will get all permissions granted to each of their groups.

admin_menus

required

Array of strings or null

Request samples

Payload

Content type

application/json

{"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"groups": [0
],
"admin_menus": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true,
"groups": [0
],
"admin_menus": ["string"
]
}

user_archives_list

Authorizations:

token

query Parameters

user	string
username	string
service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (UserArchive)

Array

id	integer (ID)
	object (DeletedUser)
username required	string (Username) [ 1 .. 256 ] characters
meta	object (Meta)
created	string <date-time> (Created)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"user": {"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"is_staff": true,
"is_superuser": true
},
"username": "string",
"meta": { },
"created": "2019-08-24T14:15:22Z"
}
]
}

user_archives_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this UserArchive.

Responses

Response Schema: application/json

id

integer (ID)

object (DeletedUser)

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
last_login	string or null <date-time> (Last login)
date_joined	string <date-time> (Date joined)
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
is_staff	boolean (Staff status) Designates whether the user can log into this admin site.
is_superuser	boolean (Superuser status) Designates that this user has all permissions without explicitly assigning them.

username

required

string (Username) [ 1 .. 256 ] characters

Response samples

200

Content type

application/json

{"id": 0,
"user": {"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"is_staff": true,
"is_superuser": true
},
"username": "string",
"meta": { },
"created": "2019-08-24T14:15:22Z"
}

users_list

Authorizations:

token

query Parameters

is_active	string
is_staff	string
is_superuser	string
service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (User)

Array

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
last_login	string or null <date-time> (Last login)
date_joined	string <date-time> (Date joined)
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
	object (UserInfo)
is_staff	boolean (Staff status) Designates whether the user can log into this admin site.
is_superuser	boolean (Superuser status) Designates that this user has all permissions without explicitly assigning them.
is_active	boolean (Active) Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}
]
}

users_create

Authorizations:

token

Request Body schema: application/json
required

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Responses

Response Schema: application/json

id

integer (ID)

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Request samples

Payload

Content type

application/json

{"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

Response samples

201

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

users_export_odc_mail_list_as_csv

Authorizations:

token

query Parameters

is_active	string
is_staff	string
is_superuser	string
service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (User)

Array

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
last_login	string or null <date-time> (Last login)
date_joined	string <date-time> (Date joined)
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
	object (UserInfo)
is_staff	boolean (Staff status) Designates whether the user can log into this admin site.
is_superuser	boolean (Superuser status) Designates that this user has all permissions without explicitly assigning them.
is_active	boolean (Active) Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}
]
}

users_export_odl_mail_list_as_csv

Authorizations:

token

query Parameters

is_active	string
is_staff	string
is_superuser	string
service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (User)

Array

id	integer (ID)
username required	string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$ Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.
email	string <email> (Email address) <= 254 characters
last_login	string or null <date-time> (Last login)
date_joined	string <date-time> (Date joined)
service_name	string or null (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
	object (UserInfo)
is_staff	boolean (Staff status) Designates whether the user can log into this admin site.
is_superuser	boolean (Superuser status) Designates that this user has all permissions without explicitly assigning them.
is_active	boolean (Active) Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}
]
}

users_is_auth

Authorizations:

token

query Parameters

is_active	string
is_staff	string
is_superuser	string
service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

users_login

Authorizations:

token

Request Body schema: application/json
required

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Responses

Response Schema: application/json

id

integer (ID)

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Request samples

Payload

Content type

application/json

{"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

Response samples

201

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

users_logout

Authorizations:

token

Request Body schema: application/json
required

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Responses

Response Schema: application/json

id

integer (ID)

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Request samples

Payload

Content type

application/json

{"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

Response samples

201

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

change admin user's password

This api is accessible only to users with is_staff=True. Password will be changed upon request.If old_password is equal to new_password, or old_password is incorrect, it fails.

Authorizations:

token

Request Body schema: application/json
required

old_password required	string (Old password) non-empty
new_password required	string (New password) non-empty

Responses

Request samples

Payload

Content type

application/json

{"old_password": "string",
"new_password": "string"
}

users_signin_with_google

Authorizations:

token

Request Body schema: application/json
required

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Responses

Response Schema: application/json

id

integer (ID)

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Request samples

Payload

Content type

application/json

{"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

Response samples

201

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

users_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user.

Responses

Response Schema: application/json

id

integer (ID)

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Response samples

200

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

users_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user.

Request Body schema: application/json
required

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Responses

Response Schema: application/json

id

integer (ID)

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Request samples

Payload

Content type

application/json

{"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

Response samples

200

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

users_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user.

Responses

users_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this user.

Request Body schema: application/json
required

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Responses

Response Schema: application/json

id

integer (ID)

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Request samples

Payload

Content type

application/json

{"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

Response samples

200

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true
}

navigation

navigation_list

Authorizations:

token

query Parameters

service_name	string
slug	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (NavigationAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

navigation_create

Authorizations:

token

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": { },
"service_name": "odk"
}

Response samples

201

Content type

application/json

{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

navigation_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

navigation_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": { },
"service_name": "odk"
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

navigation_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Responses

navigation_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this home.

Request Body schema: application/json
required

slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name

Responses

Response Schema: application/json

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Home slug for url
contents required	object (Contents)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"contents": { },
"service_name": "odk"
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"contents": { },
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

pages

pages_list

Authorizations:

token

query Parameters

service_name	string
slug	string
kind	string
meta	string
contents	string
created__lte	string
created__gte	string
modified__lte	string
modified__gte	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (Page)

Array

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Page title for url
kind	string (Kind) Enum: "markdown" "text" "html"
contents required	object (Contents)
meta	object (Meta)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"service_name": "odk",
"slug": "string",
"kind": "markdown",
"contents": { },
"meta": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

pages_create

Authorizations:

token

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Page title for url
kind	string (Kind) Enum: "markdown" "text" "html"
contents required	object (Contents)
meta	object (Meta)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Page title for url
kind	string (Kind) Enum: "markdown" "text" "html"
contents required	object (Contents)
meta	object (Meta)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"slug": "string",
"kind": "markdown",
"contents": { },
"meta": { }
}

Response samples

201

Content type

application/json

{"id": 0,
"service_name": "odk",
"slug": "string",
"kind": "markdown",
"contents": { },
"meta": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

pages_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this page.

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Page title for url
kind	string (Kind) Enum: "markdown" "text" "html"
contents required	object (Contents)
meta	object (Meta)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"slug": "string",
"kind": "markdown",
"contents": { },
"meta": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

pages_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this page.

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Page title for url
kind	string (Kind) Enum: "markdown" "text" "html"
contents required	object (Contents)
meta	object (Meta)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Page title for url
kind	string (Kind) Enum: "markdown" "text" "html"
contents required	object (Contents)
meta	object (Meta)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"slug": "string",
"kind": "markdown",
"contents": { },
"meta": { }
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"slug": "string",
"kind": "markdown",
"contents": { },
"meta": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

pages_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this page.

Responses

pages_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this page.

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Page title for url
kind	string (Kind) Enum: "markdown" "text" "html"
contents required	object (Contents)
meta	object (Meta)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Page title for url
kind	string (Kind) Enum: "markdown" "text" "html"
contents required	object (Contents)
meta	object (Meta)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"slug": "string",
"kind": "markdown",
"contents": { },
"meta": { }
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"slug": "string",
"kind": "markdown",
"contents": { },
"meta": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

pay-per-view

pay-per-view_list

Authorizations:

token

query Parameters

episode__uuid	string
payment_platform	string
price	number
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (PayPerViewAdmin)

Array

id	integer (ID)
episode	integer (Episode)
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
episode_uuid required	string (Episode uuid) [ 1 .. 36 ] characters

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"episode": 0,
"payment_platform": "web",
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"episode_uuid": "string"
}
]
}

pay-per-view_create

Authorizations:

token

Request Body schema: application/json
required

payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
episode_uuid required	string (Episode uuid) [ 1 .. 36 ] characters

Responses

Response Schema: application/json

id	integer (ID)
episode	integer (Episode)
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
episode_uuid required	string (Episode uuid) [ 1 .. 36 ] characters

Request samples

Payload

Content type

application/json

{"payment_platform": "web",
"currency": "str",
"price": "string",
"episode_uuid": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"episode": 0,
"payment_platform": "web",
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"episode_uuid": "string"
}

pay-per-view_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this pay per view.

Responses

Response Schema: application/json

id	integer (ID)
episode	integer (Episode)
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
episode_uuid required	string (Episode uuid) [ 1 .. 36 ] characters

Response samples

200

Content type

application/json

{"id": 0,
"episode": 0,
"payment_platform": "web",
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"episode_uuid": "string"
}

pay-per-view_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this pay per view.

Request Body schema: application/json
required

payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)

Responses

Response Schema: application/json

id	integer (ID)
episode	integer (Episode)
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Request samples

Payload

Content type

application/json

{"payment_platform": "web",
"currency": "str",
"price": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"episode": 0,
"payment_platform": "web",
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

pay-per-view_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this pay per view.

Request Body schema: application/json
required

payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)

Responses

Response Schema: application/json

id	integer (ID)
episode	integer (Episode)
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Request samples

Payload

Content type

application/json

{"payment_platform": "web",
"currency": "str",
"price": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"episode": 0,
"payment_platform": "web",
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

people

people_list

Authorizations:

token

query Parameters

service_name	string
slug	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (PersonAdmin)

Array

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

people_create

Authorizations:

token

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
}

Response samples

201

Content type

application/json

{"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

people_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this People.

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

people_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this People.

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

people_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this People.

Responses

people_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this People.

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { },
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

permission

permission_admin_menu_list

Authorizations:

token

query Parameters

service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (AdminMenuPermission)

Array

id	integer (ID)
permission_display	string (Permission display)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name required	string (Service name) Enum: "odk" "odc" "odv" "odl" "video" "contract" "payment" "permission"
menu_key required	string (Menu key) [ 1 .. 200 ] characters The format is `/{parent_menu_name}/{menu_name}`. ex) `/contents/program`
menu_name required	string (Menu name) [ 1 .. 100 ] characters
permission	integer (Permission)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"permission_display": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"menu_key": "string",
"menu_name": "string",
"permission": 0
}
]
}

permission_admin_menu_create

Authorizations:

token

Request Body schema: application/json
required

service_name required	string (Service name) Enum: "odk" "odc" "odv" "odl" "video" "contract" "payment" "permission"
menu_key required	string (Menu key) [ 1 .. 200 ] characters The format is `/{parent_menu_name}/{menu_name}`. ex) `/contents/program`
menu_name required	string (Menu name) [ 1 .. 100 ] characters

Responses

Response Schema: application/json

id	integer (ID)
permission_display	string (Permission display)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name required	string (Service name) Enum: "odk" "odc" "odv" "odl" "video" "contract" "payment" "permission"
menu_key required	string (Menu key) [ 1 .. 200 ] characters The format is `/{parent_menu_name}/{menu_name}`. ex) `/contents/program`
menu_name required	string (Menu name) [ 1 .. 100 ] characters
permission	integer (Permission)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"menu_key": "string",
"menu_name": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"permission_display": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"menu_key": "string",
"menu_name": "string",
"permission": 0
}

permission_admin_menu_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Admin Menu Permission.

Responses

Response Schema: application/json

id	integer (ID)
permission_display	string (Permission display)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name required	string (Service name) Enum: "odk" "odc" "odv" "odl" "video" "contract" "payment" "permission"
menu_key required	string (Menu key) [ 1 .. 200 ] characters The format is `/{parent_menu_name}/{menu_name}`. ex) `/contents/program`
menu_name required	string (Menu name) [ 1 .. 100 ] characters
permission	integer (Permission)

Response samples

200

Content type

application/json

{"id": 0,
"permission_display": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"menu_key": "string",
"menu_name": "string",
"permission": 0
}

permission_admin_menu_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Admin Menu Permission.

Request Body schema: application/json
required

service_name required	string (Service name) Enum: "odk" "odc" "odv" "odl" "video" "contract" "payment" "permission"
menu_key required	string (Menu key) [ 1 .. 200 ] characters The format is `/{parent_menu_name}/{menu_name}`. ex) `/contents/program`
menu_name required	string (Menu name) [ 1 .. 100 ] characters

Responses

Response Schema: application/json

id	integer (ID)
permission_display	string (Permission display)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name required	string (Service name) Enum: "odk" "odc" "odv" "odl" "video" "contract" "payment" "permission"
menu_key required	string (Menu key) [ 1 .. 200 ] characters The format is `/{parent_menu_name}/{menu_name}`. ex) `/contents/program`
menu_name required	string (Menu name) [ 1 .. 100 ] characters
permission	integer (Permission)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"menu_key": "string",
"menu_name": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"permission_display": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"menu_key": "string",
"menu_name": "string",
"permission": 0
}

permission_admin_menu_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Admin Menu Permission.

Request Body schema: application/json
required

service_name required	string (Service name) Enum: "odk" "odc" "odv" "odl" "video" "contract" "payment" "permission"
menu_key required	string (Menu key) [ 1 .. 200 ] characters The format is `/{parent_menu_name}/{menu_name}`. ex) `/contents/program`
menu_name required	string (Menu name) [ 1 .. 100 ] characters

Responses

Response Schema: application/json

id	integer (ID)
permission_display	string (Permission display)
created	string <date-time> (Created)
modified	string <date-time> (Modified)
service_name required	string (Service name) Enum: "odk" "odc" "odv" "odl" "video" "contract" "payment" "permission"
menu_key required	string (Menu key) [ 1 .. 200 ] characters The format is `/{parent_menu_name}/{menu_name}`. ex) `/contents/program`
menu_name required	string (Menu name) [ 1 .. 100 ] characters
permission	integer (Permission)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"menu_key": "string",
"menu_name": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"permission_display": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"service_name": "odk",
"menu_key": "string",
"menu_name": "string",
"permission": 0
}

permission_group_list

Authorizations:

token

query Parameters

ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (Group)

Array

id	integer (ID)
name required	string (Name) [ 1 .. 150 ] characters

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"name": "string"
}
]
}

permission_group_create

Authorizations:

token

Request Body schema: application/json
required

name required	string (Name) [ 1 .. 150 ] characters
admin_menus required	Array of strings or null

Responses

Response Schema: application/json

id	integer (ID)
name required	string (Name) [ 1 .. 150 ] characters
admin_menus required	Array of strings or null

Request samples

Payload

Content type

application/json

{"name": "string",
"admin_menus": ["string"
]
}

Response samples

201

Content type

application/json

{"id": 0,
"name": "string",
"admin_menus": ["string"
]
}

permission_group_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this group.

Responses

Response Schema: application/json

id	integer (ID)
name required	string (Name) [ 1 .. 150 ] characters
admin_menus required	Array of strings or null

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"admin_menus": ["string"
]
}

permission_group_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this group.

Request Body schema: application/json
required

name required	string (Name) [ 1 .. 150 ] characters
admin_menus required	Array of strings or null

Responses

Response Schema: application/json

id	integer (ID)
name required	string (Name) [ 1 .. 150 ] characters
admin_menus required	Array of strings or null

Request samples

Payload

Content type

application/json

{"name": "string",
"admin_menus": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"admin_menus": ["string"
]
}

permission_group_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this group.

Request Body schema: application/json
required

name required	string (Name) [ 1 .. 150 ] characters
admin_menus required	Array of strings or null

Responses

Response Schema: application/json

id	integer (ID)
name required	string (Name) [ 1 .. 150 ] characters
admin_menus required	Array of strings or null

Request samples

Payload

Content type

application/json

{"name": "string",
"admin_menus": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"admin_menus": ["string"
]
}

playback

playback_video_read

Authorizations:

token

path Parameters

video_id

required

string

Responses

Response Schema: application/json

id

required

integer (Id)

brightcove_id

required

string (Brightcove id) non-empty

source

required

string (Source) non-empty

duration

required

integer (Duration)

object (VideoSourceAdmin)

type required	string (Type) non-empty
url required	string (Url) non-empty
preset	string or null (Preset) non-empty

object (VideoTextTrackAdmin)

language required	string (Language) non-empty
label	string or null (Label) non-empty
url required	string (Url) non-empty
codec	string or null (Codec) non-empty
default	boolean or null (Default)

Response samples

200

Content type

application/json

{"id": 0,
"brightcove_id": "string",
"source": "string",
"duration": 0,
"sources": {"type": "string",
"url": "string",
"preset": "string"
},
"text_tracks": {"language": "string",
"label": "string",
"url": "string",
"codec": "string",
"default": true
}
}

playback_read

Authorizations:

token

path Parameters

id

required

string

Responses

Response Schema: application/json

source

string (Source)

duration

integer (Duration)

object (VideoSourceAdmin)

type required	string (Type) non-empty
url required	string (Url) non-empty
preset	string or null (Preset) non-empty

object (VideoTextTrackAdmin)

language required	string (Language) non-empty
label	string or null (Label) non-empty
url required	string (Url) non-empty
codec	string or null (Codec) non-empty
default	boolean or null (Default)

id

integer (Id)

brightcove_id

string (Brightcove id)

object (VideoCuePointAdmin)

metadata	string or null (Metadata) non-empty
name required	string (Name) non-empty
type required	string (Type) non-empty
timecode required	number (Timecode)

ip

string (Ip)

country_code

string (Country code)

Response samples

200

Content type

application/json

{"source": "string",
"duration": 0,
"sources": {"type": "string",
"url": "string",
"preset": "string"
},
"text_tracks": {"language": "string",
"label": "string",
"url": "string",
"codec": "string",
"default": true
},
"id": 0,
"brightcove_id": "string",
"cue_points": {"metadata": "string",
"name": "string",
"type": "string",
"timecode": 0
},
"ip": "string",
"country_code": "string"
}

product-subscription

product-subscription_list

Authorizations:

token

query Parameters

product_code	string
payment_platform	string
subscription_type	string
interval_unit	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ProductSubscription)

Array

id	integer (ID)
product_id	string or null (Product id) <= 50 characters pg product_id, ex) r8tasialb6pv
product_code required	string (Product code) [ 1 .. 50 ] characters
product_name required	string (Product name) [ 1 .. 255 ] characters
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
subscription_type required	string (Subscription type) Enum: "basic" "plus" "premium" "premium-box"
interval_unit required	string (Interval unit) Enum: "day" "month" "year"
interval_length	integer (Interval length) [ 0 .. 2147483647 ]
trial_unit	string or null (Trial unit) Enum: "day" "month" "year"
trial_length	integer or null (Trial length) [ -2147483648 .. 2147483647 ]
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"product_id": "string",
"product_code": "string",
"product_name": "string",
"payment_platform": "web",
"subscription_type": "basic",
"interval_unit": "day",
"interval_length": 2147483647,
"trial_unit": "day",
"trial_length": -2147483648,
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

product-subscription_create

Authorizations:

token

Request Body schema: application/json
required

product_id	string or null (Product id) <= 50 characters pg product_id, ex) r8tasialb6pv
product_code required	string (Product code) [ 1 .. 50 ] characters
product_name required	string (Product name) [ 1 .. 255 ] characters
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
subscription_type required	string (Subscription type) Enum: "basic" "plus" "premium" "premium-box"
interval_unit required	string (Interval unit) Enum: "day" "month" "year"
interval_length	integer (Interval length) [ 0 .. 2147483647 ]
trial_unit	string or null (Trial unit) Enum: "day" "month" "year"
trial_length	integer or null (Trial length) [ -2147483648 .. 2147483647 ]
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)

Responses

Response Schema: application/json

id	integer (ID)
product_id	string or null (Product id) <= 50 characters pg product_id, ex) r8tasialb6pv
product_code required	string (Product code) [ 1 .. 50 ] characters
product_name required	string (Product name) [ 1 .. 255 ] characters
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
subscription_type required	string (Subscription type) Enum: "basic" "plus" "premium" "premium-box"
interval_unit required	string (Interval unit) Enum: "day" "month" "year"
interval_length	integer (Interval length) [ 0 .. 2147483647 ]
trial_unit	string or null (Trial unit) Enum: "day" "month" "year"
trial_length	integer or null (Trial length) [ -2147483648 .. 2147483647 ]
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Request samples

Payload

Content type

application/json

{"product_id": "string",
"product_code": "string",
"product_name": "string",
"payment_platform": "web",
"subscription_type": "basic",
"interval_unit": "day",
"interval_length": 2147483647,
"trial_unit": "day",
"trial_length": -2147483648,
"currency": "str",
"price": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"product_id": "string",
"product_code": "string",
"product_name": "string",
"payment_platform": "web",
"subscription_type": "basic",
"interval_unit": "day",
"interval_length": 2147483647,
"trial_unit": "day",
"trial_length": -2147483648,
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

product-subscription_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this product subscription.

Responses

Response Schema: application/json

id	integer (ID)
product_id	string or null (Product id) <= 50 characters pg product_id, ex) r8tasialb6pv
product_code required	string (Product code) [ 1 .. 50 ] characters
product_name required	string (Product name) [ 1 .. 255 ] characters
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
subscription_type required	string (Subscription type) Enum: "basic" "plus" "premium" "premium-box"
interval_unit required	string (Interval unit) Enum: "day" "month" "year"
interval_length	integer (Interval length) [ 0 .. 2147483647 ]
trial_unit	string or null (Trial unit) Enum: "day" "month" "year"
trial_length	integer or null (Trial length) [ -2147483648 .. 2147483647 ]
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Response samples

200

Content type

application/json

{"id": 0,
"product_id": "string",
"product_code": "string",
"product_name": "string",
"payment_platform": "web",
"subscription_type": "basic",
"interval_unit": "day",
"interval_length": 2147483647,
"trial_unit": "day",
"trial_length": -2147483648,
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

product-subscription_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this product subscription.

Request Body schema: application/json
required

product_id	string or null (Product id) <= 50 characters pg product_id, ex) r8tasialb6pv
product_code required	string (Product code) [ 1 .. 50 ] characters
product_name required	string (Product name) [ 1 .. 255 ] characters
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
subscription_type required	string (Subscription type) Enum: "basic" "plus" "premium" "premium-box"
interval_unit required	string (Interval unit) Enum: "day" "month" "year"
interval_length	integer (Interval length) [ 0 .. 2147483647 ]
trial_unit	string or null (Trial unit) Enum: "day" "month" "year"
trial_length	integer or null (Trial length) [ -2147483648 .. 2147483647 ]
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)

Responses

Response Schema: application/json

id	integer (ID)
product_id	string or null (Product id) <= 50 characters pg product_id, ex) r8tasialb6pv
product_code required	string (Product code) [ 1 .. 50 ] characters
product_name required	string (Product name) [ 1 .. 255 ] characters
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
subscription_type required	string (Subscription type) Enum: "basic" "plus" "premium" "premium-box"
interval_unit required	string (Interval unit) Enum: "day" "month" "year"
interval_length	integer (Interval length) [ 0 .. 2147483647 ]
trial_unit	string or null (Trial unit) Enum: "day" "month" "year"
trial_length	integer or null (Trial length) [ -2147483648 .. 2147483647 ]
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Request samples

Payload

Content type

application/json

{"product_id": "string",
"product_code": "string",
"product_name": "string",
"payment_platform": "web",
"subscription_type": "basic",
"interval_unit": "day",
"interval_length": 2147483647,
"trial_unit": "day",
"trial_length": -2147483648,
"currency": "str",
"price": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"product_id": "string",
"product_code": "string",
"product_name": "string",
"payment_platform": "web",
"subscription_type": "basic",
"interval_unit": "day",
"interval_length": 2147483647,
"trial_unit": "day",
"trial_length": -2147483648,
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

product-subscription_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this product subscription.

Request Body schema: application/json
required

product_id	string or null (Product id) <= 50 characters pg product_id, ex) r8tasialb6pv
product_code required	string (Product code) [ 1 .. 50 ] characters
product_name required	string (Product name) [ 1 .. 255 ] characters
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
subscription_type required	string (Subscription type) Enum: "basic" "plus" "premium" "premium-box"
interval_unit required	string (Interval unit) Enum: "day" "month" "year"
interval_length	integer (Interval length) [ 0 .. 2147483647 ]
trial_unit	string or null (Trial unit) Enum: "day" "month" "year"
trial_length	integer or null (Trial length) [ -2147483648 .. 2147483647 ]
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)

Responses

Response Schema: application/json

id	integer (ID)
product_id	string or null (Product id) <= 50 characters pg product_id, ex) r8tasialb6pv
product_code required	string (Product code) [ 1 .. 50 ] characters
product_name required	string (Product name) [ 1 .. 255 ] characters
payment_platform required	string (Payment platform) Enum: "web" "apple" "google" "roku"
subscription_type required	string (Subscription type) Enum: "basic" "plus" "premium" "premium-box"
interval_unit required	string (Interval unit) Enum: "day" "month" "year"
interval_length	integer (Interval length) [ 0 .. 2147483647 ]
trial_unit	string or null (Trial unit) Enum: "day" "month" "year"
trial_length	integer or null (Trial length) [ -2147483648 .. 2147483647 ]
currency	string (Currency) [ 1 .. 3 ] characters
price required	string <decimal> (Price)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)

Request samples

Payload

Content type

application/json

{"product_id": "string",
"product_code": "string",
"product_name": "string",
"payment_platform": "web",
"subscription_type": "basic",
"interval_unit": "day",
"interval_length": 2147483647,
"trial_unit": "day",
"trial_length": -2147483648,
"currency": "str",
"price": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"product_id": "string",
"product_code": "string",
"product_name": "string",
"payment_platform": "web",
"subscription_type": "basic",
"interval_unit": "day",
"interval_length": 2147483647,
"trial_unit": "day",
"trial_length": -2147483648,
"currency": "str",
"price": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

programs

programs_list

Authorizations:

token

query Parameters

service_name	string
slug	string
enable	string
release_status	string
publish_status	string
categories	string
categories__slug	string
genres	string
genres__slug	string
content_provider	string
default_sales_type	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ProgramAdmin)

Array

id	integer (ID)
uuid	string <uuid> (Uuid) This value is not editable.
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
	object (images)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
secondary_title_ko	string or null (Secondary Title (KO)) <= 255 characters
secondary_title_en	string or null (Secondary Title (EN)) <= 255 characters
secondary_title_es	string or null (Secondary Title (ES)) <= 255 characters
secondary_title_zh_Hans	string or null (Secondary Title (ZH-HANS)) <= 255 characters
secondary_title_zh_Hant	string or null (Secondary Title (ZH-HANT)) <= 255 characters
secondary_title_zh_hans	string or null (Secondary Title (ZH-HANS)) <= 255 characters
secondary_title_zh_hant	string or null (Secondary Title (ZH-HANT)) <= 255 characters
secondary_title_pt	string or null (Secondary Title (PT)) <= 255 characters
synopsis_ko	string or null (Synopsis (KO))
synopsis_en	string (Synopsis en)
synopsis_es	string or null (Synopsis (ES))
synopsis_zh_Hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_Hant	string or null (Synopsis (ZH-HANT))
synopsis_zh_hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_hant	string or null (Synopsis (ZH-HANT))
synopsis_pt	string or null (Synopsis (PT))
enable	boolean (Enable)
publish_start	string or null <date-time> (Publish Start)
publish_end	string or null <date-time> (Publish End)
publish_status	string (Publish status)
allowed_countries	Array of strings (Allowed countries) Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" Allowed Countries(ISO-3166 Alpha-2 code)
release_start	string or null <date-time> (Release Start)
release_end	string or null <date-time> (Release End)
release_weekday	Array of strings or null (WeekDay) <= 7 items Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" Set the day of the week to release.
release_status	string (Release status)
produce_year	integer (Produce year)
	object (program meta)
content_type	string or null (Content Type) Enum: "free" "plus" "premium" "ppv" Content type for services by user type
default_sales_type	string or null (Default Sales Type) Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" Default SalesType value for episode of program
age_rating	string or null (Age rating) Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
seo_title_ko	string or null (Title(SEO) (KO)) <= 255 characters
seo_title_en	string or null (Title(SEO) (EN)) <= 255 characters
seo_title_es	string or null (Title(SEO) (ES)) <= 255 characters
seo_title_zh_Hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_Hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_zh_hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_pt	string or null (Title(SEO) (PT)) <= 255 characters
seo_synopsis_ko	string or null (Synopsis(SEO) (KO))
seo_synopsis_en	string or null (Synopsis(SEO) (EN))
seo_synopsis_es	string or null (Synopsis(SEO) (ES))
seo_synopsis_zh_Hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_Hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_zh_hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_pt	string or null (Synopsis(SEO) (PT))
seo_keyword_ko	string or null (Keyword(SEO) (KO))
seo_keyword_en	string or null (Keyword(SEO) (EN))
seo_keyword_es	string or null (Keyword(SEO) (ES))
seo_keyword_zh_Hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_Hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_zh_hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_pt	string or null (Keyword(SEO) (PT))
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)
old_id	integer or null (Old id) [ 0 .. 2147483647 ]
migrated	string or null <date-time> (Migrated) If put FUTURE time into this field, migration cron WILL NOT WORK well.
categories	Array of integers unique
	Array of objects (CategoryAdmin)
genres	Array of integers unique
	Array of objects (CategoryAdmin)
number_of_episodes	integer (Number of episodes)
latest_episode	integer or null (Latest episode)
region_age_ratings	Array of strings or null
content_provider	integer or null (Content provider)
	object (ContentProviderDisplay)
in_review	boolean (In Review)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}
]
}

programs_create

Authorizations:

token

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

genres

Array of integers unique

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Responses

Response Schema: application/json

id

integer (ID)

uuid

string <uuid> (Uuid)

This value is not editable.

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

publish_status

string (Publish status)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

release_status

string (Release status)

produce_year

integer (Produce year)

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

genres

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

number_of_episodes

integer (Number of episodes)

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Request samples

Payload

Content type

application/json

{"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"genres": [0
],
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

Response samples

201

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

programs_cache_clear_all

Authorizations:

token

query Parameters

service_name	string
slug	string
enable	string
release_status	string
publish_status	string
categories	string
categories__slug	string
genres	string
genres__slug	string
content_provider	string
default_sales_type	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ProgramAdmin)

Array

id	integer (ID)
uuid	string <uuid> (Uuid) This value is not editable.
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
	object (images)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
secondary_title_ko	string or null (Secondary Title (KO)) <= 255 characters
secondary_title_en	string or null (Secondary Title (EN)) <= 255 characters
secondary_title_es	string or null (Secondary Title (ES)) <= 255 characters
secondary_title_zh_Hans	string or null (Secondary Title (ZH-HANS)) <= 255 characters
secondary_title_zh_Hant	string or null (Secondary Title (ZH-HANT)) <= 255 characters
secondary_title_zh_hans	string or null (Secondary Title (ZH-HANS)) <= 255 characters
secondary_title_zh_hant	string or null (Secondary Title (ZH-HANT)) <= 255 characters
secondary_title_pt	string or null (Secondary Title (PT)) <= 255 characters
synopsis_ko	string or null (Synopsis (KO))
synopsis_en	string (Synopsis en)
synopsis_es	string or null (Synopsis (ES))
synopsis_zh_Hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_Hant	string or null (Synopsis (ZH-HANT))
synopsis_zh_hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_hant	string or null (Synopsis (ZH-HANT))
synopsis_pt	string or null (Synopsis (PT))
enable	boolean (Enable)
publish_start	string or null <date-time> (Publish Start)
publish_end	string or null <date-time> (Publish End)
publish_status	string (Publish status)
allowed_countries	Array of strings (Allowed countries) Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" Allowed Countries(ISO-3166 Alpha-2 code)
release_start	string or null <date-time> (Release Start)
release_end	string or null <date-time> (Release End)
release_weekday	Array of strings or null (WeekDay) <= 7 items Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" Set the day of the week to release.
release_status	string (Release status)
produce_year	integer (Produce year)
	object (program meta)
content_type	string or null (Content Type) Enum: "free" "plus" "premium" "ppv" Content type for services by user type
default_sales_type	string or null (Default Sales Type) Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" Default SalesType value for episode of program
age_rating	string or null (Age rating) Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
seo_title_ko	string or null (Title(SEO) (KO)) <= 255 characters
seo_title_en	string or null (Title(SEO) (EN)) <= 255 characters
seo_title_es	string or null (Title(SEO) (ES)) <= 255 characters
seo_title_zh_Hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_Hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_zh_hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_pt	string or null (Title(SEO) (PT)) <= 255 characters
seo_synopsis_ko	string or null (Synopsis(SEO) (KO))
seo_synopsis_en	string or null (Synopsis(SEO) (EN))
seo_synopsis_es	string or null (Synopsis(SEO) (ES))
seo_synopsis_zh_Hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_Hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_zh_hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_pt	string or null (Synopsis(SEO) (PT))
seo_keyword_ko	string or null (Keyword(SEO) (KO))
seo_keyword_en	string or null (Keyword(SEO) (EN))
seo_keyword_es	string or null (Keyword(SEO) (ES))
seo_keyword_zh_Hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_Hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_zh_hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_pt	string or null (Keyword(SEO) (PT))
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)
old_id	integer or null (Old id) [ 0 .. 2147483647 ]
migrated	string or null <date-time> (Migrated) If put FUTURE time into this field, migration cron WILL NOT WORK well.
categories	Array of integers unique
	Array of objects (CategoryAdmin)
genres	Array of integers unique
	Array of objects (CategoryAdmin)
number_of_episodes	integer (Number of episodes)
latest_episode	integer or null (Latest episode)
region_age_ratings	Array of strings or null
content_provider	integer or null (Content provider)
	object (ContentProviderDisplay)
in_review	boolean (In Review)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}
]
}

programs_cache_clear_list

Authorizations:

token

query Parameters

service_name	string
slug	string
enable	string
release_status	string
publish_status	string
categories	string
categories__slug	string
genres	string
genres__slug	string
content_provider	string
default_sales_type	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ProgramAdmin)

Array

id	integer (ID)
uuid	string <uuid> (Uuid) This value is not editable.
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
	object (images)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
secondary_title_ko	string or null (Secondary Title (KO)) <= 255 characters
secondary_title_en	string or null (Secondary Title (EN)) <= 255 characters
secondary_title_es	string or null (Secondary Title (ES)) <= 255 characters
secondary_title_zh_Hans	string or null (Secondary Title (ZH-HANS)) <= 255 characters
secondary_title_zh_Hant	string or null (Secondary Title (ZH-HANT)) <= 255 characters
secondary_title_zh_hans	string or null (Secondary Title (ZH-HANS)) <= 255 characters
secondary_title_zh_hant	string or null (Secondary Title (ZH-HANT)) <= 255 characters
secondary_title_pt	string or null (Secondary Title (PT)) <= 255 characters
synopsis_ko	string or null (Synopsis (KO))
synopsis_en	string (Synopsis en)
synopsis_es	string or null (Synopsis (ES))
synopsis_zh_Hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_Hant	string or null (Synopsis (ZH-HANT))
synopsis_zh_hans	string or null (Synopsis (ZH-HANS))
synopsis_zh_hant	string or null (Synopsis (ZH-HANT))
synopsis_pt	string or null (Synopsis (PT))
enable	boolean (Enable)
publish_start	string or null <date-time> (Publish Start)
publish_end	string or null <date-time> (Publish End)
publish_status	string (Publish status)
allowed_countries	Array of strings (Allowed countries) Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" Allowed Countries(ISO-3166 Alpha-2 code)
release_start	string or null <date-time> (Release Start)
release_end	string or null <date-time> (Release End)
release_weekday	Array of strings or null (WeekDay) <= 7 items Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" Set the day of the week to release.
release_status	string (Release status)
produce_year	integer (Produce year)
	object (program meta)
content_type	string or null (Content Type) Enum: "free" "plus" "premium" "ppv" Content type for services by user type
default_sales_type	string or null (Default Sales Type) Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+" Default SalesType value for episode of program
age_rating	string or null (Age rating) Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"
seo_title_ko	string or null (Title(SEO) (KO)) <= 255 characters
seo_title_en	string or null (Title(SEO) (EN)) <= 255 characters
seo_title_es	string or null (Title(SEO) (ES)) <= 255 characters
seo_title_zh_Hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_Hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_zh_hans	string or null (Title(SEO) (ZH-HANS)) <= 255 characters
seo_title_zh_hant	string or null (Title(SEO) (ZH-HANT)) <= 255 characters
seo_title_pt	string or null (Title(SEO) (PT)) <= 255 characters
seo_synopsis_ko	string or null (Synopsis(SEO) (KO))
seo_synopsis_en	string or null (Synopsis(SEO) (EN))
seo_synopsis_es	string or null (Synopsis(SEO) (ES))
seo_synopsis_zh_Hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_Hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_zh_hans	string or null (Synopsis(SEO) (ZH-HANS))
seo_synopsis_zh_hant	string or null (Synopsis(SEO) (ZH-HANT))
seo_synopsis_pt	string or null (Synopsis(SEO) (PT))
seo_keyword_ko	string or null (Keyword(SEO) (KO))
seo_keyword_en	string or null (Keyword(SEO) (EN))
seo_keyword_es	string or null (Keyword(SEO) (ES))
seo_keyword_zh_Hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_Hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_zh_hans	string or null (Keyword(SEO) (ZH-HANS))
seo_keyword_zh_hant	string or null (Keyword(SEO) (ZH-HANT))
seo_keyword_pt	string or null (Keyword(SEO) (PT))
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
created	string <date-time> (Created)
modified	string <date-time> (Modified)
old_id	integer or null (Old id) [ 0 .. 2147483647 ]
migrated	string or null <date-time> (Migrated) If put FUTURE time into this field, migration cron WILL NOT WORK well.
categories	Array of integers unique
	Array of objects (CategoryAdmin)
genres	Array of integers unique
	Array of objects (CategoryAdmin)
number_of_episodes	integer (Number of episodes)
latest_episode	integer or null (Latest episode)
region_age_ratings	Array of strings or null
content_provider	integer or null (Content provider)
	object (ContentProviderDisplay)
in_review	boolean (In Review)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}
]
}

programs_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Program.

Responses

Response Schema: application/json

id

integer (ID)

uuid

string <uuid> (Uuid)

This value is not editable.

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

publish_status

string (Publish status)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

release_status

string (Release status)

produce_year

integer (Produce year)

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

genres

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

number_of_episodes

integer (Number of episodes)

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

programs_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Program.

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

genres

Array of integers unique

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Responses

Response Schema: application/json

id

integer (ID)

uuid

string <uuid> (Uuid)

This value is not editable.

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

publish_status

string (Publish status)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

release_status

string (Release status)

produce_year

integer (Produce year)

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

genres

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

number_of_episodes

integer (Number of episodes)

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Request samples

Payload

Content type

application/json

{"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"genres": [0
],
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

programs_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Program.

Responses

programs_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Program.

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

genres

Array of integers unique

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Responses

Response Schema: application/json

id

integer (ID)

uuid

string <uuid> (Uuid)

This value is not editable.

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

publish_status

string (Publish status)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

release_status

string (Release status)

produce_year

integer (Produce year)

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

genres

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

number_of_episodes

integer (Number of episodes)

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Request samples

Payload

Content type

application/json

{"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"genres": [0
],
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

programs_cache_clear

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Program.

Responses

Response Schema: application/json

id

integer (ID)

uuid

string <uuid> (Uuid)

This value is not editable.

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

object (images)

poster_ko	string <uri> deprecated. only use for ODC
poster_en	string <uri> deprecated. only use for ODC
poster_es	string <uri> deprecated. only use for ODC
poster_zh_Hans	string <uri> deprecated. only use for ODC
poster_zh_Hant	string <uri> deprecated. only use for ODC
poster_zh_hans	string <uri> deprecated. only use for ODC
poster_zh_hant	string <uri> deprecated. only use for ODC
poster_pt	string <uri> deprecated. only use for ODC
poster_landscape_ko	string <uri> landscape image for program
poster_landscape_en	string <uri> landscape image for program
poster_landscape_es	string <uri> landscape image for program
poster_landscape_zh_Hans	string <uri> landscape image for program
poster_landscape_zh_Hant	string <uri> landscape image for program
poster_landscape_zh_hans	string <uri> landscape image for program
poster_landscape_zh_hant	string <uri> landscape image for program
poster_landscape_pt	string <uri> landscape image for program
poster_portrait_ko	string <uri> portrait image for program
poster_portrait_en	string <uri> portrait image for program
poster_portrait_es	string <uri> portrait image for program
poster_portrait_zh_Hans	string <uri> portrait image for program
poster_portrait_zh_Hant	string <uri> portrait image for program
poster_portrait_zh_hans	string <uri> portrait image for program
poster_portrait_zh_hant	string <uri> portrait image for program
poster_portrait_pt	string <uri> portrait image for program

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string (Title en)

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

secondary_title_ko

string or null (Secondary Title (KO)) <= 255 characters

secondary_title_en

string or null (Secondary Title (EN)) <= 255 characters

secondary_title_es

string or null (Secondary Title (ES)) <= 255 characters

secondary_title_zh_Hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_Hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_zh_hans

string or null (Secondary Title (ZH-HANS)) <= 255 characters

secondary_title_zh_hant

string or null (Secondary Title (ZH-HANT)) <= 255 characters

secondary_title_pt

string or null (Secondary Title (PT)) <= 255 characters

synopsis_ko

string or null (Synopsis (KO))

synopsis_en

string (Synopsis en)

synopsis_es

string or null (Synopsis (ES))

synopsis_zh_Hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_Hant

string or null (Synopsis (ZH-HANT))

synopsis_zh_hans

string or null (Synopsis (ZH-HANS))

synopsis_zh_hant

string or null (Synopsis (ZH-HANT))

synopsis_pt

string or null (Synopsis (PT))

enable

boolean (Enable)

publish_start

string or null <date-time> (Publish Start)

publish_end

string or null <date-time> (Publish End)

publish_status

string (Publish status)

allowed_countries

Array of strings (Allowed countries)

Items Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR"

Allowed Countries(ISO-3166 Alpha-2 code)

release_start

string or null <date-time> (Release Start)

release_end

string or null <date-time> (Release End)

release_weekday

Array of strings or null (WeekDay) <= 7 items

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

Set the day of the week to release.

release_status

string (Release status)

produce_year

integer (Produce year)

object (program meta)

cp

Array of strings

Different from meta.odk.cp. Use for odc.

score

integer <float>

Field required for popularity order logic, etc.It is updated periodically with calculated values.

is_series

boolean

Not used in the backend, but used in the front display logic

episode_ordering

string

Not used in the backend, but used in the front display logic

episode_total

boolean

Not used in the backend, but used in the front display logic

produce_countries

Array of strings

Meta info of program that shows produce countries

cc_languages

Array of strings

Meta info of program that shows available subtitle languages

owner

string

legacy data of odk

running_time

integer <int64>

Running time for content in minutes

object

cp	string Different from meta.cp. Use for odk legacy.
is_kcp	boolean This program from KCP or not
hide_badge	boolean
hide_ep_date	boolean
limited_free	boolean
	object
legacy_cat_id	integer
legacy_parent_name	string
popularity_adjust	integer
popularity_adjust_from	string <date-time>
popularity_adjust_to	string <date-time>
is_created_on_io	boolean Whether the program is created on IO
modified_on_io	string <date-time> The datetime that the program is modified on IO
last_pulled_from_legacy	string <date-time> The datetime that the program is migrated from legacy
last_pushed_to_legacy	string <date-time> The datetime that the program is reverse synced to legacy
legacy_post_date	string <date-time> post_date that is migrated from legacy (Pacific Time)
tags_ko	Array of strings
tags_en	Array of strings
tags_es	Array of strings
tags_zh_Hans	Array of strings
tags_zh_Hant	Array of strings
tags_zh_hans	Array of strings
tags_zh_hant	Array of strings
tags_pt	Array of strings
director_ko	Array of strings
director_en	Array of strings
director_es	Array of strings
director_zh_Hans	Array of strings
director_zh_Hant	Array of strings
director_zh_hans	Array of strings
director_zh_hant	Array of strings
director_pt	Array of strings
actor_ko	Array of strings
actor_en	Array of strings
actor_es	Array of strings
actor_zh_Hans	Array of strings
actor_zh_Hant	Array of strings
actor_zh_hans	Array of strings
actor_zh_hant	Array of strings
actor_pt	Array of strings

content_type

string or null (Content Type)

Enum: "free" "plus" "premium" "ppv"

Content type for services by user type

default_sales_type

string or null (Default Sales Type)

Enum: "GUEST" "FREE" "PPV" "PLUS" "PREMIUM" "VIP" "VIP+"

Default SalesType value for episode of program

age_rating

string or null (Age rating)

Enum: "All" "PG" "R12" "R13" "R14" "R15" "R16" "R17" "R18" "R19" "NR"

seo_title_ko

string or null (Title(SEO) (KO)) <= 255 characters

seo_title_en

string or null (Title(SEO) (EN)) <= 255 characters

seo_title_es

string or null (Title(SEO) (ES)) <= 255 characters

seo_title_zh_Hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_Hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_zh_hans

string or null (Title(SEO) (ZH-HANS)) <= 255 characters

seo_title_zh_hant

string or null (Title(SEO) (ZH-HANT)) <= 255 characters

seo_title_pt

string or null (Title(SEO) (PT)) <= 255 characters

seo_synopsis_ko

string or null (Synopsis(SEO) (KO))

seo_synopsis_en

string or null (Synopsis(SEO) (EN))

seo_synopsis_es

string or null (Synopsis(SEO) (ES))

seo_synopsis_zh_Hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_Hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_zh_hans

string or null (Synopsis(SEO) (ZH-HANS))

seo_synopsis_zh_hant

string or null (Synopsis(SEO) (ZH-HANT))

seo_synopsis_pt

string or null (Synopsis(SEO) (PT))

seo_keyword_ko

string or null (Keyword(SEO) (KO))

seo_keyword_en

string or null (Keyword(SEO) (EN))

seo_keyword_es

string or null (Keyword(SEO) (ES))

seo_keyword_zh_Hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_Hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_zh_hans

string or null (Keyword(SEO) (ZH-HANS))

seo_keyword_zh_hant

string or null (Keyword(SEO) (ZH-HANT))

seo_keyword_pt

string or null (Keyword(SEO) (PT))

service_name

string (Service Name)

Default: "odk"

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

created

string <date-time> (Created)

modified

string <date-time> (Modified)

old_id

integer or null (Old id) [ 0 .. 2147483647 ]

migrated

string or null <date-time> (Migrated)

If put FUTURE time into this field, migration cron WILL NOT WORK well.

categories

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

genres

Array of integers unique

Array of objects (CategoryAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
parent	integer or null (Parent)
parent_display	string (Parent display)
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string (Title en)
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
is_root	boolean (Is root)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
kind	string (Kind) Default: "category" Enum: "category" "genre" "link"
created	string <date-time> (Created)
modified	string <date-time> (Modified)
link	string or null (Link) <= 255 characters
background_image	string or null (Background image) <= 255 characters

number_of_episodes

integer (Number of episodes)

latest_episode

integer or null (Latest episode)

region_age_ratings

Array of strings or null

content_provider

integer or null (Content provider)

object (ContentProviderDisplay)

code required	string <slug> (Code) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$ Only a-z, A-Z, 0-9, _ allowed
name required	string (Name) [ 1 .. 200 ] characters
country	string or null (Country) Enum: "KR" "CN" "US" "CA" "TW" "HK" "JP" "MX" "GT" "SV" "CO" "PE" "EC" "HN" "CR" "NI" "PA" "BO" "VE" "CL" "AR" "PY" "UY" "BR" "CU" "DO" "PR" ISO-3166 Alpha-2 code

in_review

boolean (In Review)

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"slug": "string",
"images": {"poster_ko": "http://example.com",
"poster_en": "http://example.com",
"poster_es": "http://example.com",
"poster_zh_Hans": "http://example.com",
"poster_zh_Hant": "http://example.com",
"poster_zh_hans": "http://example.com",
"poster_zh_hant": "http://example.com",
"poster_pt": "http://example.com",
"poster_landscape_ko": "http://example.com",
"poster_landscape_en": "http://example.com",
"poster_landscape_es": "http://example.com",
"poster_landscape_zh_Hans": "http://example.com",
"poster_landscape_zh_Hant": "http://example.com",
"poster_landscape_zh_hans": "http://example.com",
"poster_landscape_zh_hant": "http://example.com",
"poster_landscape_pt": "http://example.com",
"poster_portrait_ko": "http://example.com",
"poster_portrait_en": "http://example.com",
"poster_portrait_es": "http://example.com",
"poster_portrait_zh_Hans": "http://example.com",
"poster_portrait_zh_Hant": "http://example.com",
"poster_portrait_zh_hans": "http://example.com",
"poster_portrait_zh_hant": "http://example.com",
"poster_portrait_pt": "http://example.com"
},
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"secondary_title_ko": "string",
"secondary_title_en": "string",
"secondary_title_es": "string",
"secondary_title_zh_Hans": "string",
"secondary_title_zh_Hant": "string",
"secondary_title_zh_hans": "string",
"secondary_title_zh_hant": "string",
"secondary_title_pt": "string",
"synopsis_ko": "string",
"synopsis_en": "string",
"synopsis_es": "string",
"synopsis_zh_Hans": "string",
"synopsis_zh_Hant": "string",
"synopsis_zh_hans": "string",
"synopsis_zh_hant": "string",
"synopsis_pt": "string",
"enable": true,
"publish_start": "2019-08-24T14:15:22Z",
"publish_end": "2019-08-24T14:15:22Z",
"publish_status": "string",
"allowed_countries": ["KR"
],
"release_start": "2019-08-24T14:15:22Z",
"release_end": "2019-08-24T14:15:22Z",
"release_weekday": ["sunday"
],
"release_status": "string",
"produce_year": 0,
"meta": {"cp": ["kbs",
"mbc"
],
"score": 0,
"is_series": true,
"episode_ordering": "newest",
"episode_total": false,
"produce_countries": ["KR",
"CN"
],
"cc_languages": ["ko",
"en"
],
"owner": "kocowa",
"running_time": 144,
"odk": {"cp": "kbs",
"is_kcp": true,
"hide_badge": true,
"hide_ep_date": false,
"limited_free": true,
"ad_hide_by_user": {"guest": false,
"free": false,
"plus": false,
"premium": true
},
"legacy_cat_id": 71,
"legacy_parent_name": "movies",
"popularity_adjust": 2000,
"popularity_adjust_from": "2020-05-15T07:00:00Z",
"popularity_adjust_to": "2020-07-01T07:00:00Z",
"is_created_on_io": true,
"modified_on_io": "2020-01-10T07:00:00Z",
"last_pulled_from_legacy": "2020-02-15T07:00:00Z",
"last_pushed_to_legacy": "2020-02-17T07:00:00Z",
"legacy_post_date": "2020-02-28T07:00:00Z",
"tags_ko": ["string"
],
"tags_en": ["string"
],
"tags_es": ["string"
],
"tags_zh_Hans": ["string"
],
"tags_zh_Hant": ["string"
],
"tags_zh_hans": ["string"
],
"tags_zh_hant": ["string"
],
"tags_pt": ["string"
],
"director_ko": ["string"
],
"director_en": ["string"
],
"director_es": ["string"
],
"director_zh_Hans": ["string"
],
"director_zh_Hant": ["string"
],
"director_zh_hans": ["string"
],
"director_zh_hant": ["string"
],
"director_pt": ["string"
],
"actor_ko": ["string"
],
"actor_en": ["string"
],
"actor_es": ["string"
],
"actor_zh_Hans": ["string"
],
"actor_zh_Hant": ["string"
],
"actor_zh_hans": ["string"
],
"actor_zh_hant": ["string"
],
"actor_pt": ["string"
]
}
},
"content_type": "free",
"default_sales_type": "GUEST",
"age_rating": "All",
"seo_title_ko": "string",
"seo_title_en": "string",
"seo_title_es": "string",
"seo_title_zh_Hans": "string",
"seo_title_zh_Hant": "string",
"seo_title_zh_hans": "string",
"seo_title_zh_hant": "string",
"seo_title_pt": "string",
"seo_synopsis_ko": "string",
"seo_synopsis_en": "string",
"seo_synopsis_es": "string",
"seo_synopsis_zh_Hans": "string",
"seo_synopsis_zh_Hant": "string",
"seo_synopsis_zh_hans": "string",
"seo_synopsis_zh_hant": "string",
"seo_synopsis_pt": "string",
"seo_keyword_ko": "string",
"seo_keyword_en": "string",
"seo_keyword_es": "string",
"seo_keyword_zh_Hans": "string",
"seo_keyword_zh_Hant": "string",
"seo_keyword_zh_hans": "string",
"seo_keyword_zh_hant": "string",
"seo_keyword_pt": "string",
"service_name": "odk",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"old_id": 2147483647,
"migrated": "2019-08-24T14:15:22Z",
"categories": [0
],
"categories_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"genres": [0
],
"genres_display": [{"id": 0,
"slug": "string",
"parent": 0,
"parent_display": "string",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"is_root": true,
"service_name": "odk",
"kind": "category",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"link": "string",
"background_image": "string"
}
],
"number_of_episodes": 0,
"latest_episode": 0,
"region_age_ratings": ["string"
],
"content_provider": 0,
"content_provider_display": {"code": "string",
"name": "string",
"country": "KR"
},
"in_review": true
}

programs_update_slug

Update program's slug only

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Program.

Request Body schema: application/json
required

slug

required

string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Responses

Response Schema: application/json

slug

required

string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Request samples

Payload

Content type

application/json

{"slug": "string"
}

Response samples

200

Content type

application/json

{"slug": "string"
}

providers

providers_list

This API is for ODK only. The provider model used in this API is temporary. It will be integrated into the content_provider model in the future. But now you can use this API to manage the ODK cp list.

Authorizations:

token

query Parameters

slug	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (ProviderAdmin)

Array

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
name_ko	string or null (Name (KO)) <= 255 characters
name_en	string or null (Name (EN)) <= 255 characters
	object (ProviderMeta)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"slug": "string",
"name_ko": "string",
"name_en": "string",
"meta": {"allow_country": "string",
"allow_continent": "string",
"disallow_country": "string",
"disallow_continent": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

providers_create

This API is for ODK only. The provider model used in this API is temporary. It will be integrated into the content_provider model in the future. But now you can use this API to manage the ODK cp list.

Authorizations:

token

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

name_ko

string or null (Name (KO)) <= 255 characters

name_en

string or null (Name (EN)) <= 255 characters

object (ProviderMeta)

allow_country required	string or null (Allow country)
allow_continent required	string or null (Allow continent)
disallow_country required	string or null (Disallow country)
disallow_continent required	string or null (Disallow continent)

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

name_ko

string or null (Name (KO)) <= 255 characters

name_en

string or null (Name (EN)) <= 255 characters

object (ProviderMeta)

allow_country required	string or null (Allow country)
allow_continent required	string or null (Allow continent)
disallow_country required	string or null (Disallow country)
disallow_continent required	string or null (Disallow continent)

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"name_ko": "string",
"name_en": "string",
"meta": {"allow_country": "string",
"allow_continent": "string",
"disallow_country": "string",
"disallow_continent": "string"
}
}

Response samples

201

Content type

application/json

{"id": 0,
"slug": "string",
"name_ko": "string",
"name_en": "string",
"meta": {"allow_country": "string",
"allow_continent": "string",
"disallow_country": "string",
"disallow_continent": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

providers_read

This API is for ODK only. The provider model used in this API is temporary. It will be integrated into the content_provider model in the future. But now you can use this API to manage the ODK cp list.

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this provider.

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

name_ko

string or null (Name (KO)) <= 255 characters

name_en

string or null (Name (EN)) <= 255 characters

object (ProviderMeta)

allow_country required	string or null (Allow country)
allow_continent required	string or null (Allow continent)
disallow_country required	string or null (Disallow country)
disallow_continent required	string or null (Disallow continent)

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"name_ko": "string",
"name_en": "string",
"meta": {"allow_country": "string",
"allow_continent": "string",
"disallow_country": "string",
"disallow_continent": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

providers_update

This API is for ODK only. The provider model used in this API is temporary. It will be integrated into the content_provider model in the future. But now you can use this API to manage the ODK cp list.

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this provider.

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

name_ko

string or null (Name (KO)) <= 255 characters

name_en

string or null (Name (EN)) <= 255 characters

object (ProviderMeta)

allow_country required	string or null (Allow country)
allow_continent required	string or null (Allow continent)
disallow_country required	string or null (Disallow country)
disallow_continent required	string or null (Disallow continent)

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

name_ko

string or null (Name (KO)) <= 255 characters

name_en

string or null (Name (EN)) <= 255 characters

object (ProviderMeta)

allow_country required	string or null (Allow country)
allow_continent required	string or null (Allow continent)
disallow_country required	string or null (Disallow country)
disallow_continent required	string or null (Disallow continent)

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"name_ko": "string",
"name_en": "string",
"meta": {"allow_country": "string",
"allow_continent": "string",
"disallow_country": "string",
"disallow_continent": "string"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"name_ko": "string",
"name_en": "string",
"meta": {"allow_country": "string",
"allow_continent": "string",
"disallow_country": "string",
"disallow_continent": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

providers_partial_update

This API is for ODK only. The provider model used in this API is temporary. It will be integrated into the content_provider model in the future. But now you can use this API to manage the ODK cp list.

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this provider.

Request Body schema: application/json
required

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

name_ko

string or null (Name (KO)) <= 255 characters

name_en

string or null (Name (EN)) <= 255 characters

object (ProviderMeta)

allow_country required	string or null (Allow country)
allow_continent required	string or null (Allow continent)
disallow_country required	string or null (Disallow country)
disallow_continent required	string or null (Disallow continent)

Responses

Response Schema: application/json

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$

name_ko

string or null (Name (KO)) <= 255 characters

name_en

string or null (Name (EN)) <= 255 characters

object (ProviderMeta)

allow_country required	string or null (Allow country)
allow_continent required	string or null (Allow continent)
disallow_country required	string or null (Disallow country)
disallow_continent required	string or null (Disallow continent)

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"slug": "string",
"name_ko": "string",
"name_en": "string",
"meta": {"allow_country": "string",
"allow_continent": "string",
"disallow_country": "string",
"disallow_continent": "string"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"slug": "string",
"name_ko": "string",
"name_en": "string",
"meta": {"allow_country": "string",
"allow_continent": "string",
"disallow_country": "string",
"disallow_continent": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

roles

roles_list

Authorizations:

token

query Parameters

name	string
program__id	number
episode__id	number
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (RoleAdmin)

Array

id	integer (ID)
name required	string (Role) Enum: "cast" "director" "writer"
order	integer or null (Order) [ 0 .. 32767 ]
person required	integer (Person)
	object (Person)
program	integer or null (Program)
	object (ProgramSimple)
episode	integer or null (Episode)
	object (EpisodeSimple)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"name": "cast",
"order": 32767,
"person": 0,
"person_display": {"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
},
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"episode": 0,
"episode_display": {"id": 0,
"slug": "string",
"season": -2147483648,
"kind": "series",
"number": 2147483647,
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"images": { },
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

roles_create

Authorizations:

token

Request Body schema: application/json
required

name

required

string (Role)

Enum: "cast" "director" "writer"

order

integer or null (Order) [ 0 .. 32767 ]

person

required

integer (Person)

object (Person)

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

program

integer or null (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

episode

integer or null (Episode)

object (EpisodeSimple)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

kind

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

integer or null (Number) [ 0 .. 2147483647 ]

program

required

integer (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

images

object or null (Images)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

Responses

Response Schema: application/json

id

integer (ID)

name

required

string (Role)

Enum: "cast" "director" "writer"

order

integer or null (Order) [ 0 .. 32767 ]

person

required

integer (Person)

object (Person)

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

program

integer or null (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

episode

integer or null (Episode)

object (EpisodeSimple)

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

kind

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

integer or null (Number) [ 0 .. 2147483647 ]

program

required

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

images

object or null (Images)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"name": "cast",
"order": 32767,
"person": 0,
"person_display": {"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
},
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"episode": 0,
"episode_display": {"slug": "string",
"season": -2147483648,
"kind": "series",
"number": 2147483647,
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"images": { },
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
}
}

Response samples

201

Content type

application/json

{"id": 0,
"name": "cast",
"order": 32767,
"person": 0,
"person_display": {"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
},
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"episode": 0,
"episode_display": {"id": 0,
"slug": "string",
"season": -2147483648,
"kind": "series",
"number": 2147483647,
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"images": { },
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

roles_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Role.

Responses

Response Schema: application/json

id

integer (ID)

name

required

string (Role)

Enum: "cast" "director" "writer"

order

integer or null (Order) [ 0 .. 32767 ]

person

required

integer (Person)

object (Person)

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

program

integer or null (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

episode

integer or null (Episode)

object (EpisodeSimple)

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

kind

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

integer or null (Number) [ 0 .. 2147483647 ]

program

required

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

images

object or null (Images)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"name": "cast",
"order": 32767,
"person": 0,
"person_display": {"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
},
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"episode": 0,
"episode_display": {"id": 0,
"slug": "string",
"season": -2147483648,
"kind": "series",
"number": 2147483647,
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"images": { },
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

roles_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Role.

Request Body schema: application/json
required

name

required

string (Role)

Enum: "cast" "director" "writer"

order

integer or null (Order) [ 0 .. 32767 ]

person

required

integer (Person)

object (Person)

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

program

integer or null (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

episode

integer or null (Episode)

object (EpisodeSimple)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

kind

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

integer or null (Number) [ 0 .. 2147483647 ]

program

required

integer (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

images

object or null (Images)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

Responses

Response Schema: application/json

id

integer (ID)

name

required

string (Role)

Enum: "cast" "director" "writer"

order

integer or null (Order) [ 0 .. 32767 ]

person

required

integer (Person)

object (Person)

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

program

integer or null (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

episode

integer or null (Episode)

object (EpisodeSimple)

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

kind

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

integer or null (Number) [ 0 .. 2147483647 ]

program

required

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

images

object or null (Images)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"name": "cast",
"order": 32767,
"person": 0,
"person_display": {"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
},
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"episode": 0,
"episode_display": {"slug": "string",
"season": -2147483648,
"kind": "series",
"number": 2147483647,
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"images": { },
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "cast",
"order": 32767,
"person": 0,
"person_display": {"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
},
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"episode": 0,
"episode_display": {"id": 0,
"slug": "string",
"season": -2147483648,
"kind": "series",
"number": 2147483647,
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"images": { },
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

roles_delete

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Role.

Responses

roles_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this Role.

Request Body schema: application/json
required

name

required

string (Role)

Enum: "cast" "director" "writer"

order

integer or null (Order) [ 0 .. 32767 ]

person

required

integer (Person)

object (Person)

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

program

integer or null (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

episode

integer or null (Episode)

object (EpisodeSimple)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

kind

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

integer or null (Number) [ 0 .. 2147483647 ]

program

required

integer (Program)

object (ProgramSimple)

slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters

images

object or null (Images)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

Responses

Response Schema: application/json

id

integer (ID)

name

required

string (Role)

Enum: "cast" "director" "writer"

order

integer or null (Order) [ 0 .. 32767 ]

person

required

integer (Person)

object (Person)

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
slug required	string <slug> (Slug) [ 1 .. 256 ] characters
name_ko	string or null (Name (KO)) <= 100 characters
name_en	string or null (Name (EN)) <= 100 characters
name_es	string or null (Name (ES)) <= 100 characters
name_zh_Hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_Hant	string or null (Name (ZH-HANT)) <= 100 characters
name_zh_hans	string or null (Name (ZH-HANS)) <= 100 characters
name_zh_hant	string or null (Name (ZH-HANT)) <= 100 characters
name_pt	string or null (Name (PT)) <= 100 characters
info	object (Info)

program

integer or null (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

episode

integer or null (Episode)

object (EpisodeSimple)

id

integer (ID)

slug

required

string <slug> (Slug) [ 1 .. 256 ] characters

season

integer or null (Season) [ -2147483648 .. 2147483647 ]

kind

string or null (Kind)

Enum: "series" "main" "trailer" "additional" "clip"

number

integer or null (Number) [ 0 .. 2147483647 ]

program

required

integer (Program)

object (ProgramSimple)

id	integer (ID)
slug required	string <slug> (Slug) [ 1 .. 256 ] characters ^[-a-zA-Z0-9_]+$
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
title_ko	string or null (Title (KO)) <= 255 characters
title_en	string or null (Title (EN)) <= 255 characters
title_es	string or null (Title (ES)) <= 255 characters
title_zh_Hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_Hant	string or null (Title (ZH-HANT)) <= 255 characters
title_zh_hans	string or null (Title (ZH-HANS)) <= 255 characters
title_zh_hant	string or null (Title (ZH-HANT)) <= 255 characters
title_pt	string or null (Title (PT)) <= 255 characters
publish_status	string (Publish status)
release_status	string (Release status)

images

object or null (Images)

title_ko

string or null (Title (KO)) <= 255 characters

title_en

string or null (Title (EN)) <= 255 characters

title_es

string or null (Title (ES)) <= 255 characters

title_zh_Hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_Hant

string or null (Title (ZH-HANT)) <= 255 characters

title_zh_hans

string or null (Title (ZH-HANS)) <= 255 characters

title_zh_hant

string or null (Title (ZH-HANT)) <= 255 characters

title_pt

string or null (Title (PT)) <= 255 characters

created

string <date-time> (Created)

modified

string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"name": "cast",
"order": 32767,
"person": 0,
"person_display": {"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
},
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"episode": 0,
"episode_display": {"slug": "string",
"season": -2147483648,
"kind": "series",
"number": 2147483647,
"program": 0,
"program_display": {"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"images": { },
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
}
}

Response samples

200

Content type

application/json

{"id": 0,
"name": "cast",
"order": 32767,
"person": 0,
"person_display": {"id": 0,
"service_name": "odk",
"slug": "string",
"name_ko": "string",
"name_en": "string",
"name_es": "string",
"name_zh_Hans": "string",
"name_zh_Hant": "string",
"name_zh_hans": "string",
"name_zh_hant": "string",
"name_pt": "string",
"info": { }
},
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"episode": 0,
"episode_display": {"id": 0,
"slug": "string",
"season": -2147483648,
"kind": "series",
"number": 2147483647,
"program": 0,
"program_display": {"id": 0,
"slug": "string",
"service_name": "odk",
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string",
"publish_status": "string",
"release_status": "string"
},
"images": { },
"title_ko": "string",
"title_en": "string",
"title_es": "string",
"title_zh_Hans": "string",
"title_zh_Hant": "string",
"title_zh_hans": "string",
"title_zh_hant": "string",
"title_pt": "string"
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

splash-screen

splash-screen_list

Authorizations:

token

query Parameters

service_name	string
platform	string
screen_type	string
active	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (SplashScreen)

Array

id	integer (ID)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
screen_type required	string (Screen Type) Enum: "splash" "promotion"
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
default	boolean (Default)
image_landscape	string or null <uri> (Landscape Image) <= 200 characters
image_portrait	string or null <uri> (Portrait Image) <= 200 characters
creator	integer or null (Creator)
modifier	integer or null (Modifier)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"service_name": "odk",
"platform": "web",
"screen_type": "splash",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"default": true,
"image_landscape": "http://example.com",
"image_portrait": "http://example.com",
"creator": 0,
"modifier": 0
}
]
}

splash-screen_create

Authorizations:

token

Request Body schema: application/json
required

service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
screen_type required	string (Screen Type) Enum: "splash" "promotion"
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
default	boolean (Default)
image_landscape	string or null <uri> (Landscape Image) <= 200 characters
image_portrait	string or null <uri> (Portrait Image) <= 200 characters
creator	integer or null (Creator)
modifier	integer or null (Modifier)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
screen_type required	string (Screen Type) Enum: "splash" "promotion"
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
default	boolean (Default)
image_landscape	string or null <uri> (Landscape Image) <= 200 characters
image_portrait	string or null <uri> (Portrait Image) <= 200 characters
creator	integer or null (Creator)
modifier	integer or null (Modifier)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"screen_type": "splash",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"default": true,
"image_landscape": "http://example.com",
"image_portrait": "http://example.com",
"creator": 0,
"modifier": 0
}

Response samples

201

Content type

application/json

{"id": 0,
"service_name": "odk",
"platform": "web",
"screen_type": "splash",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"default": true,
"image_landscape": "http://example.com",
"image_portrait": "http://example.com",
"creator": 0,
"modifier": 0
}

splash-screen_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this SplashScreen.

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
screen_type required	string (Screen Type) Enum: "splash" "promotion"
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
default	boolean (Default)
image_landscape	string or null <uri> (Landscape Image) <= 200 characters
image_portrait	string or null <uri> (Portrait Image) <= 200 characters
creator	integer or null (Creator)
modifier	integer or null (Modifier)

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"platform": "web",
"screen_type": "splash",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"default": true,
"image_landscape": "http://example.com",
"image_portrait": "http://example.com",
"creator": 0,
"modifier": 0
}

splash-screen_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this SplashScreen.

Request Body schema: application/json
required

service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
screen_type required	string (Screen Type) Enum: "splash" "promotion"
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
default	boolean (Default)
image_landscape	string or null <uri> (Landscape Image) <= 200 characters
image_portrait	string or null <uri> (Portrait Image) <= 200 characters
creator	integer or null (Creator)
modifier	integer or null (Modifier)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
screen_type required	string (Screen Type) Enum: "splash" "promotion"
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
default	boolean (Default)
image_landscape	string or null <uri> (Landscape Image) <= 200 characters
image_portrait	string or null <uri> (Portrait Image) <= 200 characters
creator	integer or null (Creator)
modifier	integer or null (Modifier)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"screen_type": "splash",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"default": true,
"image_landscape": "http://example.com",
"image_portrait": "http://example.com",
"creator": 0,
"modifier": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"platform": "web",
"screen_type": "splash",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"default": true,
"image_landscape": "http://example.com",
"image_portrait": "http://example.com",
"creator": 0,
"modifier": 0
}

splash-screen_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this SplashScreen.

Request Body schema: application/json
required

service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
screen_type required	string (Screen Type) Enum: "splash" "promotion"
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
default	boolean (Default)
image_landscape	string or null <uri> (Landscape Image) <= 200 characters
image_portrait	string or null <uri> (Portrait Image) <= 200 characters
creator	integer or null (Creator)
modifier	integer or null (Modifier)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
platform required	string (Platform Type) Enum: "web" "android" "ios" "roku" "tvos" "fire-tv" "web-os" "tizen-os" "android-tv" "odk-box"
screen_type required	string (Screen Type) Enum: "splash" "promotion"
start	string or null <date-time> (Start)
end	string or null <date-time> (End)
active	boolean (Active)
default	boolean (Default)
image_landscape	string or null <uri> (Landscape Image) <= 200 characters
image_portrait	string or null <uri> (Portrait Image) <= 200 characters
creator	integer or null (Creator)
modifier	integer or null (Modifier)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"platform": "web",
"screen_type": "splash",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"default": true,
"image_landscape": "http://example.com",
"image_portrait": "http://example.com",
"creator": 0,
"modifier": 0
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"platform": "web",
"screen_type": "splash",
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"active": true,
"default": true,
"image_landscape": "http://example.com",
"image_portrait": "http://example.com",
"creator": 0,
"modifier": 0
}

static_pages

static_pages_list

Get all static file names. If you want to get content of files, use retrieve API instead.

Authorizations:

token

header Parameters

Service-Name

required

string

Enum: "odk" "odc" "odv" "odl"

Responses

Response Schema: application/json

name	string Please use this to retrieve, update and delete the static page. Do not use `key`.
key	string Please use `name` to retrieve, update and delete the static page. Do not use this.
updated	string <date>

Response samples

200

Content type

application/json

{"name": "ads.txt",
"key": "odk/ads.txt",
"updated": "2023-10-30T07:27:39Z"
}

static_pages_create

Create new static file

Authorizations:

token

header Parameters

Service-Name

required

string

Enum: "odk" "odc" "odv" "odl"

Request Body schema: application/json
required

name	string Input name of a static page. Do not input key of the page as this field. Perhaps, this URL doesn't need to start with '/'.
content	string

Responses

Response Schema: application/json

name

string

Request samples

Payload

Content type

application/json

{"name": "ads.txt",
"content": "this is\nads.txt"
}

Response samples

400

Content type

application/json

{"name": "string"
}

static_pages_retrieve

If you need to get content of file, use this.

Authorizations:

token

path Parameters

name

required

string

Example: ads.txt

Input name of a static page. Do not input key of the page as this field. Perhaps, this URL doesn't need to start with '/'.

header Parameters

Service-Name

required

string

Enum: "odk" "odc" "odv" "odl"

Responses

Response Schema: application/json

name	string
key	string
content	string

Response Schema: application/json

name

string

Response samples

200
404

Content type

application/json

{"name": "ads.txt",
"key": "odk/ads.txt",
"content": "This is\nads.txt"
}

static_pages_update

Update static file

Authorizations:

token

path Parameters

name

required

string

Example: ads.txt

Input name of a static page. Do not input key of the page as this field. Perhaps, this URL doesn't need to start with '/'.

header Parameters

Service-Name

required

string

Enum: "odk" "odc" "odv" "odl"

Request Body schema: application/json
required

content

string

Responses

Response Schema: application/json

name

string

Request samples

Payload

Content type

application/json

{"content": "this is\nads.txt"
}

Response samples

404

Content type

application/json

{"name": "string"
}

static_pages_delete

Delete static file

Authorizations:

token

path Parameters

name

required

string

Example: ads.txt

Input name of a static page. Do not input key of the page as this field. Perhaps, this URL doesn't need to start with '/'.

header Parameters

Service-Name

required

string

Enum: "odk" "odc" "odv" "odl"

Responses

Response Schema: application/json

name

string

Response samples

404

Content type

application/json

{"name": "string"
}

subscription

subscription_list

Authorizations:

token

query Parameters

user__uuid	string
product__product_code	string
product__payment_platform	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (Subscription)

Array

id	integer (ID)
user	integer (User)
product required	integer (Product)
expired_at required	string <date-time> (Expired at)
trial_end_at	string or null <date-time> (Trial end at)
initial_billing_start_at required	string <date-time> (Initial billing start at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"user": 0,
"product": 0,
"expired_at": "2019-08-24T14:15:22Z",
"trial_end_at": "2019-08-24T14:15:22Z",
"initial_billing_start_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_uuid": "string"
}
]
}

subscription_create

Authorizations:

token

Request Body schema: application/json
required

product required	integer (Product)
expired_at required	string <date-time> (Expired at)
trial_end_at	string or null <date-time> (Trial end at)
initial_billing_start_at required	string <date-time> (Initial billing start at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters

Responses

Response Schema: application/json

id	integer (ID)
user	integer (User)
product required	integer (Product)
expired_at required	string <date-time> (Expired at)
trial_end_at	string or null <date-time> (Trial end at)
initial_billing_start_at required	string <date-time> (Initial billing start at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters

Request samples

Payload

Content type

application/json

{"product": 0,
"expired_at": "2019-08-24T14:15:22Z",
"trial_end_at": "2019-08-24T14:15:22Z",
"initial_billing_start_at": "2019-08-24T14:15:22Z",
"user_uuid": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"user": 0,
"product": 0,
"expired_at": "2019-08-24T14:15:22Z",
"trial_end_at": "2019-08-24T14:15:22Z",
"initial_billing_start_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_uuid": "string"
}

subscription_read

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this subscription.

Responses

Response Schema: application/json

id	integer (ID)
user	integer (User)
product required	integer (Product)
expired_at required	string <date-time> (Expired at)
trial_end_at	string or null <date-time> (Trial end at)
initial_billing_start_at required	string <date-time> (Initial billing start at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters

Response samples

200

Content type

application/json

{"id": 0,
"user": 0,
"product": 0,
"expired_at": "2019-08-24T14:15:22Z",
"trial_end_at": "2019-08-24T14:15:22Z",
"initial_billing_start_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_uuid": "string"
}

subscription_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this subscription.

Request Body schema: application/json
required

product required	integer (Product)
expired_at required	string <date-time> (Expired at)
trial_end_at	string or null <date-time> (Trial end at)
initial_billing_start_at required	string <date-time> (Initial billing start at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters

Responses

Response Schema: application/json

id	integer (ID)
user	integer (User)
product required	integer (Product)
expired_at required	string <date-time> (Expired at)
trial_end_at	string or null <date-time> (Trial end at)
initial_billing_start_at required	string <date-time> (Initial billing start at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters

Request samples

Payload

Content type

application/json

{"product": 0,
"expired_at": "2019-08-24T14:15:22Z",
"trial_end_at": "2019-08-24T14:15:22Z",
"initial_billing_start_at": "2019-08-24T14:15:22Z",
"user_uuid": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"user": 0,
"product": 0,
"expired_at": "2019-08-24T14:15:22Z",
"trial_end_at": "2019-08-24T14:15:22Z",
"initial_billing_start_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_uuid": "string"
}

subscription_partial_update

Authorizations:

token

path Parameters

id

required

integer

A unique integer value identifying this subscription.

Request Body schema: application/json
required

product required	integer (Product)
expired_at required	string <date-time> (Expired at)
trial_end_at	string or null <date-time> (Trial end at)
initial_billing_start_at required	string <date-time> (Initial billing start at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters

Responses

Response Schema: application/json

id	integer (ID)
user	integer (User)
product required	integer (Product)
expired_at required	string <date-time> (Expired at)
trial_end_at	string or null <date-time> (Trial end at)
initial_billing_start_at required	string <date-time> (Initial billing start at)
created_at	string <date-time> (Created at)
updated_at	string <date-time> (Updated at)
user_uuid required	string (User uuid) [ 1 .. 36 ] characters

Request samples

Payload

Content type

application/json

{"product": 0,
"expired_at": "2019-08-24T14:15:22Z",
"trial_end_at": "2019-08-24T14:15:22Z",
"initial_billing_start_at": "2019-08-24T14:15:22Z",
"user_uuid": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"user": 0,
"product": 0,
"expired_at": "2019-08-24T14:15:22Z",
"trial_end_at": "2019-08-24T14:15:22Z",
"initial_billing_start_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"user_uuid": "string"
}

text_pages

text_pages_list

Authorizations:

token

query Parameters

name	string
service_name	string
created	string
modified	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (TextPage)

Array

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"service_name": "odk",
"name": "string",
"text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

text_pages_create

Authorizations:

token

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"name": "string",
"text": "string"
}

Response samples

201

Content type

application/json

{"id": 0,
"service_name": "odk",
"name": "string",
"text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

text_pages_cache_clear_all

Authorizations:

token

query Parameters

name	string
service_name	string
created	string
modified	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (TextPage)

Array

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"service_name": "odk",
"name": "string",
"text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

text_pages_cache_clear_list

Authorizations:

token

query Parameters

name	string
service_name	string
created	string
modified	string
search	string A search term.
ordering	string Which field to use when ordering the results.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

count

required

integer

required

Array of objects (TextPage)

Array

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [{"id": 0,
"service_name": "odk",
"name": "string",
"text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}
]
}

text_pages_read

Authorizations:

token

path Parameters

name

required

string[a-zA-Z0-9_.\-]+

Filename

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"name": "string",
"text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

text_pages_update

Authorizations:

token

path Parameters

name

required

string[a-zA-Z0-9_.\-]+

Filename

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"name": "string",
"text": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"name": "string",
"text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

text_pages_delete

Authorizations:

token

path Parameters

name

required

string[a-zA-Z0-9_.\-]+

Filename

Responses

text_pages_partial_update

Authorizations:

token

path Parameters

name

required

string[a-zA-Z0-9_.\-]+

Filename

Request Body schema: application/json
required

service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Request samples

Payload

Content type

application/json

{"service_name": "odk",
"name": "string",
"text": "string"
}

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"name": "string",
"text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

text_pages_cache_clear

Authorizations:

token

path Parameters

name

required

string[a-zA-Z0-9_.\-]+

Filename

Responses

Response Schema: application/json

id	integer (ID)
service_name	string (Service Name) Default: "odk" Enum: "odk" "odc" "odv" "odl" ex) `odk`, `odc` and etc. / To specify service name
name required	string (Name) [ 1 .. 100 ] characters Filename
text required	string (Text)
created	string <date-time> (Created)
modified	string <date-time> (Modified)

Response samples

200

Content type

application/json

{"id": 0,
"service_name": "odk",
"name": "string",
"text": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z"
}

user/profile

users_profile

Authorizations:

token

query Parameters

is_active	string
is_staff	string
is_superuser	string
service_name	string
ordering	string Which field to use when ordering the results.
search	string A search term.
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response Schema: application/json

id

integer (ID)

username

required

string (Username) [ 1 .. 256 ] characters ^[a-z0-9_.@+-]+$

Required. 256 characters or fewer. Letters, digits and @/./+/-/_ only.

email

string <email> (Email address) <= 254 characters

last_login

string or null <date-time> (Last login)

date_joined

string <date-time> (Date joined)

service_name

string or null (Service Name)

Enum: "odk" "odc" "odv" "odl"

ex) odk, odc and etc. / To specify service name

object (UserInfo)

name	string (Name) [ 1 .. 256 ] characters
gender	string (Gender) [ 1 .. 8 ] characters
birthday	string <date> (Birthday) In read API, the format is `YYYY-MM-DD`, but in update and partial update API, the format is `YYYYMMDD`.
language	string (Language) [ 1 .. 32 ] characters
is_receive_mail	boolean (Is receive mail) Default: false

is_staff

boolean (Staff status)

Designates whether the user can log into this admin site.

is_superuser

boolean (Superuser status)

Designates that this user has all permissions without explicitly assigning them.

is_active

boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

admin_menus

required

Array of strings[ items non-empty ]

Admin menus that the user has permissions on

Response samples

200

Content type

application/json

{"id": 0,
"username": "string",
"email": "user@example.com",
"last_login": "2019-08-24T14:15:22Z",
"date_joined": "2019-08-24T14:15:22Z",
"service_name": "odk",
"info": {"name": "string",
"gender": "string",
"birthday": "2019-08-24",
"language": "string",
"is_receive_mail": false
},
"is_staff": true,
"is_superuser": true,
"is_active": true,
"admin_menus": ["string"
]
}

path Parameters

id

required

string

ADMIN API

adhoc

adhoc_app-ott-banner-update-order_partial_update

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

adhoc_app-ott-banner_list

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

adhoc_app-ott-banner_create

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

adhoc_app-ott-banner_read

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

adhoc_app-ott-banner_update

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

adhoc_app-ott-banner_delete

Authorizations:

path Parameters

Responses

adhoc_app-ott-banner_partial_update

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

adhoc_check-episode-ids-by-video-id_read

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

adhoc_coupon-group_list

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

adhoc_coupon-group_create

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

adhoc_coupon-group_read

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

adhoc_coupon-group_update

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required