Minimum Endpoint Version – System Level Configuration

These APIs enable Administrators to reject endpoints at the system level based on:

  • ApplicationName. By default, the following Application Names are configured to be rejected:
  • VidyoDesktop
  • VidyoMobile
  • EndpointType. By default, the following endpoints are configured to be rejected:
  • V- VidyoRoom HD200 (Windows)
  • R- VidyoRoom HD100/HD50 (Windows) 

The reject endpoints created at the system level will be the system default for all tenants  and newly created tenants.

Rejection occurs during login sequence (LinkEndpoint) and JoinConference. 

Create System Default Rejected Application

URL: /admin/api/v1/system/tenants/rejections/applications

Method: POST

Parameters

No parameters.

Request body

{

  "name": "VidyoDesktop"

}

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": [

    {

      "id": 1,

      "tenantId": 0,

      "name": "VidyoMobile"            

    }

  ]

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Get All System Default Rejected Applications

URL: /admin/api/v1/system/tenants/rejections/applications

Method: GET

Parameters

No parameters.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

[

  {

    "version": "1",

    "status": "success",

    "data": [

      {

        "id": 1,

        "tenantId": 0,

        "name": "VidyoDesktop"

      },

      {

        "id": 2,

        "tenantId": 0,

        "name": "VidyoMobile"

      }

    ]

  }

]

Error responses

HTTP response code

Error message

401

Unauthorized

403

Forbidden

500

Internal server error

Force Update System Default Rejected Applications to All Tenants

URL: /admin/api/v1/system/tenants/rejections/applications

Method: PUT

Parameters

No parameters.

Request body

{

  "name": "VidyoDesktop"

}

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": [

    {

      "id": 1,

      "tenantId": 0,

      "name": "VidyoMobile"

    }

  ]

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Get System Default Rejected Application

URL: /admin/api/v1/system/tenants/rejections/applications/{rejectedApplicationId}

Method: GET

Parameters

Field

Data type

Mandatory

Description

rejectedapplicationid

Integer

Y

Rejected application id.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": [

    {

      "id": 1,

      "tenantId": 0,

      "name": "VidyoMobile"

    }

  ]

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Update System Default Rejected Application

URL: /admin/api/v1/system/tenants/rejections/applications/{rejectedApplicationId}

Method: PUT

Parameters

Field

Data type

Mandatory

Description

rejectedApplicationid

Integer

Y

Rejected application id to update.

Request body

{

  "name": "VidyoDesktop"

}

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": [

    {

      "id": 1,

      "tenantId": 0,

      "name": "VidyoMobile"

    }

  ]

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Delete System Default Rejected Application

URL: /admin/api/v1/system/tenants/rejections/applications/{rejectedApplicationId}

Method: DELETE

Parameters

Field

Data type

Mandatory

Description

rejectedApplicationid

Integer

Y

Rejected application id to delete.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": null

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Create System Default Rejected Endpoint Type

URL: /admin/api/v1/system/tenants/rejections/endpointTypes

Method: POST

Parameters

No parameters.

Request body

{

  "endpointType": "V"

}

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": [

    {

      "id": 1,

      "tenantId": 0,

      "endpointType": "V"            

    }

  ]

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Get All System Default Rejected Endpoint Types

URL: /admin/api/v1/system/tenants/rejections/endpointTypes

Method: GET

Parameters

No parameters.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

[

  {

    "version": "1",

    "status": "success" ,

    "data": [

      {

        "id": 1,

        "tenantId": 0,

        "endpointType": "R"

      },

      {

        "id": 2,

        "tenantId": 0,

        "endpointType": "V"

      },

      {

        "id": 3,

        "tenantId": 0,

        "endpointType": "Y"

      }

    ]

  }

]

Error responses

HTTP response code

Error message

401

Unauthorized

403

Forbidden

500

Internal server error

Force Update System Default Rejected Endpoint Type to All Tenants

URL: /admin/api/v1/system/tenants/rejections/endpointTypes

Method: PUT

Parameters

No parameters.

Request body

{

  "endpointType": "V"

}

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": [

    {

      "id": 1,

      "tenantId": 0,

      "endpointType": "V"

    }

  ]

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Get System Default Rejected Endpoint Type

URL: /admin/api/v1/system/tenants/rejections/endpointTypes/{rejectedEndpointTypeId}

Method: GET

Parameters

Field

Data type

Mandatory

Description

rejectedEndpointTypeId

Integer

Y

Rejected endpoint type Id.

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": [

    {

      "id": 1,

      "tenantId": 0,

      "endpointType": "V"

    }

  ]

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Update System Default Rejected Endpoint Type

URL: /admin/api/v1/system/tenants/rejections/endpointTypes/{rejectedEndpointId}

Method: PUT

Parameters

Field

Data type

Mandatory

Description

rejectedEndpointTypeId

Integer

Y

Rejected endpoint type id to update.

Request body

{

  "endpointType": "V"

}

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": [

    {

      "id": 1,

      "tenantId": 0,

      "endpointType": "V"

    }

  ]

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

Delete System Default Rejected Endpoint Type

URL: /admin/api/v1/system/tenants/rejections/endpointTypes/{rejectedEndpointId}

Method: DELETE

Parameters

Field

Data type

Mandatory

Description

rejectedEndpointTypeId

Integer

Y

Rejected endpoint type id to delete

Success response

In case of success, success code 200 HttpStatus.OK is returned with the JSON content shown below.

Sample JSON response

{

  "version": 1,

  "status": "success",

  "data": null

}

Error responses

HTTP response code

Error message

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error