Gamma Limited · 2020-03-23 · Synchronous vs Asynchronous Processing ... Update Notification...

Gamma Limited

Mobile RESTful Web Service User Documentation

The information contained within this document, or subsequently provided, whether verbally or in documentary form, is confidential to Gamma and is provided to the organisation named within this document only. It shall not be published, disclosed or reproduced wholly or in part to any other party without our prior written consent. Gamma has made all reasonable efforts to ensure the accuracy and validity of the information provided herein and we make no warranties or representations as to its accuracy. Gamma should be notified of all requests for disclosure of Gamma supplied information under the Freedom of Information Act.

This document provides the user documentation for using the Mobile Restful Web Services.

Document Control

Document Title Mobile RESTful Web Service Documentation

Version 2.12

Author Antony Krstić

Date 10/05/2019

Status Development

Gamma Limited | Mobile RESTful Web Service User Documentation

© Gamma 2015. All rights reserved. Confidential.

of 140

Contents

Contents ........................................................................................................................................... 3

Version History ................................................................................................................................. 6

Introduction ....................................................................................................................................... 9

Security ......................................................................................................................................... 9

Synchronous vs Asynchronous Processing ................................................................................. 9

XML Examples ............................................................................................................................ 10

Setting up a Mobile Service ........................................................................................................ 11

Standard Success Response ..................................................................................................... 12

Company Management .................................................................................................................. 14

Create New Company ................................................................................................................ 14

Update Company ........................................................................................................................ 17

Remove Company ...................................................................................................................... 20

Service Provisioning ....................................................................................................................... 22

Provision New Service ................................................................................................................ 22

Cancel Order .............................................................................................................................. 26

Service Management ...................................................................................................................... 28

Activate Service .......................................................................................................................... 28

Cease Service ............................................................................................................................ 30

Change IMEI ............................................................................................................................... 32

Change MSISDN ........................................................................................................................ 34

Change USIM ............................................................................................................................. 36

Reset PIN ................................................................................................................................... 38

Suspend Service ......................................................................................................................... 40

Resume Service ......................................................................................................................... 42

Un-Blacklist Handset .................................................................................................................. 44

Change Tariff .............................................................................................................................. 46

Renew Funding ........................................................................................................................... 48

Update Contact Details ............................................................................................................... 50

Service Options .............................................................................................................................. 52

Update Network Services ........................................................................................................... 52

Update Network Bars.................................................................................................................. 54

Update Call Forwarding .............................................................................................................. 56

Update Bolt Ons ......................................................................................................................... 59

of 140


© Gamma 2015. All rights reserved. Confidential

Update Configuration ................................................................................................................. 61

Service Roaming ............................................................................................................................ 63

Update Roaming Configuration .................................................................................................. 63

Update Notification Options ....................................................................................................... 65

Update EU Max Charge ............................................................................................................. 67

Update ROW Max Charge ......................................................................................................... 69

Porting ............................................................................................................................................ 71

Port In ......................................................................................................................................... 71

Cancel Port In ............................................................................................................................ 73

Port Out ...................................................................................................................................... 75

Cancel Port Out .......................................................................................................................... 77

Accepting STAC ......................................................................................................................... 79

Cancel Accepted STAC ............................................................................................................. 81

Issuing a STAC .......................................................................................................................... 83

Cancel an Issued STAC ............................................................................................................. 85

View & Search Services ................................................................................................................. 87

View Call Forwards .................................................................................................................... 87

View Handset Details ................................................................................................................. 89

View Network Bars ..................................................................................................................... 90

View Network Services .............................................................................................................. 91

View Service History .................................................................................................................. 92

View Porting Details ................................................................................................................... 94

View Multiple Porting Details...................................................................................................... 96

View STAC Details ..................................................................................................................... 98

View Multiple STAC Details ..................................................................................................... 100

View Requests ......................................................................................................................... 102

View Service ............................................................................................................................ 104

View Bolt Ons ........................................................................................................................... 105

Search Services ....................................................................................................................... 106

Search MSISDNs ..................................................................................................................... 109

Search USIMs .......................................................................................................................... 111

Search Companies ................................................................................................................... 113

Connect ........................................................................................................................................ 115

Check Connection .................................................................................................................... 115

Allocate Number ....................................................................................................................... 116

Deallocate Number .................................................................................................................. 117



of 140

APN............................................................................................................................................... 118

Add APN ................................................................................................................................... 118

Remove APN ............................................................................................................................ 119

Update APN .............................................................................................................................. 120

Appendix ....................................................................................................................................... 118

Child Elements .......................................................................................................................... 122

Reference Data ......................................................................................................................... 131

Schema ......................................................................................................................................... 138

Glossary ........................................................................................................................................ 138

Contacts ........................................................................................................................................ 139

of 140



Version History

Version Release Date Authors Summary of Changes

1.0 07/12/2015 Stuart Smillie Draft Version

1.1 17/12/2015 Stuart Smillie Initial Version

1.2 26/01/2016 Stuart Smillie New namespaces and completion of new web services

1.3 10/03/2016 Ian Cadge 1. Replace companyId with companyName in contact element in Sample Request

2. Fix Roaming Max charge values

3. Updated value of boolean element named confirmedReviewedMaxMbCharge to true (so sample XML would result in success)

1.4 11/03/2016 Craig Greenhalgh

Search MSISDN iccid query parameter replaced with query msisdn parameter



of 140


1.5 17/03/2016 Ian Cadge EU regulation changes:

New EU max charge (MC_004_4/4.4p)

New EU max charge (MC_008_9/8.9p)

Removed sections:

Update EU Data-Bolton

Remove EU Data-Bolton

Update EU Business Traveller Bolton

Remove EU Business Traveller Bolton

Reference Data/EU Business Traveller Bolton

Reference Data/EU Roaming Data Bolton

Changed sections:

Sample Standard Success Response (removed euRoamingDataBoltOn & euRoamingDataBoltOnConnectionRebate from Sample Request)

Update Roaming Configuration (removed euRoamingDataBoltOn & euRoamingDataBoltOnConnectionRebate from Sample Request)

Update Business Traveller Package (removed euBusinessTravellerBoltOn)

Appendix/Child Elements/Business Traveller Package (removed euBusinessTravellerBoltOn)

New sections:

Update EU Business Daily Bolton

Remove EU Business Daily Bolton

Reference Data/EU Business Daily Bolton

2.0 23/11/2016 Ian Cadge Major release to support Tariff Refresh project

2.1 16/12/2016 Ian Cadge Correction to HTTP method within Update Network Services and Update Network Bars sections

2.2 28/04/2017 Ian Cadge Correction to Resource attribute within Change Tariff section

2.3 09/08/2017 Rowan Lee Added documentation for Connect and Amend Service Options

2.4 30/10/2017 Mark Willett Added documentation for APNs

2.5 17/11/2017 Nilay Patel Update Company List - now returns active companies and includes a query parameter to included deleted companies.

of 140




2.6 08/01/2018 Chris Cooper Update provisioning to include private APN options, correct remove APN endpoint

2.7 09/08/2018 Rowan Lee Added NGCS Network Bar

2.8 13/09/2018 Nilay Patel Introduce pagination in the service search endpoint

2.9 13/09/2018 Antony Krstić Added Rest of World data roaming Network Bar

2.10 13/09/2018 Luke Cann Updated reference data

2.11 04/10/2018 Luke Cann Added new Network Bars

2.12 10/05/2019 Charlie Arnold Added api's for new MNP regulations.



of 140

Introduction

Gamma provides a RESTful Web Service solution to enable Channel Partners to perform

operations on the mobile products. This is an XML based RESTful service over HTTPS (secure).

REST uses HTTP for all four CRUD based operations e.g. Create, Read, Update and Delete which

in REST methods translates respectively to POST, GET, PUT and DELETE.

Security

Only authorised users will be able to access the web service operations defined in this document.

Gamma use Basic Access Authentication to secure the request by encoding the username and

password and supplying them via the HTTP Authorization request header. An example of the

header is shown below using Gamma:NumberOne as the input:

Authorization: Basic R2FtbWE6TnVtYmVyT25l

Parameter Input

username Gamma

password NumberOne

Most operations will require a header value of 'clientId' to be provided. This value should map to

the channel partner for which the operation is being submitted.

It is not mandatory for headers to be provided with all operations. This document will define the

headers required per operation.

Before trying to connect and use the web service operations, please check the following pieces of

information have been supplied:

Username – A Gamma Web Service specific username used to validate your connection

Password - A Gamma Web Service specific password used to validate your connection

Client ID – The client ID of the Channel Partner you are executing the operation on

Please contact your account manager to obtain account credentials.

The Endpoints for the test and live web services are as follows:

Test Endpoint Live Endpoint

