user

change password

POST

https://odkmedia.io/odx/api/v2

/user/change-password/

change password › query Parameters

debug

string

If value is "on", debug is included in response.

change password › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

change password › Request Body

OdxV2ChangePassword

new_password

string · minLength: 5 · maxLength: 59 · required

password

string · minLength: 5 · maxLength: 59 · required

change password › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2UserToken

POST/user/change-password/

curl https://odkmedia.io/odx/api/v2/user/change-password \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "new_password": "new_password",
  "password": "password"
}'

Example Request Body

{
  "new_password": "new_password",
  "password": "password"
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "token": "token",
    "user": {
      "email": "test@example.com",
      "external": {
        "kcp": {
          "user_id": "user_id",
          "user_type": "Anonymous"
        }
      },
      "id": 0,
      "is_email_verified": true,
      "is_odk_coupon_user": true,
      "login_type": "email",
      "name": "name",
      "subscription_expire_date": "2024-08-25",
      "subscription_interval_unit": "month",
      "subscription_is_cancellable": false,
      "subscription_max_profile_count": 0,
      "subscription_price": 0,
      "subscription_provider": "web",
      "subscription_trial_end_date": "2024-08-25",
      "subscription_type": "basic",
      "userinfo": {
        "birthday": "2001-01-01",
        "gender": "m",
        "is_receive_mail": true,
        "language": "en"
      }
    }
  }
}

json

application/json

delete account

POST

https://odkmedia.io/odx/api/v2

/user/delete-account/

delete account › query Parameters

debug

string

If value is "on", debug is included in response.

delete account › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

delete account › Request Body

OdxV2DeleteAccount

password

string · minLength: 1 · maxLength: 256

If user's login_type is email, then password is required.

delete account › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

result

emptyResult

POST/user/delete-account/

curl https://odkmedia.io/odx/api/v2/user/delete-account \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "password": "password"
}'

Example Request Body

{
  "password": "password"
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {}
}

json

application/json

user orders pay-per-view

GET

https://odkmedia.io/odx/api/v2

/user/orders-pay-per-view/

user orders pay-per-view › query Parameters

debug

string

If value is "on", debug is included in response.

user orders pay-per-view › Headers

Service-Name

string · enum · required

Only "odk" is supported.

Enum values:

odk

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

user orders pay-per-view › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2UserOrdersPayPerView[]

GET/user/orders-pay-per-view/

curl https://odkmedia.io/odx/api/v2/user/orders-pay-per-view \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": [
    {
      "amount": "US$ 4.99",
      "method": "CC",
      "option": "Pay-Per-View VOD (Non Refundable)",
      "ordered_date": "2023-01-30",
      "product_name": "Fengshui",
      "status": "Paid"
    }
  ]
}

json

application/json

profile

GET

https://odkmedia.io/odx/api/v2

/user/profile/

profile › query Parameters

debug

string

If value is "on", debug is included in response.

profile › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

profile › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2UserProfile

GET/user/profile/

curl https://odkmedia.io/odx/api/v2/user/profile \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "email": "test@example.com",
    "external": {
      "kcp": {
        "user_id": "user_id",
        "user_type": "Anonymous"
      }
    },
    "id": 0,
    "is_email_verified": true,
    "is_odk_coupon_user": true,
    "login_type": "email",
    "name": "name",
    "subscription_expire_date": "2024-08-25",
    "subscription_interval_unit": "month",
    "subscription_is_cancellable": false,
    "subscription_max_profile_count": 0,
    "subscription_price": 0,
    "subscription_provider": "web",
    "subscription_trial_end_date": "2024-08-25",
    "subscription_type": "basic",
    "userinfo": {
      "birthday": "2001-01-01",
      "gender": "m",
      "is_receive_mail": true,
      "language": "en"
    }
  }
}

json

application/json

profile

PUT

https://odkmedia.io/odx/api/v2

/user/profile/

profile › query Parameters

debug

string

If value is "on", debug is included in response.

profile › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

profile › Request Body

OdxV2UserProfile

email

string · email · maxLength: 254 · readOnly

OdxV2UserProfileExternalSerializer

id

integer · readOnly

is_email_verified

boolean · readOnly

is_odk_coupon_user

boolean · readOnly

login_type

string · enum · readOnly

Enum values:

apple

facebook

Default: email

name

string | null · readOnly

subscription_expire_date

string | null · date · readOnly

subscription expire date or admin coupon expire date

subscription_interval_unit

string | null · enum · readOnly

Enum values:

month

year

subscription_is_cancellable

boolean · readOnly

The value True means cancellable with active subscription and False means already canceled or etc.

Default: false

subscription_max_profile_count

integer · readOnly

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_price

number | null · float · readOnly

subscription_provider

string | null · enum · readOnly

Enum values:

web

apple

google

roku

subscription_trial_end_date

string | null · date · readOnly

subscription_type

string · enum · readOnly

admin-coupon user is also premium

Enum values:

basic

plus

premium

premium-box

Default: basic

userinfo

