Schemas
Avatar
image_urldescriptionidorderCategory
idcreated_athierarchynameobjectupdated_atCategoryRequest
idcreated_athierarchynameobjectupdated_atCcLanguagesEnum
ko- Koreanen- Englishes- Spanishzh-Hans- Simplified Chinesezh-Hant- Traditional Chinesezh-hans- Simplified Chinesezh-hant- Traditional Chinesept- Portuguesevi- Vietnamese
ChannelEPG
colorhexadecimal color code for channel
createddescriptionChannel description
epggenresidprimary key of channel model
keywordmodifiedorderIncreasing values sequentially from 1. Only enabled channel has not null value
service_nameex) odk, odc, lg-channel-vietnam and etc. / To specify service name
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIANlg-channel-vietnam- LG Channel Vietnam
slug^[-\w]+$stream_urlChannel live stream url.
titleChannel title
ContentTypeEnum
episode- episodeprogram- programexternal- externalodk-box- odk-boxchannel- channel
CoverContents
CoverItem
call_to_actionA text rendered on button of cover
content_idID of Content(Program or Episode)
content_slug^[-a-zA-Z0-9_]+$ · requiredSlug of Content(Program or Episode)
The type of Content(program, episode, external)
episode- episodeprogram- programexternal- externalodk-box- odk-boxchannel- channel
descriptionA description for cover
episode_idID of Episode
image_landscapeA URL of cover landscape image
image_portraitA URL of cover portrait image
rolling_timeThe rolling time for each banner
thumbnailA URL of cover thumbnail image
titleA title of cover
trackingWhich field reserved for Google Analytics
urlA target URL pointing to specific page when cover is clicked
videoA URL of video preview
video_fileA URL of video file
DefaultSalesTypeEnum
GUEST- GuestFREE- FreePPV- PpvPLUS- PlusPREMIUM- PremiumNO_ADS- No AdsVIP- VipVIP+- Vip Plus
DiscountRequest
typeamount_offeffectEmailEnum
facebook- Facebookapple- Appleemail- Emailroku- Rokuphone- Phone
Event
idcreated_atentity_idgroup_idtypeEventRequest
idcreated_atentity_idgroup_idtypeFilterOptions
if the category does not have this item, empty array is returned.
if the category does not have this item, empty array is returned.
if the category does not have this item, empty array is returned.
if the category does not have this item, empty array is returned.
if the category does not have this item, empty array is returned.
GenderEnum
m- Malef- Femalena- Prefer not to answerother- Other
IconTypeEnum
account- Accountsubscription- Subscriptionhot- Hot
KindEnum
series- Seriesmain- Maintrailer- Traileradditional- Additionalclip- Cliplive_streaming- Live Streamingshorts- Shorts
LabelEnum
All- AllPG- PG12+- 12+13+- 13+14+- 14+15+- 15+16+- 16+17+- 17+18+- 18+19+- 19+NR- NR
LanguageEnum
en- Englishko- Koreanzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishpt- Portuguese
LayoutTypeEnum
landscape- Landscapeportrait- Portraitlist- List
LiveTv
channelsorderThe ChannelCategory's list is ordered by this value
slug^[-a-zA-Z0-9_]+$titleChannelCategory's title
LiveTvChannelEpg
colorhexadecimal color code for channel
createddescriptionChannel description
epgsgenresidprimary key of channel model
keywordmodifiednumberunique number for channel
orderIncreasing values sequentially from 1. Only enabled channel has not null value
service_nameex) odk, odc, lg-channel-vietnam and etc. / To specify service name
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIANlg-channel-vietnam- LG Channel Vietnam
slug^[-\w]+$stream_urlChannel live stream url.
titleChannel title
NameEnum
All- AllPG- PGR12- R12R13- R13R14- R14R15- R15R16- R16R17- R17R18- R18R19- R19NR- NR
NavigationItem
slug^[-a-zA-Z0-9_]+$ · requiredtypecategory- categorygenre- genrelink- link
background_imagelinklogo_imageog_imageseo_descriptionseo_keywordsseo_titlesponsor_logo_urltitleNotice
published_atCreate or WIX publish datetime
titleenableNotice enabled
External Link
NotificationPayload
idcreated_atproject_idtypeNotificationPayloadRequest
idcreated_atproject_idtypeOdxV2CategoryForSearch
idis_rootparentservice_nameex) odk, odc and etc. / To specify service name
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIAN
slug^[-a-zA-Z0-9_]+$titleOdxV2Navigation
idservice_nameex) odk, odc and etc. / To specify service name
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIAN
slug^[-a-zA-Z0-9_]+$Home slug for url
OdxV2NavigationFirst
slug^[-a-zA-Z0-9_]+$ · requiredtypecategory- categorygenre- genrelink- link
background_imageThe items is a list of child category. The max depth is 3. The schema is the same as the parent category. Please refer to the example data.
linklogo_imageog_imageseo_descriptionseo_keywordsseo_titlesponsor_logo_urltitleOdxV2NavigationSecond
slug^[-a-zA-Z0-9_]+$ · requiredtypecategory- categorygenre- genrelink- link
background_imagelinklogo_imageog_imageseo_descriptionseo_keywordsseo_titlesponsor_logo_urltitleOdxV2NavigationThird
slug^[-a-zA-Z0-9_]+$ · requiredtypecategory- categorygenre- genrelink- link
background_imagelinklogo_imageog_imageseo_descriptionseo_keywordsseo_titlesponsor_logo_urltitleOdxV3AdminCouponCreateRequest
codeThe code the customer enters to redeem the coupon.
OdxV3AdminCouponCreateRequestRequest
codeThe code the customer enters to redeem the coupon.
episode_uuidOdxV3AdminCouponRetrieve
codeThe code the customer enters to redeem the coupon.
expected_valid_toExpected admin coupon expiration date considered with the user's membership
subscription_typebasic- Basicplus- Plusstandard- Standardpremium- Premiumpremium-box- Premium Boxfamily- Family
OdxV3AgeRating
is_blocklabelAll- AllPG- PG12+- 12+13+- 13+14+- 14+15+- 15+16+- 16+17+- 17+18+- 18+19+- 19+NR- NR
nameAll- AllPG- PGR12- R12R13- R13R14- R14R15- R15R16- R16R17- R17R18- R18R19- R19NR- NR
OdxV3BundlePromotion
bundle_product_codeProductSubscription.product_code
product_codePayPerView.episode.uuid
shared_secrettoken_idA token generated by Recurly.js.
coupon_codesex) ["test-coupon1", "test-coupon2"]
OdxV3BundlePromotionRequest
bundle_product_codeProductSubscription.product_code
product_codePayPerView.episode.uuid
shared_secrettoken_idA token generated by Recurly.js.
coupon_codesex) ["test-coupon1", "test-coupon2"]
OdxV3CWEpisode
slug^[-\w]+$ · requiredvideoA URL of video preview
badgesidnumberparttitlevideo_cc_languagesvideo_durationmillisecond(ms)
OdxV3Category
idslug^[-a-zA-Z0-9_]+$Category slug
titleOdxV3CategoryItem
idservice_nameex) odk, odc and etc. / To specify service name
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIAN
slug^[-a-zA-Z0-9_]+$titleOdxV3CategoryWithFilterOptions
idslug^[-a-zA-Z0-9_]+$titleOdxV3ChangePassword
new_passwordpasswordOdxV3ChangePasswordRequest
new_passwordpasswordOdxV3ChannelImages
logoposterposter_landscapeposter_portraitOdxV3ContinuousWatchingHistory
durationThe video length
episode_idis_primarylast_positionThe last watched point
profile_idprogram_idsession_keytotal_play_timeTotal played video time
updated_atuser_idwatchedTrue if progress_ratio is larger than 90%
progress_ratiolast_position divided by duration
OdxV3CouponUsage
idredemption_datetypeOdxV3Cover
idslug^[-a-zA-Z0-9_]+$Home slug for url
OdxV3Curation
contentsidservice_nameex) odk, odc and etc. / To specify service name
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIAN
slug^[-a-zA-Z0-9_]+$Home slug for url
OdxV3CurationContentsList
contentsidservice_nameex) odk, odc and etc. / To specify service name
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIAN
slug^[-a-zA-Z0-9_]+$Home slug for url
OdxV3DeleteAccount
passwordIf user login with apple or facebook account, then password is not required.
OdxV3DeleteAccountRequest
passwordIf user login with apple or facebook account, then password is not required.
OdxV3EpisodeIdentifiers
idsales_typeSales Type needed to watch this episode
GUEST- GuestFREE- FreePPV- PpvPLUS- PlusPREMIUM- PremiumNO_ADS- No AdsVIP- VipVIP+- Vip Plus
slug^[-\w]+$OdxV3EpisodeListWithBadges
slug^[-\w]+$ · requiredbadgesdisplay_durationDisplay duration of video
idmetanumberpartrelease_datesales_typeseo_keywordseo_synopsisseo_titlesynopsistitleuuidThis value is not editable.
video_cc_languagesvideo_durationmillisecond(ms)
OdxV3EpisodeRecommendation
idslug^[-\w]+$titleOdxV3EpisodeRetrieve
slug^[-\w]+$ · requiredage_ratingdisplay_durationdurationmillisecond(ms)
idnumberoriginal_episodeOriginal episode reference
partnerrelease_dateseo_keywordseo_synopsisseo_titlesynopsistitleOdxV3EpisodeRetrieveForRedirect
idprogram_slugslugOdxV3OTPVerifyRequest
account_idotpOdxV3Playback
age_ratingbumperbumper_durationvideo's bumper duration info
language codes and settings for subtitles in manifests
cue_points isn't used in phase 1.
cwl_call_cycledrmIf Non-drm video, drm: {} in response
durationvideo's duration info (millisecond)
idID of video.api object(Video Asset)
is_chromecast_ableWhether the video can be casted to chromecast
is_live_streaming에피소드가 라이브 스트리밍 타입인지 여부를 반환
매니페스트를 반환하되, 라이브 스트리밍 에피소드는 별도 처리
mediahub_content_idPEV2 mci 조인 키 — MediahubContentEpisodeMapper(OneToOne) 없으면 null (BEE-5140).
클라이언트는 이 값을 PEV2 playlist 이벤트의 mci 로 에코한다 (st=vod 필수, spec v2.1.4). null 이면 클라이언트는 mci 를 생략 전송한다 — 잘못된 값 대체 금지 (KA2-754 #1). view 가 select_related('mediahub_episode_mapper') 로 동반 로드한다.
source비디오 소스를 반환하되, 라이브 스트리밍인 경우 'inhouse' 반환
비디오 소스를 반환하되, 라이브 스트리밍 에피소드는 별도 처리
storyboards_urlIf there's no file info for storyboards, this field returns null.
If asset_type is in inhouse, relay, and mediahold (the asset stored in s3), text_tracks is required.
OdxV3PlaybackEpisode
slug^[-\w]+$ · requiredidis_kocowaWhether this episode is in KOCOWA category
live_streaming 에피소드는 next_episode를 null로 반환, 그 외는 시리얼라이즈하여 반환.
numberpartrelease_datesales_typetitleOdxV3PlaybackProgram
slug^[-a-zA-Z0-9_]+$ · requiredidis_favoritesynopsistitleOdxV3ProductSubscription
interval_unitis_activelabellabel_typepositionpriceproduct_codeproduct_namesubscription_typecurrencyISO 4217 currency code (e.g. USD) — store IAP SDKs require the code, not a symbol.
default_coupon_codedescriptionDescription of product according to interval unit such as Month and Year
fields_onIf upgrade or downgrade, we don't need card number for recurly subscription, so fields_on = false.
grademax_profile_countoperation_typeVariable to decide whether product's information is shown or not
product_idpg product_id, ex) r8tasialb6pv
sales_descriptionsales_pricesub_titletrial_lengthtrial_unitOdxV3Profile
birthdayhas_pinidis_activeis_kidis_primarylanguageen- Englishko- Koreanzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishpt- Portuguese
OdxV3ProfileFavorites
idis_favoritealways return True because this program is in user's favorite program list
slugOdxV3ProfileFavoritesCreate
idis_favoritealways return True because this program is in user's favorite program list
slugOdxV3ProfileList
birthdayNullable
Nullable
has_pinDefault false
ididis unique per Profile.
is_activeNullable
is_kidDefault false
is_primaryDefault false
languageen- Englishko- Koreanzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishpt- Portuguese
OdxV3ProfileUpsert
nameuseravatar_idbirthdayidis_activeis_kidlanguageen- Englishko- Koreanzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishpt- Portuguese
pinOdxV3ProfileUpsertRequest
nameuseravatar_idbirthdayis_activeis_kidlanguageen- Englishko- Koreanzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishpt- Portuguese
pinOdxV3Program
slug^[-a-zA-Z0-9_]+$ · requiredbadgesDefault SalesType value for episode of program
GUEST- GuestFREE- FreePPV- PpvPLUS- PlusPREMIUM- PremiumNO_ADS- No AdsVIP- VipVIP+- Vip Plus
free_episodeidis_coming_soonIf this program has episode (except for trailer, clip episodes), this value is true.
is_favoritekinds_of_episodesKinds of episode that the program has.
해당 프로그램의 현재 라이브 및 예정 스케줄 목록을 시간순으로 반환.
- 라이브 스트리밍 에피소드가 없거나 예정 스케줄이 없으면 null 반환.
- 취소되지 않았고(진행중 포함), 오늘 아직 종료되지 않았거나 미래 날짜인 스케줄만 포함.
- 경기가 있는 가장 가까운 2일치만 반환 (연속된 날짜가 아닌 distinct date 기준).
- 시간은 PST(America/Los_Angeles)로 변환되어 반환.
- title은 EpisodeLiveStreaming.category에서 파생.
- FE는 이 값이 null이 아니면 스포츠 허브 UI를 렌더링한다.
ref: <app.content.schemas.PROGRAM_META>
partner콘텐츠 제공사 슬러그 반환.
ppvproduce_yearyyyy
프로모션 영상 URL (예: KBO/KLPGA 주간 프로모 영상)
publish_start(UTC) Publish_start Datetime of program. (e.g. 2022-08-02T00:00:00Z)
release_statuscoming-soon- Coming Sooncompleted- Completedon-air- On Airunknown- Unknown
secondary_titleseo_keywordseo_synopsisseo_titleActive SponsorshipPromotion containing this program, or None.
Relies on Prefetch(..., to_attr='active_promotions') in ProgramView. UniqueConstraint on SponsorshipPromotion guarantees at most one active.
synopsistitleuser_paymentuuidThis value is not editable.
OdxV3ProgramForEpisode
slug^[-a-zA-Z0-9_]+$ · requiredidtitleOdxV3ProgramForEpisodeRetrieve
slug^[-a-zA-Z0-9_]+$ · requiredidref: <app.content.schemas.PROGRAM_META>
produce_yearyyyy
synopsistitleOdxV3ProgramImages
posterposter_landscapeposter_portraitOdxV3ProgramMeta
cc_languagesepisode_totalhide_ep_dateiab_content_taxonomiesproduce_countriesrunning_timeunit: minutes
OdxV3Programs
content_descriptionThis field's value is localized title.
is_favoriteslug^[-a-zA-Z0-9_]+$ · requiredProgram slug by default. When categories__slug=discover (ODKR), this is the shorts episode slug (used as start_slug for /shorts/feed/).
badgesidkinds_of_episodesKinds of episode that the program has.
latest_publish_start(UTC) Publish_start Datetime of program's latest episode. (e.g. 2022-08-02T00:00:00Z)
publish_start(UTC) Publish_start Datetime of program. (e.g. 2022-08-02T00:00:00Z)
typeItem type. program by default. When categories__slug=discover (ODKR) the list returns shorts episodes and this is shorts (then slug is the episode slug, images.thumbnail is the shorts thumbnail, and content_description is the source program title).
OdxV3RecommendationProgram
slug^[-a-zA-Z0-9_]+$ · requiredbadgesidimagesynopsistitleOdxV3RecurlyCoupon
coupon_codeproduct_codeOdxV3ResetPasswordRequest
hashnew_passwordOdxV3Search
badgesdefault_sales_typeDefault SalesType value for episode of program
GUEST- GuestFREE- FreePPV- PpvPLUS- PlusPREMIUM- PremiumNO_ADS- No AdsVIP- VipVIP+- Vip Plus
idis_favoriteservice_nameex) odk, odc and etc. / To specify service name
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIAN
slug^[-a-zA-Z0-9_]+$titleuuidThis value is not editable.
OdxV3SignInRequest
emailpasswordkeepOdxV3SignInV2
keeppasswordphoneverificationOdxV3SignInV2Request
keeppasswordphoneverificationOdxV3SignUp
emailpasswordOdxV3SignUpRequest
emailpasswordOdxV3SignUpV2
passwordphoneverificationOdxV3SignUpV2Request
passwordphoneverificationOdxV3Subscription
product_codetoken_idA token generated by Recurly.js.
coupon_codetransaction_idOdxV3SubscriptionCancel
messageproduct_codeOdxV3SubscriptionCancelRequest
messageproduct_codeOdxV3SubscriptionInAppAmazon
amazon_user_idAmazon appUserId (customer id). RTN appUserId 역조회용 매핑 키 (StorePaymentAccount)
receipt_idAmazon RVS receiptId. it comes from client
OdxV3SubscriptionInAppAmazonRequest
amazon_user_idAmazon appUserId (customer id). RTN appUserId 역조회용 매핑 키 (StorePaymentAccount)
receipt_idAmazon RVS receiptId. it comes from client
OdxV3SubscriptionInAppApple
receiptBase64 encoded Apple in-app purchase receipt data. it comes from client
OdxV3SubscriptionInAppAppleRequest
receiptBase64 encoded Apple in-app purchase receipt data. it comes from client
OdxV3SubscriptionInAppSamsung
country_codeTV country code (DPI invoice 조회용)
invoice_idSamsung Checkout InvoiceID (buyItem 결과). it comes from client
OdxV3SubscriptionInAppSamsungRequest
country_codeTV country code (DPI invoice 조회용)
invoice_idSamsung Checkout InvoiceID (buyItem 결과). it comes from client
OdxV3SubscriptionRenewal
dateexpire -> null / renew -> next subscription renewal date / cancel -> current subscription expiration date
interval_unitis_discountIf the user has a discount, this value is true.
priceproduct_codestart_atsubscription_typeadmin-coupon user is also premium
typeOdxV3SubscriptionRequest
product_codetoken_idA token generated by Recurly.js.
coupon_codetransaction_idOdxV3UserInfo
birthdayThe format should be YYYY-MM-DD, not YYYYMMDD like other version APIs.
is_receive_maillanguageen- Englishko- Koreanzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishpt- Portuguese
postal_codeOdxV3UserInfoRequest
birthdayis_receive_maillanguageen- Englishko- Koreanzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishpt- Portuguese
postal_codeOdxV3UserModify
passwordphoneverificationOdxV3UserProfile
emailfacebook- Facebookapple- Appleemail- Emailroku- Rokuphone- Phone
idis_email_password_setis_email_verifiedis_in_billing_retry_periodIndicates whether the user is in the billing retry period for subscription
is_in_grace_periodIndicates whether the user is in the grace period for subscription
is_odk_coupon_userlogin_typeLogin type saved in Token
member_idODK User's member ID for Loyalty program (Reward)
namephonesubscription_expire_datesubscription expire date or admin coupon expire date
subscription_interval_unitsubscription_is_cancellableThe value True means cancellable with active subscription and False means already canceled or etc.
subscription_max_profile_count- This value is the maximum number of Profiles a user can create.
- If the user is not a subscription user, the value is '1'.
subscription_pricesubscription_product_codeUser's subscription product code
subscription_providerPlatform in which a user purchased a product
subscription_trial_end_datesubscription_typeUser's subscription level
uuidThis value is not editable.
PatchedOdxV3ProfileUpsertRequest
avatar_idbirthdayis_activeis_kidlanguageen- Englishko- Koreanzh-hans- Simplified Chinesezh-hant- Traditional Chinesees- Spanishpt- Portuguese
namepinuserPatchedOdxV3SubscriptionInAppSamsungRequest
country_codeTV country code (DPI invoice 조회용)
invoice_idSamsung Checkout InvoiceID (buyItem 결과). it comes from client
ProduceCountriesEnum
KR- KoreaCN- ChinaUS- United StatesCA- CanadaTW- TaiwanHK- Hong KongJP- JapanMX- MexicoGT- GuatemalaSV- El SalvadorCO- ColombiaPE- PeruEC- EcuadorHN- HondurasCR- Costa RicaNI- NicaraguaPA- PanamaBO- BoliviaVE- VenezuelaCL- ChileAR- ArgentinaPY- ParaguayUY- UruguayBR- BrazilCU- CubaDO- Dominican RepublicPR- Puerto Rico
ProfileAvatar
image_urldescriptionidorderRatioEnum
portrait- portraitlandscape- landscapethumbnail- thumbnailnone- none
Redemption
expired_atSet to after time limit from redemption. If no time limit, set to null.
idReward redemption ID
redeemed_atA timestamp of when a user redeemed the coupon.
userUser ID
RedemptionProgram
barcode_urlVoucher barcode image URL
idReward program ID
instructionmessage for Coupon code page
time_limit_secondsOffer must be used within this time.
RedemptionRuleEnum
subscription_required- Subscription Requiredsign_in_required- Sign In Requiredno_restriction- No Restriction
ReleaseStatusEnum
coming-soon- Coming Sooncompleted- Completedon-air- On Airunknown- Unknown
RewardCategory
icon_typeaccount- Accountsubscription- Subscriptionhot- Hot
idReward category ID
layout_typelandscape- Landscapeportrait- Portraitlist- List
nameex) ODK Exclusive Perks, Only for Subscribers, Hot Deals
programsRewardProgramDetail
card_urlCoupon card image URL
codeReward program code (Coupon code), The empty string means no coupon code.
disclaimerIt will parse with -(hyphen) to make string list.
idReward program ID
partner_nameex) H Mart, LandingHelp, etc.
redemption_rulesubscription_required- Subscription Requiredsign_in_required- Sign In Requiredno_restriction- No Restriction
redirect_urlPartner website URL
secondary_titlesubtitle for reward program
time_limit_secondsOffer must be used within this time.
titleBenefit title for reward program
ServiceName688Enum
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIAN
ServiceName8c0Enum
odk- ODKodc- ODCodv- ODVodl- ODLamasian- AMASIANlg-channel-vietnam- LG Channel Vietnam
SourceRequest
idobjecttarget_urlSubscriptionTypeEnum
basic- Basicplus- Plusstandard- Standardpremium- Premiumpremium-box- Premium Boxfamily- Family
UTMData
attribution_campaignattribution_sourceutm_mediumUTMDataRequest
attribution_campaignattribution_sourceutm_mediumVideoCcLanguagesEnum
ko- Koreanen- Englishes- Spanishzh-Hans- Simplified Chinesezh-Hant- Traditional Chinesezh-hans- Simplified Chinesezh-hant- Traditional Chinesept- Portuguesevi- Vietnamese
Voucher
idactiveadditional_infocampaigncampaign_idcategorycategory_idcodecreated_atexpiration_dategiftis_referral_codeloyalty_cardmetadataobjectpublishredemptionstart_datetypeupdated_atvalidation_rules_assignmentsvalidity_day_of_weekvalidity_hoursvalidity_timeframeVoucherRequest
idactiveadditional_infocampaigncampaign_idcategorycategory_idcodecreated_atexpiration_dategiftis_referral_codeloyalty_cardmetadataobjectpublishredemptionstart_datetypeupdated_atvalidation_rules_assignmentsvalidity_day_of_weekvalidity_hoursvalidity_timeframe