ads
API | Description |
---|---|
GET api/categoryads/category/{categoryid}/lang/{language} |
No documentation available. |
Customers
API | Description |
---|---|
GET api/customer |
Gets information about the currently logged-in customer. |
POST api/customer |
Creates a new customer. |
PUT api/customer |
Updates an existing customer. |
DELETE api/customer |
Deactivates the currently logged-in customer. |
GET api/customer/addresses |
Retrieves a list of all additional addresses related to the currently logged-in customer. |
GET api/customer/addresses/{addressId} |
Retrieves a specific additional address related to the currently logged-in customer. |
PUT api/customer/addresses |
Updates an existing additional address on the currently logged-in customer. |
POST api/customer/addresses |
No documentation available. |
GET api/customer/invoices |
Retrieves a list of invoices for the currently logged-in customer. |
GET api/customer/invoices/{invoiceId}/pdf |
Retrieves a PDF file of the specified invoice. |
GET api/customer/paymentinfobyticket/{ticket} |
No documentation available. |
GET api/customer/paymentinfo |
No documentation available. |
GET api/customer/paymentinfo/{paymentInfoId} |
No documentation available. |
GET api/customer/registreredcreditcard |
No documentation available. |
GET api/customer/registreredcreditcardstatus/{paymentId}/{uuid} |
No documentation available. |
GET api/customer/cardstatus/{siteId}/{paymentId}/{uuid} |
No documentation available. |
ExternalValidation
API | Description |
---|---|
GET api/validate/testvalidatetrue/{errorMessageName}/{value} |
No documentation available. |
GET api/validate/testvalidatefalse/{errorMessageName}/{value} |
No documentation available. |
GET api/validate/testvalidate/{errorMessageName}/{value} |
No documentation available. |
GET api/validate/dkcpr/{errorMessageName}/{value} |
No documentation available. |
GET api/validate/telebonusmedlem/{errorMessageName}/{value} |
No documentation available. |
GET api/validate/fastnetnucheckportin/{errorMessageName}/{value} |
No documentation available. |
GET api/validate/cashbackcheckportin/{errorMessageName}/{value} |
No documentation available. |
GET api/validate/emobilecheckportin/{errorMessageName}/{value} |
No documentation available. |
Miscellaneous
API | Description |
---|---|
GET api/simtypes |
Returns a list of possible types of SIM card, e.g. regular, micro or nano. |
GET api/invoicedeliverytypes |
Returns a list of possible invoice delivery types, e.g. e-mail or physical mail. |
GET api/countries |
Returns a list of all zip / postal codes known to the system. |
GET api/cultures |
Returns a list of all formatting cultures known to the system. |
GET api/zipcodes |
Returns a list of all zip / postal codes known to the system. |
GET api/translations |
Returns a list of all translations of static text from Umbraco. |
GET api/translations/lang/{language} |
Returns a list of all translations of static text for the specified language from Umbraco. |
GET api/operators/type/{type} |
Returns a list of all telecom operators of the specified type known to the system. |
GET api/operators/subscriptionCategory/{category} |
Returns a list of all telecom operators relevant to the specificed subscription category and known to the system. |
GET api/operatortypes |
Returns a list of possible operator types, e.g. mobile or internet. |
GET api/subscriptioncategories |
Returns a list of possible subscription categories (not to be confused with subscription types), e.g. mobile or internet. |
GET api/subscriptionproductstates |
Returns a list of possible subscription/product states, e.g. active or closed. |
GET api/subscriptiontypes |
Returns a list of possible subscription types (not to be confused with subscription categories), e.g. postpaid or prepaid. |
GET api/numbertypes |
Returns a list of possible number types, e.g. mobile or internet. |
GET api/ordertypes |
Returns a list of possible order types, e.g. selecting a new number or porting an existing one. |
GET api/genders |
Returns a list of possible genders - or at least, genders acknowleged by the system. |
GET api/topuptypes |
Returns a list of possible types of top-up for prepaid subscriptions, e.g. manual or automatic. |
GET api/customertypes |
Returns a list of possible types of customer, e.g. private or business. |
GET api/customer/adresses/types |
Returns a list of possible types of address, e.g. billing or shipping. |
GET api/addresstypes |
Returns a list of possible types of address, e.g. billing or shipping. |
GET api/billingintervals |
Returns a list of possible billing intervals, e.g. Monthly or Quarterly. |
GET api/terminationtypes |
Returns a list of possible types of termination. |
GET api/creditcardtypes |
Returns a list of supported types of credit card. |
GET api/paymenttypes |
Returns a list of supported types of payment, e.g. credit card or direct debit. |
GET api/producttypes |
Returns a list of possible types of product, e.g. Main, Service or Bundle. |
GET api/parentconnectiontypes |
Returns a list of possible parent connection types. |
GET api/allowedorigins |
No documentation available. |
Subscriptions
API | Description |
---|---|
GET api/subscriptions |
Retrieves a list of subscriptions for the currently logged-in customer. |
GET api/subscriptions/category/{subscriptionCategory} |
Retrieves a list of subscriptions of the specified category for the currently logged-in customer. |
GET api/subscriptions/subscriptionswithpayment |
No documentation available. |
GET api/subscriptions/mobile |
Retrieves a list of subscriptions of type Mobile for the currently logged-in customer. |
GET api/subscriptions/fixedline |
Retrieves a list of subscriptions of type Fixed Line for the currently logged-in customer. |
GET api/subscriptions/voip |
Retrieves a list of subscriptions of type VoIP for the currently logged-in customer. |
GET api/subscriptions/internet |
Retrieves a list of subscriptions of type Internet for the currently logged-in customer. |
GET api/subscriptions/iptv |
Retrieves a list of subscriptions of type IPTV for the currently logged-in customer. |
GET api/subscriptions/content |
Retrieves a list of subscriptions of type Content for the currently logged-in customer. |
GET api/subscriptions/{subscriptionId}/lang/{language} |
Retrieves information about the specified subscription. |
GET api/subscriptions/grouped |
Retrieves an list of the customer's subscriptions, grouped by category. |
GET api/subscriptions/{subscriptionId}/balance |
Retrieves the current balance of the specified subscription. |
GET api/subscriptions/{subscriptionId}/addresses/type/{addressTypeId} |
Retrieves a list of additional addresses related to the specified subscription. |
POST api/subscriptions/{subscriptionId}/addresses/type/{addressTypeId} |
Adds an additional address to the customer and sets it as either billing or shipping address for the specified subscription. |
POST api/subscriptions/{subscriptionId}/addresses/{addressId}/type/{addressTypeId} |
Sets the specified existing address as either billing or shipping address for the specified subscription. |
GET api/subscriptions/{subscriptionId}/bundlestatus/{startDate}/{endDate} |
No documentation available. |
GET api/subscriptions/{subscriptionId}/cdr/{startDate}/{endDate} |
Retrieves a list of usage records (CDR's) for the specified subscription. |
GET api/subscriptions/{subscriptionId}/cdr/{startDate}/{endDate}/grouped |
Retrieves a list of usage records (CDR's) for the specified subscription, grouped by type. |
GET api/subscriptions/{subscriptionId}/cdr/{startDate}/{endDate}/sums |
Retrieves a list of total usage sums for the specified subscription, grouped by type. |
GET api/subscriptions/{subscriptionId}/accountrecords/{startDate}/{endDate} |
Retrieves a list of account records (invoices) for the specified subscription. |
GET api/subscriptions/category/1/{subscriptionId}/sim |
Retrieves SIM card details for the specified subscription of type Mobile. |
GET api/subscriptions/mobile/{subscriptionId}/sim |
Retrieves SIM card details for the specified subscription of type Mobile. |
GET api/subscriptions/category/1/{subscriptionId}/topup |
No documentation available. |
GET api/subscriptions/mobile/{subscriptionId}/topup |
No documentation available. |
POST api/subscriptions/{subscriptionId} |
Deactivates a subscription. |
PUT api/subscriptions/category/2/{subscriptionId} |
Updates an existing order of type FixedLine. |
PUT api/subscriptions/fixedline/{subscriptionId} |
Updates an existing order of type FixedLine. |
PUT api/subscriptions/category/1/{subscriptionId} |
Updates an existing order of type Mobile or Mobile Internet. |
PUT api/subscriptions/mobile/{subscriptionId} |
Updates an existing order of type Mobile or Mobile Internet. |
PUT api/subscriptions/category/4/{subscriptionId} |
Updates an existing order of type Internet. |
PUT api/subscriptions/internet/{subscriptionId} |
Updates an existing order of type Internet. |
PUT api/subscriptions/category/3/{subscriptionId} |
Updates an existing order of type VoIP. |
PUT api/subscriptions/voip/{subscriptionId} |
Updates an existing order of type VoIP. |
GET api/subscriptions/{subscriptionId}/simreplace/price |
Retrieves the price for SIM card replacement on a mobile subscription. |
POST api/subscriptions/category/1/{subscriptionId}/simreplace |
Submits a SIM replacement order for the specified subscription of type Mobile. |
POST api/subscriptions/mobile/{subscriptionId}/simreplace |
Submits a SIM replacement order for the specified subscription of type Mobile. |
POST api/subscriptions/category/1/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type Mobile or Mobile Internet. |
POST api/subscriptions/category/1000/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type Mobile or Mobile Internet. |
POST api/subscriptions/mobileinternet/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type Mobile or Mobile Internet. |
POST api/subscriptions/mobile/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type Mobile or Mobile Internet. |
POST api/subscriptions/category/2/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type FixedLine. |
POST api/subscriptions/fixedline/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type FixedLine. |
POST api/subscriptions/category/3/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type VoIP. |
POST api/subscriptions/voip/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type VoIP. |
POST api/subscriptions/category/4/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type Internet. |
POST api/subscriptions/internet/{subscriptionId}/suspend/date/{dateString} |
Submits an order to ("soft") suspend an existing subscription of type Internet. |
POST api/subscriptions/category/1/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type Mobile or Mobile Internet. |
POST api/subscriptions/category/1000/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type Mobile or Mobile Internet. |
POST api/subscriptions/mobileinternet/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type Mobile or Mobile Internet. |
POST api/subscriptions/mobile/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type Mobile or Mobile Internet. |
POST api/subscriptions/category/2/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type FixedLine. |
POST api/subscriptions/fixedline/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type FixedLine. |
POST api/subscriptions/category/3/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type VoIP. |
POST api/subscriptions/voip/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type VoIP. |
POST api/subscriptions/category/4/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type Internet. |
POST api/subscriptions/internet/{subscriptionId}/reactivate/date/{dateString} |
Submits an order to reactivate a suspended subscription of type Internet. |
PUT api/subscriptions/category/1/{subscriptionId}/topup |
No documentation available. |
PUT api/subscriptions/mobile/{subscriptionId}/topup |
No documentation available. |
GET api/subscriptions/{subscriptionId}/paymentinfo |
Retrieves payment information for the specified subscription. |
POST api/subscriptions/{subscriptionId}/paymentinfo/{paymentInfoId} |
Sets the specified payment information to be used for the specified subscription. |
POST api/subscriptions/{subscriptionId}/payment/{paymentId} |
Submits a top-up payment for a subscription. |
GET api/subscriptions/subscriptionbypaymentid/{PaymentInformationId} |
No documentation available. |
POST api/subscriptions/{subscriptionId}/autotopup |
Tops up the specified subscription with the paid amount, and enables auto-topup for the future using the same payment information. |
DELETE api/subscriptions/{subscriptionId}/autotopup |
Disables auto-topup for a subscription. |
Products
API | Description |
---|---|
GET api/products/categories/test |
Retrieves a list of all subscription categories defined in Umbraco, with information as to whether there is a matching iTMS category. |
GET api/products/categories/customertype/{customerType}/lang/{language} |
Retrieves a list of subscription categories for the specified customer type, with supplemental info from Umbraco. |
GET api/products/packages/test |
Retrieves a list of all product packages defined in Umbraco, with information as to whether there is a matching iTMS product package. |
GET api/products/packages/category/{subscriptionCategory}/customertype/{customerType}/lang/{language} |
Retrieves a list of product packages based on the specified subscription category and customer type. |
GET api/products/packages/subscription/{subscriptionId}/lang/{language} |
Retrieves a list of available product packages based on the specified subscriptionId. |
GET api/products/packages/{productPackageProvisioningCode}/customertype/{customerType}/category/{subscriptionCategory}/lang/{language} |
Retrieves information about a specific product package. |
GET api/products/category/{categoryId}/customerType/{customerType}/ordertype/{orderType}/package/{productPackageProvisioningCode}/lang/{language} |
Retrieves a list of products based on the specified product package and order type. |
GET api/products/subscription/{subscriptionId}/lang/{language} |
Retrieves a list of available products based on the specified subscription Id, with an indication of whether each product is currently active for the subscription. This method is only available for Mobile, FixedLine and Internet subscriptions. |
UpdateCreditCard
API | Description |
---|---|
GET api/updatecreditcard/customersubscriptions |
No documentation available. |
GET api/updatecreditcard/{subscriptionId}/paymentinfo |
No documentation available. |
POST api/updatecreditcard/paymenturl |
No documentation available. |
GET api/updatecreditcard/link2paycompleted |
No documentation available. |
Authorization
API | Description |
---|---|
POST api/auth/logincustomer |
Submits username and password to receive a login session token for a specific customer. Note that the username can be either CustomerId or phone number. |
POST api/auth/login |
Submits username and password to receive a login session token for a specific customer. Note that the username can be either CustomerId or phone number. |
POST api/auth/changepw |
Changes the customer's current password. |
POST api/auth/resetpw |
Submits a password reset request for the customer matching the submitted information. |
Orders
API | Description |
---|---|
GET api/orders/statuses |
Returns a list of possible order statuses, e.g. "In progress" or "Cancelled". |
GET api/orders |
Retrieves a list of iTMS orders related to the currently logged-in customer. |
POST api/orders/availablenumbers |
Retrieves a list of available phone numbers of the specified type. |
POST api/orders/availablenumbers/reserve/{phoneNumber}/{packageProvisioningCode} |
No documentation available. |
GET api/orders/fiberlookup/{kvhx} |
No documentation available. |
POST api/orders |
Creates an order for a new subscription of any type. |
GET api/orders/new |
Retrieves a new payment Id. |
POST api/orders/swedbankcheckoutuser |
No documentation available. |
POST api/orders/billwerkcheckoutuser |
No documentation available. |
POST api/orders/swedbankcheckout |
No documentation available. |
POST api/orders/billwerkcheckout |
No documentation available. |
POST api/orders/bamboracheckout |
No documentation available. |
POST api/orders/paymentform |
Retrieves an HTML payment form to be injected in the user's order submission page. |
GET api/orders/paymentcompleted |
Confirms a Kvanto payment. This method is reserved for automated post-sales notification requests issued directly from the Kvanto server. |
GET api/orders/paymentchanged |
No documentation available. |