VIZpin OEM API Revision History

Owned by Rui Barreira
Last updated: Dec 07, 2023 by Nuno Gomes
2 min read

21-Jul-15

1.0.0

JHM

Initial version

27-Jul-15

1.1.0

JHM

Added additional methods, errors and details

1-May-17

2.0.0

RDS

Modified to support Vanderbilt and vPROX integration

14-Jul-17

2.0.1

JSW

Added Find User method, Corrected Errors

14-Aug-17

2.0.2

JSW

Adjusted Authentication documentation

17-May-19

3.0.0

JAP

Adjusted Objects for Partner using API version 2.0
Added Sample Codes

21-Jun-19

3.1.0

JAP

Added API calls for API version 2.0 requirements
Added relationship diagrams
Fix Return Messages and Codes
Addded Sample Codes
Added Objects for Holidays, Locations, Schedule, Schedule Element, Reader Settings, Credentials

03-July-19

3.1.1

JAP

Change Wiegand Credential Object's field "wiegand" to "cardnumber"
Added "cardnumberformatted" field
Changed Document layout

15-July-19

3.1.2

JAP

Added Table of Contents
Change Header Formats

17-July-19

3.1.2

JAP

Change locationid to id in request parameter of Get Location

23-July-19

3.1.4

JAP

Added Appendix for Policies
Added Password under Policies
Added Country Codes for the Location
Changed "firmwareversion" property of Reader Object to "version"

29-July-19

3.1.4

JAP

Added appendix for Postman Link

05-Aug-19

3.2

JAP

Added new method for user Preregistration
Added new method to associate user to an account

21-Aug-19

3.2.1

JAP

Change "date" to "audit_date" in Activity
Added readerid and activity_code in Activity object
Added appendix for list of "unlock" Activity

30-Aug-19

3.2.2

MAF

Added method to delete user

16-Jan-20

3.3.0

JAP

Added PUSH API CALLS
Added Activity Event Codes
Modified "Remarks" of Location timezone in Appendix 2 - Object Definition
Modified "Remarks" of Location locationtype in Appendix 2 - Object Definition
Modified "Remarks" of Reader locationid in Appendix 2 - Object Definition
Modified "type" of Account in Appendix 2 - Object Definition
Added API_VIZPIN_USER_PREREGISTER_SUCCESS and API_VIZPIN_ACCOUNT_EDIT_ERROR in Appendix 1 - Object Definition
Added Error Codes:

  • Integer API_VIZPIN_ACCOUNT_EDIT_ERROR = 98

  • Integer API_VIZPIN_USER_DELETE_ERROR = 101

  • Integer API_VIZPIN_USER_ACCOUNT_REMOVE_ERROR = 103

  • Integer API_VIZPIN_OBJECT_DELETE_ERROR = 104

  • Integer API_VIZPIN_SITE_DELETE_ERROR = 106

  • Integer API_VIZPIN_READER_DELETE_ERROR =107

  • Integer API_VIZPIN_USER_DELETE_SUCCESS = 100;

  • Integer API_VIZPIN_USER_ACCOUNT_REMOVE_SUCCESS = 102;

  • Integer API_VIZPIN_OBJECT_DELETE_SUCCESS = 105;

    Added API calls for com.vizpin.object.delete
    Added API call for com.vizpin.user.remove

22-Jan-20

3.3.0

JAP

Added Hierarchy of Object Deletion in object delete API call

06-Feb-20

3.3.3

JAP

Added "reader_collateral" in Reader Object

17-Feb-20

3.3.3

JAP

Updated remarks for reader_collateral

20-Feb-20

3.3.3

JAP

Added new Audits in Appendix 5

24-Feb-20

3.3.3

JAP

Added new Audit in Appendix 5

30-Apr-20

3.3.4

JAP

Added new objects for multiple schedules

Added Sample of multiple schedules

05-May-20

4.0

JAP

Added implementation of time in VIZpin Object start and stop date params

05-Aug-20

4.1

JAP

Remove references and objects for Holidays

19-Oct-20

4.2

JAP

Added powermode options under ReaderSettings object

02-Feb-21

4.3

RMB

Added support for vPROX 2.0 features

08-Dec-23

4.4

NFG

Added limited support for roles management:

  • com.vizpin.role.list

  • com.vizpin.role.add

  • com.vizpin.role.edit

  • com.vizpin.user.grantphonerole