Magrathea REST API

Account

accountAddsipip

Add a SipIP to the account

/account/addsipip

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/addsipip"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        SipIPAddBody sipIPAddBody = ; // SipIPAddBody | IP Address to add
        try {
            Message result = apiInstance.accountAddsipip(sipIPAddBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountAddsipip");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        SipIPAddBody sipIPAddBody = ; // SipIPAddBody | IP Address to add
        try {
            Message result = apiInstance.accountAddsipip(sipIPAddBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountAddsipip");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

SipIPAddBody *sipIPAddBody = ; // IP Address to add

AccountApi *apiInstance = [[AccountApi alloc] init];

// Add a SipIP to the account
[apiInstance accountAddsipipWith:sipIPAddBody
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var sipIPAddBody = ; // {SipIPAddBody} IP Address to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountAddsipip(sipIPAddBody, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountAddsipipExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var sipIPAddBody = new SipIPAddBody(); // SipIPAddBody | IP Address to add

            try
            {
                // Add a SipIP to the account
                Message result = apiInstance.accountAddsipip(sipIPAddBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountAddsipip: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$sipIPAddBody = ; // SipIPAddBody | IP Address to add

try {
    $result = $api_instance->accountAddsipip($sipIPAddBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountAddsipip: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $sipIPAddBody = WWW::SwaggerClient::Object::SipIPAddBody->new(); # SipIPAddBody | IP Address to add

eval { 
    my $result = $api_instance->accountAddsipip(sipIPAddBody => $sipIPAddBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountAddsipip: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
sipIPAddBody =  # SipIPAddBody | IP Address to add

try: 
    # Add a SipIP to the account
    api_response = api_instance.account_addsipip(sipIPAddBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountAddsipip: %s\n" % e)

Parameters

Body parameters

Name	Description
sipIPAddBody *

Responses

Status: 200 - SipIP added

Schema
Response Example

[{accountnumber=111384, details=16, date=2121-04-23, accountnumberx=111384, amount=60}]

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 420 - Application error

Schema
Response Example

{error=420 - Reserved IP : 127.0.0.1}

Status: default - Unexpected error

Schema
Response Example

{error=An unknown error occurred, please contact Support if this continues}

accountBalance

Get an Account Balance

Output the balance of the account including the funds and promo funds.

/account/balance/{AccountNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/balance/{AccountNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            Balance result = apiInstance.accountBalance(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountBalance");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            Balance result = apiInstance.accountBalance(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountBalance");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountNumber = accountNumber_example; // Account number

AccountApi *apiInstance = [[AccountApi alloc] init];

// Get an Account Balance
[apiInstance accountBalanceWith:accountNumber
              completionHandler: ^(Balance output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var accountNumber = accountNumber_example; // {String} Account number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountBalance(accountNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountBalanceExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var accountNumber = accountNumber_example;  // String | Account number

            try
            {
                // Get an Account Balance
                Balance result = apiInstance.accountBalance(accountNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountBalance: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountNumber = accountNumber_example; // String | Account number

try {
    $result = $api_instance->accountBalance($accountNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountBalance: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $accountNumber = accountNumber_example; # String | Account number

eval { 
    my $result = $api_instance->accountBalance(accountNumber => $accountNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountBalance: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
accountNumber = accountNumber_example # String | Account number

try: 
    # Get an Account Balance
    api_response = api_instance.account_balance(accountNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountBalance: %s\n" % e)

Parameters

Path parameters

Name	Description
AccountNumber*	String Account number Required

Responses

{funds=100, promofunds=50}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountCdrs

Get Account CDRs

Output details of recent calls on the account.

/account/cdrs/{AccountNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/cdrs/{AccountNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            cdrs result = apiInstance.accountCdrs(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountCdrs");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            cdrs result = apiInstance.accountCdrs(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountCdrs");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountNumber = accountNumber_example; // Account number

AccountApi *apiInstance = [[AccountApi alloc] init];

// Get Account CDRs
[apiInstance accountCdrsWith:accountNumber
              completionHandler: ^(cdrs output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var accountNumber = accountNumber_example; // {String} Account number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountCdrs(accountNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountCdrsExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var accountNumber = accountNumber_example;  // String | Account number

            try
            {
                // Get Account CDRs
                cdrs result = apiInstance.accountCdrs(accountNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountCdrs: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountNumber = accountNumber_example; // String | Account number

try {
    $result = $api_instance->accountCdrs($accountNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountCdrs: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $accountNumber = accountNumber_example; # String | Account number

eval { 
    my $result = $api_instance->accountCdrs(accountNumber => $accountNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountCdrs: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
accountNumber = accountNumber_example # String | Account number

try: 
    # Get Account CDRs
    api_response = api_instance.account_cdrs(accountNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountCdrs: %s\n" % e)

Parameters

Path parameters

Name	Description
AccountNumber*	String Account number Required

Responses

Status: 200 - cdrs

Schema
Response Example

{calldate=14/02/2018, calltime=10:59:99, anumber=11555503450040040, bnumber=VOIP, origination=650, dialled=447481911562, destination=316, duration=110, debit=0.0026}

Status: 400 - No cdrs for this account

Schema
Response Example

{string=No CDRS for this account}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountDetail

Get Account Details

Display all the account details that are currently used in our communications.

/account/detail/{AccountNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/detail/{AccountNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            Detail result = apiInstance.accountDetail(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountDetail");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            Detail result = apiInstance.accountDetail(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountDetail");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountNumber = accountNumber_example; // Account number

AccountApi *apiInstance = [[AccountApi alloc] init];

// Get Account Details
[apiInstance accountDetailWith:accountNumber
              completionHandler: ^(Detail output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var accountNumber = accountNumber_example; // {String} Account number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountDetail(accountNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountDetailExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var accountNumber = accountNumber_example;  // String | Account number

            try
            {
                // Get Account Details
                Detail result = apiInstance.accountDetail(accountNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountDetail: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountNumber = accountNumber_example; // String | Account number

try {
    $result = $api_instance->accountDetail($accountNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountDetail: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $accountNumber = accountNumber_example; # String | Account number

eval { 
    my $result = $api_instance->accountDetail(accountNumber => $accountNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountDetail: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
accountNumber = accountNumber_example # String | Account number

try: 
    # Get Account Details
    api_response = api_instance.account_detail(accountNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountDetail: %s\n" % e)

Parameters

Path parameters

Name	Description
AccountNumber*	String Account number Required

Responses

Status: 200 - Detail

Schema
Response Example

{name=Test Account, company=Magrathea Test Account, addr1=8th Floor, Spider Place,Brighton, vat=BG12942392358, label=Golf Fund, email=accounts@test.com, acemail=accountspayables@test.com, frdmail=technicalsupport@test.com}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountGetlabel

Get account's label

/account/getlabel/{AccountNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/getlabel/{AccountNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            LabelR result = apiInstance.accountGetlabel(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountGetlabel");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            LabelR result = apiInstance.accountGetlabel(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountGetlabel");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountNumber = accountNumber_example; // Account number

AccountApi *apiInstance = [[AccountApi alloc] init];

// Get account's label
[apiInstance accountGetlabelWith:accountNumber
              completionHandler: ^(LabelR output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var accountNumber = accountNumber_example; // {String} Account number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountGetlabel(accountNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountGetlabelExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var accountNumber = accountNumber_example;  // String | Account number

            try
            {
                // Get account's label
                LabelR result = apiInstance.accountGetlabel(accountNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountGetlabel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountNumber = accountNumber_example; // String | Account number

try {
    $result = $api_instance->accountGetlabel($accountNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountGetlabel: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $accountNumber = accountNumber_example; # String | Account number

eval { 
    my $result = $api_instance->accountGetlabel(accountNumber => $accountNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountGetlabel: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
accountNumber = accountNumber_example # String | Account number

try: 
    # Get account's label
    api_response = api_instance.account_getlabel(accountNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountGetlabel: %s\n" % e)

Parameters

Path parameters

Name	Description
AccountNumber*	String Account number Required

Responses

Status: 200 - Account label

Schema
Response Example

{label=Golf Fund | <none>}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountGettariff

Get your tariff scheme

/account/gettariff/{AccountNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/gettariff/{AccountNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            TariffSchemeR result = apiInstance.accountGettariff(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountGettariff");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        try {
            TariffSchemeR result = apiInstance.accountGettariff(accountNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountGettariff");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountNumber = accountNumber_example; // Account number

AccountApi *apiInstance = [[AccountApi alloc] init];

// Get your tariff scheme
[apiInstance accountGettariffWith:accountNumber
              completionHandler: ^(TariffSchemeR output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var accountNumber = accountNumber_example; // {String} Account number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountGettariff(accountNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountGettariffExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var accountNumber = accountNumber_example;  // String | Account number

            try
            {
                // Get your tariff scheme
                TariffSchemeR result = apiInstance.accountGettariff(accountNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountGettariff: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountNumber = accountNumber_example; // String | Account number

try {
    $result = $api_instance->accountGettariff($accountNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountGettariff: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $accountNumber = accountNumber_example; # String | Account number

eval { 
    my $result = $api_instance->accountGettariff(accountNumber => $accountNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountGettariff: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
accountNumber = accountNumber_example # String | Account number

try: 
    # Get your tariff scheme
    api_response = api_instance.account_gettariff(accountNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountGettariff: %s\n" % e)

Parameters

Path parameters

Name	Description
AccountNumber*	String Account number Required

Responses

Status: 200 - Current band and restriction

Schema
Response Example

{band=GOLD, restriction=HIGH}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountListsipip

Display all IP addresses for an account

/account/listsipip

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/listsipip"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        SipIPListBody sipIPListBody = ; // SipIPListBody | List of account's IPs
        try {
            SipIPList result = apiInstance.accountListsipip(sipIPListBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountListsipip");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        SipIPListBody sipIPListBody = ; // SipIPListBody | List of account's IPs
        try {
            SipIPList result = apiInstance.accountListsipip(sipIPListBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountListsipip");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

SipIPListBody *sipIPListBody = ; // List of account's IPs

AccountApi *apiInstance = [[AccountApi alloc] init];

// Display all IP addresses for an account
[apiInstance accountListsipipWith:sipIPListBody
              completionHandler: ^(SipIPList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var sipIPListBody = ; // {SipIPListBody} List of account's IPs


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountListsipip(sipIPListBody, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountListsipipExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var sipIPListBody = new SipIPListBody(); // SipIPListBody | List of account's IPs

            try
            {
                // Display all IP addresses for an account
                SipIPList result = apiInstance.accountListsipip(sipIPListBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountListsipip: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$sipIPListBody = ; // SipIPListBody | List of account's IPs

try {
    $result = $api_instance->accountListsipip($sipIPListBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountListsipip: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $sipIPListBody = WWW::SwaggerClient::Object::SipIPListBody->new(); # SipIPListBody | List of account's IPs

eval { 
    my $result = $api_instance->accountListsipip(sipIPListBody => $sipIPListBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountListsipip: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
sipIPListBody =  # SipIPListBody | List of account's IPs

try: 
    # Display all IP addresses for an account
    api_response = api_instance.account_listsipip(sipIPListBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountListsipip: %s\n" % e)

Parameters

Body parameters

Name	Description
sipIPListBody *

Responses

Status: 200 - SipIP List

Schema
Response Example

[{ipaddress=0.0.0.13, to=16, accountnumber=111384}, {ipaddress=44.44.44.44, to=45, accountnumber=111384}]

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 420 - Application error

Schema
Response Example

{error=Illegal value 333 at octet 4}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountRemovesipip

Remove a SIP IP from the account

/account/removesipip

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/removesipip"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        SipIPRemoveBody sipIPRemoveBody = ; // SipIPRemoveBody | IP Address to remove
        try {
            Message result = apiInstance.accountRemovesipip(sipIPRemoveBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountRemovesipip");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        SipIPRemoveBody sipIPRemoveBody = ; // SipIPRemoveBody | IP Address to remove
        try {
            Message result = apiInstance.accountRemovesipip(sipIPRemoveBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountRemovesipip");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

SipIPRemoveBody *sipIPRemoveBody = ; // IP Address to remove

AccountApi *apiInstance = [[AccountApi alloc] init];

// Remove a SIP IP from the account
[apiInstance accountRemovesipipWith:sipIPRemoveBody
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var sipIPRemoveBody = ; // {SipIPRemoveBody} IP Address to remove


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountRemovesipip(sipIPRemoveBody, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountRemovesipipExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var sipIPRemoveBody = new SipIPRemoveBody(); // SipIPRemoveBody | IP Address to remove

            try
            {
                // Remove a SIP IP from the account
                Message result = apiInstance.accountRemovesipip(sipIPRemoveBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountRemovesipip: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$sipIPRemoveBody = ; // SipIPRemoveBody | IP Address to remove

try {
    $result = $api_instance->accountRemovesipip($sipIPRemoveBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountRemovesipip: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $sipIPRemoveBody = WWW::SwaggerClient::Object::SipIPRemoveBody->new(); # SipIPRemoveBody | IP Address to remove

eval { 
    my $result = $api_instance->accountRemovesipip(sipIPRemoveBody => $sipIPRemoveBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountRemovesipip: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
sipIPRemoveBody =  # SipIPRemoveBody | IP Address to remove

try: 
    # Remove a SIP IP from the account
    api_response = api_instance.account_removesipip(sipIPRemoveBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountRemovesipip: %s\n" % e)

Parameters

Body parameters

Name	Description
sipIPRemoveBody *

Responses

Status: 200 - SipIP removed

Schema
Response Example

{message=user123: 111384 remove 45.27.111.10-16, error=user123: 111384 remove 23.45.203.120-124 Not found 122 123}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 420 - Application error

Schema
Response Example

{error=Illegal value 333 at octet 4}

Status: default - Unexpected error

Schema
Response Example

{error=An unknown error occurred, please contact Support if this continues}

accountServices

Get Allowed Services

Display the services that the user has permissions for.

/account/services

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/services"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        try {
            Services result = apiInstance.accountServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountServices");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        try {
            Services result = apiInstance.accountServices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountServices");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];


AccountApi *apiInstance = [[AccountApi alloc] init];

// Get Allowed Services
[apiInstance accountServicesWithCompletionHandler: 
              ^(Services output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountServices(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountServicesExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();

            try
            {
                // Get Allowed Services
                Services result = apiInstance.accountServices();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountServices: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();

try {
    $result = $api_instance->accountServices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountServices: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();

eval { 
    my $result = $api_instance->accountServices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountServices: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()

try: 
    # Get Allowed Services
    api_response = api_instance.account_services()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountServices: %s\n" % e)

Parameters

Responses

Status: 200 - Services

Schema
Response Example

{CPORTAL=1, ACCMGMT=1, FTRANSFER=1, PORTING=1, NTSAPIUSER=fbloggs, MACCOUNT=113333, ACCOUNT=114444,115555, INVOICES=1, CP999=1, SIPAUTH=1}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountSetlabel

Set account's label

/account/setlabel/{AccountNumber}

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/setlabel/{AccountNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        LabelD label = ; // LabelD | Label
        try {
            LabelR result = apiInstance.accountSetlabel(accountNumber, label);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountSetlabel");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        LabelD label = ; // LabelD | Label
        try {
            LabelR result = apiInstance.accountSetlabel(accountNumber, label);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountSetlabel");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountNumber = accountNumber_example; // Account number
LabelD *label = ; // Label

AccountApi *apiInstance = [[AccountApi alloc] init];

// Set account's label
[apiInstance accountSetlabelWith:accountNumber
    label:label
              completionHandler: ^(LabelR output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var accountNumber = accountNumber_example; // {String} Account number

var label = ; // {LabelD} Label


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountSetlabel(accountNumber, label, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountSetlabelExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var accountNumber = accountNumber_example;  // String | Account number
            var label = new LabelD(); // LabelD | Label

            try
            {
                // Set account's label
                LabelR result = apiInstance.accountSetlabel(accountNumber, label);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountSetlabel: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountNumber = accountNumber_example; // String | Account number
$label = ; // LabelD | Label

try {
    $result = $api_instance->accountSetlabel($accountNumber, $label);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountSetlabel: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $accountNumber = accountNumber_example; # String | Account number
my $label = WWW::SwaggerClient::Object::LabelD->new(); # LabelD | Label

eval { 
    my $result = $api_instance->accountSetlabel(accountNumber => $accountNumber, label => $label);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountSetlabel: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
accountNumber = accountNumber_example # String | Account number
label =  # LabelD | Label

try: 
    # Set account's label
    api_response = api_instance.account_setlabel(accountNumber, label)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountSetlabel: %s\n" % e)

Parameters

Path parameters

Name	Description
AccountNumber*	String Account number Required

Body parameters

Name	Description
label *

Responses

Status: 200 - Account label

Schema
Response Example

{label=Tea & biscuits | <none> | ""}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 443 - Invalid Restriction

Schema
Response Example

{error=443 -  Invalid Restriction}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountSetsippw

Change the SIP password on an account

/account/setsippw

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/setsippw"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        SipSetPwBody sipSetPwBody = ; // SipSetPwBody | New SIP secret word
        try {
            Message result = apiInstance.accountSetsippw(sipSetPwBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountSetsippw");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        SipSetPwBody sipSetPwBody = ; // SipSetPwBody | New SIP secret word
        try {
            Message result = apiInstance.accountSetsippw(sipSetPwBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountSetsippw");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

SipSetPwBody *sipSetPwBody = ; // New SIP secret word

AccountApi *apiInstance = [[AccountApi alloc] init];

// Change the SIP password on an account
[apiInstance accountSetsippwWith:sipSetPwBody
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var sipSetPwBody = ; // {SipSetPwBody} New SIP secret word


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountSetsippw(sipSetPwBody, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountSetsippwExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var sipSetPwBody = new SipSetPwBody(); // SipSetPwBody | New SIP secret word

            try
            {
                // Change the SIP password on an account
                Message result = apiInstance.accountSetsippw(sipSetPwBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountSetsippw: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$sipSetPwBody = ; // SipSetPwBody | New SIP secret word

try {
    $result = $api_instance->accountSetsippw($sipSetPwBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountSetsippw: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $sipSetPwBody = WWW::SwaggerClient::Object::SipSetPwBody->new(); # SipSetPwBody | New SIP secret word

eval { 
    my $result = $api_instance->accountSetsippw(sipSetPwBody => $sipSetPwBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountSetsippw: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
sipSetPwBody =  # SipSetPwBody | New SIP secret word

try: 
    # Change the SIP password on an account
    api_response = api_instance.account_setsippw(sipSetPwBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountSetsippw: %s\n" % e)

Parameters

Body parameters

Name	Description
sipSetPwBody *

Responses

Status: 200 - SIP password changed

Schema
Response Example

{message=SIP password change}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 420 - Application error

Schema
Response Example

{error=420 - No Sip Reg User: joanb 111390}

Status: default - Unexpected error

Schema
Response Example

{error=An unknown error occurred, please contact Support if this continues}

accountSettariff

Set your tariff restriction

/account/settariff/{AccountNumber}/

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/settariff/{AccountNumber}/"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        RestrictionD restriction = ; // RestrictionD | Restriction level
        try {
            TariffSchemeR result = apiInstance.accountSettariff(accountNumber, restriction);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountSettariff");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String accountNumber = accountNumber_example; // String | Account number
        RestrictionD restriction = ; // RestrictionD | Restriction level
        try {
            TariffSchemeR result = apiInstance.accountSettariff(accountNumber, restriction);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountSettariff");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountNumber = accountNumber_example; // Account number
RestrictionD *restriction = ; // Restriction level

AccountApi *apiInstance = [[AccountApi alloc] init];

// Set your tariff restriction
[apiInstance accountSettariffWith:accountNumber
    restriction:restriction
              completionHandler: ^(TariffSchemeR output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var accountNumber = accountNumber_example; // {String} Account number

var restriction = ; // {RestrictionD} Restriction level


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountSettariff(accountNumber, restriction, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountSettariffExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var accountNumber = accountNumber_example;  // String | Account number
            var restriction = new RestrictionD(); // RestrictionD | Restriction level

            try
            {
                // Set your tariff restriction
                TariffSchemeR result = apiInstance.accountSettariff(accountNumber, restriction);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountSettariff: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountNumber = accountNumber_example; // String | Account number
$restriction = ; // RestrictionD | Restriction level

try {
    $result = $api_instance->accountSettariff($accountNumber, $restriction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountSettariff: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $accountNumber = accountNumber_example; # String | Account number
my $restriction = WWW::SwaggerClient::Object::RestrictionD->new(); # RestrictionD | Restriction level

eval { 
    my $result = $api_instance->accountSettariff(accountNumber => $accountNumber, restriction => $restriction);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountSettariff: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
accountNumber = accountNumber_example # String | Account number
restriction =  # RestrictionD | Restriction level

try: 
    # Set your tariff restriction
    api_response = api_instance.account_settariff(accountNumber, restriction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountSettariff: %s\n" % e)

Parameters

Path parameters

Name	Description
AccountNumber*	String Account number Required

Body parameters

Name	Description
restriction *

Responses

Status: 200 - Tariff restriction set

Schema
Response Example

{band=DIRECT', restriction=NONE}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 443 - Invalid Restriction

Schema
Response Example

{error=443 -  Invalid Restriction}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountTransfer

Transfer Funds Between Accounts

Transfer funds between accounts.

/account/transfer/{AccountFrom}/{AccountTo}/{Funds}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/transfer/{AccountFrom}/{AccountTo}/{Funds}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        String accountFrom = accountFrom_example; // String | An account number to transfer funds from
        String accountTo = accountTo_example; // String | An account number to transfer funds to
        BigDecimal funds = 3.4; // BigDecimal | Amount of funds to transfer
        try {
            Transfer result = apiInstance.accountTransfer(accountFrom, accountTo, funds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountTransfer");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String accountFrom = accountFrom_example; // String | An account number to transfer funds from
        String accountTo = accountTo_example; // String | An account number to transfer funds to
        BigDecimal funds = 3.4; // BigDecimal | Amount of funds to transfer
        try {
            Transfer result = apiInstance.accountTransfer(accountFrom, accountTo, funds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountTransfer");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *accountFrom = accountFrom_example; // An account number to transfer funds from
String *accountTo = accountTo_example; // An account number to transfer funds to
BigDecimal *funds = 3.4; // Amount of funds to transfer

AccountApi *apiInstance = [[AccountApi alloc] init];

// Transfer Funds Between Accounts
[apiInstance accountTransferWith:accountFrom
    accountTo:accountTo
    funds:funds
              completionHandler: ^(Transfer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var accountFrom = accountFrom_example; // {String} An account number to transfer funds from

var accountTo = accountTo_example; // {String} An account number to transfer funds to

var funds = 3.4; // {BigDecimal} Amount of funds to transfer


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountTransfer(accountFrom, accountTo, funds, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountTransferExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var accountFrom = accountFrom_example;  // String | An account number to transfer funds from
            var accountTo = accountTo_example;  // String | An account number to transfer funds to
            var funds = 3.4;  // BigDecimal | Amount of funds to transfer

            try
            {
                // Transfer Funds Between Accounts
                Transfer result = apiInstance.accountTransfer(accountFrom, accountTo, funds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountTransfer: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$accountFrom = accountFrom_example; // String | An account number to transfer funds from
$accountTo = accountTo_example; // String | An account number to transfer funds to
$funds = 3.4; // BigDecimal | Amount of funds to transfer

try {
    $result = $api_instance->accountTransfer($accountFrom, $accountTo, $funds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountTransfer: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $accountFrom = accountFrom_example; # String | An account number to transfer funds from
my $accountTo = accountTo_example; # String | An account number to transfer funds to
my $funds = 3.4; # BigDecimal | Amount of funds to transfer

eval { 
    my $result = $api_instance->accountTransfer(accountFrom => $accountFrom, accountTo => $accountTo, funds => $funds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountTransfer: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
accountFrom = accountFrom_example # String | An account number to transfer funds from
accountTo = accountTo_example # String | An account number to transfer funds to
funds = 3.4 # BigDecimal | Amount of funds to transfer

try: 
    # Transfer Funds Between Accounts
    api_response = api_instance.account_transfer(accountFrom, accountTo, funds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountTransfer: %s\n" % e)

Parameters

Path parameters

Name	Description
AccountFrom*	String An account number to transfer funds from Required
AccountTo*	String An account number to transfer funds to Required
Funds*	BigDecimal (int10) Amount of funds to transfer Required

Responses

Status: 200 - Transfer

Schema
Response Example

{transfer=OK}

Status: 400 - Failed

Schema
Response Example

{message=Not enough funds to transfer}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema
Response Example

{message=An unknown error occurred, please contact Support if this continues}

accountTransferhistory

Show fund transfers on one or more of user's accounts

/account/transferhistory

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/account/transferhistory"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountApi;

import java.io.File;
import java.util.*;

public class AccountApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AccountApi apiInstance = new AccountApi();
        TransferHistoryBParams transferHistoryBParams = ; // TransferHistoryBParams | Transfer History params
        try {
            TransferHistoryList result = apiInstance.accountTransferhistory(transferHistoryBParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountTransferhistory");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        TransferHistoryBParams transferHistoryBParams = ; // TransferHistoryBParams | Transfer History params
        try {
            TransferHistoryList result = apiInstance.accountTransferhistory(transferHistoryBParams);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountTransferhistory");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

TransferHistoryBParams *transferHistoryBParams = ; // Transfer History params

AccountApi *apiInstance = [[AccountApi alloc] init];

// Show fund transfers on one or more of user's accounts
[apiInstance accountTransferhistoryWith:transferHistoryBParams
              completionHandler: ^(TransferHistoryList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.AccountApi()

var transferHistoryBParams = ; // {TransferHistoryBParams} Transfer History params


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountTransferhistory(transferHistoryBParams, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class accountTransferhistoryExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountApi();
            var transferHistoryBParams = new TransferHistoryBParams(); // TransferHistoryBParams | Transfer History params

            try
            {
                // Show fund transfers on one or more of user's accounts
                TransferHistoryList result = apiInstance.accountTransferhistory(transferHistoryBParams);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.accountTransferhistory: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AccountApi();
$transferHistoryBParams = ; // TransferHistoryBParams | Transfer History params

try {
    $result = $api_instance->accountTransferhistory($transferHistoryBParams);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountTransferhistory: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AccountApi->new();
my $transferHistoryBParams = WWW::SwaggerClient::Object::TransferHistoryBParams->new(); # TransferHistoryBParams | Transfer History params

eval { 
    my $result = $api_instance->accountTransferhistory(transferHistoryBParams => $transferHistoryBParams);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->accountTransferhistory: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AccountApi()
transferHistoryBParams =  # TransferHistoryBParams | Transfer History params

try: 
    # Show fund transfers on one or more of user's accounts
    api_response = api_instance.account_transferhistory(transferHistoryBParams)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->accountTransferhistory: %s\n" % e)

Parameters

Body parameters

Name	Description
transferHistoryBParams *

Responses

Status: 200 - Transactions

Schema
Response Example

[{date=2021-10-14, time=17:58, fromaccount=111384, toaccount=111582, amount=80, transferredby=Either 'Client' or 'Magrathea'}]

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 420 - Application error

Schema
Response Example

{error=420 - Invalid date range}

Status: default - Unexpected error

Schema
Response Example

{error=An unknown error occurred, please contact Support if this continues}

Block

blockActivate

Allocate a number or range of numbers

Search the specified number range and attempt to allocate a block of numbers of the requested size to your account.

/block/activate/{NumberRange}/{size}

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/block/activate/{NumberRange}/{size}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlockApi;

import java.io.File;
import java.util.*;

public class BlockApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        BlockApi apiInstance = new BlockApi();
        String numberRange = numberRange_example; // String | A range to find allocatable numbers within
        BigDecimal size = 3.4; // BigDecimal | The size of the range of numbers to allocate
        try {
            NumberRange result = apiInstance.blockActivate(numberRange, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlockApi#blockActivate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BlockApi;

public class BlockApiExample {

    public static void main(String[] args) {
        BlockApi apiInstance = new BlockApi();
        String numberRange = numberRange_example; // String | A range to find allocatable numbers within
        BigDecimal size = 3.4; // BigDecimal | The size of the range of numbers to allocate
        try {
            NumberRange result = apiInstance.blockActivate(numberRange, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlockApi#blockActivate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *numberRange = numberRange_example; // A range to find allocatable numbers within
BigDecimal *size = 3.4; // The size of the range of numbers to allocate

BlockApi *apiInstance = [[BlockApi alloc] init];

// Allocate a number or range of numbers
[apiInstance blockActivateWith:numberRange
    size:size
              completionHandler: ^(NumberRange output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.BlockApi()

var numberRange = numberRange_example; // {String} A range to find allocatable numbers within

var size = 3.4; // {BigDecimal} The size of the range of numbers to allocate


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.blockActivate(numberRange, size, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class blockActivateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new BlockApi();
            var numberRange = numberRange_example;  // String | A range to find allocatable numbers within
            var size = 3.4;  // BigDecimal | The size of the range of numbers to allocate

            try
            {
                // Allocate a number or range of numbers
                NumberRange result = apiInstance.blockActivate(numberRange, size);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlockApi.blockActivate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\BlockApi();
$numberRange = numberRange_example; // String | A range to find allocatable numbers within
$size = 3.4; // BigDecimal | The size of the range of numbers to allocate

try {
    $result = $api_instance->blockActivate($numberRange, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlockApi->blockActivate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlockApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::BlockApi->new();
my $numberRange = numberRange_example; # String | A range to find allocatable numbers within
my $size = 3.4; # BigDecimal | The size of the range of numbers to allocate

eval { 
    my $result = $api_instance->blockActivate(numberRange => $numberRange, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlockApi->blockActivate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BlockApi()
numberRange = numberRange_example # String | A range to find allocatable numbers within
size = 3.4 # BigDecimal | The size of the range of numbers to allocate

try: 
    # Allocate a number or range of numbers
    api_response = api_instance.block_activate(numberRange, size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlockApi->blockActivate: %s\n" % e)

Parameters

Path parameters

Name	Description
NumberRange*	String A range to find allocatable numbers within Required
size*	BigDecimal The size of the range of numbers to allocate Required

Responses

Status: 200 - Numbers allocated

Schema
Response Example

{start=03450040040, end=03450040043}

Status: 400 - Not a Block

Schema
Response Example

{code=1, ntsapiresponse=Not a Block, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 406 - Unable to allocate a block

Schema
Response Example

{code=1, message=Unable to allocate a block}

Status: default - Unexpected error

Schema

blockDeactivate

Deactivate a block

Deactivate and return a block of numbers. You must pass in the first number of the block.

/block/deactivate/{FullNumber}

Usage and SDK Samples

Curl

curl -X DELETE -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/block/deactivate/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlockApi;

import java.io.File;
import java.util.*;

public class BlockApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        BlockApi apiInstance = new BlockApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            apiInstance.blockDeactivate(fullNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlockApi#blockDeactivate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BlockApi;

public class BlockApiExample {

    public static void main(String[] args) {
        BlockApi apiInstance = new BlockApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            apiInstance.blockDeactivate(fullNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlockApi#blockDeactivate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

BlockApi *apiInstance = [[BlockApi alloc] init];

// Deactivate a block
[apiInstance blockDeactivateWith:fullNumber
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.BlockApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.blockDeactivate(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class blockDeactivateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new BlockApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Deactivate a block
                apiInstance.blockDeactivate(fullNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlockApi.blockDeactivate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\BlockApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $api_instance->blockDeactivate($fullNumber);
} catch (Exception $e) {
    echo 'Exception when calling BlockApi->blockDeactivate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlockApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::BlockApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    $api_instance->blockDeactivate(fullNumber => $fullNumber);
};
if ($@) {
    warn "Exception when calling BlockApi->blockDeactivate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BlockApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Deactivate a block
    api_instance.block_deactivate(fullNumber)
except ApiException as e:
    print("Exception when calling BlockApi->blockDeactivate: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Number deactivated

Status: 400 - Not a block

Schema
Response Example

{code=1, ntsapiresponse=Not a block, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

blockInfo

Determine if a number is part of a block

Determine if the number given is part of a block. If it is, then the first number and size of the block are returned.

/block/info/{FullNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/block/info/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlockApi;

import java.io.File;
import java.util.*;

public class BlockApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        BlockApi apiInstance = new BlockApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            NumberInfo result = apiInstance.blockInfo(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlockApi#blockInfo");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BlockApi;

public class BlockApiExample {

    public static void main(String[] args) {
        BlockApi apiInstance = new BlockApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            NumberInfo result = apiInstance.blockInfo(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlockApi#blockInfo");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

BlockApi *apiInstance = [[BlockApi alloc] init];

// Determine if a number is part of a block
[apiInstance blockInfoWith:fullNumber
              completionHandler: ^(NumberInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.BlockApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.blockInfo(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class blockInfoExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new BlockApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Determine if a number is part of a block
                NumberInfo result = apiInstance.blockInfo(fullNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlockApi.blockInfo: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\BlockApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $result = $api_instance->blockInfo($fullNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlockApi->blockInfo: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlockApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::BlockApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    my $result = $api_instance->blockInfo(fullNumber => $fullNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlockApi->blockInfo: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BlockApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Determine if a number is part of a block
    api_response = api_instance.block_info(fullNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlockApi->blockInfo: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Number Information

Schema
Response Example

{start=03450040040, size=10}

Status: 400 - Not a Block

Schema
Response Example

{code=1, ntsapiresponse=Permission denied, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 404 - Number Not found

Schema

Status: default - Unexpected error

Schema

blockReactivate

Attempt to reactivate a block

Try to reactivate a block you have deactivated. Will only succeed if no numbers in the block have since been reallocated to other clients.

/block/reactivate/{FullNumber}

Usage and SDK Samples

Curl

curl -X PUT -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/block/reactivate/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlockApi;

import java.io.File;
import java.util.*;

public class BlockApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        BlockApi apiInstance = new BlockApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            NumberInfo result = apiInstance.blockReactivate(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlockApi#blockReactivate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BlockApi;

public class BlockApiExample {

    public static void main(String[] args) {
        BlockApi apiInstance = new BlockApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            NumberInfo result = apiInstance.blockReactivate(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlockApi#blockReactivate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

BlockApi *apiInstance = [[BlockApi alloc] init];

// Attempt to reactivate a block
[apiInstance blockReactivateWith:fullNumber
              completionHandler: ^(NumberInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.BlockApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.blockReactivate(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class blockReactivateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new BlockApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Attempt to reactivate a block
                NumberInfo result = apiInstance.blockReactivate(fullNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlockApi.blockReactivate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\BlockApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $result = $api_instance->blockReactivate($fullNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlockApi->blockReactivate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlockApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::BlockApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    my $result = $api_instance->blockReactivate(fullNumber => $fullNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlockApi->blockReactivate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.BlockApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Attempt to reactivate a block
    api_response = api_instance.block_reactivate(fullNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlockApi->blockReactivate: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Number reactivated

Schema
Response Example

{start=03450040040, size=10}

Status: 400 - Not a block

Schema
Response Example

{code=1, ntsapiresponse=Not a block, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

Nine

nineAddress

Set an address value for a 999 number

The following options are available for storing name and address details for a 999 number.

/nine/nineaddress/{FullNumber}/{NineAddressItem}/{NineAddressValue}

Usage and SDK Samples

Curl

curl -X PUT -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/nine/nineaddress/{FullNumber}/{NineAddressItem}/{NineAddressValue}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NineApi;

import java.io.File;
import java.util.*;

public class NineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        String nineAddressItem = nineAddressItem_example; // String | [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY]
        String nineAddressValue = nineAddressValue_example; // String | NineaddressValue
        try {
            Nineapidetails result = apiInstance.nineAddress(fullNumber, nineAddressItem, nineAddressValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineAddress");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NineApi;

public class NineApiExample {

    public static void main(String[] args) {
        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        String nineAddressItem = nineAddressItem_example; // String | [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY]
        String nineAddressValue = nineAddressValue_example; // String | NineaddressValue
        try {
            Nineapidetails result = apiInstance.nineAddress(fullNumber, nineAddressItem, nineAddressValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineAddress");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question
String *nineAddressItem = nineAddressItem_example; // [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY]
String *nineAddressValue = nineAddressValue_example; // NineaddressValue

NineApi *apiInstance = [[NineApi alloc] init];

// Set an address value for a 999 number
[apiInstance nineAddressWith:fullNumber
    nineAddressItem:nineAddressItem
    nineAddressValue:nineAddressValue
              completionHandler: ^(Nineapidetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NineApi()

var fullNumber = fullNumber_example; // {String} The number in question

var nineAddressItem = nineAddressItem_example; // {String} [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY]

var nineAddressValue = nineAddressValue_example; // {String} NineaddressValue


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.nineAddress(fullNumber, nineAddressItem, nineAddressValue, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nineAddressExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NineApi();
            var fullNumber = fullNumber_example;  // String | The number in question
            var nineAddressItem = nineAddressItem_example;  // String | [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY]
            var nineAddressValue = nineAddressValue_example;  // String | NineaddressValue

            try
            {
                // Set an address value for a 999 number
                Nineapidetails result = apiInstance.nineAddress(fullNumber, nineAddressItem, nineAddressValue);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NineApi.nineAddress: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NineApi();
$fullNumber = fullNumber_example; // String | The number in question
$nineAddressItem = nineAddressItem_example; // String | [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY]
$nineAddressValue = nineAddressValue_example; // String | NineaddressValue

try {
    $result = $api_instance->nineAddress($fullNumber, $nineAddressItem, $nineAddressValue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NineApi->nineAddress: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NineApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NineApi->new();
my $fullNumber = fullNumber_example; # String | The number in question
my $nineAddressItem = nineAddressItem_example; # String | [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY]
my $nineAddressValue = nineAddressValue_example; # String | NineaddressValue

eval { 
    my $result = $api_instance->nineAddress(fullNumber => $fullNumber, nineAddressItem => $nineAddressItem, nineAddressValue => $nineAddressValue);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NineApi->nineAddress: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NineApi()
fullNumber = fullNumber_example # String | The number in question
nineAddressItem = nineAddressItem_example # String | [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY]
nineAddressValue = nineAddressValue_example # String | NineaddressValue

try: 
    # Set an address value for a 999 number
    api_response = api_instance.nine_address(fullNumber, nineAddressItem, nineAddressValue)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NineApi->nineAddress: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required
NineAddressItem*	String [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE],[Ireland:: UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY] Required
NineAddressValue*	String NineaddressValue Required

Responses

Status: 200 - Information updated

Schema
Response Example

{number=0 Information updated}

Status: 400 - Update failed; Invalid keyword

Schema
Response Example

{code=1, ntsapirespone=Invalid nineaddress feature supplied. Valid values: [UK:: TITLE,FORENAME,NAME,HONOURS,BUSSUFFIX,PREMISES,THOROUGHFARE,LOCALITY,POSTCODE] [Ireland:: ,UNITNO,UNITNAME,UNITFLOOR,PREMISES,STREETNUM,THOROUGHFARE,TOWN,COUNTY], message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

nineCreate

Attempt to create a 999 record for the number given

Create a new 999 record for the number given. This must be used before any other 999 requests, and should only be used once. This does not affect the status of any existing data.

/nine/create/{FullNumber}

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/nine/create/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NineApi;

import java.io.File;
import java.util.*;

public class NineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Nineapidetails result = apiInstance.nineCreate(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineCreate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NineApi;

public class NineApiExample {

    public static void main(String[] args) {
        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Nineapidetails result = apiInstance.nineCreate(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineCreate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

NineApi *apiInstance = [[NineApi alloc] init];

// Attempt to create a 999 record for the number given
[apiInstance nineCreateWith:fullNumber
              completionHandler: ^(Nineapidetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NineApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.nineCreate(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nineCreateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NineApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Attempt to create a 999 record for the number given
                Nineapidetails result = apiInstance.nineCreate(fullNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NineApi.nineCreate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NineApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $result = $api_instance->nineCreate($fullNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NineApi->nineCreate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NineApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NineApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    my $result = $api_instance->nineCreate(fullNumber => $fullNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NineApi->nineCreate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NineApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Attempt to create a 999 record for the number given
    api_response = api_instance.nine_create(fullNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NineApi->nineCreate: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Record created

Schema
Response Example

{number=0 Record Created}

Status: 400 - Number not valid or Create failed

Schema
Response Example

{ntsapirespone=[1.'Create failed (Record Exists)', 1. 'Number not valid'], message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

nineDataj

Retrieve current data for number stored

Retrieve the current 999 data stored for the number.

/nine/dataj/{FullNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/nine/dataj/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NineApi;

import java.io.File;
import java.util.*;

public class NineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Nineaddressdetails result = apiInstance.nineDataj(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineDataj");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NineApi;

public class NineApiExample {

    public static void main(String[] args) {
        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Nineaddressdetails result = apiInstance.nineDataj(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineDataj");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

NineApi *apiInstance = [[NineApi alloc] init];

// Retrieve current data for number stored
[apiInstance nineDatajWith:fullNumber
              completionHandler: ^(Nineaddressdetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NineApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.nineDataj(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nineDatajExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NineApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Retrieve current data for number stored
                Nineaddressdetails result = apiInstance.nineDataj(fullNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NineApi.nineDataj: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NineApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $result = $api_instance->nineDataj($fullNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NineApi->nineDataj: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NineApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NineApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    my $result = $api_instance->nineDataj(fullNumber => $fullNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NineApi->nineDataj: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NineApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Retrieve current data for number stored
    api_response = api_instance.nine_dataj(fullNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NineApi->nineDataj: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Information Retrieved

Schema
Response Example

 **UK** "TITLE": "Mrs", "FORENAME": "Dorothea", "NAME": "Smith", "HONOURS": "OBE", "BUSSUFFIX": "Ltd", "PREMISES": "5 Commerce Park", "THOROUGHFARE": "Brunel Road", "LOCALITY": "Theale, Berkshire", "POSTCODE": "RG7 4AB"
, **Ireland** "UNITNO": "243", "UNITNAME": "Office", "UNITFLOOR": "3", "PREMISES": "Central Towers", "STREETNUM": "394", "THOROUGHFARE": "O'Grady Avenue", "TOWN": "Galway", "COUNTY": "Connacht"

Status: 400 - Number not valid or no record found

Schema
Response Example

{code=1, ntsapirespone=-9 No record found, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

nineStatus

Retrieve the status of 999 data for the number

Retrieve the status of submission for the number. A variety of responses are possible.

/nine/status/{FullNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/nine/status/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NineApi;

import java.io.File;
import java.util.*;

public class NineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Nineapidetails result = apiInstance.nineStatus(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NineApi;

public class NineApiExample {

    public static void main(String[] args) {
        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Nineapidetails result = apiInstance.nineStatus(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

NineApi *apiInstance = [[NineApi alloc] init];

// Retrieve the status of 999 data for the number
[apiInstance nineStatusWith:fullNumber
              completionHandler: ^(Nineapidetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NineApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.nineStatus(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nineStatusExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NineApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Retrieve the status of 999 data for the number
                Nineapidetails result = apiInstance.nineStatus(fullNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NineApi.nineStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NineApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $result = $api_instance->nineStatus($fullNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NineApi->nineStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NineApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NineApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    my $result = $api_instance->nineStatus(fullNumber => $fullNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NineApi->nineStatus: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NineApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Retrieve the status of 999 data for the number
    api_response = api_instance.nine_status(fullNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NineApi->nineStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Accepted

Schema
Response Example

{number=2 Info awaiting further validation}

Status: 400 - Status of numbers

Schema
Response Example

{code=1, ntsapirespone=[1. Info received , 2. Info awaiting further validation, 3. Info submitted, 6. Submitted Awaiting manual processing, 8. Rejected (message), 9. No record found], message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

nineValidate

Attempt to validate the 999 data previously submitted for the number

Commence the actual data submission process. Before using this request, you should ensure that the data provided in all fields is present and correct.

/nine/validate/{FullNumber}

Usage and SDK Samples

Curl

curl -X PUT -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/nine/validate/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NineApi;

import java.io.File;
import java.util.*;

public class NineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Nineapidetails result = apiInstance.nineValidate(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineValidate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NineApi;

public class NineApiExample {

    public static void main(String[] args) {
        NineApi apiInstance = new NineApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Nineapidetails result = apiInstance.nineValidate(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NineApi#nineValidate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

NineApi *apiInstance = [[NineApi alloc] init];

// Attempt to validate the 999 data previously submitted for the number
[apiInstance nineValidateWith:fullNumber
              completionHandler: ^(Nineapidetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NineApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.nineValidate(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class nineValidateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NineApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Attempt to validate the 999 data previously submitted for the number
                Nineapidetails result = apiInstance.nineValidate(fullNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NineApi.nineValidate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NineApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $result = $api_instance->nineValidate($fullNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NineApi->nineValidate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NineApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NineApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    my $result = $api_instance->nineValidate(fullNumber => $fullNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NineApi->nineValidate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NineApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Attempt to validate the 999 data previously submitted for the number
    api_response = api_instance.nine_validate(fullNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NineApi->nineValidate: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Information Valid

Schema

Status: 400 - Validation State

Schema
Response Example

{code=1, ntsapirespone=example - '1. Number not valid' - '9. No record found', message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

Number

numberActivate

Activate a number

Activate a number obtained using the allocate request.

/number/activate/{FullNumber}

Usage and SDK Samples

Curl

curl -X PUT -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/activate/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            apiInstance.numberActivate(fullNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberActivate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            apiInstance.numberActivate(fullNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberActivate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

NumberApi *apiInstance = [[NumberApi alloc] init];

// Activate a number
[apiInstance numberActivateWith:fullNumber
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.numberActivate(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberActivateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Activate a number
                apiInstance.numberActivate(fullNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberActivate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $api_instance->numberActivate($fullNumber);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberActivate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    $api_instance->numberActivate(fullNumber => $fullNumber);
};
if ($@) {
    warn "Exception when calling NumberApi->numberActivate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Activate a number
    api_instance.number_activate(fullNumber)
except ApiException as e:
    print("Exception when calling NumberApi->numberActivate: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Number activated

Status: 400 - Number not activated

Schema
Response Example

{code=1, ntsapiresponse=Number not activated, message=NTSAPI returned an unexpected error code}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

numberAlist

Lists a number or range of numbers.

Provide a selection of available numbers, from the range requested, to enable a choice of numbers to allocate.

/number/alist/{NumberRange}/{size}

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/alist/{NumberRange}/{size}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String numberRange = numberRange_example; // String | A range to find allocatable numbers within
        BigDecimal size = 3.4; // BigDecimal | The size of the range of numbers to allocate
        try {
            Numbers result = apiInstance.numberAlist(numberRange, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberAlist");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String numberRange = numberRange_example; // String | A range to find allocatable numbers within
        BigDecimal size = 3.4; // BigDecimal | The size of the range of numbers to allocate
        try {
            Numbers result = apiInstance.numberAlist(numberRange, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberAlist");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *numberRange = numberRange_example; // A range to find allocatable numbers within
BigDecimal *size = 3.4; // The size of the range of numbers to allocate

NumberApi *apiInstance = [[NumberApi alloc] init];

// Lists a number or range of numbers.
[apiInstance numberAlistWith:numberRange
    size:size
              completionHandler: ^(Numbers output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var numberRange = numberRange_example; // {String} A range to find allocatable numbers within

var size = 3.4; // {BigDecimal} The size of the range of numbers to allocate


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.numberAlist(numberRange, size, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberAlistExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var numberRange = numberRange_example;  // String | A range to find allocatable numbers within
            var size = 3.4;  // BigDecimal | The size of the range of numbers to allocate

            try
            {
                // Lists a number or range of numbers.
                Numbers result = apiInstance.numberAlist(numberRange, size);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberAlist: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$numberRange = numberRange_example; // String | A range to find allocatable numbers within
$size = 3.4; // BigDecimal | The size of the range of numbers to allocate

try {
    $result = $api_instance->numberAlist($numberRange, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberAlist: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $numberRange = numberRange_example; # String | A range to find allocatable numbers within
my $size = 3.4; # BigDecimal | The size of the range of numbers to allocate

eval { 
    my $result = $api_instance->numberAlist(numberRange => $numberRange, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NumberApi->numberAlist: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
numberRange = numberRange_example # String | A range to find allocatable numbers within
size = 3.4 # BigDecimal | The size of the range of numbers to allocate

try: 
    # Lists a number or range of numbers.
    api_response = api_instance.number_alist(numberRange, size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NumberApi->numberAlist: %s\n" % e)

Parameters

Path parameters

Name	Description
NumberRange*	String A range to find allocatable numbers within Required
size*	BigDecimal The size of the range of numbers to allocate Required

Responses

Status: 200 - Numbers offered

Schema
Response Example

{string=03450040040,03450040041,03450040042}

Status: 400 - Invalid

Schema
Response Example

{code=2, ntsapiresponse=Size 0 is invalid, message=NTSAPI returned an unexpected error code'}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

numberAllocate

Allocate a number

Attempt to allocate a phone number.

/number/allocate/{PartialNumber}

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/allocate/{PartialNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String partialNumber = partialNumber_example; // String | A partial number to allocate, underscores should be used to declare wildcard spaces
        try {
            FullNumber result = apiInstance.numberAllocate(partialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberAllocate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String partialNumber = partialNumber_example; // String | A partial number to allocate, underscores should be used to declare wildcard spaces
        try {
            FullNumber result = apiInstance.numberAllocate(partialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberAllocate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *partialNumber = partialNumber_example; // A partial number to allocate, underscores should be used to declare wildcard spaces

NumberApi *apiInstance = [[NumberApi alloc] init];

// Allocate a number
[apiInstance numberAllocateWith:partialNumber
              completionHandler: ^(FullNumber output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var partialNumber = partialNumber_example; // {String} A partial number to allocate, underscores should be used to declare wildcard spaces


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.numberAllocate(partialNumber, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberAllocateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var partialNumber = partialNumber_example;  // String | A partial number to allocate, underscores should be used to declare wildcard spaces

            try
            {
                // Allocate a number
                FullNumber result = apiInstance.numberAllocate(partialNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberAllocate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$partialNumber = partialNumber_example; // String | A partial number to allocate, underscores should be used to declare wildcard spaces

try {
    $result = $api_instance->numberAllocate($partialNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberAllocate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $partialNumber = partialNumber_example; # String | A partial number to allocate, underscores should be used to declare wildcard spaces

eval { 
    my $result = $api_instance->numberAllocate(partialNumber => $partialNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NumberApi->numberAllocate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
partialNumber = partialNumber_example # String | A partial number to allocate, underscores should be used to declare wildcard spaces

try: 
    # Allocate a number
    api_response = api_instance.number_allocate(partialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NumberApi->numberAllocate: %s\n" % e)

Parameters

Path parameters

Name	Description
PartialNumber*	String A partial number to allocate, underscores should be used to declare wildcard spaces Required

Responses

Status: 200 - Number allocated

Schema
Response Example

{number=03450040040}

Status: 400 - Invalid number

Schema
Response Example

{code=8, ntsapiresponse=Invalid number format, message=NTSAPI returned an unexpected error code'}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

numberDeactivate

Deactivate a number

Deactivate the specified number. The number will no longer operate when dialled.

/number/deactivate/{FullNumber}

Usage and SDK Samples

Curl

curl -X DELETE -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/deactivate/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            apiInstance.numberDeactivate(fullNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberDeactivate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            apiInstance.numberDeactivate(fullNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberDeactivate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

NumberApi *apiInstance = [[NumberApi alloc] init];

// Deactivate a number
[apiInstance numberDeactivateWith:fullNumber
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.numberDeactivate(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberDeactivateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Deactivate a number
                apiInstance.numberDeactivate(fullNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberDeactivate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $api_instance->numberDeactivate($fullNumber);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberDeactivate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    $api_instance->numberDeactivate(fullNumber => $fullNumber);
};
if ($@) {
    warn "Exception when calling NumberApi->numberDeactivate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Deactivate a number
    api_instance.number_deactivate(fullNumber)
except ApiException as e:
    print("Exception when calling NumberApi->numberDeactivate: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Number deactivated

Status: 400 - Number not changed

Schema
Response Example

{code=1, ntsapiresponse=Number not changed, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

numberFeature

Check or set a feature on a number

Check, enable or disable a particular feature for a number.

/number/feature/{FullNumber}/{Feature}

Usage and SDK Samples

Curl

curl -X PUT -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/feature/{FullNumber}/{Feature}?enabled="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        String feature = feature_example; // String | ACR or CALLERID
        Boolean enabled = true; // Boolean | This parameter is optional. Tells us the current setting or enables/disables the feature.
        try {
            FeatureResponse result = apiInstance.numberFeature(fullNumber, feature, enabled);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberFeature");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        String feature = feature_example; // String | ACR or CALLERID
        Boolean enabled = true; // Boolean | This parameter is optional. Tells us the current setting or enables/disables the feature.
        try {
            FeatureResponse result = apiInstance.numberFeature(fullNumber, feature, enabled);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberFeature");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question
String *feature = feature_example; // ACR or CALLERID
Boolean *enabled = true; // This parameter is optional. Tells us the current setting or enables/disables the feature. (optional)

NumberApi *apiInstance = [[NumberApi alloc] init];

// Check or set a feature on a number
[apiInstance numberFeatureWith:fullNumber
    feature:feature
    enabled:enabled
              completionHandler: ^(FeatureResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question

var feature = feature_example; // {String} ACR or CALLERID

var opts = { 
  'enabled': true // {Boolean} This parameter is optional. Tells us the current setting or enables/disables the feature.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.numberFeature(fullNumber, feature, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberFeatureExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question
            var feature = feature_example;  // String | ACR or CALLERID
            var enabled = true;  // Boolean | This parameter is optional. Tells us the current setting or enables/disables the feature. (optional) 

            try
            {
                // Check or set a feature on a number
                FeatureResponse result = apiInstance.numberFeature(fullNumber, feature, enabled);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberFeature: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question
$feature = feature_example; // String | ACR or CALLERID
$enabled = true; // Boolean | This parameter is optional. Tells us the current setting or enables/disables the feature.

try {
    $result = $api_instance->numberFeature($fullNumber, $feature, $enabled);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberFeature: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question
my $feature = feature_example; # String | ACR or CALLERID
my $enabled = true; # Boolean | This parameter is optional. Tells us the current setting or enables/disables the feature.

eval { 
    my $result = $api_instance->numberFeature(fullNumber => $fullNumber, feature => $feature, enabled => $enabled);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NumberApi->numberFeature: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question
feature = feature_example # String | ACR or CALLERID
enabled = true # Boolean | This parameter is optional. Tells us the current setting or enables/disables the feature. (optional)

try: 
    # Check or set a feature on a number
    api_response = api_instance.number_feature(fullNumber, feature, enabled=enabled)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NumberApi->numberFeature: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required
Feature*	String ACR or CALLERID Required

Query parameters

Name	Description
enabled	Boolean This parameter is optional. Tells us the current setting or enables/disables the feature.

Responses

Status: 200 - Feature Value

Schema
Response Example

{feature=CALLERID, enabled=true}

Status: 400 - Invalid number

Schema
Response Example

{code=1, ntsapiresponse=Number not valid, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

numberInfo

Set information for a number

Add information about the user of the number.

/number/info/{FullNumber}

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/info/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        Information information = ; // Information | Information on a number
        try {
            apiInstance.numberInfo(fullNumber, information);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberInfo");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        Information information = ; // Information | Information on a number
        try {
            apiInstance.numberInfo(fullNumber, information);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberInfo");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question
Information *information = ; // Information on a number

NumberApi *apiInstance = [[NumberApi alloc] init];

// Set information for a number
[apiInstance numberInfoWith:fullNumber
    information:information
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question

var information = ; // {Information} Information on a number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.numberInfo(fullNumber, information, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberInfoExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question
            var information = new Information(); // Information | Information on a number

            try
            {
                // Set information for a number
                apiInstance.numberInfo(fullNumber, information);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberInfo: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question
$information = ; // Information | Information on a number

try {
    $api_instance->numberInfo($fullNumber, $information);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberInfo: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question
my $information = WWW::SwaggerClient::Object::Information->new(); # Information | Information on a number

eval { 
    $api_instance->numberInfo(fullNumber => $fullNumber, information => $information);
};
if ($@) {
    warn "Exception when calling NumberApi->numberInfo: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question
information =  # Information | Information on a number

try: 
    # Set information for a number
    api_instance.number_info(fullNumber, information)
except ApiException as e:
    print("Exception when calling NumberApi->numberInfo: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Body parameters

Name	Description
information *

Responses

Status: 200 - Info Stored

Status: 400 - Invalid number

Schema
Response Example

{code=1, ntsapirespone=Number not valid, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

numberOrder

Set the targets for a number

Set the destination usage by time of day, allowing (for advanced NTS only) multiple targets to be set up and configured when each target is active.

/number/order/{FullNumber}/{index}/{periods}

Usage and SDK Samples

Curl

curl -X PUT -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/order/{FullNumber}/{index}/{periods}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        BigDecimal index = 3.4; // BigDecimal | The target index, valid values are 1, 2 or 3
        String periods = periods_example; // String | Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special.  Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority.
        try {
            apiInstance.numberOrder(fullNumber, index, periods);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberOrder");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        BigDecimal index = 3.4; // BigDecimal | The target index, valid values are 1, 2 or 3
        String periods = periods_example; // String | Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special.  Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority.
        try {
            apiInstance.numberOrder(fullNumber, index, periods);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberOrder");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question
BigDecimal *index = 3.4; // The target index, valid values are 1, 2 or 3
String *periods = periods_example; // Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special.  Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority.

NumberApi *apiInstance = [[NumberApi alloc] init];

// Set the targets for a number
[apiInstance numberOrderWith:fullNumber
    index:index
    periods:periods
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question

var index = 3.4; // {BigDecimal} The target index, valid values are 1, 2 or 3

var periods = periods_example; // {String} Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special.  Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.numberOrder(fullNumber, index, periods, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberOrderExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question
            var index = 3.4;  // BigDecimal | The target index, valid values are 1, 2 or 3
            var periods = periods_example;  // String | Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special.  Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority.

            try
            {
                // Set the targets for a number
                apiInstance.numberOrder(fullNumber, index, periods);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberOrder: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question
$index = 3.4; // BigDecimal | The target index, valid values are 1, 2 or 3
$periods = periods_example; // String | Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special.  Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority.

try {
    $api_instance->numberOrder($fullNumber, $index, $periods);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberOrder: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question
my $index = 3.4; # BigDecimal | The target index, valid values are 1, 2 or 3
my $periods = periods_example; # String | Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special.  Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority.

eval { 
    $api_instance->numberOrder(fullNumber => $fullNumber, index => $index, periods => $periods);
};
if ($@) {
    warn "Exception when calling NumberApi->numberOrder: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question
index = 3.4 # BigDecimal | The target index, valid values are 1, 2 or 3
periods = periods_example # String | Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special.  Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority.

try: 
    # Set the targets for a number
    api_instance.number_order(fullNumber, index, periods)
except ApiException as e:
    print("Exception when calling NumberApi->numberOrder: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required
index*	BigDecimal (int32) The target index, valid values are 1, 2 or 3 Required
periods*	String Periods definition - 4 digits representing the Daytime, Evening, Weekend and Special. Each position can be . for never, 0 for primary, 1 for secondary and 2 for tertiary priority. Required

Responses

Status: 200 - Time period Set

Status: 400 - Invalid request

Schema
Response Example

{code=1, ntsapiresponse=Number not valid, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

numberReactivate

Attempt to reactivate a number

Reactivate a number that has previously been deactivated, using the deactivate request (if it has not since been allocated by someone else).

/number/reactivate/{FullNumber}

Usage and SDK Samples

Curl

curl -X PUT -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/reactivate/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            apiInstance.numberReactivate(fullNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberReactivate");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            apiInstance.numberReactivate(fullNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberReactivate");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

NumberApi *apiInstance = [[NumberApi alloc] init];

// Attempt to reactivate a number
[apiInstance numberReactivateWith:fullNumber
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.numberReactivate(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberReactivateExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Attempt to reactivate a number
                apiInstance.numberReactivate(fullNumber);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberReactivate: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $api_instance->numberReactivate($fullNumber);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberReactivate: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    $api_instance->numberReactivate(fullNumber => $fullNumber);
};
if ($@) {
    warn "Exception when calling NumberApi->numberReactivate: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Attempt to reactivate a number
    api_instance.number_reactivate(fullNumber)
except ApiException as e:
    print("Exception when calling NumberApi->numberReactivate: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Number reactivated

Status: 400 - Non activated number

Schema
Response Example

{code=1, ntsapiresponse=Number not changed, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

numberSet

Set targets for a number

Set up the destination for when the number is dialled. The index allows setting of multiple destinations, which in combination with the order request allows time-based routing.

/number/set/{FullNumber}

Usage and SDK Samples

Curl

curl -X POST -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/set/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        Destination destination = ; // Destination | The Destination for a number
        try {
            apiInstance.numberSet(fullNumber, destination);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberSet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        Destination destination = ; // Destination | The Destination for a number
        try {
            apiInstance.numberSet(fullNumber, destination);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberSet");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question
Destination *destination = ; // The Destination for a number

NumberApi *apiInstance = [[NumberApi alloc] init];

// Set targets for a number
[apiInstance numberSetWith:fullNumber
    destination:destination
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question

var destination = ; // {Destination} The Destination for a number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.numberSet(fullNumber, destination, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberSetExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question
            var destination = new Destination(); // Destination | The Destination for a number

            try
            {
                // Set targets for a number
                apiInstance.numberSet(fullNumber, destination);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberSet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question
$destination = ; // Destination | The Destination for a number

try {
    $api_instance->numberSet($fullNumber, $destination);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberSet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question
my $destination = WWW::SwaggerClient::Object::Destination->new(); # Destination | The Destination for a number

eval { 
    $api_instance->numberSet(fullNumber => $fullNumber, destination => $destination);
};
if ($@) {
    warn "Exception when calling NumberApi->numberSet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question
destination =  # Destination | The Destination for a number

try: 
    # Set targets for a number
    api_instance.number_set(fullNumber, destination)
except ApiException as e:
    print("Exception when calling NumberApi->numberSet: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Body parameters

Name	Description
destination *

Responses

Status: 200 - Destination Set

Status: 400 - Invalid Number

Schema
Response Example

{code=1, ntsapiresponse=Number not valid, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

numberSetpin

Set Pin on a number

Set a Pin for the number. The [Pin] is optional â€“ if no Pin is provided then any existing Pin on the number is removed.

/number/setpin/{FullNumber}/{Pin}

Usage and SDK Samples

Curl

curl -X PUT -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/setpin/{FullNumber}/{Pin}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        String pin = pin_example; // String | The Pin number to set, or blank for none
        try {
            apiInstance.numberSetpin(fullNumber, pin);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberSetpin");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        String pin = pin_example; // String | The Pin number to set, or blank for none
        try {
            apiInstance.numberSetpin(fullNumber, pin);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberSetpin");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question
String *pin = pin_example; // The Pin number to set, or blank for none

NumberApi *apiInstance = [[NumberApi alloc] init];

// Set Pin on a number
[apiInstance numberSetpinWith:fullNumber
    pin:pin
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question

var pin = pin_example; // {String} The Pin number to set, or blank for none


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.numberSetpin(fullNumber, pin, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberSetpinExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question
            var pin = pin_example;  // String | The Pin number to set, or blank for none

            try
            {
                // Set Pin on a number
                apiInstance.numberSetpin(fullNumber, pin);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberSetpin: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question
$pin = pin_example; // String | The Pin number to set, or blank for none

try {
    $api_instance->numberSetpin($fullNumber, $pin);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberSetpin: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question
my $pin = pin_example; # String | The Pin number to set, or blank for none

eval { 
    $api_instance->numberSetpin(fullNumber => $fullNumber, pin => $pin);
};
if ($@) {
    warn "Exception when calling NumberApi->numberSetpin: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question
pin = pin_example # String | The Pin number to set, or blank for none

try: 
    # Set Pin on a number
    api_instance.number_setpin(fullNumber, pin)
except ApiException as e:
    print("Exception when calling NumberApi->numberSetpin: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required
Pin*	String The Pin number to set, or blank for none Required

Responses

Status: 200 - The Status of a number

Status: 400 - Invalid Number

Schema
Response Example

{code=1, ntsapiresponse=PIN unchanged, message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: default - Unexpected error

Schema

numberStatus

Request status on the specified number

Query the current status of the specified number. A successful reply contains the information about the number's current settings.

/number/status/{FullNumber}

Usage and SDK Samples

Curl

curl -X GET -u "USERNAME:PASSWORD" "https://restapi.magrathea.net:8443/v1/number/status/{FullNumber}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NumberApi;

import java.io.File;
import java.util.*;

public class NumberApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Status result = apiInstance.numberStatus(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.NumberApi;

public class NumberApiExample {

    public static void main(String[] args) {
        NumberApi apiInstance = new NumberApi();
        String fullNumber = fullNumber_example; // String | The number in question
        try {
            Status result = apiInstance.numberStatus(fullNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberApi#numberStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *fullNumber = fullNumber_example; // The number in question

NumberApi *apiInstance = [[NumberApi alloc] init];

// Request status on the specified number
[apiInstance numberStatusWith:fullNumber
              completionHandler: ^(Status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var MagratheaRestApi = require('magrathea_rest_api');
var defaultClient = MagratheaRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new MagratheaRestApi.NumberApi()

var fullNumber = fullNumber_example; // {String} The number in question


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.numberStatus(fullNumber, , callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class numberStatusExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new NumberApi();
            var fullNumber = fullNumber_example;  // String | The number in question

            try
            {
                // Request status on the specified number
                Status result = apiInstance.numberStatus(fullNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NumberApi.numberStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\NumberApi();
$fullNumber = fullNumber_example; // String | The number in question

try {
    $result = $api_instance->numberStatus($fullNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NumberApi->numberStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NumberApi;

# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::NumberApi->new();
my $fullNumber = fullNumber_example; # String | The number in question

eval { 
    my $result = $api_instance->numberStatus(fullNumber => $fullNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NumberApi->numberStatus: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.NumberApi()
fullNumber = fullNumber_example # String | The number in question

try: 
    # Request status on the specified number
    api_response = api_instance.number_status(fullNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NumberApi->numberStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
FullNumber*	String The number in question Required

Responses

Status: 200 - Number Status

Schema
Response Example

{status=ACTIVATED, expiry=2018-02-18, targets={index=1, value=9876}}

Status: 400 - Not Activated

Schema
Response Example

{code=1, ntsapirespone=[Account not Active], message=NTSAPI returned a non-zero value}

Status: 401 - Unauthorised

Schema
Response Example

{error=Wrong username,password or account}

Status: 404 - The number is not activated

Status: default - Unexpected error

Schema

Generated 2023-04-11T09:39:48.780+01:00

Magrathea REST API

API and SDK Documentation

Account

accountAddsipip

Usage and SDK Samples

Parameters

Responses

Status: 200 - SipIP added

Status: 401 - Unauthorised

Status: 420 - Application error

Status: default - Unexpected error

accountBalance

Usage and SDK Samples

Parameters

Responses

Status: 200 - Balance

Status: 401 - Unauthorised

Status: default - Unexpected error

accountCdrs

Usage and SDK Samples

Parameters

Responses

Status: 200 - cdrs

Status: 400 - No cdrs for this account

Status: 401 - Unauthorised

Status: default - Unexpected error

accountDetail

Usage and SDK Samples

Parameters

Responses

Status: 200 - Detail

Status: 401 - Unauthorised

Status: default - Unexpected error

accountGetlabel

Usage and SDK Samples

Parameters

Responses

Status: 200 - Account label

Status: 401 - Unauthorised

Status: default - Unexpected error

accountGettariff

Usage and SDK Samples

Parameters

Responses

Status: 200 - Current band and restriction

Status: 401 - Unauthorised

Status: default - Unexpected error

accountListsipip

Usage and SDK Samples

Parameters

Responses

Status: 200 - SipIP List

Status: 401 - Unauthorised

Status: 420 - Application error

Status: default - Unexpected error

accountRemovesipip

Usage and SDK Samples

Parameters

Responses

Status: 200 - SipIP removed

Status: 401 - Unauthorised

Status: 420 - Application error

Status: default - Unexpected error

accountServices

Usage and SDK Samples

Parameters

Responses

Status: 200 - Services

Status: 401 - Unauthorised

Status: default - Unexpected error

accountSetlabel

Usage and SDK Samples

Parameters

Responses

Status: 200 - Account label

Status: 401 - Unauthorised

Status: 443 - Invalid Restriction

Status: default - Unexpected error

accountSetsippw

Usage and SDK Samples