Tip
Available from CRM.COM R12.0.0

Table of Contents

maxLevel	2

GET netflix/promotions/list

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

N/A

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

     {
        "data":
        [
            {
                "code": "14",
                "expires_on": null,
                "name": "Test",
                "description": null,
                "effective_from": "2017-01-01T00:00:00"
            },
            {
                "code": "15",
                "expires_on": null,
                "name": "Test_2",
                "description": null,
                "effective_from": "2017-02-01T00:00:00"
            }
        ],
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

GET netflix/subscriptions/show

This method returns the status and additional billing information related with netflix subscriptions . Multiple netflix subscriptions are returned by 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
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

N/A

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

     {"data":{"netflix_state":"EFFECTIVE","promotions_set":[],"subscription_number":"93","prices_set":[],"life_cycle_state":"EFFECTIVE"},"status":{"code":"OK","description":"","message":""}}

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

...

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

     {
        "data":
        {
            "subscription_number": "S0000003566",
            "netflix_token": "faa718658f9f4dbe84d73dc1030d31cd",
            "netflix_token_expiration_date": "2017-02-01T18:13:34"
        },
        "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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "token":"737C2CC402644029BA7827E41B932C79",
    "billing_system_customer_identifier":"pci123"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

     {
        "data":
        {
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "token":"737C2CC402644029BA7827E41B932C79",
    "billing_system_customer_identifier":"pci123"   
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

     {
        "data":
        {
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "token":"737C2CC402644029BA7827E41B932C79",
    "billing_system_customer_identifier":"pci123"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

     {
        "data":
        {
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

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

N/A

Response Data

Name	Type	Description
charges_set	Set of Charges Objects	The netflix charges related with the operator which are pending acknowledgement

...

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
        "data":
        {
            "charges_set":
            [
                {
                    "set_as_rejected_request_on": "2017-02-06T07:22:07",
                    "number": "I00002662",
                    "amount": 5.989999771118164,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "pci150",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": null,
                    "paid_through_date": "2017-02-04T02:00:00",
                    "currency": "USD",
                    "received_on": "2017-02-06T07:18:47",
                    "set_as_declined_on": null
                },
                {
                    "set_as_rejected_request_on": "2017-02-06T07:22:07",
                    "number": "I00002671",
                    "amount": 5.989999771118164,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "pci150",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": null,
                    "paid_through_date": "2017-02-04T02:00:00",
                    "currency": "USD",
                    "received_on": "2016-07-06T07:18:47",
                    "set_as_declined_on": null
                },
                {
                    "set_as_rejected_request_on": null,
                    "number": "I00002776",
                    "amount": 5.989999771118164,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "1pci30",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": "2017-02-21T10:38:58",
                    "paid_through_date": "2017-02-19T02:00:00",
                    "currency": "USD",
                    "received_on": "2017-02-21T10:07:23",
                    "set_as_declined_on": null
                },
                {
                    "set_as_rejected_request_on": null,
                    "number": "I00002778",
                    "amount": 2.990000009536743,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "1pci28",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": "2017-02-21T10:38:58",
                    "paid_through_date": "2017-02-19T02:00:00",
                    "currency": "USD",
                    "received_on": "2017-02-21T10:07:24",
                    "set_as_declined_on": null
                },
                {
                    "set_as_rejected_request_on": null,
                    "number": "I00002780",
                    "amount": 1.9900000095367432,
                    "charge_status": "PENDING",
                    "billing_system_customer_identifier": "1pci26",
                    "set_as_bad_request_on": null,
                    "set_as_approved_on": "2017-02-21T10:38:58",
                    "paid_through_date": "2017-02-19T02:00:00",
                    "currency": "USD",
                    "received_on": "2017-02-21T10:07:24",
                    "set_as_declined_on": null
                }
            ]
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

POST 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

...

Response Data

Name	Type	Description
failed_charges_set	Set of Failed Charges Objects	The netflix charges that failed to be acknowledged by CRM.COM

...

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19kZXYiLCJvdW4iOiIxIiwiZXhwIjoiMTQ4ODI5OTQwMiIsImlhdCI6IjE0ODgyOTIyMDIiLCJqdGkiOiJFNEIyNTdDNDA2NUE0NTA3OTYzNkI3NkI2MDUwMzY5QSJ9.KhMhy4Sz2iG0g14Sv_pUpE0KFweKsicf9aR44mg0vuE",
    "acknowledged_charges_set":[
{
"number":"I00002707",
"billing_system_customer_identifier":"pp"
}
]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

     {
        "data":
        {
            "failed_charges_set":
            [
                {
                    "number": "I00002707",
                    "error_description": "The specified charge was not issued for the specified customer",
                    "error_code": "1",
                    "reference_number": null
                }
            ]
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

POST netflix/operators/register_devices

Tip
Available from CRM.COM R12.1.0

This method registers a set of devices against a specific netflix operator. Multiple devices can be registered through each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

The identifier of the group that represents the operator. The allowed group identifier fields are the following:

...

devices

(mandatory)

...

The devices that will be registered against the specified operator

Maximum 1000 Devices can be registered through each call

...

Response Data

Name	Type	Description
failed_devices_set	Set of Devices Objects	The devices that failed to be registered against the specified operator

...

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

POST netflix/operators/unregister_devices

Tip
Available from CRM.COM R12.1.0

This method unregisters a set of devices which are mapped against a specific operator. Multiple devices can be unregistered through each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

The identifier of the group that represents the operator. The allowed group identifier fields are the following:

...

devices

(mandatory)

...

The devices that will be unregistered against the specified operator

Maximum 1000 Devices can be unregistered through each call

...

Response Data

Name	Type	Description
failed_devices_set	Set of Devices Objects	The devices that failed to be unregistered against the specified operator

...

Examples

HTTP Method: POST

Request:

Body:

Expand

title	Example 1

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Panel

name	blue

Child pages (Children Display)

all	true
excerpt	true

Page Comparison

Versions Compared

Old Version 24

New Version Current

Key

GET netflix/promotions/list

Resource URL

Parameters

Restrictions

Response Data

Examples

GET netflix/subscriptions/show

Resource URL

Parameters

Restrictions

Response Data

Examples

POST netflix/subscriptions/create

Parameters

Response Data

Examples

POST netflix/subscriptions/suspend

Parameters

Response Data

Examples

POST netflix/subscriptions/unsuspend

Parameters

Response Data

Examples

POST netflix/subscriptions/cancel

Parameters

Response Data

Examples

GET netflix/charges/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST netflix/charges/acknowledge

Resource URL

Parameters

Response Data

Examples

POST netflix/operators/register_devices

Resource URL

Parameters

Response Data

Examples

POST netflix/operators/unregister_devices

Resource URL

Parameters

Response Data

Examples