https://ws-test.gammaoperations.com/mobile/v3/rest https://ws.gammaoperations.com/mobile/v3/rest

Synchronous vs Asynchronous Processing

By default, most of the web services are Asynchronous but return an immediate response; which

signifies that the request has been received successfully and has been queued to be processed

(asynchronously). All operations will define if their process is Synchronous or Asynchronous.

of 140



NOTE: If the process is Asynchronous then the object returned (e.g. Service) will not contain the

requested changes. The final status of the request can be obtained via a View Service or View

Requests API call.

XML Examples

Throughout the document, sample request and response XML's have been produced for each

operation where applicable. Please note that the XML name spacing used in the requests or

returned in the responses may differ depending on what software you are using to send the

requests. The link below outlines how name spacing works:

http://www.w3schools.com/xml/xml_namespaces.asp



of 140

Setting up a Mobile Service

In order to make it easy to start using the Mobile Web Services an example story is outlined below

which shows how to provision, activate and use the first Gamma Mobile Service.

This example presumes that MSISDNs and USIMs are in an available state within the Gamma

system; assigned to the Channel Partner that you wish to create the service in.

Beginning

of Story

Create New

Company

Activate New

Gamma Mobile

Service

Provision New

Gamma Mobile

Service

Gamma Mobile Service

created and assigned to

a new Company

Use

Create New

Company

Use

Activate Service

Use

Provision New

Service

of 140



Standard Success Response

A standard success response, consisting of a XML representation of the affected service, is

returned by the majority of web services.

Whilst the web services are in asynchronous processing mode, the service object returned in the

response will have a status of Pending and will not yet have been updated to reflect the newly

requested features.

Success Response Elements

Schema Element Description Comment

service Parent Element

Ref: Service

Master element for a Gamma service

Headers Output

GAMMA-REQUEST-ID 000 (An integer identifier for the request)

Sample Standard Success Response

<ns2:service id="9141007" externalIdentifier="12345" xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">

<status>ACTIVE</status>

<msisdn id="5">

<value>447900000005</value>

<status>IN_USE</status>

<portingStatus>NO_PORT </portingStatus>

<portData/>

<channelPartner id="169">

<name>XXXX - Gamma Test 1</name>

</channelPartner>

<operator>GAMMA</operator>

<startDate>2016-07-22T00:00:00+01:00</startDate>

</msisdn>

<usim id="1000005">

<iccid>8944390000000002039</iccid>


<type>STANDARDSIM</type>

<homeImsi>1</homeImsi>

<roamingImsi>2</roamingImsi>



</channelPartner>



<pin1>0000</pin1>

<pin2>0000</pin2>

<puk1>00050005</puk1>



of 140

<puk2>0050005</puk2>

</usim>

<handset>

<imei>359205057702385</imei>

<blacklisted>false</blacklisted>

</handset>

<tariff>

<type>BUSINESS_BASIC</type>



</tariff>

<configuration>

<networkServices>

<networkService>FOURTH_GENERATION</networkService>

<networkService>DATA_WHEN_ROAMING</networkService>

<networkService>INTERNATIONAL_ROAMING</networkService>

<networkService>DATA</networkService>

<networkService>INTERNATIONAL_CALLING</networkService>

</networkServices>

<networkBars>

<networkBar>OUTGOING_CALLS</networkBar>

<networkBar>VOICEMAIL</networkBar>

</networkBars>

<boltOns>

<boltOn>DATA_5GB</boltOn>

<boltOn>MULTINET</boltOn>

</boltOns>

<roamingConfiguration>

<notificationOptions>

<notificationOption>INITIAL_DATA </notificationOption>

<notificationOption>PERCENTAGE_LIMIT_REACHED</notificationOption>

<notificationOption>DATA_CAP</notificationOption>

</notificationOptions>

<euRoamingMaxCharge>MC_008_9</euRoamingMaxCharge>

<rowRoamingMaxCharge>MC_500_0</rowRoamingMaxCharge>

</roamingConfiguration>

</configuration>

<advancedFunding>

<type>LEVEL_2</type>

<repaymentPeriod>THIRTY_SIX_MONTHS</repaymentPeriod>

<startDate>2016-10-28T11:14:23.470+01:00</startDate>

<endDate>2019-10-28T11:14:23.470Z</endDate>

</advancedFunding>

<connectConfiguration>

<type>M3H</type>

<status>ALLOCATED</status>

</connectConfiguration>

<apnConfiguration>

<apnName>Apn Name</apnName>

<ipAddress>0.0.0.0</ipAddress>

</apnConfiguration>


</ns2:service>

of 140



Company Management

Create New Company

This web service can be used to create a new company which is associated to a particular Channel

Partner account. It is then possible to provision new services under the created company. The

company must have valid address and contact details.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/company/{clientId}

Method POST

Parameters

Headers Input

clientId 000

Request Elements

Schema Element Mandatory Description Comment

company Yes Parent Element

externalReference No String Designed for client use

name Yes String Company Name

contact Yes Child Element

Ref: Address Contact

address Yes Child Element

Ref: Address

Sample Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<domain:company xmlns:domain="http://www.gamma.co.uk/mobile/api/domain">

<externalReference>12345</externalReference>

<name>Test Company 1</name>

<contact>



of 140

<name>Tester</name>

<emailAddress>[email protected]</emailAddress>

<phoneNumber>00000000000</phoneNumber>

</contact>

<address>

<thoroughfareNumber>The Crown House 15</thoroughfareNumber>

<thoroughfareName>Kings Road West</thoroughfareName>

<town>Newbury</town>

<county>Berkshire</county>

<postcode>RG14 5BY</postcode>

</address>

</domain:company>



Company Parent Element

externalReference String Designed for client use

Name String Company Name

Address Child Element

Ref: Address

Contact Child Element


channelPartner Child Element

Ref: Channel Partner

Sample Success Response

<ns2:company id="1" xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">



<contact>

<name>Tester</name>



</contact>

<address id="1">






</address>

<channelPartner id="169"/>

</ns2:company>

of 140



Failure Response Elements


Collection Parent Element

validationError Child Element

Ref: Validation Error

Sample Failure Response

<collection xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">

<ns2:validationError>

<errorCode>COMPANY_NAME_NON_UNIQUE</errorCode>

<message>Company name 'Test Account' is not unique</message>

</ns2:validationError>

</collection>



of 140

Update Company

This web service can be used to update the details of a company. For example, address and

contract information.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/company/{clientId}/{name}

Method PUT

Parameters

Headers Input

clientId 000

Request Elements








Ref: Address

Sample Request


<domain:company xmlns:domain="http://www.gamma.co.uk/mobile/api/domain">



<contact>

<name>Tester</name>



</contact>

<address>

of 140








</address>

</domain:company>



company Parent Element


name String Company Name

contact Child Element


address Child Element

Ref: Address







<contact>

<name>Tester</name>



</contact>

<address id="1">






</address>



</channelPartner>

</ns2:company>



of 140



collection Parent Element






<errorCode>COMPANY_NAME_NON_UNIQUE</errorCode>

<message>Company name 'J K Thomson' is not unique</message>


</collection>

of 140



Remove Company

This web service can be used to delete a company. A company cannot be deleted if it is associated

with any live Gamma services. Note that once deleted the company cannot be re-instated, a new

company will have to be created.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/company/{clientId}/{name}

Method DELETE

Parameters

Headers Input

clientId 000

Request Elements

No additional XML elements required.



company Parent Element


name String Company Name

contact Child Element


address Child Element

Ref: Address



endDate DateTime Should be in the following format:

YYYY-MM-DDThh:mm:ss.SSSZ

Indicates that company has been removed from the system



of 140





<contact>

<name>Tester</name>



</contact>

<address id="1">






</address>



</channelPartner>

<endDate>2015-11-03T11:32:47.287Z </endDate>

</ns2:company>









<errorCode>COMPANY_HAS_SERVICES</errorCode>

<message>Company has services attached</message>


</collection>

of 140



Service Provisioning

Provision New Service

This web service can be used to provision a new Gamma Mobile service. The resulting Gamma

service will have a status of 'Set Up'. No calls can be made, or charges applied, until the service is

activated on the Gamma network; Activate Service. In order to provision a new Mobile service you

must have created a Company to assign it to under the same Channel Partner; Create New

Company.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/provision

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


provision Yes Parent Element

imei No String

tariff Yes Child Element

Ref: Tariff

configuration Yes Child Element

Ref: Configuration


Ref: Provision Contact

advancedFunding No Child Element

Ref: Advanced Funding



of 140


portDetail No Child Element

Ref:Port Detail (Provision)

Only include if a port in is required. Only one of 'portDetail' or 'stacDetail' should be provided.

stacDetail No Child Element

Ref: STAC Detail (Provision)

Only include if accepting a STAC. Only one of 'portDetail' or 'stacDetail' should be provided.

