Skip to main content

Content lock

Content lock (0.14)

This specification is available in Open API format:Download

This API product retrieves the level of content lock for a given account from 3 security levels.

Get content lock setting

This API returns the content lock setting which is applied to a given EE Mobile account.

Intermediate (Moderate)
This is the default setting for new and existing customers with content lock enabled. This gives access to social networking sites but not to 18-rated content in accordance with BBFC (British Board of Film Classification) guidelines or to pornography sites.
Off
This gives full access to the internet with no filter including to 18-rated content.
On (Strict)
This is the safe setting for children under 12. It filters all 18-rated content but also content the BBFC rates higher than 'PG' as well as other content not suitable for younger children including chat, dating and unmoderated social networking sites.

By default this API supports the Anonymised Mobile Subscriber Reference (AMSR) identifier in lieu of the subscriber's mobile phone number (MSISDN). The AMSR is obtained from the Network Identity API. Please contact us if you require to use MSISDN rather than AMSR.

Sandbox responses

The sandbox supports a number of success and failure scenarios which can be simulated by changing the last 6 characters of the X-EE-EL-Tracking-Header as defined in the tables below.

Success scenarios
X-EE-EL-Tracking-Header (last 6 characters) Sandbox response invoked Description
default 200 Simulates lockSetting Off.
PASS01 200 Simulates lockSetting Intermediate.
PASS02 200 Simulates lockSetting On.
Error scenarios
X-EE-EL-Tracking-Header (last 6 characters) Sandbox response invoked Description
E02001 400, 20 Invalid URL parameter value: amsr.
E06001 404, 60 Resource not found.
E00101 500, 01 Internal error.
E00501 503, 05 The service is temporarily unavailable.
Authorizations:
OAuth2
path Parameters
identifier
required
string
Example: gjPab2w1z2_Zg-ZJIpyQ-g.. or 447700900000

Either an Anonymised Mobile Subscription Reference or UK mobile phone number (12 digits in International format).

header Parameters
X-EE-EL-Tracking-Header
required
string (trackingHeader) ^[\w.~:@-]{1,255}$
Example: 96bb97fa-b941-46bb-8c4e-86c616c28a13

A unique reference used to track the transaction end to end. The recommended format is UUID (a 36-character alphanumeric string "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX").

Authorization
required
string
Example: Bearer <token>

This contains the access token obtained from a call to the OAuth API.
The access token is prefixed with the word 'Bearer ' to form the authorisation string.

Responses

Request samples

curl -XGET 
-H "X-EE-EL-Tracking-Header: 96bb97fa-b941-46bb-8c4e-86c616c28a13"
-H "Authorization: Bearer SZrYQsmi9tvGj1XwmKr5lXD4dpXY" 
https://api-sandbox.ee.co.uk/v1/mobile-subscriptions/447700900000/adult-content-lock           

Response samples

Content type
application/json
{
  • "lockSetting": "off"
}
Back to top