You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Current »
This method creates a new netflix subscriber within CRM.COM and returns a netflix token that can be used to redirect the subscriber to the Netflix registration page. A single subscription can be created within each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
billing_system_customer_identifier (mandatory) | String | The identifier of the customer as defined in the billing system managed by the caller |
promotion_code (optional) | String | The promotion code that should be used during the registration. The promotion code can be retrieved through the promotions/list Web API method |
channel (optional) | String | The channel that the registration was done through which can be one of the following: - WEB
- STORE
- MOBILE
- BROADBAND
- OTHER
|
validity_duration (optional) | Integer | The validity duration of the netflix token, specified in seconds, The duration can be up to 24 hours. |
customer_first_name (optional) | String | The first name of the customer |
customer_last_name (optional) | String | The last name of the customer |
customer_address (optional) | Address Object | The address of the customer |
customer_email (optional) | Email Object | The email of the customer |
customer_phone (optional) | Phone Object | The phone of the customer |
Referred Parameter Objects Data
address parameter object data
From R14.2.0, the following object is applicable for CRM.COM Address Format
| Name | Type | Description |
type (mandatory) | String | The type of the address which can be added HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
is_primary (mandatory on conditions) | Boolean | Weather the address is the primary one
|
postal_code (optional) | String | The postal code of the address |
street_name (mandatory on conditions) | String | The street name of the address |
street_number (optional) | String | The street number of the address
|
floor (optional) | Integer | The floor of the address
|
apartment_number (optional) | String | The apartment number of the address
|
area (optional) | String | The area of the address
|
town_city (optional) | String | The town/city of the address
|
district (optional) | String | The district of the address
|
municipality (optional) | String | The municipality of the address
|
country_identifier (optional) | Country identifier | The country of the address. The allowed country identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the country | name (semi-optional) | String | The name of the country | alternative_code (semi-optional) | String | The alternative code of the retrieved country | two_character_code (semi-optional) | String | The two character code of the retrieved country
| three_character_code (semi-optional) | String | The three character code of the retrieved country |
|
po_box (optional) | String | The PO box of the address |
po_box_postal_code (optional) | String | The PO box postal code of the address |
care_of (optional) | String | The care of person of the address |
udf_string_1 (optional) | String | User Defined Field of type String |
udf_string_2 (optional) | String | User Defined Field of type String |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_string_9 (optional) | String | User Defined Field of type String |
udf_string_10 (optional) | String | User Defined Field of type String |
udf_string_11 (optional) | String | User Defined Field of type String |
udf_string_12 (optional) | String | User Defined Field of type String |
udf_string_13 (optional) | String | User Defined Field of type String |
udf_string_14 (optional) | String | User Defined Field of type String |
udf_string_15 (optional) | String | User Defined Field of type String |
udf_string_16 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) | Float | User Defined Field of type Float |
udf_float_2 (optional) | Float | User Defined Field of type Float |
udf_float_3 (optional) | Float | User Defined Field of type Float |
udf_float_4 (optional) | Float | User Defined Field of type Float |
udf_date_1 (optional) | Date | User Defined Field of type Date |
udf_date_2 (optional) | Date | User Defined Field of type Date |
udf_date_3 (optional) | Date | User Defined Field of type Date |
udf_date_4 (optional) | Date | User Defined Field of type Date |
From R14.2.0, the following object is applicable for International Address Format| Name | Type | Description |
type (mandatory) | String | The type of the address which can be added HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
postal_code (optional) | String | The postal code of the address
|
town_city (optional) | String | The town/city of the address |
country_identifier (optional) | Country identifier | The country of the address. The allowed country identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the country | name (semi-optional) | String | The name of the country | alternative_code (semi-optional) | String | The alternative code of the retrieved country | two_character_code (semi-optional) | String | The two character code of the retrieved country
| three_character_code (semi-optional) | String | The three character code of the retrieved country |
|
address_line_1 (mandatory) | String | The address line 1 |
address_line_2 (optional) | String | The address line 2 |
state_province_county (optional) | String | The state or province or county of the address.
|
udf_string_1 (optional) | String | User Defined Field of type String |
udf_string_2 (optional) | String | User Defined Field of type String |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_string_9 (optional) | String | User Defined Field of type String |
udf_string_10 (optional) | String | User Defined Field of type String |
udf_string_11 (optional) | String | User Defined Field of type String |
udf_string_12 (optional) | String | User Defined Field of type String |
udf_string_13 (optional) | String | User Defined Field of type String |
udf_string_14 (optional) | String | User Defined Field of type String |
udf_string_15 (optional) | String | User Defined Field of type String |
udf_string_16 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) | Float | User Defined Field of type Float |
udf_float_2 (optional) | Float | User Defined Field of type Float |
udf_float_3 (optional) | Float | User Defined Field of type Float |
udf_float_4 (optional) | Float | User Defined Field of type Float |
udf_date_1 (optional) | Date | User Defined Field of type Date |
udf_date_2 (optional) | Date | User Defined Field of type Date |
udf_date_3 (optional) | Date | User Defined Field of type Date |
udf_date_4 (optional) | Date | User Defined Field of type Date |
phone parameter object data
| | |
|---|
type (mandatory) | String | The type of the phone which can be LANDLINE, MOBILE, FAX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
is_primary (mandatory on conditions) | Boolean | Weather the phone is the primary one
|
number (mandatory) | String | The number of the phone |
area_code (optional) | String | The area code of the phone |
country_identifier (optional) | Country identifier | The country of the phone. The allowed country identifier fields are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the country | name (semi-optional) | String | The name of the country | alternative_code (semi-optional) | String | The alternative code of the retrieved country | two_character_code (semi-optional) | String | The two character code of the retrieved country
| three_character_code (semi-optional) | String | The three character code of the retrieved country |
|
notes (optional) | String | The notes of the phone |
udf_string_1 (optional) | String | User Defined Field of type String |
udf_string_2 (optional) | String | User Defined Field of type String |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) | Float | User Defined Field of type Float |
udf_float_2 (optional) | Float | User Defined Field of type Float |
udf_float_3 (optional) | Float | User Defined Field of type Float |
udf_float_4 (optional) | Float | User Defined Field of type Float |
udf_date_1 (optional) | Date | User Defined Field of type Date |
udf_date_2 (optional) | Date | User Defined Field of type Date |
udf_date_3 (optional) | Date | User Defined Field of type Date |
udf_date_4 (optional) | Date | User Defined Field of type Date |
email parameter object data
| | |
|---|
type (mandatory) | String | The type of the retrieved email which can be PERSONAL, BUSINESS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
is_primary (mandatory on conditions) | Boolean | Weather the email is the primary one
|
email_address (mandatory) | String | The address of the retrieved email |
notes (optional) | String | The notes of the retrieved email |
udf_string_1 (optional) | String | User Defined Field of type String |
udf_string_2 (optional) | String | User Defined Field of type String |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) | String | User Defined Field of type String |
udf_string_5 (optional) | String | User Defined Field of type String |
udf_string_6 (optional) | String | User Defined Field of type String |
udf_string_7 (optional) | String | User Defined Field of type String |
udf_string_8 (optional) | String | User Defined Field of type String |
udf_float_1 (optional) | Float | User Defined Field of type Float |
udf_float_2 (optional) | Float | User Defined Field of type Float |
udf_float_3 (optional) | Float | User Defined Field of type Float |
udf_float_4 (optional) | Float | User Defined Field of type Float |
udf_date_1 (optional) | Date | User Defined Field of type Date |
udf_date_2 (optional) | Date | User Defined Field of type Date |
udf_date_3 (optional) | Date | User Defined Field of type Date |
udf_date_4 (optional) | Date | User Defined Field of type Date |
Response Data
Name | Type | Description |
subscription_number | String | The number of the subscription created in CRM.COM |
| netflix_token | String | The token retrieved from Netflix |
| netflix_token_expiration_date | Date | The date that the netflix token will expire |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"token":"33586DF3842E4AE5BABF43C43269E8F8",
"billing_system_customer_identifier":"pci123",
"promotion_code":"14",
"channel":"OTHER",
"validity_duration":100,
"customer_first_name":"Test_8",
"customer_last_name":"Netflix",
"customer_address":{
"type": "HOME",
"postal_code": "3020",
"street_name": "Ilia Papakiriakou",
"street_number" : "8",
"floor":2,
"apartment_number":"202",
"area": "Plati",
"town_city":"Aglanjia",
"district":"Nicosia",
"municipality":"Aglanjia",
"country_identifier":{ "two_character_code": "CY" },
"po_box":"70022",
"po_box_postal_code":"AG70022",
"care_of":"Maria Kyriacou",
}
}
Response:
{
"data":
{
"subscription_number": "S0000003566",
"netflix_token": "faa718658f9f4dbe84d73dc1030d31cd",
"netflix_token_expiration_date": "2017-02-01T18:13:34"
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}