apnConfiguration No Child Element

Ref:APN Configuration

Only include if a private APN is to be used

Sample Request

Example that includes a port-in request:


<ns2:provision xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<imei>123123123123123</imei>

<tariff>


</tariff>

<configuration>

<networkServices>



<networkService>PREMIUM_CONTENT</networkService>




</networkServices>

<networkBars>


</networkBars>

<boltOns>



</boltOns>



<notificationOption>INITIAL_DATA</notificationOption>







</configuration>

<contact>

<companyName>Gamma Test 169-4</companyName>

<name>IC Test</name>

of 140



</contact>

<advancedFunding>


<repaymentPeriod>TWELVE_MONTHS</repaymentPeriod>

<startDate>2016-09-23T00:00:00</startDate>

</advancedFunding>

<portDetail>

<msisdn>447814111226</msisdn>

<portDate>2016-09-26</portDate>

<pacDetail>

<pac>XXX123456</pac>

</pacDetail>

</portDetail>

<apnConfiguration>

<apnName>APN Name</apnName>


</apnConfiguration>

</ns2:provision>

If accepting a STAC then the request will be like the one shown above but including a stacDetail

rather than a portDetail:


<ns2:provision xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<imei>123123123123123</imei>

…

<stacDetail>

<oldMsisdn>447814111226</oldMsisdn>

<stacDate>2016-09-26</stacDate>

<stac>123456XXX</stac>

</stacDetail>

…

</ns2:provision>

Success Response

See Standard Success Response

If stacDetail is provided then the response will also include the STAC details as shown

in the success response section of Accepting STAC.



of 140









<errorCode>USIM_INCORRECT_STATUS</errorCode>

<message>USIM status of 'IN_USE' is incorrect for this operation. Expected status of 'AVAILABLE'</message>


</collection>

of 140



Cancel Order

This web service can be used to cancel a previous provision order. The MSISDN and USIM which

were associated with the order will be returned to an Available state in the Gamma system (and

available to re-use).

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/provision

Method DELETE

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response

HTTP Code 204



Collection Parent Element





of 140




<errorCode>SERVICE_INCORRECT_STATUS</errorCode>

<message>Service status of 'ACTIVE' is incorrect for this operation. Expected status of 'SETUP'</message>


</collection>

of 140



Service Management

Activate Service

This web service can be used to activate a provisioned service. The service must be in a status of

'Set Up'. Once activated mobile services will become available and charging will commence.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/activate

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


serviceActivationDetails No Parent Element

imei No String The IMEI to be associated to the handset

Sample Request


<api:serviceActivationDetails xmlns:api="http://www.gamma.co.uk/mobile/api">

<imei>000000000000000</imei>

</api:serviceActivationDetails>

Success Response




of 140









<errorCode>IMEI_REQUIRED</errorCode>

<message>Imei is required</message>


</collection>

of 140



Cease Service

This web service can be used to cease a live Gamma service. All network features associated with

the service will be removed from the Gamma network and the Gamma billing system will be notified

to bill out all Bolt Ons and Advanced Funding.

NOTE: This operation cannot be reversed once requested on the network.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}

Method DELETE

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response









of 140





<message>Service status of 'PAC_REQUESTED' is incorrect for this operation. Expected status of 'ACTIVE', 'ACTIVE_BLACKLISTED', 'SUSPENDED' </message>


</collection>

of 140



Change IMEI

This web service can be used to change the IMEI for the handset associated with a live Gamma

service.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/handset

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


imei Yes String The New IMEI to be associated to the handset

Sample Request


<api:imei xmlns:api="http://www.gamma.co.uk/mobile/api">123451234512345</api:imei>



handset Parent Element

Ref: Handset



of 140


<ns2:handset xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">

<imei>123451234512345</imei>


</ns2:handset>










<message>Service status of 'CEASED' is incorrect for this operation. Expected status of 'ACTIVE', 'ACTIVE_BLACKLISTED', 'PAC_REQUESTED', 'ACTIVE_PENDING_PORT_IN'</message>


</collection>

of 140



Change MSISDN

This web service can be used to change the MSISDN associated with a live Gamma service. The

new MSISDN must exist in the Gamma system, have an 'Available' status and be associated to the

same Channel Partner.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/msisdn

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


msisdn Yes String The New MSISDN to be associated to the service

Sample Request


<api:msisdn xmlns:api="http://www.gamma.co.uk/mobile/api">447730434510</api:msisdn>

Success Response




of 140









<errorCode>MSISDN_INCORRECT_STATUS</errorCode>

<message>MSISDN status of 'IN_USE' is incorrect for this operation. Expected status of 'AVAILABLE'</message>


</collection>

of 140



Change USIM

This web service can be used to change the USIM associated with a live Gamma service. The new

USIM must exist in the Gamma system, have an 'Available' status and be associated to the same

Channel Partner.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/usim

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


iccid Yes String The New ICCID to be associated to the service

Sample Request


<api:iccid xmlns:api="http://www.gamma.co.uk/mobile/api">8944390303602937467</api:iccid>

Success Response




of 140









<errorCode>USIM_INCORRECT_STATUS</errorCode>

<message>USIM status of 'IN_USE' is incorrect for this operation. Expected status of 'AVAILABLE'</message>


</collection>

of 140



Reset PIN

This web service can be used to reset the Voicemail PIN for a Gamma service.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/voicemail/resetpin

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response









of 140





<message>Service status of 'CEASED' is incorrect for this operation. Expected status of 'ACTIVE', 'ACTIVE_BLACKLISTED', 'PAC_REQUESTED'</message>


</collection>

of 140



Suspend Service

This web service can be used to suspend a live Gamma service (and optionally blacklist the

associated handset, if required). Once suspended the user will not be able to use the features

associated with that service but they will still be charged.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/suspend

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


blacklist Yes Boolean Flag to blacklist handset when suspending service

Sample Request


<api:blacklist xmlns:api="http://www.gamma.co.uk/mobile/api">true</api:blacklist>

Success Response




of 140









<errorCode>IMEI_MISMATCH</errorCode>

<message>The IMEI provided does not match the last IMEI used with this MSISDN. The last used IMEI is '353117020367129'. Please use Change IMEI operation to correct this and then re-submit the Suspend & Blacklist request or to blacklist the entered IMEI request a Manual Blacklist - follow the instructions on the Mobile Knowledgebase > Support > Lost & Stolen</message>


</collection>

of 140



Resume Service

This web service can be used to resume a live Gamma service which is currently in a 'Suspended'

status (and optionally unblacklist the associated handset, where applicable). Once resumed all

service features will be available on the Gamma network.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/resume

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


unblacklist Yes Boolean Flag to unblacklist handset when resuming service

Sample Request


<api:unblacklist xmlns:api="http://www.gamma.co.uk/mobile/api">false</api:unblacklist>

Success Response




of 140










<message>Service status of 'ACTIVE' is incorrect for this operation. Expected status of 'SUSPENDED'</message>


</collection>

of 140



Un-Blacklist Handset

This web service can be used to un-blacklist the handset of a live Gamma service.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/handset/unblacklist

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response



Ref: Handset





<imei>000000000000000</imei>

</ns2:handset>



of 140









<errorCode>UNBLACKLIST_INVALID_WHEN_NOT_BLACKLISTED</errorCode>

<message>Service cannot be unblacklisted when service is not currently blacklisted</message>


</collection>

of 140



Change Tariff

This web service can be used to change the Tariff type of the Gamma service, from Business Basic

to Business Extra for example.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/tariff

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


tariffType Yes Enum See Tariff Type for values

Sample Request


<ns2:tariffType xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain" xmlns:ns3="http://www.gamma.co.uk/mobile/api">BUSINESS_EXTRA</ns2:tariffType>

Success Response




of 140









<errorCode>BILLING_CHANGE_TARIFF_SAME_DAY</errorCode>

<message>This change is prohibited today as a change tariff was completed earlier today</message>


</collection>

of 140



Renew Funding

This web service can be used to renew the funding associated with a live Gamma service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/funding/renew

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


fundingRenewal Yes Parent Element

type Yes Child Element Ref: Advanced Funding Type

repaymentPeriod Yes Child Element Ref: Repayment Period

Sample Request


<ns3:fundingRenewal xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain" xmlns:ns3="http://www.gamma.co.uk/mobile/api">


<repaymentPeriod>THIRTY_SIX_MONTHS</repaymentPeriod>

</ns3:fundingRenewal>

Success Response




of 140










<message>Service status of 'SETUP' is incorrect for this operation. Expected status of 'ACTIVE', 'ACTIVE_PENDING_PORT_IN', 'PAC_REQUESTED'</message>


</collection>

of 140



Update Contact Details

This web service can be used amend the contact details of a service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/contact

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


