Certification Read

By Anand Mehta
4 min

Summary

image-20240405-183234.png
image-20240405-183343.png
image-20240405-183446.png

 

The certification API provides a comprehensive digital record of the attendee's certification earned at event.

This set of API endpoints will let you:

  • Get all certifications.

  • Get certification by badge number.

  • Get a count of all certifications.

Pagination was added to Certification Read on 3/14/24.

  • API pagination is a technique used to manage large datasets returned by an API. Instead of delivering the entire dataset in a single response, pagination breaks it down into smaller, discrete chunks or "pages." This helps improve performance by reducing the amount of data transferred in each request and allows clients to fetch data incrementally as needed. Pagination typically involves parameters like "page number" and "page size," enabling clients to specify which portion of the dataset they want to retrieve. It's a common practice in web APIs to enhance efficiency and manage resources effectively.

 

EndPoints:

  • Certification/Get and GetCertification

  • GetByBadge

  • Certification/GetCount and GetCertificationCount

 

Response

Field

DataType

Description

Field

DataType

Description

ShowCode

String

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

Badge

Integer

A unique ID provided to an Attendee

OrderNumber

Integer

A unique ID provided to an order

Association

String

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

SessionTitle

String

Title of the session attendee has attended

CreditsClaimed

Number

Number of credits successfully acquired for attending a session

SystemCertificateID

Integer

Unique certification ID?

CreditType

String

Type of credit acquired

CertificationName

String

Name of the certification

DateClaimed

String

Date certification was received

CertificationID

Integer

Unique certification ID

CourseCode

String

Unique code provided to the course.

DateAdded

String

Date certification was added to the system

DateViewed

String

Last date certification was viewed?

Active

Integer

If the certification is active

CourseType

String

Type of course

CourseDate

String

Date the course started

StartTime

String

Time the course started

EndTime

String

Time the course ended

Lecturer

String

Who was the person giving the lecture during the session.

LastUpdate

String

Last time this record was updated.

Base URL

The base URL for all API endpoints is:

https://bridge.cdsreg.com/

GetCertification

Get certification for all

  • URL: https://bridge.cdsreg.com/api/Data/GetCertifications

  • Method: GET

  • Parameters:

    • StartDate: User selects this date, this is the from date. This filed looks at the date the record was added.

    • EndDate: User selects this date, this is the TO date. This filed looks at the date the record was added.

    • RecordLimit: Number of records that you would like to pull.

    • Page: How many pages would you like to pull from CDS Bridge.

    • AuthKey: Authentication Key provided by CDS (This can be utilized in swagger to test)

Example Request:

curl -X 'GET' \ 'https://bridge.cdsreg.com/Certification/Get?StartDate=10%2F1%2F2023%2008%3A00&EndDate=11%2F20%2F2023%2017%3A01&RecordLimit=100&AuthKey={Omited}' \ -H 'accept: text/plain'

Example Response:

{ "RecordCount": 0, "StatusCode": 0, "ReturnMessages": [ "string" ], "Success": true, "OperationId": "string", "Certifications": [ { "ShowCode": "string", "Badge": 0, "OrderNumber": 0, "Association": "string", "SessionTitle": "string", "CreditsClaimed": 0, "SystemCertificateID": 0, "CreditType": "string", "CertificateName": "string", "DateClaimed": "2024-02-14T18:47:49.875Z", "CertificateID": 0, "CourseCode": "string", "DateAdded": "2024-02-14T18:47:49.875Z", "DateViewed": "2024-02-14T18:47:49.875Z", "Active": 0, "CourseType": "string", "CourseDate": "string", "StartTime": "string", "EndTime": "string", "Lecturer": "string", "LastUpdate": "2024-02-14T18:47:49.875Z" } ] }

GetByBadge

  • URL: https://bridge.cdsreg.com/Certification/GetByBadges

  • Method: POST

  • Parameters:

    • Badge: A unique ID provided to an Attendee

    • AuthKey: Authentication Key provided by CDS (This can be utilized in swagger to test)

Example Request:

curl -X 'GET' \ 'https://bridge.cdsreg.com/Certification/GetByBadges?Badges=200039&AuthKey=(Omitted)' \ -H 'accept: text/plain'

Example Response:

{ "RecordCount": 0, "StatusCode": 0, "ReturnMessages": [ "string" ], "Success": true, "OperationId": "string", "Certifications": [ { "ShowCode": "string", "Badge": 0, "OrderNumber": 0, "Association": "string", "SessionTitle": "string", "CreditsClaimed": 0, "SystemCertificateID": 0, "CreditType": "string", "CertificateName": "string", "DateClaimed": "2024-04-03T14:18:58.431Z", "CertificateID": 0, "CourseCode": "string", "DateAdded": "2024-04-03T14:18:58.431Z", "DateViewed": "2024-04-03T14:18:58.431Z", "Active": 0, "CourseType": "string", "CourseDate": "string", "StartTime": "string", "EndTime": "string", "Lecturer": "string", "LastUpdate": "2024-04-03T14:18:58.431Z" } ] }

 

GetCount

  • URL: https://bridge.cdsreg.com/Certification/GetCount

  • Method: POST

  • Parameters:

    • StartDate: User selects this date, this is the from date. This filed looks at the date the record was added.

    • EndDate: User selects this date, this is the TO date. This filed looks at the date the record was added.

    • RecordLimit: Number of records that you would like to pull.

    • AuthKey: Authentication Key provided by CDS (This can be utilized in swagger to test)

Example Request:

curl -X 'GET' \ 'https://bridge.cdsreg.com/Certification/GetCount?StartDate=10%2F12%2F2023&EndDate=12%2F1%2F2023&RecordLimit=1000&AuthKey=(Omitted)' \ -H 'accept: text/plain'

Example Response:

{ "RecordCount": 0, "StatusCode": 0, "ReturnMessages": [ "string" ], "Success": true, "OperationId": "string", "Certifications": [ { "ShowCode": "string", "Badge": 0, "OrderNumber": 0, "Association": "string", "SessionTitle": "string", "CreditsClaimed": 0, "SystemCertificateID": 0, "CreditType": "string", "CertificateName": "string", "DateClaimed": "2024-02-14T19:14:37.985Z", "CertificateID": 0, "CourseCode": "string", "DateAdded": "2024-02-14T19:14:37.985Z", "DateViewed": "2024-02-14T19:14:37.985Z", "Active": 0, "CourseType": "string", "CourseDate": "string", "StartTime": "string", "EndTime": "string", "Lecturer": "string", "LastUpdate": "2024-02-14T19:14:37.985Z" } ] }

Error Responses

  • 400 Bad Request:

    • Sql DateTime Overflow

Example Error Response:

{ "RecordCount": 0, "StatusCode": 400, "ReturnMessages": [ "SqlDateTime overflow. Must be between 1/1/1753 12:00:00 AM and 12/31/9999 11:59:59 PM." ], "Success": false, "OperationId": "string", "Certifications": [] }

 

 

Related content