List available license add-on

URI - GET

To use this endpoint, send a GET request to list add-on: /msp/addons

Request

The request must only include HTTP headers (obtained in the authentication/authorization process and used to sign the request).

Request Headers

Header	Type	Required	Format	Description/Sample
x-av-req-id	String	Yes	UUID – generated and supplied on the request	d290f1ee-6c54-4b01-90e6-d701748f0851
x-av-token	String	Yes	Token obtained in the authentication sequence	tkn8546ffffggd9d8934593
x-av-app-id	String	Yes	Application ID provided by Avanan	myapp29
x-av-date	String	Yes	Date-time in GMT	'2016-08-29T09:12:33.001Z'
x-av-sig	String	Yes	Calculated signature	tkn8jmveolrrtertr9d8934593

Request sample (CURL) format

This request sample shows URI base in USA region. For URI base in other regions, see MSP Types.

Copy

curl -X GET -H "Accept: application/json" \
    -H "x-av-req-id: d290f1ee-6c54-4b01-90e6-jjshduhuh" \
    -H "x-av-token: tkn8546ffffggd9d8934593" \
    -H "x-av-app-id: myapp29" \
    -H "x-av-date: 2021-02-28T09:12:33.001Z" \
    -H "x-av-sig: tkn8jmveolrrtertr9d8934593" \
    https://smart-api-production-1-us.avanan.net/v1.0/msp/addons

Response

The response obtained from the service includes an HTTP response code and JSON formatted structure. The structure consists of a responseEnvelope structure and a responseData object with an array of add-on objects. The add-on objects include the ID and name of all the available tenant add-ons.

Response Structure

Copy

{
  "responseEnvelope": {
        "requestId": "string",
        "responseCode": 0,
        "responseText": "",
        "additionalText": "",
        "recordsNumber": 0,
        "scrollId": "string"
  },
  "responseData": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

Response Parameters

The response parameters:

Parameter		Type	Description
responseEnvelope		Object	A container of metadata properties
	requestId	String	Request ID (from the request header x-av-req-id value)
	responseCode	Integer	0 = Success Other values = Failure
	responseText	String	The text value of the response
	additionalText	String	Additional information
	recordsNumber	Integer	Number of records in the response
	totalRecordsNumber	Integer	Total number of records
	scrollId	String	A unique ID used to scroll through data
responseData		Object	An array of License Objects
	id	Integer	ID of license choice
	name	String	Name of the add-on

Response Sample

A valid response from the service:

Copy

{
    'responseEnvelope': {
        'requestId': 'da1b074e-8f54-495b-b626-182c883e3817',
          'responseCode': 200,
          'responseText': '',
          'additionalText': '',
          'recordsNumber': 1,
          'scrollId': ''
    },
     'responseData': [
         {
             'id': 1, 
             'name': 'IRaaS'
         }
     ]
}