Web API Help Page

Reference

This page details each of the available API methods.

Clicking on any of the available methods, for example: Get api/site, will take you to a new page for that method.
This new page will provide the following information:

An overview of the methods purpose.

Details of the Request Information.
- Required Parameters
- A sample of the Request Format(s)
Details of the Response Information.
- Resource Description
- A sample of the Response Format(s)
The capability to test the API method

Configuration

API	Description
GET api/configuration/AutoImportPlan/CDRFilenameFormat/{ID}	Get a single auto import plan CDRFilenameFormat
POST api/configuration/AutoImportPlan/CDRFilenameFormat	Create a new auto import plan CDRFilenameFormat
PATCH api/configuration/AutoImportPlan/CDRFilenameFormat/{ID}
PUT api/configuration/AutoImportPlan/CDRFilenameFormat/{ID}

Contract

API	Description
GET api/contract?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of Contracts
GET api/contract/{id}	Return details of the specified Contract
POST api/contract	Create a new Contract
PATCH api/contract/{id}	Update all details of the specified Contract
PUT api/contract/{id}	Update the details of the specified Contract

ServiceChargeType

API	Description
GET api/servicechargetype?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of Service Charge Types
GET api/servicechargetype/carrierdescription/{carrierdescription}	This method returns a list of matching carrier descriptions along with information on any associated Service Charge Types
GET api/servicechargetype/{id}	Return details for the specified Service Charge Type
GET api/servicechargetype/category	Return a list of Service Charge Type categories
POST api/servicechargetype	Add a new Service Charge Type
POST api/servicechargetype/hardware	Add a new hardware record
PATCH api/servicechargetype/{id}	Update details for the specified Service Charge Type
PUT api/servicechargetype/{id}	Update details for the specified Service Charge Type
GET api/servicechargetype/hardware?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of hardware
GET api/servicechargetype/hardware/{id}	Return details for the specified hardware
PATCH api/servicechargetype/hardware/{id}	Update all hardware details for the specified hardware
PUT api/servicechargetype/hardware/{id}	Update hardware

Site

API	Description
GET api/site	Return a list of sites
GET api/site/{id}	Return details of the specified site
GET api/site/{id}/SiteContact	Return a list of site contacts for the specified site
GET api/site/{id}/cli?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of CLIs for the specified site
POST api/site	Add a new site.
PATCH api/site/{id}	Update details of the specified site
PUT api/site/{id}	Update details of the specified site
GET api/site/{id}/candelete	The purpose of this method is to know whether a site can be deleted and if it can not be deleted, the reasons why.
DELETE api/site/{id}	This method deletes a site within a company.
PATCH api/site/{SiteID}/Property	Update a custom property on a site
PUT api/site/{id}/setbillingaddress	Set the billing address for the specified site
PATCH api/site/{id}/setbillingaddress	Set the billing address for the specified site
GET api/site/{id}/servicecharge?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of Service Charges for the specified site
GET api/site/{id}/servicecharge/cli/{cli}	Return a list of Service Charges for the specified site and CLI.
GET api/site/{id}/billinginformation	Return the billing information details for the specified site
PUT api/site/{id}/billinginformation	Update the billing information details for the specified site
PATCH api/site/{id}/billinginformation	Update billing information details for the specified site
GET api/site/{id}/invoiceinformation	Return the invoice information details for the specified site
PATCH api/site/{id}/invoiceinformation	Update invoice information details for the specified site
PUT api/site/{id}/invoiceinformation	Update the invoice information details for the specified site
GET api/site/{id}/siteselltariff	Return the site level sell tariffs for the specified site
PATCH api/site/{id}/siteselltariff	Update the site level sell tariffs for the specified site
PUT api/site/{id}/siteselltariff	Update the site level sell tariffs for the specified site
GET api/site/{id}/package	Return the packages for the specified site
PATCH api/site/{id}/package	Update package details for the specified site
PUT api/site/{id}/package	Update package details for the specified site
GET api/site/{id}/freeminutes	Return the Free Minutes for the specified site
PATCH api/site/{id}/freeminutes	Update Free Minutes details for the specified site
PUT api/site/{id}/freeminutes	Update Free Minutes details for the specified site
GET api/site/{SiteID}/EndPoint	Returns a list of provisioned end points that are available on a specific site
GET api/site/{SiteID}/EndPoint/{EndPointID}	Displays EndPoint details based on ID. This method will return provisioned and non-provisioned Endpoints.
GET api/site/{SiteID}/EndPoint/{EndPointID}/Addresses	Returns a list of addresses associated with an EndpointID
POST api/site/{SiteID}/EndPoint/{EndPointID}/Addresses	Create a new address on an Endpoint
GET api/site/{SiteID}/EndPoint/{EndPointID}/Numbers	Returns a list of associated numbers on an endpoint
GET api/site/{SiteID}/EndPoint/{EndPointID}/Numbers/{EndpointNumberID}	Returns details of an end point number
PATCH api/site/{SiteID}/EndPoint/{EndPointID}/Numbers/{EndPointNumberID}/properties	Update Endpoint number properties