OdxV2UserInfo

profile › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2UserProfile

PUT/user/profile/

curl https://odkmedia.io/odx/api/v2/user/profile \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "email": "test@example.com",
  "external": {
    "kcp": {
      "user_id": "user_id",
      "user_type": "Anonymous"
    }
  },
  "id": 0,
  "is_email_verified": true,
  "is_odk_coupon_user": true,
  "login_type": "email",
  "name": "name",
  "subscription_expire_date": "2024-08-25",
  "subscription_interval_unit": "month",
  "subscription_is_cancellable": false,
  "subscription_max_profile_count": 0,
  "subscription_price": 0,
  "subscription_provider": "web",
  "subscription_trial_end_date": "2024-08-25",
  "subscription_type": "basic",
  "userinfo": {
    "birthday": "2001-01-01",
    "gender": "m",
    "is_receive_mail": true,
    "language": "en"
  }
}'

Example Request Body

{
  "email": "test@example.com",
  "external": {
    "kcp": {
      "user_id": "user_id",
      "user_type": "Anonymous"
    }
  },
  "id": 0,
  "is_email_verified": true,
  "is_odk_coupon_user": true,
  "login_type": "email",
  "name": "name",
  "subscription_expire_date": "2024-08-25",
  "subscription_interval_unit": "month",
  "subscription_is_cancellable": false,
  "subscription_max_profile_count": 0,
  "subscription_price": 0,
  "subscription_provider": "web",
  "subscription_trial_end_date": "2024-08-25",
  "subscription_type": "basic",
  "userinfo": {
    "birthday": "2001-01-01",
    "gender": "m",
    "is_receive_mail": true,
    "language": "en"
  }
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "email": "test@example.com",
    "external": {
      "kcp": {
        "user_id": "user_id",
        "user_type": "Anonymous"
      }
    },
    "id": 0,
    "is_email_verified": true,
    "is_odk_coupon_user": true,
    "login_type": "email",
    "name": "name",
    "subscription_expire_date": "2024-08-25",
    "subscription_interval_unit": "month",
    "subscription_is_cancellable": false,
    "subscription_max_profile_count": 0,
    "subscription_price": 0,
    "subscription_provider": "web",
    "subscription_trial_end_date": "2024-08-25",
    "subscription_type": "basic",
    "userinfo": {
      "birthday": "2001-01-01",
      "gender": "m",
      "is_receive_mail": true,
      "language": "en"
    }
  }
}

json

application/json

profile

PATCH

https://odkmedia.io/odx/api/v2

/user/profile/

profile › query Parameters

debug

string

If value is "on", debug is included in response.

profile › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

profile › Request Body

OdxV2UserProfile

email

string · email · maxLength: 254 · readOnly

OdxV2UserProfileExternalSerializer

id

integer · readOnly

is_email_verified

boolean · readOnly

is_odk_coupon_user

boolean · readOnly

login_type

string · enum · readOnly

Enum values:

apple

facebook

Default: email

name

string | null · readOnly

subscription_expire_date

string | null · date · readOnly

subscription expire date or admin coupon expire date

subscription_interval_unit

string | null · enum · readOnly

Enum values:

month

year

subscription_is_cancellable

boolean · readOnly

The value True means cancellable with active subscription and False means already canceled or etc.

Default: false

subscription_max_profile_count

integer · readOnly

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_price

number | null · float · readOnly

subscription_provider

string | null · enum · readOnly

Enum values:

web

apple

google

roku

subscription_trial_end_date

string | null · date · readOnly

subscription_type

string · enum · readOnly

admin-coupon user is also premium

Enum values:

basic

plus

premium

premium-box

Default: basic

userinfo

OdxV2UserInfo

profile › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2UserProfile

PATCH/user/profile/

curl https://odkmedia.io/odx/api/v2/user/profile \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>' \
  --data '{
  "email": "test@example.com",
  "external": {
    "kcp": {
      "user_id": "user_id",
      "user_type": "Anonymous"
    }
  },
  "id": 0,
  "is_email_verified": true,
  "is_odk_coupon_user": true,
  "login_type": "email",
  "name": "name",
  "subscription_expire_date": "2024-08-25",
  "subscription_interval_unit": "month",
  "subscription_is_cancellable": false,
  "subscription_max_profile_count": 0,
  "subscription_price": 0,
  "subscription_provider": "web",
  "subscription_trial_end_date": "2024-08-25",
  "subscription_type": "basic",
  "userinfo": {
    "birthday": "2001-01-01",
    "gender": "m",
    "is_receive_mail": true,
    "language": "en"
  }
}'

Example Request Body

