Link

Bundle Services

Bundles list

Return a list of all configured bundles for the current vendor.

</tbody> </table> See also JavaDoc: BundleService.listExample
Request
{: .code-example .ml-5 .code-header } ```http GET https://go.netlicensing.io/core/v2/rest/bundle Accept: application/xml ``` {: .ml-5 }
Response
{: .code-example .ml-5 .code-header } ```xml B001 true Bundle Numero Uno 0.00 EUR Bundle Descripcion Uno LT01,LT02 CustomPropertyValue B002 true Bundle Numero Dos 10.00 EUR Bundle Descripcion Dos CustomPropertyValue ``` {: .ml-5 }
Try it now
{: .code-example .ml-5 .code-header } ```bash $ curl --header "Accept: application/xml" --insecure --user demo:demo --request GET https://go.netlicensing.io/core/v2/rest/bundle ``` {: .ml-5 } ### Get bundle Return a bundle by bundleNumber.

HTTP Method / URL

GET /core/v2/rest/bundle

Security
  • Basic Authentication
  • API Key Identification
    • ROLE_APIKEY_ADMIN
    • ROLE_APIKEY_MAINTENANCE
    • ROLE_APIKEY_OPERATION
    • ROLE_APIKEY_ANALYTICS
  • </ul> </td> </tr>

Request Header

Accept: application/json | application/xml

Request Parameters

- None -

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

HTTP Method / URL

GET /core/v2/rest/bundle/{bundleNumber}

Security
  • Basic Authentication
  • API Key Identification
    • ROLE_APIKEY_ADMIN
    • ROLE_APIKEY_MAINTENANCE
    • ROLE_APIKEY_OPERATION
    • ROLE_APIKEY_ANALYTICS

Request Header

Accept: application/json | application/xml

Request Parameters

bundleNumber (string) - Bundle number.

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

See also JavaDoc: BundleService.get Example
Request
{: .code-example .ml-5 .code-header } ```http GET https://go.netlicensing.io/core/v2/rest/bundle/B004 Accept: application/xml ``` {: .ml-5 }
Response
{: .code-example .ml-5 .code-header } ```xml B004 true Bundle Numero Cuatro 40.00 EUR Bundle Descripcion Cuatro CustomPropertyValue ``` {: .ml-5 } ### Create bundle Creates a new bundle.  
</tbody> </table> Example
Request
{: .code-example .ml-5 .code-header } ```http POST https://go.netlicensing.io/core/v2/rest/bundle number=BQVJQ5F7H&active=false&name=Bundle+6QP3NKHO&price=10&currency=EUR Accept: application/xml Content-Type: application/x-www-form-urlencoded ``` {: .ml-5 }
Response
{: .code-example .ml-5 .code-header } ```xml BQVJQ5F7H false Bundle 6QP3NKHO 10.00 EUR ``` {: .ml-5 } ### Update bundle Sets the provided properties to a bundle. Return an updated bundle.

HTTP Method / URL

POST /core/v2/rest/bundle

Security

Request Header

Accept: application/json | application/xml
Content-Type: application/x-www-form-urlencoded

Request Parameters

number (string) - Unique number that identifies the bundle. Vendor can assign this number when creating a bundle or let NetLicensing generate one.

active (boolean) - If set to false, the bundle is disabled. Licensees can not obtain new licenses.

name (string) - Bundle name. Identifies the bundle for the end customer.

description (string) - Bundle description. Optional.

price (double) - Price for the bundle. If >0, it must always be accompanied by the currency specification. Optional. 

currency (enum) - specifies currency for the bundle price. Check data types to discover which currencies are supported. Optional.

- EUR       - Euro currency for the bundle price

licenseTemplatesNumbers (string) - Comma-separated license templates numbers.

</tr>

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
402 - Not allowed within your pricing plan
403 - Access is denied
404 - Resource not found
500 - Internal service error

</tbody> </table> Example
Request
{: .code-example .ml-5 .code-header } ```http POST https://go.netlicensing.io/core/v2/rest/bundle/BJIF898SP number=BQVJQ5F7H&active=false&name=Bundle+6QP3NKHO&price=10&currency=EUR Accept: application/xml Content-Type: application/x-www-form-urlencoded ``` {: .ml-5 }
Response
{: .code-example .ml-5 .code-header } ```xml BQVJQ5F7H false Bundle 6QP3NKHO 10.00 EUR ``` {: .ml-5 } ### Delete bundle Delete a bundle by number.

HTTP Method / URL

POST /core/v2/rest/bundle/{bundleNumber}

Security

Request Header

Accept: application/json | application/xml
Content-Type: application/x-www-form-urlencoded

Request Parameters

bundleNumber (string) - Unique number that identifies the bundle.

number (string) - New bundle number (update)

active (boolean) - If set to false, the bundle is disabled. Licensees can not obtain new licenses.

name (string) - Bundle name. Identifies the bundle for the end customer.

description (string) - Bundle description. Optional.

price (double) - Price for the bundle. If >0, it must always be accompanied by the currency specification. Optional.

currency (enum) - specifies currency for the bundle price. Check data types to discover which currencies are supported. Optional.

- EUR       - Euro currency for the bundle price

licenseTemplatesNumbers (string) - Comma-separated license templates numbers.

</tr>

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
402 - Not allowed within your pricing plan
403 - Access is denied
404 - Resource not found
500 - Internal service error

HTTP Method / URL

DELETE /core/v2/rest/bundle/{bundleNumber}

Security

Request Header

Accept: application/json | application/xml

Request Parameters

bundleNumber (string) - Bundle number.

HTTP Status Code

204 - Successful request
400 - Malformed or illegal request
403 - Access is denied
404 - Resource not found
500 - Internal service error

Example
Request
{: .code-example .ml-5 .code-header } ```http DELETE https://go.netlicensing.io/core/v2/rest/bundle/B001 Accept: application/xml ``` {: .ml-5 }
Response
{: .code-example .ml-5 .code-header } ```html HTTP/1.1 204 No Content ``` {: .ml-5 } ### Obtain bundle Obtain bundle - create licenses based on license templates.

HTTP Method / URL

POST /core/v2/rest/bundle/{bundleNumber}/obtain

Security

Request Header

Accept: application/json | application/xml

Request Parameters

bundleNumber (string) - Bundle number.

licenseeNumber (string) - Licensee number

HTTP Status Code

200 - Successful request
400 - Malformed or illegal request
402 - Not allowed within your pricing plan
403 - Access is denied
404 - Resource not found
500 - Internal service error

Example
Request
{: .code-example .ml-5 .code-header } ```http POST https://go.netlicensing.io/core/v2/rest/bundle/BJIF898SP licenseeNumber=LQVJQ5F7H Accept: application/xml Content-Type: application/x-www-form-urlencoded ``` {: .ml-5 }
Response
{: .code-example .ml-5 .code-header } ```xml L7NWRXKTN true Feature 2 20.00 EUR false IJ5AFCRHP EIG97Y953 MYMW47CMQ L7KMDCA6G true Feature 3 30.00 EUR false IJ5AFCRHP EWT4U3F9V MYMW47CMQ L23YKRDWW true 1 day 10.00 EUR false IJ5AFCRHP EKR3P2NZU MKGMPKCN9 false DAY 1 2023-05-17T10:13:40.015Z ``` {: .ml-5 }