contact Yes Parent Element

Ref: Provision Contact

Sample Request


<ns2:contact xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<companyName>Gamma Test 169-4</companyName>

<name>IC Test</name>

</ns2:contact>








of 140




<errorCode>COMPANY_NOT_FOUND</errorCode>

<message>Company not found</message>


</collection>

of 140



Service Options

Update Network Services

This web service can be used to change the network services assigned to a live Gamma service.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/services

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


collection Yes Parent Element

networkService No Child Element

Ref: Network Service

Sample Request


<ns2:collection xmlns="http://www.gamma.co.uk/mobile/api/domain" xmlns:ns2="http://www.gamma.co.uk/mobile/api">







<networkService>ADULT_CONTENT</networkService>

</ns2:collection>



of 140

Success Response











<message>Service status of 'CEASED' is incorrect for this operation. Expected status of 'ACTIVE', 'PAC_REQUESTED', 'ACTIVE_PENDING_PORT_IN'</message>


</collection>

of 140



Update Network Bars

This web service can be used to change the network bars assigned to a live Gamma service.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/barring

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements



networkBar No Child Element

Ref: Network Bar

Sample Request




<networkBar>OUTGOING_MMS</networkBar>

<networkBar>OUTGOING_SMS</networkBar>

<networkBar>INCOMING_CALLS</networkBar>

<networkBar>INCOMING_MMS</networkBar>

<networkBar>INCOMING_SMS</networkBar>


</ns2:collection>

Success Response




of 140










<message>Service status of 'CEASED' is incorrect for this operation. Expected status of 'ACTIVE', 'PAC_REQUESTED', 'ACTIVE_PENDING_PORT_IN'</message>


</collection>

of 140



Update Call Forwarding

This web service can be used to change the call forwarding options associated with a service on

the Gamma network.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/callforwarding

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


callForwardConfiguration Yes Parent Element

forward

type=" forwardToNumber "

No Child Element

Ref: Forward To Number

Can be repeated to configure different call forward options

forward

type=" forwardToVoicemail"

No Child Element

Ref: Forward To Voicemail

Can only be used once for setting up voicemail call forwarding

Sample Request 1


<api:callForwardConfiguration xmlns:api="http://www.gamma.co.uk/mobile/api">

<forward xsi:type="api:forwardToNumber" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<conditions>

<condition>NO_REPLY</condition>

<condition>UNREACHABLE</condition>

</conditions>

<number>447000000001</number>

</forward>

<forward xsi:type="api:forwardToVoicemail" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<conditions>



of 140

<condition>BUSY</condition>

</conditions>

</forward>

</api:callForwardConfiguration>

Sample Request 2


<api:callForwardConfiguration xmlns:api="http://www.gamma.co.uk/mobile/api">

<forward xsi:type="api:forwardToVoicemail" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<conditions>

<condition>ALWAYS</condition>

</conditions>

</forward>

</api:callForwardConfiguration>



callForwardConfiguration Parent Element

forward


Child Element


Will be repeated to display different call forward options

forward

type=" forwardToVoicemail "

Child Element


Will be displayed if voicemail call forwarding is configured

Sample Success Response 1

<ns2:callForwardConfiguration xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<forward xsi:type="ns2:forwardToVoicemail" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<conditions>


</conditions>

</forward>

<forward xsi:type="ns2:forwardToNumber" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<conditions>



</conditions>


</forward>


<conditions>


</conditions>


</forward>

</ns2:callForwardConfiguration>

of 140

Gamma Limited |


Sample Success Response 2



<conditions>


</conditions>

</forward>










<errorCode>DUPLICATE_FORWARDING_CONDITION</errorCode>

<message>Multiple forwards requested for 'BUSY'</message>


</collection>

Gamma Limited |


of 140

Update Bolt Ons

This web service can be used to change the Bolt Ons associated with a service on the Gamma

network.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/bolton

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements



boltOn No Child Element

Ref: Bolt On

Sample Request 1



<boltOn>SMART_BUSINESS_PACK</boltOn>

<boltOn>WORLDWIDE_DATA</boltOn>


<boltOn>DATA_SHARER_ENABLER</boltOn>


<boltOn>INTERNATIONAL_VOICE_ROW</boltOn>

<boltOn>INTERNATIONAL_VOICE_EUROPE_NORTH_AMERICA</boltOn>

</ns2:collection>

Success Response


of 140

Gamma Limited |










<errorCode>BILLING_BOLT_ON_SAME_DAY</errorCode>

<message>Your 'ROW Roaming Data' for '447900000010' has already been changed today, further changes to the same bolt-on type on the same day are prohibited</message>


</collection>

Gamma Limited |


of 140

Update Configuration

This web service can be used to change the configuration associated with a service on the Gamma

network. This allows the channel partner to combine changes to Network Services, Network Bars,

Bolt Ons and Roaming Configuration in a single API call.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/configure

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


configuration Yes Parent Element

Ref: Configuration

Sample Request 1


<ns2:configuration xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">>

<networkServices>








</networkServices>

<networkBars>




of 140

Gamma Limited |






</networkBars>

<boltOns>








</boltOns>










</ns2:configuration>

Success Response










<errorCode>BILLING_BOLT_ON_SAME_DAY</errorCode>

<message>Your 'MultiNet' for '447900000010' has already been changed today, further changes to the same bolt-on type on the same day are prohibited</message>


</collection>

Gamma Limited |


of 140

Service Roaming

Update Roaming Configuration

This web service can be used to update the Roaming Configuration associated with a Gamma

service.. Anything not included in the request such as a Notification Option shall be considered not

required and therefore removed on the Gamma network.

These elements can also be updated individually in other web service operations found in this

document.

Response Type Condition Clause -

IF <euRomaingDataBoltOn> OR <rowRoamingDataBoltOn> are changed

Asynchronous true

Synchronous false

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/roaming

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


roamingConfiguration Yes Parent Element

Ref: Roaming Configuration

Sample Request


<domain:roamingConfiguration xmlns:domain="http://www.gamma.co.uk/mobile/api/domain">






of 140

Gamma Limited |




</domain:roamingConfiguration>

Success Response










<errorCode>INITIAL_NOTIFICATION_DATA_CAP_REQUIRED</errorCode>

<message>Initial data cap notification only available if data cap and data cap reached message is set</message>


</collection>

Gamma Limited |


of 140

Update Notification Options

This web service can be used to update the Notification Options associated with a Gamma service.

There are three available Notification Options available in Gamma which are outlined here:

Notification Option

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/roaming/notifications

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements



notificationOption Yes Enum Potentially multiple occurrences

See Notification Option for values

Sample Request






</ns2:collection>

Success Response


of 140

Gamma Limited |










<errorCode>PERCENTAGE_NOTIFICATION_OTHERS_REQUIRED</errorCode>

<message>Eighty % Data Cap notification only available if data cap and Data Cap reached Message and initial data notification message are set</message>


</collection>

Gamma Limited |


of 140

Update EU Max Charge

This web service can be used to update the EU Max Charge associated with a Gamma service.

The EU Max Charge that you request will be added to your Gamma service; if you already have an

EU Max Charge then this will be removed first.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/roaming/maxCharge/eu

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


euRomaingMaxCharge Yes Enum See EU Roaming Max Charge for values

Sample Request


<domain:euRoamingMaxCharge xmlns:domain="http://www.gamma.co.uk/mobile/api/domain">MC_017_5</domain:euRoamingMaxCharge>

Success Response


of 140

Gamma Limited |











<message>Service status of 'SUSPENDED' is incorrect for this operation. Expected status of 'ACTIVE', 'ACTIVE_BLACKLISTED', 'PAC_REQUESTED', 'ACTIVE_PENDING_PORT_IN'</message>


</collection>

Gamma Limited |


of 140

Update ROW Max Charge

This web service can be used to update the ROW Max Charge associated with a Gamma service.

The ROW Max Charge that you request will be added to your Gamma service; if you already have

a ROW Max Charge then this will be removed first

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/roaming/maxCharge/row

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


rowRoamingMaxCharge Yes Enum See ROW Roaming Max Charge for values

Sample Request


<domain:rowRoamingMaxCharge xmlns:domain="http://www.gamma.co.uk/mobile/api/domain">MC_300_0</domain:rowRoamingMaxCharge>

Success Response


of 140

Gamma Limited |











<message>Service status of 'SUSPENDED' is incorrect for this operation. Expected status of 'ACTIVE', 'ACTIVE_BLACKLISTED', 'PAC_REQUESTED', 'ACTIVE_PENDING_PORT_IN'</message>


</collection>

Gamma Limited |


of 140

Porting

Port In

This web service can be used to import a MSISDN from another service provider onto the Gamma

network using the current MSISDN as a temporary MSISDN to support the port. The MSISDN being