CLI

API	Description
GET api/cli?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of CLIs.
GET api/cli/bycli/{cli}	Return CLI details for specified CLI string
GET api/cli/{id}	Return CLI details for specified CLI my_id
POST api/cli	Add a new CLI
PATCH api/cli/{id}	Update details for the specified CLI
PUT api/cli/{id}	Update details for the specified CLI
GET api/cli/{id}/tariff	Return the CLI level sell tariffs for the specified CLI
PUT api/cli/{id}/tariff	Update the CLI level sell tariffs for the specified CLI
PATCH api/cli/{id}/tariff	Update the CLI level sell tariffs for the specified CLI
GET api/cli/freeminutesplan	Return a list of Free Minutes plans
GET api/cli/{id}/freeminutes	Return a list of Free Minutes plans for specified CLI
PATCH api/cli/{id}/freeminutes	Add a Free Minute Plan to a specified CLI
PUT api/cli/{id}/freeminutes	Update a Free Minute plan for specified CLI
GET api/cli/balance/bycli/{cli}	Return CLI Outstanding Balance for specified CLI string

RevenueAssurance

API	Description
GET api/revenueassurance/GetCallAnalysis?BillingPeriodId={BillingPeriodId}&BillRunId={BillRunId}&CompanyId={CompanyId}&SiteId={SiteId}&CalledFrom={CalledFrom}&CalledTo={CalledTo}&DestinationIds={DestinationIds}&ChargeCategoryIds={ChargeCategoryIds}&CallFromDate={CallFromDate}&CallToDate={CallToDate}&CallFromTime={CallFromTime}&CallToTime={CallToTime}&LimitId={LimitId}&LimitValue={LimitValue}&CallCostFrom={CallCostFrom}&CallCostTo={CallCostTo}&ExtensionFrom={ExtensionFrom}&ExtensionTo={ExtensionTo}&DurationFrom={DurationFrom}&DurationTo={DurationTo}&CallTypeId={CallTypeId}&Carrier={Carrier}&ExtensionNo={ExtensionNo}&CarrierCostFrom={CarrierCostFrom}&CarrierCostTo={CarrierCostTo}&UsageFrom={UsageFrom}&UsageTo={UsageTo}&PageSize={PageSize}&StartRow={StartRow}&SortColumn={SortColumn}&SortDirection={SortDirection}	This method returns itemised rated call records for a given billing period
GET api/revenueassurance/GetBillingServiceCharges?BillingPeriodId={BillingPeriodId}&PageSize={PageSize}&StartRow={StartRow}&BuyPriceOption={BuyPriceOption}&CompanyId={CompanyId}&SiteId={SiteId}&Account={Account}&BillingId={BillingId}&BillRunId={BillRunId}&Carrier={Carrier}&InvoiceId={InvoiceId}&Nominal={Nominal}&Frequency={Frequency}&ServiceChargeTypeId={ServiceChargeTypeId}	This method returns service billing charges for a given billing period

API

Description

GET api/revenueassurance/GetCallAnalysis?BillingPeriodId={BillingPeriodId}&BillRunId={BillRunId}&CompanyId={CompanyId}&SiteId={SiteId}&CalledFrom={CalledFrom}&CalledTo={CalledTo}&DestinationIds={DestinationIds}&ChargeCategoryIds={ChargeCategoryIds}&CallFromDate={CallFromDate}&CallToDate={CallToDate}&CallFromTime={CallFromTime}&CallToTime={CallToTime}&LimitId={LimitId}&LimitValue={LimitValue}&CallCostFrom={CallCostFrom}&CallCostTo={CallCostTo}&ExtensionFrom={ExtensionFrom}&ExtensionTo={ExtensionTo}&DurationFrom={DurationFrom}&DurationTo={DurationTo}&CallTypeId={CallTypeId}&Carrier={Carrier}&ExtensionNo={ExtensionNo}&CarrierCostFrom={CarrierCostFrom}&CarrierCostTo={CarrierCostTo}&UsageFrom={UsageFrom}&UsageTo={UsageTo}&PageSize={PageSize}&StartRow={StartRow}&SortColumn={SortColumn}&SortDirection={SortDirection}

