Versions Compared

Old Version 23

changes.mady.by.user George Rossides

Saved on

compared with

New Version 24

changes.mady.by.user George Rossides

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R12.0.0

 

Table of Contents
maxLevel2

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

Tip

Available from CRM.COM R12.0.0

 

Table of Contents
maxLevel2

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

...

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe 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

...

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

promotion_code

(optional)

StringThe 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)

IntegerThe 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

...

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

...

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

...

Name

Type

Description

token

String

The token retrieved from the login method

billing_system_customer_identifier

(mandatory)

StringThe identifier of the customer as defined in the billing system managed by the caller

...

Name

Type

Description

token

String

The token retrieved from the login method

number_of_results

(mandatory)

NumberThe 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)

NumberIt 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

...

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

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19kZXYiLCJvdW4iOiIxIiwiZXhwIjoiMTQ4ODI5OTQwMiIsImlhdCI6IjE0ODgyOTIyMDIiLCJqdGkiOiJFNEIyNTdDNDA2NUE0NTA3OTYzNkI3NkI2MDUwMzY5QSJ9.KhMhy4Sz2iG0g14Sv_pUpE0KFweKsicf9aR44mg0vuE",
    "acknowledged_charges_set":[
{
"number":"I00002707",
"billing_system_customer_identifier":"pp"
}
]
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
     {
        "data":
        {
            "failed_charges_set":
            [
                {
                    "number": "I00002707",
                    "error_description": "The specified charge was not issued for the specified              "error_description": "The specified charge was not issued for the specified customer",
                    "error_code": "1",
                    "reference_number": null
                }
            ]
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }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

group_identifierGroup Identifier

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

Include Page
V4:group_identifier
V4:group_identifier

devices

(mandatory)

Set of Devices Objects

The devices that will be registered against the specified operator

Maximum 1000 Devices can be registered through each call

Anchor
netflix register devices parameters referred objects
netflix register devices parameters referred objects
Referred Parameter Objects Data

Include Page
V4:netflix_devices_parameters
V4:netflix_devices_parameters

Response Data

Name

Type

Description

failed_devices_setSet of Devices Objects

The devices that failed to be registered against the specified operator

Anchor
netflix failed register devices response referred objects
netflix failed register devices response referred objects
Referred Objects Response Data

Include Page
V4:netflix_devices_short
V4:netflix_devices_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

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

group_identifierGroup Identifier

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

Include Page
V4:group_identifier
V4:group_identifier

devices

(mandatory)

Set of Devices Objects

The devices that will be unregistered against the specified operator

Maximum 1000 Devices can be unregistered through each call

Anchor
netflix register devices parameters referred objects
netflix register devices parameters referred objects
Referred Parameter Objects Data

Include Page
V4:netflix_devices_parameters
V4:netflix_devices_parameters

Response Data

Name

Type

Description

failed_devices_setSet of Devices Objects

The devices that failed to be unregistered against the specified operator

Anchor
netflix failed register devices response referred objects
netflix failed register devices response referred objects
Referred Objects Response Data

Include Page
V4:netflix_devices_short
V4:netflix_devices_short

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue