Session/Get and GetSessions

By Anand Mehta
2 min

Summary

image-20240329-191609.png
image-20240329-191639.png

These set of APIs will let you:

  1. Get session information

 

EndPoints:

  • RegistrationCategory/GetAvailable

Response

Field

Data Type

Definition

ShowCode

 String

An 8 alpha numerical code provided to an event. (EX.AFTS0124 = 4 letter event code and month and year of the event) - (AKA Event Code)

Badge

 Integer

Unique ID given to a Registrant.

Scan_TS

 String

The date and time registrants badge was scanned for the session. (Scan time stamp)

SessionCode

String

Unique code provided to the session by the client

AccessStatus

Integer

 Scan indicator (0-Session, 1-Granted, 2-Denied, 3-Manually Granted, 4-Manually Denied, 5-Session Out)

Notes

String

Additional notes added in the system

DeviceID

String

ID of the device that scanned the registrants badge.

Association

String

Defined by the client and is often the clients member number for the registrant or something similar.

ProductID

String

Unique product ID for the session

Base URL

The base URL for all API endpoints is:

https://bridge.cdsreg.com/

Session/Get and GetSessions

 

  • URL: https://bridge.cdsreg.com/Session/Get

  • Method: Get

  • Parameters

    • Start Date: From Date - Date the badge was scanned for the session

    • End Date: To Date - Date the badge was scanned for the session

    • Record Limit: Number of records user selects to pull via endpoint

    • Page: Number of pages of data user selects to pull via endpoint

    • Auth Key: Authorization Key needed to call API endpoint.

Example Request:

curl -X 'GET' \ 'https://bridge.cdsreg.com/Session/Get?StartDate=1%2F1%2F2017&EndDate=5%2F1%2F2017&RecordLimit=20&Page=3&AuthKey=ffba70f5-f71b-4e2d-b26a-90c921ac11ba' \ -H 'accept: text/plain'

Example Response:

"RecordCount": 0, "StatusCode": 0, "ReturnMessages": [ "string" ], "Success": true, "OperationId": "string", "ScannedSessions": [ { "ShowCode": "string", "Badge": 0, "Scan_TS": "2024-03-29T19:22:55.755Z", "SessionCode": "string", "AccessStatus": 0, "Notes": "string", "DeviceID": "string", "Association": "string", "ProductId": "string" } ] }

Error Responses

  • 400 Bad Request:

    • Invalid Auth Key

Example Error Response:

{ "RecordCount": 0, "StatusCode": 400, "ReturnMessages": [ "INVALID AUTH KEY" ], "Success": false, "OperationId": "4739ef76fa187cac9de91dfd8fe829c7", "RegRecords": [] }

Related content