Partner API

Partner API for all types of ICC-integrated partners

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

Data Types

XML

Default Namespace (schema)
type description
NO_CONTENT
Namespace http://partner.get.no/api/schema/v1 (schema)
type description
aLaCarteChannel
aLaCarteChannelOption
aLaCarteOption
aLaCarteProduct
ApsDevice
ApsInformation
address
addressEntry
addressId
addressType
addresses
agreement
agreementDetail
agreementDetailStatus
agreementForCustomer
agreementStatus
agreements
allowedModel
apartment
apartments
partnerAuthentication Created with IntelliJ IDEA. User: 005075 Date: 5/3/13 Time: 3:10 PM To change this template use File | Settings | File Templates.
availableOfferDefinition
availableOfferDefinitions
availableProduct
availableProducts
cadastre
cadastres
channel
channelForProduct
channelType
channels
chargePeriod
customField
customFieldEntry
customFields Collection of all custom fields for an entity.
customFieldEntries
customerClass
customer
customerReference The customer id. This holds a reference to a customer via the customerId field. The provided links should reference resources for accessing the customer data for the id.
customerLocation
customerOwnedDevice
provisioningDeviceType
customerOwnedDevices
customerPassword
customerPasswordVerificationResult
customer-secure-password
customerStatus
customerSubUser
customerSubUsers
customerType
customerUsername A customer's username.
customers
device
deviceModel
deviceModels
devicePerAgreementDetail
deviceStatus
devices
devicesForCustomer
devicesPerAgreementDetail
distributor
distributors
dunningLevel
emailAccountAddressSuggestions
emailAccountAlias
emailAccount
emailAccounts
financeOption
financeOptionForDevice
financialAccount
financialAccountForCustomer
financialAccountStatus
gabAddress
gabAddresses
histories
history
IbsInformation
letter
letters
invoice
invoices
lineOfService
lineOfServices
link
linkToValidAddressDTO
links
listPrice
listPrices
modelReference
networkComponent
networkComponentStatus
networkComponentType
networkComponents
networkLocation Date: 4/17/13
offer
offerDefinition
offerDefinitions
offerLevelTypeDTO Data Transfer object for contract.
offers
onetimePassword
service
onetimeValidationResult
operationDTO Created with IntelliJ IDEA. User: 005075 Date: 5/3/13 Time: 3:18 PM To change this template use File | Settings | File Templates.
operationalStatus
operationalStatuses
pairedWith
pairingDirection
pairingForDevice
pairingsForDevice
pricingChargeType
pricingInfo
productCombinationRule
productCombinationRulesPerProductCollection
productCombinationRulesPerProduct
product
productInCombinationRule
products
province
provinces
provisioningStatus Collection of information from backend services that shed a light on the current provisioning status of the query that produces it. All fields must have the "available" attribute set to either true or false, depending on whether the data from the given backend service exists and is valid. Typical example of this are devices that exists in IBS, but not APS, which means that the device is probably not provisioned to a customer, and can be used by a new customer.
provisioningToken
reactivateCustomer
root
shipAddress
shippingMethod
shippingOrder A shipping order represents an order of one or more order lines to be sent from one stock handler to another entity, such as a customer.
shippingOrderDeviceValidation
shippingOrderDeviceValidations
shippingOrderLine
shippingOrderLines
shippingOrderStatus
shippingOrderType The type of a shipping order. These are the valid types of a shipping order, which denotes what kind of exchange the order is for.
shippingOrders
mapping
shippinigOrder A shipping order represents an order of one or more order lines to be sent from one stock handler to another entity, such as a customer.
option
softwarePerAgreementDetailCollection
softwarePerAgreementDetail
stockHandler A stock handler represents an entity that has a stock of devices that may be shipped to and from customers or other entities.
stockHandlerReference
swapDeviceReason
transientAgreement
unlinkedSoftware
unlinkedSoftwareList
validAddressCustomFieldKey
validAddress
validAddressId
validAddressIds
validAddresses
validationResult
verificationResult
warranty
activateAgreementDetail (Empty) object to send to activate agreement detail
agreementDetailUpdates
authenticateCustomerSubUser
cancelAgreementDetail
changeEntitlement
createAgreement
addProduct
createCustomer
createCustomerSubUser
createDevice
createDistributor
createEmailAccountAlias
createEmailAccount
createOffer
createSoftwarePerAgreementDetail
createTrackingNumber
createValidAddress
destroyDevice Destroy device request
findCustomerLocation
generateOnetimePassword
generateProvisioningToken
provisionLineOfService
provisionPairedDevice
partnerDeviceWarranty
provisionCustomerEntitlements
provisionCustomerOwnedDevice
provisionDevice
receiveExchangeDevice
receiveReturnedDevice DTO for receiving a returned device at warehouse or dealer
remoteBooking
replaceALaCarteChannel
returnDevice DTO for returning device
swapDevice
transferSerialisedStock DTO for transfer serialised stock on device
updateALaCarteProduct
updateAgreementDetail
updateCustomerAddress
updateCustomerSubUser
UpdateDeviceForDevicePerAgreementDetail
updateDeviceStatus DTO for transfer serialised stock on device
updateEmailAccountPassword DTO for updating password on an email account
updateExternalRefId
validateDeviceForOrderLine
validateOnetimePassword