6.2.1 HTTP API Changes version 2

What’s New

---

PUT /api/v2/Users/credentials/{credential}

What’s Changed

---

PUT /api/v2/Companies/{companyId}/ldap/{settingId}/synchronize

Return Type:

New response : 200 OK

Success

Deleted response : 204 No Content

No Content

PUT /api/v2/Companies/{companyId}/sendTestMail

Request:

Changed content type : application/json

• Changed property TemplateType (string)

  Added enum value:

  • UserMobileKey

PUT /api/v2/System/smtp/sendtestemail

Request:

Changed content type : application/json

• Changed property TemplateType (string)

  Added enum value:

  • UserMobileKey

GET /api/v2/System/datetime

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property TimeZone (string)

PUT /api/v2/System/datetime

Request:

Changed content type : application/json

• Changed property TimeZone (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property TimeZone (string)

PUT /api/v2/System/datetime/timezone

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property TimeZone (string)

DELETE /api/v2/Devices/{deviceId}/cleardirectory

Request:

Changed content type : application/json

• Added property DevType (string)

DELETE /api/v2/Devices/{deviceId}/factoryreset

Request:

Changed content type : application/json

• Added property DevType (string)

PUT /api/v2/Devices/backup

Request:

Changed content type : application/json

Changed items (object):

• Added property DevType (string)

PUT /api/v2/Devices/{deviceId}/floors/{floorId}

Parameters:

Changed: floorId in path

GET /api/v2/Companies/{companyId}/emailSettings

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property Templates (object)
      • Added property UserMobileKey (object)

        • Property Subject (string)

        • Property Header (string)

        • Property Introduction (string)

        • Property Message (string)

        • Property Signature (string)

PUT /api/v2/Companies/{companyId}/emailSettings

Request:

Changed content type : application/json

• Changed property Templates (object)
  • Added property UserMobileKey (object)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property Templates (object)
      • Added property UserMobileKey (object)

GET /api/v2/Companies/{companyId}/defaultEmailSettings

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property Templates (object)
      • Added property UserMobileKey (object)

PATCH /api/v2/Devices

Request:

Changed content type : application/json

Changed items (object):

• Added property DevType (string)

GET /api/v2/Devices

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Added property DevType (string)

POST /api/v2/Devices

Request:

Changed content type : application/json

Changed items (object):

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Added property DevType (string)

GET /api/v2/Devices/{deviceId}

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Added property DevType (string)

PUT /api/v2/Devices/{deviceId}

Request:

Changed content type : application/json

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Added property DevType (string)

DELETE /api/v2/Devices/{deviceId}

Request:

Changed content type : application/json

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Added property DevType (string)

GET /api/v2/Devices/scannetwork

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Added property DevType (string)

GET /api/v2/Devices/{deviceId}/password

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Added property DevType (string)

PUT /api/v2/Devices/{deviceId}/password

Request:

Changed content type : application/json

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Added property DevType (string)

PUT /api/v2/Devices/{deviceId}/password/generate

Request:

Changed content type : application/json

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Added property DevType (string)

PUT /api/v2/Devices/{deviceId}/replace

Request:

Changed content type : application/json

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Added property DevType (string)

PUT /api/v2/DeviceUpdate/firmware/{firmwareId}/candidate/devicetest

Request:

Changed content type : application/json

Changed items (object):

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Added property DevType (string)

GET /api/v2/Snapshots/setting/{camLogId}/devices

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Added property DevType (string)

PUT /api/v2/Snapshots/setting/{camLogId}/devices

Request:

Changed content type : application/json

Changed items (object):

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Added property DevType (string)

DELETE /api/v2/Snapshots/setting/{camLogId}/devices

Request:

Changed content type : application/json

Changed items (object):

• Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Added property DevType (string)

PUT /api/v2/Antipassback/areas/{areaId}/devices

Request:

Changed content type : application/json

Changed items (object):

• Added property DevType (string)

DELETE /api/v2/Antipassback/areas/{areaId}/devices

Request:

Changed content type : application/json

Changed items (object):

• Added property DevType (string)

GET /api/v2/Snapshots/setting

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (array)

    Changed items (object):

    • Changed property Devices (array)

      Changed items (object):

      • Added property DevType (string)

POST /api/v2/Snapshots/setting

Request:

Changed content type : application/json

• Changed property Devices (array)

  Changed items (object):

  • Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property Devices (array)

      Changed items (object):

      • Added property DevType (string)

DELETE /api/v2/Snapshots/setting/{camLogId}

Request:

Changed content type : application/json

• Changed property Devices (array)

  Changed items (object):

  • Added property DevType (string)

GET /api/v2/Snapshots/setting/{camLogId}

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property Devices (array)

      Changed items (object):

      • Added property DevType (string)

PUT /api/v2/Snapshots/setting/{camLogId}

Request:

Changed content type : application/json

• Changed property Devices (array)

  Changed items (object):

  • Added property DevType (string)

Return Type:

Changed response : 200 OK

Success

• Changed content type : application/json
  • Changed property data (object)
    • Changed property Devices (array)

      Changed items (object):

      • Added property DevType (string)