ported in will retain all the services from the temporary MSISDN and billing will be updated with the

new MSISDN.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/port/in

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


portDetail Yes Parent Element

msisdn Yes String MSISDN being ported onto the Gamma network

portDate Yes DateTime Should be in the following format:

YYYY-MM-DD

pacDetail Yes Child Element

Ref: PAC Detail

of 140

Gamma Limited |


Sample Request


<api:portDetail xmlns:api="http://www.gamma.co.uk/mobile/api ">


<portDate>2015-11-09</portDate>

<pacDetail>


</pacDetail>

</api:portDetail>

Success Response










<errorCode>PACDETAIL_PORTDATE_WEEKEND</errorCode>

<message>Port Date cannot be requested on a weekend</message>


</collection>

Gamma Limited |


of 140

Cancel Port In

This web service can be used to cancel an in-flight port request, as long as the MNP status has not

progressed to 'Locked' (which generally occurs after 6pm on the working day prior to the port date).

If cancelled, the service status will revert to Active and the PAC will return to a status of Open on

MNP (where it can be used on another service provider or re-used on Gamma with a different port

date).

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/port/in

Method DELETE

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response







of 140

Gamma Limited |






<message>Service status of 'ACTIVE' is incorrect for this operation. Expected status of 'ACTIVE_PENDING_PORT_IN'</message>


</collection>

Gamma Limited |


of 140

Port Out

This web service can be used to request a PAC to cease a service and port the MSISDN to another

service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/port/out

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response







of 140

Gamma Limited |






<message>Service status of 'SUSPENDED' is incorrect for this operation. Expected status of 'ACTIVE', 'ACTIVE_BLACKLISTED'</message>


</collection>

Gamma Limited |


of 140

Cancel Port Out

This web service can be used to cancel a PAC which has been obtained via Gamma, as long as

the MNP status has not progressed to 'Closed'. If cancelled, the service status will revert to Active

and the PAC will be cancelled both on the Gamma system and on MNP.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/port/out

Method DELETE

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response







of 140

Gamma Limited |






<message>Service status of 'ACTIVE' is incorrect for this operation. Expected status of 'PAC_REQUESTED'</message>


</collection>

Gamma Limited |


of 140

Accepting STAC

This web service can be used to accept a STAC (to cease a service on another provider).

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/stac/in

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


stacPortDetail Yes Parent Element

oldMsisdn Yes String MSISDN of the service that is being ceased

stacDate Yes Date Should be in the following format:

YYYY-MM-DD

stac Yes String

Sample Request


<api:stacPortDetail xmlns:api="http://www.gamma.co.uk/mobile/api ">


<stacDate>2015-11-09</ stacDate>


</api:stacPortDetail>

of 140

Gamma Limited |


Success Response

The standard success response (See Standard Success Response) will be returned which will

additionally include a 'stacInData' sub-element, an example of which is shown below:



...

<stacInData>



<expiryDate>2015-05-22T00:00:00+01:00</expiryDate>

<stacDate>2015-05-09T00:00:00+01:00</stacDate>

<networkDetected>false</networkDetected>

<dnoCode>DNO</dnoCode>

<dspCode>DSP</dspCode>

</stacInData>

...


</ns2:service>









<errorCode>STAC_DETAIL_STACDATE_WEEKEND_OR_BANKHOLIDAY</errorCode>

<message>STAC Date cannot be requested on a weekend or Bank Holiday</message>


</collection>

Gamma Limited |


of 140

Cancel Accepted STAC

This web service can be used to cancel an in-flight STAC In request, as long as the MNP status

has not progressed to 'Locked' (which generally occurs after 6pm on the working day prior to the

port date). If cancelled, the service status will revert to Active and the STAC will return to a status

of Open on MNP (where it can be used on another service provider or re-used on Gamma with a

different STAC date).

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/stac/in

Method DELETE

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response







of 140

Gamma Limited |






<message>Service status of 'CEASED' is incorrect for this operation. Expected status of 'ACTIVE' </message>


</collection>

Gamma Limited |


of 140

Request a STAC

This web service can be used to request a STAC (used to terminate a Gamma MSISDN when

moving to another service provider).

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/stac/out

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response

The standard success response (See Standard Success Response) will be returned which will

additionally include a 'stacOutData' sub-element, an example of which is shown below:



...

<stacOutData>

<stac>123456QWE</stac>

<expiryDate>2019-06-22T00:00:00+01:00</expiryDate>

</stacOutData>

...


</ns2:service>

of 140

Gamma Limited |











<message>Service status of 'SUSPENDED' is incorrect for this operation. Expected status of 'ACTIVE', 'ACTIVE_BLACKLISTED'</message>


</collection>

Gamma Limited |


of 140

Cancel a Requested STAC

This web service can be used to cancel a STAC which has been obtained via Gamma, as long as

the MNP status has not progressed to 'Closed'. If cancelled the STAC will be cancelled both on the

Gamma system and on MNP.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/stac/out

Method DELETE

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response







of 140

Gamma Limited |



<ns3:collection xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain" xmlns:ns3="http://www.gamma.co.uk/mobile/api">

<validationError>

<errorCode>STAC_OUT_CANCEL_REQUEST_FAILED</errorCode>

<message>STAC Out cancel request has failed: 'Cancel STAC failed'</message>

</validationError>

</ns3:collection>

Gamma Limited |


of 140

View & Search Services

View Call Forwards

This web service can be used to obtain the current call forward settings for a live Gamma service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/callforwarding

Method GET

Parameters ?iccid=

Headers Input

clientId 000

Request Elements




callForwardConfiguration Parent Element

forward


Child Element


Will be repeated to display different call forward options

forward

type=" forwardToVoicemail "

Child Element


Will be displayed if voicemail call forwarding is configured

of 140

Gamma Limited |





<conditions>


</conditions>

</forward>


<conditions>


</conditions>


</forward>


<conditions>


</conditions>


</forward>


Gamma Limited |


of 140

View Handset Details

This web service can be used to obtain the current handset information for a live Gamma service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/handset

Method GET

Parameters ?iccid=

Headers Input

clientId 000

Request Elements





Ref: Handset



<blacklisted>true</blacklisted>

<imei>000000000000000</imei>

</ns2:handset>

of 140

Gamma Limited |


View Network Bars

This web service can be used to obtain the current network bars enabled for a live Gamma service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/barring

Method GET

Parameters ?iccid=

Headers Input

clientId 000

Request Elements





networkBar Child Element

Ref: Network Bar










</ns2:collection>

Gamma Limited |


of 140

View Network Services

This web service can be used to obtain the current network services enabled for a live Gamma

service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/services

Method GET

Parameters ?iccid=

Headers Input

clientId 000

Request Elements





networkService Child Element

Ref: Network Service










</ns2:collection>

of 140

Gamma Limited |


View Service History

This web service can be used to obtain the complete history of a service from provision up to the

most recent transaction.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/history

Method GET

Parameters ?iccid=

Headers Input

clientId 000

Request Elements





record

type="order"

Child Element

Ref: Record - Order

Many of these can occur depending on the amount of records. Will contain 'subRecords' elements that can in turn contain more 'record' elements

Gamma Limited |


of 140


<collection xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain" xmlns:ns3="http://www.gamma.co.uk/mobile/api" xmlns:ns4="http://www.gamma.co.uk/mobile/api/order">

<ns4:order id="1" requestId="1" serviceId="1">

<detail xsi:type="ns4:basicOrderDetail" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<description>Activate Service</description>

</detail>

<subRecords/>

<type>ACTIVATE_SERVICE</type>

<status>COMPLETE</status>

<orderedDateTime>2012-01-25T12:57:10.137Z</orderedDateTime>

</ns4:order>

</collection>

of 140

Gamma Limited |


View Porting Details

This web service can be used to look up the details of a port on MNP.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/port

Method GET

Parameters ?pac=

Headers Input

clientId 000

Request Elements




portDetail Parent Element

msisdn String

portDate DateTime

pacDetail Child Element

Ref: Pac Detail

Gamma Limited |


of 140


<ns2:portDetail xmlns:ns2="http://www.gamma.co.uk/mobile/api">


<portDate>2016-01-07T00:00:00Z</portDate>

<pacDetail>


<expiryDate>2016-01-17T00:00:00Z</expiryDate>

<pacStatus>OPEN</pacStatus>



</pacDetail>

</ns2:portDetail>

of 140

Gamma Limited |


View Multiple Porting Details

This web service can be used to look up the details of multiple ports on MNP.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/ports

Method POST

Headers Input

clientId 000

Request Elements


multiplePortDetailRequest Yes Parent element

pacDetails Yes Map<String,String> Mapping of MSISDN and PAC

<ns2:multiplePortDetailRequest xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<pacDetails>

