Api >

Service Portal REST API

GET Customer contract information
Given I am authenticated as admin
and there is a Customer with ID K0002 with:
ncomplete contract type When I send /api/customers/K0002/contract-information
Then I should receive HTTP/1.1 200 OK
and body with following fields:
{
  "href": "/api/customers/K0002/contract-information",
  "links": [{
    "rel": "subcontracts",
    "href": "/api/customers/K0002/contracts"
  }, {
    "rel": "features",
    "href": "/api/customers/K0002/feature-status"
  }, {
    "rel": "subscriptions",
    "href": "/api/customers/K0002/subscriptions"
  }],
  "data": [{
    "name": "name",
    "value": "vertragstyp_Premium-Version"
  }, {
    "name": "nameSdr",
    "value": "premium"
  }, {
    "name": "nameEnum",
    "value": "ncomplete"
  }, {
    "name": "allowServiceportalLogin",
    "value": true
  }, {
    "name": "allowAdminportalLogin",
    "value": true
  }, {
    "name": "maxDevicesPerExtension",
    "value": 9
  }, {
    "name": "maxDevicesPerCustomer",
    "value": 9999999
  }, {
    "name": "capabilitiesDefinedBy",
    "value": "NAME"
  }, {
    "name": "deleteUnrestricted",
    "value": true
  }, {
    "name": "cloudyaAllowed",
    "value": false
  }, {
    "name": "nctiProLicense",
    "value": false
  }, {
    "name": "canUsePreviewMode",
    "value": false
  }, {
    "name": "coachingExtensionEnable",
    "value": false
  }, {
    "name": "allowOperatorContractChange",
    "value": false
  }, {
    "name": "voicemailTranscriptionAllowed",
    "value": false
  }, {
    "name": "previewModeExplanationLink",
    "value": ""
  }, {
    "name": "nmqEnabled",
    "value": false
  }]
}
GET Customer coaching information
Given I am authenticated as admin
and there is a Customer with ID K0002 with:
ncomplete contract type When I send /api/customers/K0002/contract-information
Then I should receive HTTP/1.1 200 OK
and body with following fields:
{
  "href": "/api/customers/K0002/contract-information",
  "links": [{
    "rel": "subcontracts",
    "href": "/api/customers/K0002/contracts"
  }, {
    "rel": "features",
    "href": "/api/customers/K0002/feature-status"
  }, {
    "rel": "subscriptions",
    "href": "/api/customers/K0002/subscriptions"
  }],
  "data": [{
    "name": "name",
    "value": "vertragstyp_Premium-Version"
  }, {
    "name": "nameSdr",
    "value": "premium"
  }, {
    "name": "nameEnum",
    "value": "ncomplete"
  }, {
    "name": "allowServiceportalLogin",
    "value": true
  }, {
    "name": "allowAdminportalLogin",
    "value": true
  }, {
    "name": "maxDevicesPerExtension",
    "value": 9
  }, {
    "name": "maxDevicesPerCustomer",
    "value": 9999999
  }, {
    "name": "capabilitiesDefinedBy",
    "value": "NAME"
  }, {
    "name": "deleteUnrestricted",
    "value": true
  }, {
    "name": "cloudyaAllowed",
    "value": false
  }, {
    "name": "nctiProLicense",
    "value": false
  }, {
    "name": "canUsePreviewMode",
    "value": false
  }, {
    "name": "coachingExtensionEnable",
    "value": true
  }, {
    "name": "allowOperatorContractChange",
    "value": false
  }, {
    "name": "voicemailTranscriptionAllowed",
    "value": false
  }, {
    "name": "previewModeExplanationLink",
    "value": ""
  }, {
    "name": "nmqEnabled",
    "value": false
  }]
}
GET Customer contract information for license based contracts
Given I am authenticated as admin
and there is a Customer with ID K0002 with:
centrexx30 contract type When I send /api/customers/K0002/contract-information
Then I should receive HTTP/1.1 200 OK
and body with following fields:
{
  "href": "/api/customers/K0002/contract-information",
  "links": [{
    "rel": "subcontracts",
    "href": "/api/customers/K0002/contracts"
  }, {
    "rel": "features",
    "href": "/api/customers/K0002/feature-status"
  }, {
    "rel": "subscriptions",
    "href": "/api/customers/K0002/subscriptions"
  }],
  "data": [{
    "name": "name",
    "value": "vertragstyp_centrexx30"
  }, {
    "name": "nameSdr",
    "value": "centrexx30"
  }, {
    "name": "nameEnum",
    "value": "centrexx30"
  }, {
    "name": "allowServiceportalLogin",
    "value": true
  }, {
    "name": "allowAdminportalLogin",
    "value": true
  }, {
    "name": "maxDevicesPerExtension",
    "value": 4
  }, {
    "name": "maxDevicesPerCustomer",
    "value": 9999999
  }, {
    "name": "capabilitiesDefinedBy",
    "value": "SUBSCRIPTION"
  }, {
    "name": "deleteUnrestricted",
    "value": true
  }, {
    "name": "cloudyaAllowed",
    "value": true
  }, {
    "name": "nctiProLicense",
    "value": false
  }, {
    "name": "canUsePreviewMode",
    "value": false
  }, {
    "name": "coachingExtensionEnable",
    "value": false
  }, {
    "name": "allowOperatorContractChange",
    "value": false
  }, {
    "name": "voicemailTranscriptionAllowed",
    "value": false
  }, {
    "name": "previewModeExplanationLink",
    "value": ""
  }, {
    "name": "extensionAddAllowed",
    "value": false
  }, {
    "name": "groupAddAllowed",
    "value": false
  }, {
    "name": "virtualFaxAddAllowed",
    "value": false
  }, {
    "name": "virtualFaxAlwaysAddAllowed",
    "value": false
  }, {
    "name": "virtualFaxNeedsPerExtensionLicense",
    "value": true
  }, {
    "name": "conferenceAddAllowed",
    "value": false
  }, {
    "name": "queueAddAllowed",
    "value": false
  }, {
    "name": "timecontrolAddAllowed",
    "value": false
  }, {
    "name": "ivrAddAllowed",
    "value": false
  }, {
    "name": "mobilityPerUserAddAllowed",
    "value": false
  }, {
    "name": "mobilityAddAllowed",
    "value": false
  }, {
    "name": "basicCTIAddAllowed",
    "value": false
  }, {
    "name": "nmqEnabled",
    "value": false
  }]
}
GET Customer contract information includes previewModeExplainationLink
Given I am authenticated as admin
and there is a Customer with ID K0002 with:
ncomplete contract type

and there is a feature: PILOTMODE_EXPLANATION_LINK
with value: https://content.nfon.com/de-de/pilotmode

When I send /api/customers/K0002/contract-information
Then I should receive HTTP/1.1 200 OK
and body with following fields:
{
  "href": "/api/customers/K0002/contract-information",
  "data": [{
    "name": "previewModeExplanationLink",
    "value": "https://content.nfon.com/de-de/pilotmode"
  }]
}