getBrokerOptions

Description

Retrieves the contents of the license file registered with the Master module you're connected to.

Example

Request

{}

Reply

{
  "productId": 1,
  "licenseVersion": 42,
  "companyId": 99999,
  "platformCode": 3,
  "minionCount": 0,
  "publicKey": "AkLkwNa9oq7a",
  "options": [
    {
      "name": "Base Product",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "First Class Mail",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Advanced First Class Mail",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Periodical Mail",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Advanced Periodical Mail",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Periodical Comail",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Standard Mail",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Advanced Standard Mail",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Standard Comail",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Package Services",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Advanced Package Services",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name": "Labels Module",
      "isEnabled": true,
      "isTrial": false,
      "renewalDate": "20160831"
    },
    {
      "name" : "C Wrapper",
      "isEnabled" : true,
      "isTrial" : false,
      "renewalDate" : null
    },
    {
      "name" : ".NET Wrapper",
      "isEnabled" : true,
      "isTrial" : false,
      "renewalDate" : null
    },
    {
      "name" : "Python Wrapper",
      "isEnabled" : true,
      "isTrial" : false,
      "renewalDate" : null
    },
    {  
      "name" : "Address Standardization",
      "isEnabled" : true,
      "isTrial" : false,
      "renewalDate" : null
    },
    {  
      "name" : "First Class Comail",
      "isEnabled" : true,
      "isTrial" : false,
      "renewalDate" : null
    },
    {  
      "name" : "NCOALink FSP",
      "isEnabled" : true,
      "isTrial" : false,
      "renewalDate" : null
    },
    {  
      "name" : "NCOALink LSP",
      "isEnabled" : false,
      "isTrial" : false,
      "renewalDate" : null
    },
    {  
      "name" : "NCOALink EU",
      "isEnabled" : false,
      "isTrial" : false,
      "renewalDate" : null
    },
    {  
      "name" : "NCOALink LSP with ANKLink",
      "isEnabled" : false,
      "isTrial" : false,
      "renewalDate" : null
    },
    {  
      "name" : "NCOALink EU with ANKLink",
      "isEnabled" : false,
      "isTrial" : false,
      "renewalDate" : null
    },
    {
      "name" : "Additional Worker Threads",
      "isEnabled" : true,
      "isTrial" : false,
      "renewalDate" : "20160831",
      "value": 42
    }
  ]
}

Request Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"object"
}

Reply Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"object",
  "required":[
    "options",
    "productId",
    "licenseVersion",
    "companyId",
    "publicKey"
  ],
  "properties":{
    "options":{
      "type":"array",
      "items":{
        "type":"object",
        "properties":{
          "name":{
            "type":"string"
          },
          "isEnabled":{
            "type":"boolean"
          },
          "isTrial":{
            "oneOf":[
              {
                "type":"boolean"
              },
              {
                "type":"null"
              }
            ]
          },
          "renewalDate":{
            "oneOf":[
              {
                "type":"string",
                "minLength":8,
                "maxLength":8
              },
              {
                "type":"null"
              }
            ]
          },
          "value":{
            "type":"integer"
          }
        }
      }
    },
    "productId":{
      "type":"integer"
    },
    "licenseVersion":{
      "type":"integer"
    },
    "companyId":{
      "type":"integer"
    },
    "publicKey":{
      "type":"string"
    }
  }
}