You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 12
Next »
This method returns the netflix promotions which are applicable for the operator that the caller belongs to. Multiple promotions are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
Response Data
Name | Type | Description |
|---|
code | String | The code of the retrieved promotion |
name | String | The name of the retrieved promotion |
description | String | The description of the retrieved promotion |
effective_from | Date | The date that the retrieved promotion becomes effective |
expires_on | Date | The date that the retrieved promotion expires |
Examples
Example 1
HTTP Method: GET
Request:
Response:
POST netflix/subscriptions/create
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_7",
"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": "S0000003564",
"netflix_token": "cf7edbceb33f4e43a61cfbce13a4ef5f",
"netflix_token_expiration_date": null
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}
POST netflix/subscriptions/suspend
This method suspends an existing netflix subscriber. A single subscription can be suspended through 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 |
Response Data
Not applicable
Examples
Example 1
HTTP Method: POST
Request:
Body:
Response:
POST netflix/subscriptions/unsuspend
This method unsuspends an existing netflix subscriber. A single subscription can be suspended through 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 |
Response Data
Not applicable
Examples
Example 1
HTTP Method: POST
Request:
Body:
Response:
POST netflix/subscriptions/cancel
This method cancels an existing netflix subscriber. A single subscription can be suspended through 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 |
Response Data
Not applicable
Examples
Example 1
HTTP Method: POST
Request:
Body:
Response:
GET netflix/charges/list
This method returns the netflix charges which were processed by CRM.COM and were not acknowledged by the operator which are applicable for the operator, starting from the oldest charge. Retrieved charges should be acknowledged through the charges/acknowledge Web API in order to be excluded by any subsequent calls . Up to 50 charges can be returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
number_of_results (mandatory) | Number | The number of results that can be retrieved through each call. The maximum number of results can be 50. The oldest charges are retrieved fist |
offset (mandatory) | Number | It defines the number of charges that should be skipped from the results. During the first call it should be set to 0 and then it should be increased based on the number of results that were retrieved |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
Response Data
Name | Type | Description |
| charges_set | Set of Charges Objects | The netflix charges related with the operator which are pending acknowledgement |
Referred Objects Response Data
netflix charges response data
Name | Type | Description |
|---|
number | String | The number of the charge as provided by CRM.COM. This number should be used while acknowledging the charge through the charges/acknowledge Web API |
| billing_system_customer_identifier | String | The identifier of the customer as defined in the billing system managed by the operator |
| amount | Number | The amount of the charge |
| currency | String | The currency of the charge which is a three letter currency codes, such as USD and EUR, that conform to ISO-4217. |
| local_currency_amount | Number | The amount of the charge in the local currency of the operator |
| local_currency | String | The local currency of the operator, which is a three letter currency codes, such as USD and EUR, that conform to ISO-4217. |
| paid_through_date | Date | The future date until which Netflix service will be provided if this charge is Approved. Starting the day after this date, the customer will be charged for access to service |
| charge_status | String | The status of the charge on Netflix which can be one of the following: - PENDING: The charge was retrieved by Netflix but was not processed by CRM.COM yet. Those charges should not be billed until they are processed by CRM.COM
- APPROVED: The charge was approved and the customer should be billed
- DECLINED: The charge was declined and the customer should not be billed. The netflix subscription will be terminated.
- BAD_REQUEST: The charge was set as bad request due to erroneous information, therefore the customer should not be billed. The netflix subscription will be terminated.
- REJECTED: The charge was rejected and the customer should not be billed. The netflix subscription will be terminated.
|
| received_on | Date | The date that the charge was received by Netflix |
| set_as_approved_on | Date | The date that the charge was approved |
| set_as_declined_on | Date | The date that the charge was declined |
| set_as_bad_request_on | Date | The date that the charge was set as bad request |
| set_as_rejected_request_on | Date | The date that the charge was rejected |
Examples
Example 1
HTTP Method: GET
Request:
Response:
GET netflix/charges/acknowledge
This method is used in order to acknowledge that Netflix Charges were retrieved by an Operator. Acknowledged charges will not be included in any subsequent calls of the charges/list Web API. Up to 50 charges can be acknowledged through each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
acknowledged_charges_set (mandatory) | Set of Acknowledged Netflix Charge Objects | The netflix charges that were received by the operator and were acknowledged. Acknowledged charges will not be included in any subsequent calls of the charges/list Web API. Maximum 50 charges can be acknowledged through each call |
Referred Parameter Objects Data
acknowledged netfix charges parameter object data
| | |
|---|
number (mandatory) | String | The number of the charge that should be acknowledged as provided by CRM.COM |
billing_system_customer_identifier (mandatory) | String | The identifier of the customer as defined in the billing system managed by the operator |
reference_number (optional) | String | A reference number for the acknowledged charge. The reference number is used mainly for reconciliation purposes. TIf specified then reference number should be unique for each operator |
Response Data
Name | Type | Description |
| failed_charges_set | Set of Failed Charges Objects | The netflix charges that failed to be acknowledged by CRM.COM |
Referred Objects Response Data
Failed netflix charges response data
Name | Type | Description |
|---|
number | String | The number of the failed charge |
reference_number | String | The reference number of the failed charge as specified by the operator |
error_code | String | The code of the error |
error_description | Date | The description of the error |
Examples
Example 1
HTTP Method: POST
Request:
Body:
Response: