Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the Swagger UI provided for this API.

name path methods description
AddressResource
  • /address/{addressId}
  • /address/address-for-customer/{customerId}
  • GET
  • GET
AgreementDetailResource
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/a-la-carte-product/update
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/activate
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/a-la-carte-product
  • POST
  • POST
  • GET, PUT
  • GET
AgreementResource
  • /customer/{customerId}/agreement/{agreementId}
  • /customer/{customerId}/agreement
  • /customer/{customerId}/agreement/{agreementId}/activate
  • GET, POST
  • GET, POST
  • POST
ApiAccessResource
  • /access
  • GET
AuthenticationResource
  • /user/authenticate/sub-user
  • POST
CacheFlusher
  • /cache
  • DELETE
ChannelResource
  • /channel
  • /channel/{channelId}
  • GET
  • GET
CustomerResource
  • /customer/{customerId}/verify-customer-password
  • /customer/{customerId}/secure-password
  • /customer/{customerId}
  • /customer/{customerId}/update-customer-password
  • /customer/customers-for-address-details
  • /customer/{customerId}/find-customer-location
  • /customer/customers-for-serialnumber/{serialNumber}
  • /customer/{customerId}/move
  • /customer/{customerId}/onetime-password/generate
  • /customer/customer-for-username/{userName}
  • /customer/{customerId}/username
  • /customer
  • /customer/{customerId}/onetime-password/validate
  • /customer/{customerId}/reactivate
  • POST
  • GET
  • GET, PUT
  • PUT
  • GET
  • POST
  • GET
  • POST
  • POST
  • GET
  • DELETE, GET, PUT
  • POST
  • POST
  • POST
Customer service.
CustomerSubUserResource
  • /customer/{customerId}/sub-user/{mobilePhone}
  • /customer/{customerId}/sub-user
  • DELETE, PUT
  • GET, POST
DeviceCommandResource
  • /device/{deviceId}/command/reset-pin
  • /device/{deviceId}/command/downgrade-mikro
  • /device/{deviceId}/command/change-to-fusion
  • /device/{deviceId}/command/reprovision-smartcard
  • /device/{deviceId}/command/reset-product
  • /device/{deviceId}/command/change-to-evolution
  • /device/{deviceId}/command/change-to-ivp
  • /device/{deviceId}/command/refresh-device
  • /device/{deviceId}/command/upgrade-mikro
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
DeviceModelResource
  • /device-model
  • /device-model/{modelId}
  • GET
  • GET
DevicePerAgreementDetailResource
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/device-per-agreement-detail/{devicePerAgreementDetailId}/swap-device
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/device-per-agreement-detail/{devicePerAgreementDetailId}
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/device-per-agreement-detail/{devicePerAgreementDetailId}/device
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/device-per-agreement-detail
  • POST
  • GET
  • PUT
  • GET
DeviceResource
  • /device/{deviceId}/transfer-serialised-stock
  • /device/{deviceId}/update-device-model/{modelId}
  • /device/serial/{serialNumber}
  • /device/{deviceId}/finance-option
  • /device/device-for-ip-address/{ipaddress}
  • /device/devices-for-customer/{customerId}
  • /device/{deviceId}/return-to-stock
  • /device/{deviceId}/pairing-for-device/{pairedDeviceId}
  • /device/{deviceId}/customer-warranty
  • /device/{deviceId}
  • /device/device-for-macaddress/{macAddress}
  • /device
  • /device/{deviceId}/pairing-for-device
  • /device/{deviceId}/reauthorize-software
  • /device/{deviceId}/destroy
  • /device/{deviceId}/receive-returned-device-at-warehouse
  • /device/{deviceId}/manual-status-change
  • /device/{deviceId}/receive-exchange
  • /device/{deviceId}/manufacturer-warranty
  • /device/{deviceId}/remote-booking
  • /device/{deviceId}/receive-returned-device-at-dealer
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • POST
  • DELETE, POST
  • GET
  • GET
  • GET
  • GET, POST
  • GET
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
DistributorResource
  • /distributor/{distributorId}/linked-validaddresses
  • /distributor/{distributorId}
  • /distributor/{distributorId}/link-validaddress
  • /distributor/distributor-for-valid-address/{validAddressId}
  • /distributor/{distributorId}/unlink-validaddress
  • /distributor
  • GET
  • GET
  • POST
  • GET
  • POST
  • GET, POST
EmailAdminResource
  • /email/{emailAccountId}/alias
  • /email/{emailAccountId}/activate
  • /email/{emailAccountId}/password
  • /email/{emailAccountId}
  • /email
  • /email/{emailAccountId}/lock
  • /email/{emailAccountId}/alias/{alias}
  • /email/address-suggestions
  • /email/{emailAccountId}/deactivate
  • POST
  • POST
  • POST
  • GET
  • GET, POST
  • POST
  • DELETE
  • GET
  • POST
FinancialAccountResource
  • /customer/{customerId}/financial-account/{financialAccountId}
  • /customer/{customerId}/financial-account
  • /customer/{customerId}/financial-account/{financialAccountId}/reconnect
  • /customer/{customerId}/financial-account/{financialAccountId}/soft-disconnect
  • GET
  • POST
  • POST
  • POST
FireportalResource
  • /fireportal/apartment/portgroup/{portGroup}
  • /fireportal/apartment/{apartmentId}
  • /fireportal/ipaddress/{ipAddress}
  • GET, PUT
  • GET, PUT
  • GET, PUT
FusionLetterResource
  • /customer/{customerId}/fusion-letter
  • GET, POST
GabResource
  • /gab-data/address
  • /gab-data/cadastre
  • /gab-data/{id}/apartments
  • /gab-data/address/{id}
  • /gab-data/cadastre/{id}
  • GET
  • GET
  • GET
  • GET
  • GET
HealthCheckResource
  • /healthcheck
  • GET
HistoryResource
  • /customer/{customerId}/history
  • GET
InvoiceResource
  • /customer/{customerId}/invoice
  • GET
LetterResource
  • /letter/{letterId}
  • GET, POST
LineOfServiceResource
  • /line-of-service/phone/{phoneNumber}
  • /line-of-service/customer/{customerId}
  • /line-of-service/email/{email}
  • GET
  • GET
  • GET
ListPriceResource
  • /list-price
  • GET
NetworkComponentResource
  • /infrastructure/network-component
  • /infrastructure/network-component/{networkComponentId}
  • GET
  • GET
OfferDefinitionResource
  • /offer-definition
  • /offer-definition/{offerDefinitionId}
  • /offer-definition/automatic/for-customer/{customerId}
  • /offer-definition/automatic/for-customer/{customerId}/product/{productId}
  • /offer-definition/{offerDefinitionId}/offer
  • GET
  • GET
  • GET
  • GET
  • POST
OfferResource
  • /customer/{customerId}/offer
  • /customer/{customerId}/offer/{offerId}
  • GET
  • DELETE, GET
OldAgreementDetailResource
  • /customer/{customerId}/agreement/{agreementId}/old-agreement-detail/{agreementDetailId}
  • GET
OperationalStatusResource
  • /infrastructure/operational-status
  • GET
PartnerDeviceWarrantyResource
  • /device/{deviceId}/partner-warranty
  • GET, POST
ProductCombinationRulesResource
  • /product-combination-rule
  • GET
ProductResource
  • /product
  • /product/{productId}
  • GET
  • GET
ProvinceResource
  • /province/{provinceId}
  • /province
  • GET
  • GET
ProvisionCustomerOwnedDeviceResource
  • /customer/{customerId}/customer-owned-device/{deviceId}
  • /customer/{customerId}/customer-owned-device/token
  • /customer/{customerId}/customer-owned-device
  • GET, PUT
  • POST
  • GET
ProvisionCustomerResource
  • /customer/{customerId}/provision/entitlement
  • PUT
ProvisionDeviceResource
  • /device/{deviceId}/provision/disable
  • /device/{deviceId}/provision
  • POST
  • DELETE, PUT
RootResource
  • GET
ShippingOrderResource
  • /warehouse/shipping-order/{orderId}/tracking
  • /warehouse/shipping-order/{orderId}/line/{orderLineId}/validate
  • /warehouse/shipping-order/new
  • /warehouse/shipping-order/{orderId}/ship
  • /warehouse/shipping-order/{orderId}
  • PUT
  • POST
  • GET
  • POST
  • GET
SoftwarePerAgreementDetailResource
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/software-per-agreement-detail
  • /customer/{customerId}/agreement/{agreementId}/agreement-detail/{agreementDetailId}/software-per-agreement-detail/{softwarePerAgreementDetailId}
  • GET, POST
  • GET
StatusResource
  • /provisioning/status
  • GET
TransientAgreementResource
  • /customer/{customerId}/agreement/{agreementId}/transient
  • POST
UnlinkedSoftwareResource
  • /customer/{customerId}/agreement/{agreementId}/unlinked-software
  • GET
ValidAddressResource
  • /valid-address/{validAddressId}
  • /valid-address/{validAddressId}/available-product
  • /valid-address
  • GET, PUT
  • GET
  • GET, POST