This method returns itemised rated call records for a given billing period

GET api/revenueassurance/GetBillingServiceCharges?BillingPeriodId={BillingPeriodId}&PageSize={PageSize}&StartRow={StartRow}&BuyPriceOption={BuyPriceOption}&CompanyId={CompanyId}&SiteId={SiteId}&Account={Account}&BillingId={BillingId}&BillRunId={BillRunId}&Carrier={Carrier}&InvoiceId={InvoiceId}&Nominal={Nominal}&Frequency={Frequency}&ServiceChargeTypeId={ServiceChargeTypeId}

This method returns service billing charges for a given billing period

Invoice

API	Description
GET api/invoice/ByPeriod/{BillingPeriodID}	Lists invoices filtered by billing period and status
GET api/invoice/{InvoiceId}/AccountsBreakdown	The purpose of this method is to breakdown the invoices
GET api/invoice/{InvoiceID}	Returns details of a selected invoice
GET api/invoice/{InvoiceID}/report	Returns details of a selected invoice including its report file

WLR3

API	Description
GET api/WLR3/LineDetails/{CLI}	This method returns line details of a Openreach CLI
POST api/WLR3/LineTest	Run a WLR3 line test on a CLI
GET api/WLR3/NoLineTestReasons	Returns a list of No Line Test Reasons
GET api/WLR3/Appointments/{CLI}	Returns a list of available appointments on a line
POST api/WLR3/Appointment	Reserve a WLR3 appointment with Openreach
POST api/WLR3/Fault	Reports a line fault to Openreach
PATCH api/WLR3/Fault/{IncidentID}	Cancel, clear, or reject a fault.
PUT api/WLR3/Fault/{IncidentID}	Cancel, clear, or reject a fault.
GET api/WLR3/Fault/{incidentId}	Returns details for the specified fault
GET api/WLR3/Faults	Returns a list of faults.
GET api/WLR3/CancelReasons	A list of reasons a fault can be cancelled for.
GET api/WLR3/ClearReasons	A list of reasons a fault can be cleared for.
GET api/WLR3/RejectReasons	A list of reasons a fault can be rejected for.
GET api/WLR3/TimeSlots	A Key-Value list of available time slots

Incident

API	Description
GET api/incident	Returns a complete list of incidents
GET api/incident/{IncidentID}	Returns a specified incident
GET api/incident/categories	This method gets the categories relating to an Incident Type.
GET api/incident/IncidentType	Returns a list of all the Incident Types
GET api/incident/IncidentType/{id}	Returns details of an Incident Type
GET api/incident/Owners	Returns a list of all the owners that can be assigned to an incident.
GET api/incident/IncidentType/{id}/Symptom	Returns a list of all the symptoms for the specified Incident Type, as well as the symptoms not belonging to any specific Incident Type
GET api/incident/priority/{CLI}	This method returns a list of priority states.
GET api/incident/{id}/notifications	This method gets a list of notifications for a specified incident.
GET api/incident/status	This method gets a list of incident statuses.
GET api/incident/{categoryID}/status	Returns a list of statuses for the specified category.
GET api/incident/actions	This method gets the list of actions that can be applied to an incident.
GET api/incident/servicelevels	Returns a list of service levels.
POST api/incident	This method creates a new incident
PATCH api/incident/{IncidentID}	This method amends an incident
PUT api/incident/{IncidentID}	This method amends an incident

Company