<entry>

<key>447900000002</key>

<value>XBU123458</value>

</entry>

<entry>

<key>447900000001</key>


</entry>

<entry>

<key>447900000000</key>


</entry>

</pacDetails>

</ns2:multiplePortDetailRequest>

Gamma Limited |


of 140



multiplePortDetail Parent element

portDetails Map<String, PortDetail>

Mapping of a MSISDN to its corresponding PortDetail.


<ns2:multiplePortDetail xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<portDetails>

<entry>

<key>447900000002</key>

<value>



<pacDetail>

<pac>XBU123458</pac>


<pacStatus>Open</pacStatus>

</pacDetail>

</value>

</entry>

<entry>

<key>447900000001</key>

<value>



<pacDetail>




</pacDetail>

</value>

</entry>

<entry>

<key>447900000000</key>

<value>



<pacDetail>




</pacDetail>

</value>

</entry>

</portDetails>

</ns2:multiplePortDetail>

of 140

Gamma Limited |


View STAC Details

This web service can be used to look up the details of a STAC on MNP.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/stac

Method GET

Parameters ?stac=

Headers Input

clientId 000

Request Elements




stacDetailResponse Parent element

stac String

expiryDate LocalDate Date the STAC expires

msisdn String MSISDN of the service being terminated.

stacStatus String STAC STATUS

dnoCode String

dspCode String

Gamma Limited |


of 140


<ns2:stacDetailResponse xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<stac>123456XBU</stac>



<stacStatus>OPEN</stacStatus>



</ns2:stacDetailResponse>

of 140

Gamma Limited |


View Multiple STAC Details

This web service can be used to look up the details of multiple STACs on MNP.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/stacs

Method POST

Headers Input

clientId 000

Request Elements


multipleStacDetailRequest Yes Parent element

stacDetails Yes Map<String, String> Mapping of MSISDN to STAC

<ns2:multipleStacDetailRequest xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<stacDetails>

<entry>

<key>447900000002</key>

<value>123458XBU</value>

</entry>

<entry>

<key>447900000001</key>


</entry>

<entry>

<key>447900000000</key>


</entry>

</stacDetails>

</ns2:multipleStacDetailRequest>

Gamma Limited |


of 140



multipleStacDetailResponse Parent element

stacDetailResponses Map<String, StacDetailResponse>

Mapping of MSISDN to its corresponding StacDetailResponse.


<ns2:multipleStacDetailResponse xmlns:ns2="http://www.gamma.co.uk/mobile/api">

<stacDetailResponses>

<entry>

<key>447900000002</key>

<value>







</value>

</entry>

<entry>

<key>447900000002</key>

<value>







</value>

</entry>

<entry>

<key>447900000002</key>

<value>







</value>

</entry>

</stacDetailResponses>

</ns2:multipleStacDetailResponse>

of 140

Gamma Limited |


View Requests

This web service can be used to obtain all the requests that have been requested. It is

recommended to use the filtering feature (e.g. filter by status or id) to improve performance.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/request

Method GET

Parameters ?requestId=

?status=

Headers Input

clientId 000

Request Elements


Response Elements



Request Child Element

Ref: Request

Gamma Limited |


of 140


<collection xmlns:ns2="http://www.gamma.co.uk/mobile/api/request">

<ns2:request id="1">

<status>SUCCESSFUL</status>

<requestDate>2015-09-09T21:37:13.810Z</requestDate>

<responseDate>2015-09-09T21:37:14.960Z</responseDate>

</ns2:request>





</ns2:request>





</ns2:request>





</ns2:request>





</ns2:request>

</collection>

of 140

Gamma Limited |


View Service

This web service can be used to obtain all the details for a particular Gamma service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}

Method GET

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response


Gamma Limited |


of 140

View Bolt Ons

This web service can be used to obtain all the Bolt Ons for a particular Gamma service.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/bolton

Method GET

Parameters ?iccid=

Headers Input

clientId 000

Request Elements





boltOn Child Element

Ref: Bolt Ons










</ns2:collection>

of 140

Gamma Limited |


Search Services

This web service can be used to search for Services that match certain search parameters. Please

use these filters when possible to help improve the performance of the request.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services

Method GET

Parameters ?msisdn=

?iccid=

?status=

?companyId=

?portDate=

?maxResults=*

?page=

?perPage=

* maxResults has been deprecated, page and/or perPage should be used instead. See section

on pagination below.

Headers Input

clientId 000

Pagination

A paginated response can be returned from the service search by using a combination of the

following query parameters:

page - the page number to return (defaults to 1 if only perPage is specified)

perPage - the number of services to return in a page (defaults to 200 if only page is

specified)

The result will additionally contain the following header parameters:

X-Pagination-Total-Pages - the total number of pages available

X-Pagination-Total-Count - the total number of services found matching the search

criteria

X-Pagination-Current-Page - current page number

X-Pagination-Page-Size - number of services per page

Link - the following links are also provided

Gamma Limited |


of 140

~ first - the URL for the first page

~ last - the URL for the last page

~ next - the URL for the next page (this will be the same as the last page if this is a

request for the last page)

~ previous - the URL for the previous page (this will be the same as the first page if

this is a request for the first page)

Please note that if page and perPage are not specified then the result will be returned without

pagination.

Request Elements





service Child Element

Ref: Service



<ns2:service id="960000" externalIdentifier="BAN_960000">


<msisdn id="960000">

<value>447900960000</value>


<portingStatus>NO_PORT</portingStatus>

<portData/>



</channelPartner>



</msisdn>

<usim id="960000">

<iccid>89441000302538156449</iccid>


<type>STANDARDSIM</type>





</channelPartner>



of 140

Gamma Limited |


<pin1>0000</pin1>

<pin2>0000</pin2>

<puk1>05028161</puk1>

<puk2>26001889</puk2>

</usim>

<handset>

<imei>300000000010006</imei>

<blacklisted>true</blacklisted>

</handset>

<tariff>




</tariff>

<configuration>

<networkServices>





</networkServices>

<networkBars/>

<boltOns/>


<notificationOptions/>




</configuration>


</ns2:service>

</collection>

Gamma Limited |


of 140

Search MSISDNs

This web service can be used to search for MSISDNs that match certain search parameters. Please


Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/msisdn

Method GET

Parameters ?clientId=

?status=

?msisdn=

?maxResults=

Headers Input

clientId 000

Request Elements





msisdn Child Element

Ref: MSISDN

Potentially multiple occurrences



<ns2:msisdn id="1">

<value>447000000001</value>


<portingStatus>PORT_OUT_PAC_ASSIGNED</portingStatus>

<portData>

of 140

Gamma Limited |



<pacExpiryDate>2016-02-20T00:00:00Z</pacExpiryDate>

</portData>


<name>Gamma Test</name>

</channelPartner>


<startDate>2016-01-20T19:07:55.490Z</startDate>

</ns2:msisdn>

<ns2:msisdn id="2">

<value>447000000002</value>


<portingStatus>NO_PORT</portingStatus>

<portData/>


<name>Gamma Test</name>

</channelPartner>


<startDate>2016-01-20T19:07:55.490Z</startDate>

</ns2:msisdn>

</collection>

Gamma Limited |


of 140

Search USIMs

This web service can be used to search for USIMs that match certain search parameters. Please


Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/usim

Method GET


?status=

?iccid=

?maxResults=

Headers Input

clientId 000

Request Elements





usim Child Element

Ref: USIM

Potentially multiple occurrences



<ns2:usim id="1">

<iccid>8944390000000000001</iccid>


<type>TRIPLESIM</type>


of 140

Gamma Limited |




<name>Uniworld Communications Ltd</name>

</channelPartner>



<pin1>0000</pin1>

<pin2>0000</pin2>

<puk1>05028161</puk1>

<puk2>26001889</puk2> </ns2:usim>

<ns2:usim id="2">

<iccid>8944390000000000002</iccid>


<type>TRIPLESIM</type>




<name>Uniworld Communications Ltd</name>

</channelPartner>



<pin1>0000</pin1>

<pin2>0000</pin2>

<puk1>05028162</puk1>

<puk2>26001890</puk2> </ns2:usim>

</collection>

Gamma Limited |


of 140

Search Companies

This web service can be used to search for the Companies defined by the Channel Partner.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/v3/rest/company

Method GET


?maxResults=

?name=

?includeDeleted=

Headers Input

clientId 000

Request Elements





company Child Element

Ref: Company



<ns2:company id="1">

<externalReference>Gam169</externalReference>

<name>Gamma Test 169</name>

<contact>

<name>Paul Smith</name>


of 140

Gamma Limited |



</contact>

<address id="1">

<thoroughfareNumber>1</thoroughfareNumber>

<thoroughfareName>Mill Lane</thoroughfareName>