{
  "email": "test@example.com",
  "external": {
    "kcp": {
      "user_id": "user_id",
      "user_type": "Anonymous"
    }
  },
  "id": 0,
  "is_email_verified": true,
  "is_odk_coupon_user": true,
  "login_type": "email",
  "name": "name",
  "subscription_expire_date": "2024-08-25",
  "subscription_interval_unit": "month",
  "subscription_is_cancellable": false,
  "subscription_max_profile_count": 0,
  "subscription_price": 0,
  "subscription_provider": "web",
  "subscription_trial_end_date": "2024-08-25",
  "subscription_type": "basic",
  "userinfo": {
    "birthday": "2001-01-01",
    "gender": "m",
    "is_receive_mail": true,
    "language": "en"
  }
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "email": "test@example.com",
    "external": {
      "kcp": {
        "user_id": "user_id",
        "user_type": "Anonymous"
      }
    },
    "id": 0,
    "is_email_verified": true,
    "is_odk_coupon_user": true,
    "login_type": "email",
    "name": "name",
    "subscription_expire_date": "2024-08-25",
    "subscription_interval_unit": "month",
    "subscription_is_cancellable": false,
    "subscription_max_profile_count": 0,
    "subscription_price": 0,
    "subscription_provider": "web",
    "subscription_trial_end_date": "2024-08-25",
    "subscription_type": "basic",
    "userinfo": {
      "birthday": "2001-01-01",
      "gender": "m",
      "is_receive_mail": true,
      "language": "en"
    }
  }
}

json

application/json

POST

https://odkmedia.io/odx/api/v2

/user/sign-in/

debug

string

If value is "on", debug is included in response.

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

OdxV2SignIn

email

string · email · minLength: 1 · required

password

string · minLength: 1 · maxLength: 256 · required

keep

boolean

In ODK, default value is true. If keep is true, expiration time is 1 year. Default expiration time is 1 day.

Default: false

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2UserToken

POST/user/sign-in/

curl https://odkmedia.io/odx/api/v2/user/sign-in \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --data '{
  "email": "test@example.com",
  "keep": false,
  "password": "password"
}'

Example Request Body

{
  "email": "test@example.com",
  "keep": false,
  "password": "password"
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "token": "token",
    "user": {
      "email": "test@example.com",
      "external": {
        "kcp": {
          "user_id": "user_id",
          "user_type": "Anonymous"
        }
      },
      "id": 0,
      "is_email_verified": true,
      "is_odk_coupon_user": true,
      "login_type": "email",
      "name": "name",
      "subscription_expire_date": "2024-08-25",
      "subscription_interval_unit": "month",
      "subscription_is_cancellable": false,
      "subscription_max_profile_count": 0,
      "subscription_price": 0,
      "subscription_provider": "web",
      "subscription_trial_end_date": "2024-08-25",
      "subscription_type": "basic",
      "userinfo": {
        "birthday": "2001-01-01",
        "gender": "m",
        "is_receive_mail": true,
        "language": "en"
      }
    }
  }
}

json

application/json

sign out

POST

https://odkmedia.io/odx/api/v2

/user/sign-out/

sign out › query Parameters

debug

string

If value is "on", debug is included in response.

sign out › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

sign out › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

result

emptyResult

POST

https://odkmedia.io/odx/api/v2

/user/sign-up/

debug

string

If value is "on", debug is included in response.

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

OdxV2SignUp

email

string · email · minLength: 1 · maxLength: 256 · required

password

string · minLength: 5 · maxLength: 59 · required

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2UserToken

POST/user/sign-up/

curl https://odkmedia.io/odx/api/v2/user/sign-up \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --data '{
  "email": "test@example.com",
  "password": "password"
}'

Example Request Body

{
  "email": "test@example.com",
  "password": "password"
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "token": "token",
    "user": {
      "email": "test@example.com",
      "external": {
        "kcp": {
          "user_id": "user_id",
          "user_type": "Anonymous"
        }
      },
      "id": 0,
      "is_email_verified": true,
      "is_odk_coupon_user": true,
      "login_type": "email",
      "name": "name",
      "subscription_expire_date": "2024-08-25",
      "subscription_interval_unit": "month",
      "subscription_is_cancellable": false,
      "subscription_max_profile_count": 0,
      "subscription_price": 0,
      "subscription_provider": "web",
      "subscription_trial_end_date": "2024-08-25",
      "subscription_type": "basic",
      "userinfo": {
        "birthday": "2001-01-01",
        "gender": "m",
        "is_receive_mail": true,
        "language": "en"
      }
    }
  }
}

json

application/json

user/change-email continuous-watching

user

change password

change password › query Parameters

change password › Headers

change password › Request Body

change password › Responses

delete account

delete account › query Parameters

delete account › Headers

delete account › Request Body

delete account › Responses

user orders pay-per-view

user orders pay-per-view › query Parameters

user orders pay-per-view › Headers

user orders pay-per-view › Responses

profile

profile › query Parameters

profile › Headers

profile › Responses

profile

profile › query Parameters

profile › Headers

profile › Request Body

profile › Responses

profile

profile › query Parameters

profile › Headers

profile › Request Body

profile › Responses

sign in

sign in › query Parameters

sign in › Headers

sign in › Request Body

sign in › Responses

sign out

sign out › query Parameters

sign out › Headers

sign out › Responses

sign up

sign up › query Parameters

sign up › Headers

sign up › Request Body

sign up › Responses