API	Description
GET api/company?IsConsumer={IsConsumer}&IsProspect={IsProspect}&IsOperator={IsOperator}&IsSupplier={IsSupplier}&IsReseller={IsReseller}&IsCarrier={IsCarrier}&IsAgent={IsAgent}&IsCustomer={IsCustomer}	Return a list of companies
GET api/company/{id}	Return details of the specified company
GET api/company/supplier	Return a list of suppliers
GET api/company/consumer	Return a list of consumers
GET api/company/MyCompany	Return the name and ID of the current users` company
GET api/company/{id}/Site	Return a list of sites for the specified company
GET api/company/{id}/SiteContact	Return a list of site contacts for the specified company
GET api/company/{id}/Site/{siteid}/SiteContact	Return a list of site contacts for a specific site of the specified company
GET api/company/{id}/cli?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of CLIs for the specified company.
GET api/company/{id}/Site/{siteid}	Return details of a specific site of the specified company
GET api/company/{id}/contract?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of contracts for the specified company
POST api/company	Add a new company
PATCH api/company/{id}/agentdetails	This method updates details of a specified agent
GET api/company/{id}/agentdetails	This method gets the details of a specified agent
PATCH api/company/{id}	Update all details of the specified company
PUT api/company/{id}	Update details of the specified company
PATCH api/company/{CompanyID}/Property	Update custom properties of a company
GET api/company/{id}/primaryagent	Return the primary agent
PATCH api/company/{id}/primaryagent	Update details of the primary agent
PUT api/company/{id}/primaryagent	Update details of the primary agent
GET api/company/{id}/accountmanager	This method returns a list of account managers by ID
POST api/company/{id}/accountmanager	This method returns a new account manager Id and Is Primary flag
PUT api/company/{id}/accountmanager/{accountmanagerid}	Updates account manager commission details
PATCH api/company/{id}/accountmanager/{accountmanagerid}	Updates account manager commission details

Package

API	Description
GET api/package?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of packages
GET api/package/{id}	Return details of the specified package
POST api/package	Add new package
PATCH api/package/{id}	Update package details of specified package
PUT api/package/{id}	Update specified package
GET api/package/{id}/freeminutes	Return a list of Free Minute plans for the specified package
PATCH api/package/{id}/freeminutes	Update Free Minute plan details of the specified package
PUT api/package/{id}/freeminutes	Update a Free Minute plan of the specified package
GET api/package/{id}/tariffs	Return a list of tariffs for the specified package
PATCH api/package/{id}/tariffs	Update tariff details of the specified package
PUT api/package/{id}/tariffs	Update a tariff of the specified package

CustomProperty

API	Description
GET api/CustomProperty/{entityName}/ByEntityId/{entityId}
GET api/CustomProperty/{entityName}/{controlId}?value={value}
PATCH api/CustomProperty/{entityName}/ByEntityId/{entityId}
PUT api/CustomProperty/{entityName}/ByEntityId/{entityId}

Common

API	Description
GET api/common/frequencytype	Return a list of frequency types (for use with Service Charges and Service Charge Types)
GET api/common/reportdelivery	Return a list of report delivery types (for use with Invoice Information)
GET api/common/invoicedelivery	Return a list of invoice delivery types (for use with Invoice Information).
GET api/common/cdrformat	Return a list of CDR formats (for use with Invoice Information)
GET api/common/reportprofile	Return a list of report profiles (for use with Invoice Information)
GET api/common/serviceformat	Return a list of service formats (for use with Invoice Information)
GET api/common/paymentmethod	Return a list of payment methods (for use with Billing Information)
GET api/common/billrun	Return a list of billruns (for use with Invoice Information)
POST api/common/billrun	This method adds a new Bill Run
GET api/common/BillingPeriods	Return a list of billing periods
GET api/common/taxcodes	Return a list of tax codes types (for use with Invoice Information)
GET api/common/linetypes	Return a list of supported line types for use with CLIs
GET api/common/calltypes	Return a list of call types for use with CLIs
GET api/common/defaultvalue	Return a list of Default Values.
GET api/common/defaultvalue/{id}	Return a specified Default Value.
POST api/common/reprice/proforma	Trigger a reprice of proformas in a billing period
POST api/common/reprice/rejects	Trigger a reprice of rejects in a billing period

ServiceCharge

API	Description
GET api/servicecharge?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of Service Charges.
GET api/servicecharge/{id}	Return details for the specified Service Charge
PATCH api/servicecharge/{id}	Update details for the specified Service Charge
PUT api/servicecharge/{id}	Update details for the specified Service Charge
POST api/servicecharge	Add a new Service Charge

Commission

API	Description
POST api/commission/plan	This method adds new commission plan
POST api/commission/plan/{id}/section	This method adds new section to a commission plan

SiteContact

API	Description
GET api/sitecontact	Return a list of site contacts
GET api/sitecontact/{id}	Return details of the specified site contact
PATCH api/sitecontact/{id}	Update details of the specified site contact
PUT api/sitecontact/{id}	Update details of the specified site
POST api/sitecontact	Add a new site contact

FreeMinutes

API	Description
GET api/freeminutes	Return a list of Free Minute plans

Authenticate

API	Description
POST api/Authenticate	Creates a login token that should be presented to the API on requests for secure pages.
POST api/Authenticate/QueryBuilderAccess

Orders

Using order repository to retrieve information

API	Description
GET api/order?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}&OrderStatus={OrderStatus}&siteid={siteid}&companyid={companyid}	Returns a list of orders
GET api/order/{ID}	Return the details of a specific order, including services and their costs.
POST api/order/quote	Creates an empty quote for a specified company.
PATCH api/order/quote/{QuoteID}	Update all details for a specific quote
DELETE api/order/quote/{QuoteID}	Deletes a quote
GET api/order/ServiceInventories?filter={filter}	Return the full list of available Service Inventories
GET api/order/Service/{OrderServiceID}	Returns a service from an order or quote containing a sub-list of order service properties
POST api/order/quote/{QuoteID}/Service	Creates a new service that is attached to a quote
PATCH api/order/Service/{OrderServiceID}/Property	Update any properties in an order service
DELETE api/order/quote/{QuoteID}/Service/{OrderServiceID}	Deletes a service from a quote
GET api/order/service/{OrderServiceID}/attachment	Get list of attachments on an order service
GET api/order/service/{OrderServiceID}/attachment/{AttachmentID}	Get an attachment on an order service including the file contents as a byte array
POST api/order/service/{OrderServiceID}/attachment	Create a new attachment (including file, uploaded as a byte array)
GET api/order/Service/{OrderServiceID}/EndPointProperties	Get a list of endpoint properties associated with an order service
POST api/order/Service/{OrderServiceID}/EndPoint	Creates and binds an endpoint to an order service
PATCH api/order/Service/{OrderServiceID}/EndPoint/{EndPointID}	Updates an endpoint on an order service
PATCH api/order/Service/{OrderServiceID}/EndPointProperties	Update a set of endpoint properties associated with an order service
GET api/order/Service/{OrderServiceID}/StockNumber	Get a list of stock numbers that are assigned to an order
POST api/order/Service/{OrderServiceID}/StockNumber	Add stock numbers to an order
DELETE api/order/Service/{OrderServiceID}/StockNumber/{StockNumberID}	Deletes a stock reservation from an order service
GET api/order/service/{OrderServiceID}/fraud	Returns a list of fraud records for an order servce.
PATCH api/order/service/{OrderServiceID}/fraud	Sets a list of fraud records for an order servce.
GET api/order/Service/{OrderServiceID}/PortNumber	Returns a list of numbers that will be ported on a specified order service
POST api/order/Service/{OrderServiceID}/PortNumber	Creates a new Porting number range and binds it to an order service
DELETE api/order/Service/{OrderServiceID}/PortNumber/{PortNumberID}	Removes a porting number range from an orderservice on a quote
GET api/order/{OrderID}/Task	Returns a list of tasks on an order
PATCH api/order/{OrderID}/Task/{TaskID}	Completes a pending task

Tariff

API	Description
GET api/tariff?IsExactNameMatch={IsExactNameMatch}&TariffName={TariffName}&TariffCode={TariffCode}&Costinterrate={Costinterrate}&Decimalplaces={Decimalplaces}&Mobile={Mobile}&Roundup={Roundup}&MobileNetwork={MobileNetwork}&RetailId={RetailId}&PerSecondBilling={PerSecondBilling}&BaseTariff={BaseTariff}&BaseMarkup={BaseMarkup}&LongTariff={LongTariff}&MinCharge={MinCharge}&MinConnectionFee={MinConnectionFee}&MaxCharge={MaxCharge}&LongChange={LongChange}&ServiceCharge={ServiceCharge}&PerCallPerTimeband={PerCallPerTimeband}&ApplyConnectionAfterFreeMins={ApplyConnectionAfterFreeMins}&IsObsolete={IsObsolete}&TariffType={TariffType}&Consumer={Consumer}&AccessCharge={AccessCharge}&Buy={Buy}&LastUpdated={LastUpdated}	Returns a list of tariffs
GET api/tariff/{TariffCode}	Return details (not rates) for the specified tariff
GET api/tariff/{TariffCode}/CallRate	Get a list of call rates of a tariff
GET api/tariff/{TariffCode}/ServiceChargeRate	Returns rates for a service charge tariff
GET api/tariff/{TariffCode}/Revision	Returns a list of tariff revisions

ChargeGroup

API	Description
GET api/chargegroup?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of charge groups
GET api/chargegroup/{id}	Return details of the specified charge group
GET api/chargegroup/mobile?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of mobile only charge groups
GET api/chargegroup/category	Return a list of charge group categories
GET api/chargegroup/continent	Return a list of charge group continents
GET api/chargegroup/fixedline?search_text={search_text}&page_no={page_no}&sort_column={sort_column}&sort_direction={sort_direction}&page_size={page_size}	Return a list of fixed line charge groups
POST api/chargegroup	Add new charge group
PATCH api/chargegroup/{id}	Update a specified charge group
PUT api/chargegroup/{id}	Update a specified charge group

Developers Portal