License Agreement API

Permission

No permission check

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/LicenseAgreement/GetVersion

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

Checks DAPI current username exists

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/LicenseAgreement/GetLatestCurrentReleased

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

license_agreement:add

Accessible

Portal only. See response and accessiblity information for more

URL

https://portal.iotnxt.io/DAPI/v1/LicenseAgreement/AddLicenseAgreement

URL Params

None

Data Params

Example:
{
    "agreementText": "string",
    "releaseDateTime": DateTime
}

• agreementText: string

• releaseDateTime: DateTime? optional

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

license_agreement:edit

Accessible

Portal only. See response and accessiblity information for more

URL

https://portal.iotnxt.io/DAPI/v1/LicenseAgreement/UpdateLicenseAgreement

URL Params

None

Data Params

Example:
{
    "licenseAgreementId": "string",
    "agreementText": "string",
    "releaseDateTime": "DateTime"
}

• licenseAgreementId: string

• agreementText: string

• releaseDateTime: DateTime? (optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

license_agreement:delete

Accessible

Portal only. See response and accessiblity information for more

URL

https://portal.iotnxt.io/DAPI/v1/LicenseAgreement/RemoveLicenseAgreement

URL Params

None

Data Params

{
    "licenseAgreementId": "string"
}

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

license_agreement:edit

Checks DAPI current username exists

Accessible

Portal only. See response and accessiblity information for more

URL

https://portal.iotnxt.io/DAPI/v1/LicenseAgreement/ReleaseLicenseAgreement

URL Params

None

Data Params

{
    "licenseAgreementId": "string",
    "releaseDateTime": DateTime
}

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

license_agreement:get

Checks DAPI current username exists

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/LicenseAgreement/GetAllLicenseAgreements

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

Checks DAPI current username exists

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/LicenseAgreement/HasUserAcceptedLatestLicenseAgreement

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

Checks DAPI current username exists

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/LicenseAgreement/GetPendingLicenseAgreementForUser

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

Checks DAPI current username exists

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/LicenseAgreement/SetUserAgreementResponse

URL Params

None

Data Params

Example:
{
    "version": "2"
    "accepted": "true"
}

• version: int

• accepted: bool? (optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

Checks DAPI current username exists

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/LicenseAgreement/GetUserLastAcceptedLicenseAgreement

URL Params

None

Data Params

{
    "username": "string"
}

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

No permission check

Accessible

Portal only. See response and accessiblity information for more

URL

https://portal.iotnxt.io/DAPI/v1/LicenseAgreement/GetReportFilterConfig

URL Params

None

Data Params

None

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Permission

No permission check

Accessible

Portal only. See response and accessiblity information for more

URL

https://portal.iotnxt.io/DAPI/v1/LicenseAgreement/GetLicenseAgreementReport

URL Params

None

Data Params

Example:
{
    "startDate": DateTime,
    "endDate": DateTime,
    "clientId": "string",
    "username" : "string",
    "version" : 5,
    "status": "string"
}

• startDate: DateTime

• endDate: DateTime

• clientId: string (optional)

• username : string (optional)

• version : int? (optional)

• status: string (optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None