<postcode>RG12 3AB</postcode>

</address>



</channelPartner>

</ns2:company>

<ns2:company id="2">

<externalReference>Gam169</externalReference>

<name>Gamma Test 169-2</name>

<contact>

<name>Steve Smith</name>



</contact>

<address id="2">

<thoroughfareNumber>10B</thoroughfareNumber>

<thoroughfareName>Cottesmore Close</thoroughfareName>

<town>Canvey Island</town>

<county>Essex</county>

<postcode>SS8 0EA</postcode>

</address>



</channelPartner>

</ns2:company>

</collection>

Gamma Limited |


of 140

Connect

Check Connection

This web service can be used to check if a mobile company is connected to a horizon company.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/rest/company/{clientId}/{name}/connections/horizon

Method GET

Parameters

Headers Input

clientId 000

Request Elements




companyConnectStatusWrapper Parent Element

isConnected String



<ns2:companyConnectStatusWrapper xmlns:ns2="http://www.gamma.co.uk/mobile/api/connect">

<isConnected>true</isConnected>

</ns2:companyConnectStatusWrapper>

of 140

Gamma Limited |


Allocate Number

This web service can be used to allocate a number with voice enabled to horizon.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/rest/services/{msisdn}/connect

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response





validationErrors Child Element

Ref: Validation Errors



< collection xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">

< ns2:validationErrors>

<errorCode>CONNECT_INVALID_OPERATION</errorCode>

<message>This operation is not possible as the service has a connect status of ALLOCATED</message>

</ns2:validationErrors>

</collection>

Gamma Limited |


of 140

Deallocate Number

This web service can be used to deallocate a number with voice enabled from horizon.

Response Type

Synchronous

Interface

Attributes Input

Resource /mobile/rest/services/{msisdn}/connect

Method DELETE

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response





validationErrors Child Element

Ref: Validation Errors



< collection xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">

< ns2:validationErrors>

<errorCode>CONNECT_INVALID_OPERATION</errorCode>

<message>This operation is not possible as the service has a connect status of AVAILABLE</message>

</ns2:validationErrors>

</collection>

of 140

Gamma Limited |


APN

The following webservices are used to maintain APNs on services on the Gamma network

Add APN

This webservice can be used to add an APN to a service on the Gamma network

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/apn/

Method POST

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


apnConfiguration Yes Parent Element

Ref: APN Configuration

Sample Request

<ns2:apnConfiguration xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">



</ns2:apnConfiguration>

Success Response


Gamma Limited |


of 140









<errorCode>APN_NAME_REQUIRED</errorCode>

<message> APN name is required</message>


</collection>

Remove APN

This web service can be used to remove an APN from a service on the Gamma network

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/apn

Method DELETE

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


Success Response


of 140

Gamma Limited |










<errorCode>SERVICE_PAIRING_DOESNT_EXIST</errorCode>

<message>The service does not have an APN associated with it</message>


</collection>

Update APN

This webservice can be used to update a service on the Gamma network to have a different APN.

Response Type

Asynchronous

Interface

Attributes Input

Resource /mobile/v3/rest/services/{msisdn}/apn/

Method PUT

Parameters ?iccid=

Headers Input

clientId 000

Request Elements


apnConfiguration Yes Parent Element


Gamma Limited |


of 140

Sample Request

<ns2:apnConfiguration xmlns:ns2="http://www.gamma.co.uk/mobile/api/domain">



</ns2:apnConfiguration>

Success Response










<errorCode>APN_NAME_REQUIRED</errorCode>

<message>APN name is required</message>


</collection>

of 140

Gamma Limited |


Appendix

This section contains some helpful reference data to enhance the usability of this document. Most

of the information below is accessed via links in the document sections for convenience.

Child Elements

The following are the child elements referenced in the web service XML's throughout the document.

NOTE: The 'Mandatory' column is only relevant for web service requests.

Address


thoroughfareNumber Yes String

thoroughfareName Yes String

town Yes String

county Yes String

postcode Yes String

Address Contact


name Yes String

emailAddress Yes String

phoneNumber Yes String

Advanced Funding


type Yes Child Element Ref: Advanced Funding Type

repaymentPeriod Yes Child Element Ref: Repayment Period

startDate Yes DateTime

endDate No DateTime

Gamma Limited |


of 140

APN Configuration


apnName Yes String

ipAddress No String Mandatory if allocating to an APN with only static IP allocation

Bolt Ons


boltOn Enum See Bolt On for values

Can be used multiple times for each option required

Channel Partner


name String

Company








Ref: Address

channelPartner Yes Child Element


Conditions


condition Yes String

of 140

Gamma Limited |


Configuration


networkServices No Child Element Ref: Network Services

networkBars No Child Element Ref: Network Bars

boltOns No Child Element Ref: Bolt Ons

roamingConfiguration No Child Element Ref: Roaming Configuration

Connect Configuration


type Yes Enum See Connect Type for values

status Yes Enum See Connect Status for values

Forward to Number


conditions No Child Element

Ref: Conditions

number No String

Forward to Voicemail


conditions No Child Element

Ref: Conditions

number No String

Handset


blacklisted Boolean

imei String

Gamma Limited |


of 140

MSISDN


operator Enum See Operator for values

portData Child Element

Ref: Port Data

portingStatus Enum See Porting Status for values



startDate DateTime Should be in the following format:

YYYY-MM-DDThh:mm:ss.msmsmsZ

status Enum See MSISDN Status for values

value String

Network Bars


networkBars Enum See Network Bar for values

Can be used multiple times for each bar required

Network Services


networkServices Enum See Network Service for values

Can be used multiple times for each service required

Notification Options


notificationOptions Enum See Notification Options for values

Can be used multiple times for each option required

of 140

Gamma Limited |


PAC Detail


pac Yes String

expiryDate No Date

pacStatus No String MNP PAC Status

dnoCode No String For information only

dspCode No String For information only

Provision Contact


id Integer RESPONSE ONLY

companyName String

name String

Port Data


pac String

pacExpiryDate Date

portDate Date

portInPacId Integer

dnoCode String For information only

dspCode String For information only

networkDetect Boolean If set to true, the port will be triggered by the user's first registration on the network

Port Detail (Provision)


msisdn String

portDate DateTime Either portDate or networkDetect must be provided

pacDetail Child Element

Ref: Pac Detail

networkDetect Boolean If set to true, the port is triggered by the user's first registration on the network

Gamma Limited |


of 140

Request


requestDate DateTime Should be in the following format:


responseDate DateTime Should be in the following format:


status Enum See Request Status for values

Roaming Bundle Package


euRoamingDataBoltOn Enum See EU Roaming Data Bolton for values

euRoamingDataBoltOnConnectionRebate boolean States if Connection Rebate is applied to the bolton

rowRoamingDataBoltOn Enum See ROW Roaming Data Bolton for values

rowRoamingDataBoltOnConnectionRebate boolean States if Connection Rebate is applied to the bolton

Roaming Configuration


notificationOptions Child Element

Ref: Notification Options

euRoamingMaxCharge Enum See EU Roaming Max Charges for values

rowRoamingMaxCharge Enum See ROW Roaming Max Charges for values

of 140

Gamma Limited |


Service


status Enum See Service Status for values

msisdn Child Element

Ref: MSISDN

usim Child Element

Ref: USIM

handset Child Element

Ref: Handset

tariff Child Element

Ref: Tariff

configuration Child Element

Ref: Configuration

advancedFunding Child Element

Ref: Advanced Funding

connectConfiguration Child Element

Ref: Connect Configuration

apnConfiguration Child Element


stacInData Child Element

Ref: STAC In Data

stacOutData ChildElement Ref: STAC Out Data





Gamma Limited |


of 140

STAC In Data


oldMsisdn String MSISDN of the service being terminated.

stac String

expiryDate DateTime Date the STAC expires

stacDate DateTime Date the transfer process completes

networkDetected Boolean If set to true, the transfer will be triggered by the user's first registration on the network

dnoCode String For information only

dspCode String For information only

STAC Out Data


stac String

ceaseDate DateTime Date the service will cease

expiryDate DateTime Date the STAC expires

STAC Detail (Provision)


oldMsisdn String MSISDN of the service being terminated.

stacDate DateTime Date the transfer process completes. Either stacDate or networkDetect must be provided.

stac String

networkDetect Boolean If set to true, the transfer is triggered by the user's first registration on the network

Tariff


type Yes Enum See Tariff Type for values

status No Enum See Tariff Status for values

startDate No DateTime

of 140

Gamma Limited |


USIM


iccid String

status Enum See USIM Status for values

type Enum See USIM Type for values

homeImsi String

roamingImsi String



operator Enum See Operator for values





pin1 String

pin2 String

puk1 String

puk2 String

Validation Error


errorCode String Error Code from Gamma system

