/
VL_SignOnOff Method

VL_SignOnOff Method

To use the existing SignOn/Off algorithm implemented for TimeClockWebService. The possibility to use 3rd party Gangway Application aside from APP TimeClock.

For the guide on how to consume, please view How to consume the Adonis API

Mapping of Fields

API Parameter

DATABASE MAPPING

Mandatory

Sample Value

XREF

Details

API Parameter

DATABASE MAPPING

Mandatory

Sample Value

XREF

Details

PIN

WEB_CP_GANGWAY_REGISTRY.PIN

Y

100012

 

UUID of the crew member

DateUTC

WEB_CP_GANGWAY_REGISTRY.DATE_UTC

Y

03-05-2024 08:10:00

 

MM-DD-YYYY 00:00:00

LOCATION

WEB_CP_GANGWAY_REGISTRY.LOCATION_NAME

Y

MT Green Star

PWORG.NAME

 

SignOn

WEB_CP_GANGWAY_REGISTRY.ACTION_SEQNO

Y

false

WEB_CP_GANGWAY_ACTIONS.SEQUENCENO

(bool flag)

TRUE - signOn = WEB_CP_GANGWAY_ACTIONS.TYPE=100

FALSE - signOff = WEB_CP_GANGWAY_ACTIONS.TYPE=200

Authentication_Token

 

Y

IBQGMSgXXXXXXXXIj09XnxUQllbU1d0RF5eU0N7SFZCcC4/CCCCCClVdRFlRUGFVXlRZS3lBUFcRIg==

 

https://rippleops.atlassian.net/l/cp/qov0xujy

 

How to consume using Swagger

  1. Go to Swagger by clicking the below link from APP > Configurations > Web Services

    image-20250210-101703.png

 

  1. Go to Security Tab
    Check this link for more information https://rippleops.atlassian.net/l/cp/qov0xujy

    image-20250210-102031.png



    Copy the hash Authentication_Token



  2. Go to Gangway Tab


    Response

     

  3. Go to the SQL and check the WEB_CP_GANGWAY_REGISTRY Table

Action_SeqNo = 1 (Sign On)
Action_SeqNo = 2 (Sign Off)

 

Housekeeping

  1. Gangway Control

 

If the Gangway control is inactive please go to APP Adonis Gangway Control Functionality | Setup

 

 

Related content