message String Detailed error message

Gamma Limited |


of 140

Reference Data

Use this section to find the correct value for the service attributes, for example the bolt on code.

Linked to when necessary throughout the document.

NOTE: Gamma will always notify Channel Partners of any schema changes. However, it is

advisable to use the published XSD to ensure the latest Reference Data values are used.

XSD URL

http://ws.gammaoperations.com/mobile/v3/xsd/mobile-domain.xsd.xml

Advanced Funding Type

Value Description

LEVEL_1 Level 1 hardware funding credit



Bolt On

Value Description

DATA_2GB 2 GB Data PCM








DATA_150GB 150GB MBB Data



DATA_SHARER_ENABLER Data Sharer Enabler

GLOBAL_BUSINESS_DAILY Global Business Daily

INTERNATIONAL_VOICE_EUROPE_NORTH_AMERICA Intl Voice Europe & North America

INTERNATIONAL_VOICE_ROW Intl Voice Rest Of World

MULTINET MultiNet

ROW_BUSINESS_TRAVELLER ROW Business 7 day Traveller

http://ws.gammaoperations.com/mobile/v3/xsd/mobile-domain.xsd.xml

of 140

Gamma Limited |


Value Description

SMART_BUSINESS_PACK Smart Business Pack (combining: Non-Geographic 250, MMS 50 & International SMS 50)

SMS Business SMS 250

WORLDWIDE_DATA Worldwide Data 250MB

Connect Type

Value Description

M3H Horizon Connect

Connect Status

Value Description

ALLOCATED MSISDN has been assigned to a Horizon company

IN_USE MSISDN has been assigned to a Horizon user

EU Roaming Max Charge

Value Description

MC_004_4 0.044p charged per MB roamed in EU



MSISDN Status

Value Description

AVAILABLE Free to use for a new service provision

IN_USE Assigned to a live Gamma service

QUARANTINED MSISDN has been quarantined on the Gamma network

RESERVED_FOR_PORT_IN Being used for a Port In process

PORT_CANCELLED Port was cancelled, MSISDN back to normal usage

AVAILABLE_AS_SIM_SWAP_DUMMY Can be used as a placeholder during SIM swap

HOLDING_FOR_SIM_SWAP Being used for a SIM swap

PAIRED

NETWORK_ROUTED Configured for wholesale routing

Gamma Limited |


of 140

Network Bar

Value Description

VOICEMAIL Voicemail

INCOMING_CALLS Receive incoming calls

OUTGOING_CALLS Make outgoing calls

INCOMING_SMS Receive incoming SMS messages

Network Service

Value Description

DATA Mobile Data

DATA_WHEN_ROAMING Data Roaming

PREMIUM_CONTENT Premium Content

INTERNATIONAL_CALLING International Calling

INTERNATIONAL_ROAMING International Roaming

ADULT_CONTENT Adult Content Services

FOURTH_GENERATION 4G

Notification Option

Value Description

DATA_CAP Data Cap & Data Cap reached message

INITIAL_DATA Initial Data Notification message

PERCENTAGE_LIMIT_REACHED 80% Data Cap reached message

Operator

Value Description

VODAFONE Assigned to the Vodafone Network Operator

GAMMA Assigned to the Gamma Network Operator

STAC Status

of 140

Gamma Limited |


Value Description

OPEN STAC Entry is Open on MNP

CLOSED STAC Entry has been closed on MNP

LOCKED STAC Entry is locked on MNP

EXPIRED STAC Entry has gone beyond its expiry date

ARCHIVED STAC Entry has been archived on MNP

CANCELLED STAC Entry has been cancelled on MNP

Porting Status

Value Description

NO_PORT No Port requested on service

PORT_IN_CLOSED_SENT Request to Close the port has been sent to MNP

PORT_IN_LOCKED Port Entry has been Locked on MNP

PORTED_IN Port In has completed on all systems

PORT_OUT_PAC_ASSIGNED Service porting out as a PAC assigned to it

PORT_OUT_CLOSED Port Entry has been Closed on MNP

PORT_OUT_LOCKED Port Entry has been Locked on MNP

PORTED_OUT Port Out has completed on all systems

AWAITING_PORT_IN Waiting to Port In

SEND_PORT_IN_CLOSED Send a Close request to MNP for Port In

PORTING_FAILED Failure in the porting process

PORT_CANCELLED Port has been cancelled

AWAITING_PORT_OUT_RESUBMIT_TO_SPCONNECT

PORT_OUT_AUTO_LOCKED Port Out has been locked automatically on MNP

PENDING_VF_ON_NET_MIGRATION On Net Migration across VF network pending

FAILED_VF_ON_NET_MIGRATION On Net Migration across VF network failed

PENDING_EXPORT Export process pending

EXPORTED Export process completed

Gamma Limited |


of 140

Value Description

FAILED_RK_PORT_IN_SCHEDULE Port In process schedule failed on Redknee system

FAILED_RK_PORT_OUT_SCHEDULE Port Out process schedule failed on Redknee system

Repayment Period

Value Description

TWELVE_MONTHS 12 months

TWENTY_FOUR_MONTHS 24 months

THIRTY_SIX_MONTHS 36 months

Request Status

Value Description

PROCESSING Currently being processed

PENDING Waiting for a response

SUCCESSFUL Completed correctly

VALIDATION_FAILED Did not pass validation checks for operation type

NOT_FOUND Resource required could not be established

UNHANDLED_EXCEPTION An issue has occurred which was unforeseen by the system

ROW Roaming Max Charge

Value Description

MC_300_0 £3.00 charged per MB roamed when outside EU (ROW)







of 140

Gamma Limited |


Tariff Status

Tariff Type

Service Status

Value Description

SETUP Service is set up, occurs after provisioning

ACTIVE Service is active on Gamma network

CEASED Service has been ceased on the Gamma network

SUSPENDED Service is suspended on the Gamma network

PENDING A request for this service is currently being processed

PENDING_BATCH_PROCESSING Service is being prepared for a backend process

PAC_REQUESTED Service has been requested for exporting

ACTIVE_PENDING_PORT_IN Active but processing port in currently

NETWORK_ROUTED Configured for wholesale routing

USIM Status

Value Description

AVAILABLE Free to use for a new service provision

IN_USE Assigned to a live Gamma service

QUARANTINED USIM has been quarantined on the Gamma network

Value Description

ACTIVE Tariff is active

CEASED Tariff is no longer active

Value Description

BUSINESS_BASIC The Business Basic tariff

BUSINESS_EXTRA The Business Extra Unlimited Voice & SMS tariff

MOBILE_BROADBAND The Mobile Broadband (data only) tariff

MBB

Gamma Limited |


of 140

Value Description

AVAILABLE_AS_DUMMY Can be used as a placeholder during SIM swap

CEASED USIM has been ceased on the Gamma network

HOLDING_FOR_SIM_SWAP Being used for a SIM swap

PAIRED

USIM Type

Value Description

STANDARDSIM Original SIM card

MICROSIM Smaller version of a standard or mini SIM card

NANOSIM Smaller version of a micro SIM card

DUALSIM In some mobile devices two SIM cards can be used

TRIPLESIM In some mobile devices three SIM cards can be used

NON_MULTINET SIM that does not support multinet

of 140

Gamma Limited |


Schema

Name URL (on Test)

API

DOMAIN

REQUEST

ORDER

CONNECT

Glossary

Term Description

DSP Donating Service Provider

DNO Donating Network Operator

EU European Union

GB Giga Byte

HTTP Hyper Text Transfer Protocol

HTTPS Hyper Text Transfer Protocol Secure

BltOne///////////// The Integrated Circuit Card Identification is the USIM card serial number.

IMEI The International Mobile Equipment Identity is a unique fifteen-digit code used to identify a mobile device to a mobile network.

MB Mega Byte

MNP Multiple Number Porting - a central database that controls all ports between operators

Gamma Limited |


of 140

Term Description

MSISDN The Mobile Station Integrated Services Digital Network. Essentially the phone number

PAC Porting Authorisation Code.

PAYU Pay As You Use

PCM Per Calendar Month

PIN Personal Identification Number

ROW Rest of World

RSP Receiving Service Provider

SMS Short Messaging Service

STAC Service Termination Authorisation Code.

URL Uniform Resource Locator

USIM Universal Subscriber Identity Module

XML Extensible Markup Language

XSD Schema Definition

Contacts

Name OSS

Role Operational Support Team

[email protected]

Name Mobile

Role Development Team

[email protected]

of 140

Gamma Limited |


- END OF DOCUMENT -

Gamma Limited · 2020-03-23 · Synchronous vs Asynchronous Processing ... Update Notification...

Documents

Transcript of Gamma Limited · 2020-03-23 · Synchronous vs Asynchronous Processing ... Update Notification...