Add and Update Exhibitor

Summary

These set of APIs will let you:

  1. Add an Exhibitor

  2. Updated an Exhibitor

 

End Points:

  • AddExhibitor

  • UpdateExhibitor

 

Response

 

Field

DataType

Description

Field

DataType

Description

AuthKey

String

Authentication key provided to access the API endpoint to retrieve data from CDS.

OrderNumber

Integer

A unique ID provided to an order

ThirdPartyKey

String

Unique ID provided by a third party integration.

OrderNumber

String

A unique ID provided to an order

Booth

String

Booth number provided to a exhibitor. As a exhibitor can also register as a attendee.

Notes

Integer

Notes from RegAdmin System.

CompanyID

String

Unique ID provided to a Company.

CompanyName

String

Name of the company

CompanyPassword

String

Password provided to the company.

MailBadges

Boolean

Will the badge for the Attendee(s) be mailed. (True or False field)

Allotments

String

Allotments Section

RegClass

String

Attendees registration class. (RegClasses are defined by clients)

Allotment

Integer

Value of allotment assigned to the order

EnableAllotment

Boolean

Status flag indicating is allotment is enabled or not.

OrderExtrainfo 1-6

String

Extra Data fields requested by clients.

Registrants

String

Registrants Section

IsPrimary

Boolean

First record in an order

Badge

Integer

Unique ID given to a Registrant.

ThirdPartyKey

String

Used to store third party key.

FirstName

String

First name (Legal First name) of the attendee

MiddleInitial

String

Middle initial (Legal first initial of the middle name) of the attendee

LastName

String

Last name (Legal Last name (Surname)) of the attendee

NickName

String

A secondary name for the attendee.

Degree

String

Educational certification provided to the Attendee

Title

String

Work title provided by a registrants company

Company

String

Company the registrant represents

Street

String

House/Building number and street name

Street2

String

Additional street address field

Street3

String

Additional street address field

City

String

Registrant residential city

State

String

Registrant residential state

ZipCode

String

Registrant residential zipcode

Country

String

Registrant residential country

Phone

String

Registrants phone number

CellPhone

String

Registrants mobile phone number

Ext

String

Registrants phone extension

Fax

String

Registrants fax number

Email

String

Registrants email

HandicapBtn

String

Used to indicate if service is required.

LrOption

Integer

Flag to indicate LR opt in/out option

MethodID

Integer

Method how registration was received.

RegClass

String

Attendees registration class. (RegClasses are defined by clients)

Promo1

String

Promo code to provide discounts to the customer.

Promo2

String

Promo code to provide discounts to the customer.

EB

String

Username for manually entered registrations.

RegTimeStamp

String

Date and time stamp when the Attendee registered for the event.

Verified

String

Date and time registrant was verified as attending the event.

Association

String

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

BatchTag

String

Tag assigned to record based on method.

RegNotes

String

Registrant notes

GuestOf

Integer

Guest of which Attendee

EmailConf

String

Date and time the last email confirmation was sent.

FaxConf

String

NO LONGER IN USE

MailConf

String

NO LONGER IN USE

ConfCount

Integer

Indicates a confirmation was sent.

MailBadge

Boolean

Mail or hold badge indicator

BadgePrinted

String

Last Date and Time badge was printed.

BadgePrintedOrg

String

First Date and Time badge was printed.

BadgePrintedcnt

String

Count of how many times badge was printed.

HandicapText

String

Extra data field requested by clients. Used to capture service required.

VipCode

String

Promo code to provide discounts to the customer.

Prefix

String

Prefix for the Attendee (Ex. DR, MS, MR)

ExtraInfo Fields 1- 100

String

Extra Data fields requested by clients.

GdprOptIn

Integer

EU General Data Protection Regulation opt in flag

WebSiteURL

String

Extra data field requested by clients. Primarily used for Attendees company website.

Demo

Array

Demo section

Key

Integer

 Demo key

Badge

Integer

Unique ID given to a Registrant.

DemoID

Integer

A unique ID for an Event provided to a demographic question (This ID is unique to 1 event and be utilized in another event)

AnswerID

String

A unique ID for an Event provided to a demographic answer (This ID is unique to 1 event and be utilized in another event)

OtherText

String

The free form text response of a registrant to the demographic question

ThirdPartyKey

String

Used to store third party key.

RecordStatus

Integer

Status flag indicating whether the record is active or not.

Items

String

Items Section

OrderNumber

Integer

A unique ID provided to an order

ItemCode

String

Unique code provided to an Item

Qty

Integer

Number of Items purchased.

Badge

Integer

Unique ID given to a Registrant.

ItemPriceKey

Integer

Unique ID provided by a third party integration.

ItemDate

String

Date the Item was purchased

ItemStatus

String

Status flag of item: A(ctive), R(emoved), U(pgrade), W(aitlist)

ModifiedBy

String

Person the record was changed by.

ItemNotes

String

Notes created for the item

PrintTicket

Integer

Flag indicating if the item is printable as ticket

PackageItemKey

Integer

Key value of primary item of package

PaymentKey

Integer

Payment key

ModifiedDate

String

Date the item was modified

ThirdPartyKey

String

Used to store third party key.

RecordStatus

Integer

Status flag indicating whether the record is active or not.

PackageKey

Integer

Key value of packaged items

TaxTypeID

Integer

Determines the type of item to be taxed.

ConsumptionID

Integer

Indicates consumption tax applied (Onsite or Offsite)

TaxCategoryID

Integer

Unique identifier assigned to a particular tax category chosen by the client. The Tax category ID is derived from the provider of the Tax software.

TaxRate

Number

Amount of tax charged

TaxAmount

Number

Amount charged for tax purposes

Price

String

Cost of the item

ItemPriceTier 1 - 5

String

Pricing Tiers set by client

Promocode

String

Promo code to provide discounts to the customer.

Payments

String

Payments tied to the record

Key

Integer

Payment key 

OrderNumber

Integer

A unique ID provided to an order

PaymentType

String

A type of legal payment method (Credit card, Check, Cash)

AccountNumber

String

Valid account number provided by the Primary Attendee for processing the payment.

ExpirationDate

String

Expiration date for a credit card/ Debit card

FirstName

String

First name (Legal First name) of the attendee

MiddleName

String

Middle initial (Legal first initial of the middle name) of the attendee

LastName

String

Last name (Legal Last name (Surname)) of the attendee

ChargeDate

String

Payment processed date and time.

TotalDue

Number

Total amount that is Due to the vendor.

AmountPaid

Number

Total amount paid to the vendor.

CashierID

String

ID provided to a cashier that entered the order in the system.

Notes

String

Notes provided from the system

StatusFlag

String

Two digit code provided if the payment was approved (AP), canceled (CX)…

Fpbatch

String

Tag assigned to record based on method.

Eftordernumber

String

Electronic funds transfer (EFT) number provided by the payment processor

Company

String

Payees Company

Address

String

Payees address (House/Building number, street name…)

City

String

Payees City

State

String

Payees State

Zip

String

Payees Zipcode

Country

String

Payees Country

Phone

String

Payees phone number

ModifiedBy

String

Name of the person who modified the payment

ModifiedDate

String

Date the payment was modified

AvsAddReturnCode

String

Address verification service return code for verification of the address

AvsZipReturnCode

String

Address verification service return code for verification of the zip or postal code

CscReturnCode

String

Card security code verification return code

CscNumber

String

Card security code number

CreatedDate

String

Date and time when the payment was created.

ThirdPartyKey

String

Used to store third party key.

Extrainfo 1-5

String

Extra payment related information fields definable per event

RecordStatus

Integer

Status flag indicating whether the payment is active or not.

BoothSize

String

Size of the exhibitor booth.

TaxExempt

Boolean

Provides if the registrant or exhibitor is tax exempt.

Base URL

The base URL for all API endpoints is:

https://bridge.cdsreg.com/

Add Exhibitor

 

  • URL: https://bridge.cdsreg.com/Registration/AddExhibitor

  • Method: Post

Example Request:

{ "AuthKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Badge": 0, "ThirdPartyKey": "string", "OrderDate": "2024-03-14T02:45:05.246Z", "Booth": "string", "Notes": "string", "CompanyId": "string", "CompanyName": "string", "CompanyPassword": "string", "MailBadges": true, "Allotments": [ { "RegClass": "string", "Allotment": 0 } ], "EnableAllotment": true, "OrderExtraInfo1": "string", "OrderExtraInfo2": "string", "OrderExtraInfo3": "string", "OrderExtraInfo4": "string", "OrderExtraInfo5": "string", "OrderExtraInfo6": "string", "LrOption": 0, "FirstName": "string", "MiddleInitial": "string", "LastName": "string", "NickName": "string", "Degree": "string", "Title": "string", "Company": "string", "Street": "string", "Street2": "string", "Street3": "string", "City": "string", "State": "string", "Zipcode": "string", "Country": "string", "Phone": "string", "CellPhone": "string", "Ext": "string", "Fax": "string", "Email": "user@example.com", "HandicapBtn": "string", "MethodId": 0, "RegClass": "string", "Promo1": "string", "Promo2": "string", "Eb": "string", "RegTimeStamp": "2024-03-14T02:45:05.246Z", "Verified": "2024-03-14T02:45:05.246Z", "Association": "string", "BatchTag": "string", "RegNotes": "string", "GuestOf": 0, "EmailConf": "2024-03-14T02:45:05.246Z", "FaxConf": "2024-03-14T02:45:05.246Z", "MailConf": "2024-03-14T02:45:05.246Z", "ConfCount": 0, "MailBadge": true, "BadgePrinted": "2024-03-14T02:45:05.246Z", "BadgePrintedOrg": "2024-03-14T02:45:05.246Z", "BadgePrintedCnt": 0, "HandicapText": "string", "VipCode": "string", "Prefix": "string", "ExtraInfo1": "string", "ExtraInfo2": "string", "ExtraInfo3": "string", "ExtraInfo4": "string", "ExtraInfo5": "string", "ExtraInfo6": "string", "ExtraInfo7": "string", "ExtraInfo8": "string", "ExtraInfo9": "string", "ExtraInfo10": "string", "ExtraInfo11": "string", "ExtraInfo12": "string", "ExtraInfo13": "string", "ExtraInfo14": "string", "ExtraInfo15": "string", "ExtraInfo16": "string", "ExtraInfo17": "string", "ExtraInfo18": "string", "ExtraInfo19": "string", "ExtraInfo20": "string", "ExtraInfo21": "string", "ExtraInfo22": "string", "ExtraInfo23": "string", "ExtraInfo24": "string", "ExtraInfo25": "string", "ExtraInfo26": "string", "ExtraInfo27": "string", "ExtraInfo28": "string", "ExtraInfo29": "string", "ExtraInfo30": "string", "ExtraInfo31": "string", "ExtraInfo32": "string", "ExtraInfo33": "string", "ExtraInfo34": "string", "ExtraInfo35": "string", "ExtraInfo36": "string", "ExtraInfo37": "string", "ExtraInfo38": "string", "ExtraInfo39": "string", "ExtraInfo40": "string", "ExtraInfo41": "string", "ExtraInfo42": "string", "ExtraInfo43": "string", "ExtraInfo44": "string", "ExtraInfo45": "string", "ExtraInfo46": "string", "ExtraInfo47": "string", "ExtraInfo48": "string", "ExtraInfo49": "string", "ExtraInfo50": "string", "ExtraInfo51": "string", "ExtraInfo52": "string", "ExtraInfo53": "string", "ExtraInfo54": "string", "ExtraInfo55": "string", "ExtraInfo56": "string", "ExtraInfo57": "string", "ExtraInfo58": "string", "ExtraInfo59": "string", "ExtraInfo60": "string", "ExtraInfo61": "string", "ExtraInfo62": "string", "ExtraInfo63": "string", "ExtraInfo64": "string", "ExtraInfo65": "string", "ExtraInfo66": "string", "ExtraInfo67": "string", "ExtraInfo68": "string", "ExtraInfo69": "string", "ExtraInfo70": "string", "ExtraInfo71": "string", "ExtraInfo72": "string", "ExtraInfo73": "string", "ExtraInfo74": "string", "ExtraInfo75": "string", "ExtraInfo76": "string", "ExtraInfo77": "string", "ExtraInfo78": "string", "ExtraInfo79": "string", "ExtraInfo80": "string", "ExtraInfo81": "string", "ExtraInfo82": "string", "ExtraInfo83": "string", "ExtraInfo84": "string", "ExtraInfo85": "string", "ExtraInfo86": "string", "ExtraInfo87": "string", "ExtraInfo88": "string", "ExtraInfo89": "string", "ExtraInfo90": "string", "ExtraInfo91": "string", "ExtraInfo92": "string", "ExtraInfo93": "string", "ExtraInfo94": "string", "ExtraInfo95": "string", "ExtraInfo96": "string", "ExtraInfo97": "string", "ExtraInfo98": "string", "ExtraInfo99": "string", "ExtraInfo100": "string", "GdprOptIn": 0, "WebsiteUrl": "string", "BoothSize": "string", }

Example Response:

curl -X 'POST' \ 'https://bridge.cdsreg.com/Registration/AddExhibitor' \ -H 'accept: text/plain' \ -H 'Content-Type: application/json' \ -d '{ "AuthKey": "Omitted", "Badge": 0, "ThirdPartyKey": "string", "OrderDate": "2024-03-14T02:45:59.441Z", "Booth": "string", "Notes": "string", "CompanyId": "string", "CompanyName": "string", "CompanyPassword": "string", "MailBadges": true, "Allotments": [ { "RegClass": "string", "Allotment": 0 } ], "EnableAllotment": true, "OrderExtraInfo1": "string", "OrderExtraInfo2": "string", "OrderExtraInfo3": "string", "OrderExtraInfo4": "string", "OrderExtraInfo5": "string", "OrderExtraInfo6": "string", "LrOption": 0, "FirstName": "string", "MiddleInitial": "string", "LastName": "string", "NickName": "string", "Degree": "string", "Title": "string", "Company": "string", "Street": "string", "Street2": "string", "Street3": "string", "City": "string", "State": "string", "Zipcode": "string", "Country": "string", "Phone": "string", "CellPhone": "string", "Ext": "string", "Fax": "string", "Email": "user@example.com", "HandicapBtn": "string", "MethodId": 0, "RegClass": "string", "Promo1": "string", "Promo2": "string", "Eb": "string", "RegTimeStamp": "2024-03-14T02:45:59.441Z", "Verified": "2024-03-14T02:45:59.441Z", "Association": "string", "BatchTag": "string", "RegNotes": "string", "GuestOf": 0, "EmailConf": "2024-03-14T02:45:59.441Z", "FaxConf": "2024-03-14T02:45:59.441Z", "MailConf": "2024-03-14T02:45:59.441Z", "ConfCount": 0, "MailBadge": true, "BadgePrinted": "2024-03-14T02:45:59.441Z", "BadgePrintedOrg": "2024-03-14T02:45:59.441Z", "BadgePrintedCnt": 0, "HandicapText": "string", "VipCode": "string", "Prefix": "string", "ExtraInfo1": "string", "ExtraInfo2": "string", "ExtraInfo3": "string", "ExtraInfo4": "string", "ExtraInfo5": "string", "ExtraInfo6": "string", "ExtraInfo7": "string", "ExtraInfo8": "string", "ExtraInfo9": "string", "ExtraInfo10": "string", "ExtraInfo11": "string", "ExtraInfo12": "string", "ExtraInfo13": "string", "ExtraInfo14": "string", "ExtraInfo15": "string", "ExtraInfo16": "string", "ExtraInfo17": "string", "ExtraInfo18": "string", "ExtraInfo19": "string", "ExtraInfo20": "string", "ExtraInfo21": "string", "ExtraInfo22": "string", "ExtraInfo23": "string", "ExtraInfo24": "string", "ExtraInfo25": "string", "ExtraInfo26": "string", "ExtraInfo27": "string", "ExtraInfo28": "string", "ExtraInfo29": "string", "ExtraInfo30": "string", "ExtraInfo31": "string", "ExtraInfo32": "string", "ExtraInfo33": "string", "ExtraInfo34": "string", "ExtraInfo35": "string", "ExtraInfo36": "string", "ExtraInfo37": "string", "ExtraInfo38": "string", "ExtraInfo39": "string", "ExtraInfo40": "string", "ExtraInfo41": "string", "ExtraInfo42": "string", "ExtraInfo43": "string", "ExtraInfo44": "string", "ExtraInfo45": "string", "ExtraInfo46": "string", "ExtraInfo47": "string", "ExtraInfo48": "string", "ExtraInfo49": "string", "ExtraInfo50": "string", "ExtraInfo51": "string", "ExtraInfo52": "string", "ExtraInfo53": "string", "ExtraInfo54": "string", "ExtraInfo55": "string", "ExtraInfo56": "string", "ExtraInfo57": "string", "ExtraInfo58": "string", "ExtraInfo59": "string", "ExtraInfo60": "string", "ExtraInfo61": "string", "ExtraInfo62": "string", "ExtraInfo63": "string", "ExtraInfo64": "string", "ExtraInfo65": "string", "ExtraInfo66": "string", "ExtraInfo67": "string", "ExtraInfo68": "string", "ExtraInfo69": "string", "ExtraInfo70": "string", "ExtraInfo71": "string", "ExtraInfo72": "string", "ExtraInfo73": "string", "ExtraInfo74": "string", "ExtraInfo75": "string", "ExtraInfo76": "string", "ExtraInfo77": "string", "ExtraInfo78": "string", "ExtraInfo79": "string", "ExtraInfo80": "string", "ExtraInfo81": "string", "ExtraInfo82": "string", "ExtraInfo83": "string", "ExtraInfo84": "string", "ExtraInfo85": "string", "ExtraInfo86": "string", "ExtraInfo87": "string", "ExtraInfo88": "string", "ExtraInfo89": "string", "ExtraInfo90": "string", "ExtraInfo91": "string", "ExtraInfo92": "string", "ExtraInfo93": "string", "ExtraInfo94": "string", "ExtraInfo95": "string", "ExtraInfo96": "string", "ExtraInfo97": "string", "ExtraInfo98": "string", "ExtraInfo99": "string", "ExtraInfo100": "string", "GdprOptIn": 0, "WebsiteUrl": "string", "BoothSize": "string", "TaxExempt": "True" }'

Update Exhibitor

[Description of another endpoint with its purpose and functionality.]

  • URL: /another-endpoint

  • Method: PUT

  • Parameters:

    • No Parameters

Example Request:

http POST /another-endpoint Content-Type: application/json { "parameter_name": "value" }

Example Response:

{ "AuthKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Badge": 0, "ThirdPartyKey": "string", "OrderDate": "2024-02-14T16:07:47.163Z", "Booth": "string", "Notes": "string", "CompanyId": "string", "CompanyName": "string", "CompanyPassword": "string", "MailBadges": true, "Allotments": [ { "RegClass": "string", "Allotment": 0 } ], "EnableAllotment": true, "OrderExtraInfo1": "string", "OrderExtraInfo2": "string", "OrderExtraInfo3": "string", "OrderExtraInfo4": "string", "OrderExtraInfo5": "string", "OrderExtraInfo6": "string", "LrOption": 0, "FirstName": "string", "MiddleInitial": "string", "LastName": "string", "NickName": "string", "Degree": "string", "Title": "string", "Company": "string", "Street": "string", "Street2": "string", "Street3": "string", "City": "string", "State": "string", "Zipcode": "string", "Country": "string", "Phone": "string", "CellPhone": "string", "Ext": "string", "Fax": "string", "Email": "user@example.com", "HandicapBtn": "string", "MethodId": 0, "RegClass": "string", "Promo1": "string", "Promo2": "string", "Eb": "string", "RegTimeStamp": "2024-02-14T16:07:47.163Z", "Verified": "2024-02-14T16:07:47.163Z", "Association": "string", "BatchTag": "string", "RegNotes": "string", "GuestOf": 0, "EmailConf": "2024-02-14T16:07:47.163Z", "FaxConf": "2024-02-14T16:07:47.163Z", "MailConf": "2024-02-14T16:07:47.163Z", "ConfCount": 0, "MailBadge": true, "BadgePrinted": "2024-02-14T16:07:47.163Z", "BadgePrintedOrg": "2024-02-14T16:07:47.163Z", "BadgePrintedCnt": 0, "HandicapText": "string", "VipCode": "string", "Prefix": "string", "ExtraInfo1": "string", "ExtraInfo2": "string", "ExtraInfo3": "string", "ExtraInfo4": "string", "ExtraInfo5": "string", "ExtraInfo6": "string", "ExtraInfo7": "string", "ExtraInfo8": "string", "ExtraInfo9": "string", "ExtraInfo10": "string", "ExtraInfo11": "string", "ExtraInfo12": "string", "ExtraInfo13": "string", "ExtraInfo14": "string", "ExtraInfo15": "string", "ExtraInfo16": "string", "ExtraInfo17": "string", "ExtraInfo18": "string", "ExtraInfo19": "string", "ExtraInfo20": "string", "ExtraInfo21": "string", "ExtraInfo22": "string", "ExtraInfo23": "string", "ExtraInfo24": "string", "ExtraInfo25": "string", "ExtraInfo26": "string", "ExtraInfo27": "string", "ExtraInfo28": "string", "ExtraInfo29": "string", "ExtraInfo30": "string", "ExtraInfo31": "string", "ExtraInfo32": "string", "ExtraInfo33": "string", "ExtraInfo34": "string", "ExtraInfo35": "string", "ExtraInfo36": "string", "ExtraInfo37": "string", "ExtraInfo38": "string", "ExtraInfo39": "string", "ExtraInfo40": "string", "ExtraInfo41": "string", "ExtraInfo42": "string", "ExtraInfo43": "string", "ExtraInfo44": "string", "ExtraInfo45": "string", "ExtraInfo46": "string", "ExtraInfo47": "string", "ExtraInfo48": "string", "ExtraInfo49": "string", "ExtraInfo50": "string", "ExtraInfo51": "string", "ExtraInfo52": "string", "ExtraInfo53": "string", "ExtraInfo54": "string", "ExtraInfo55": "string", "ExtraInfo56": "string", "ExtraInfo57": "string", "ExtraInfo58": "string", "ExtraInfo59": "string", "ExtraInfo60": "string", "ExtraInfo61": "string", "ExtraInfo62": "string", "ExtraInfo63": "string", "ExtraInfo64": "string", "ExtraInfo65": "string", "ExtraInfo66": "string", "ExtraInfo67": "string", "ExtraInfo68": "string", "ExtraInfo69": "string", "ExtraInfo70": "string", "ExtraInfo71": "string", "ExtraInfo72": "string", "ExtraInfo73": "string", "ExtraInfo74": "string", "ExtraInfo75": "string", "ExtraInfo76": "string", "ExtraInfo77": "string", "ExtraInfo78": "string", "ExtraInfo79": "string", "ExtraInfo80": "string", "ExtraInfo81": "string", "ExtraInfo82": "string", "ExtraInfo83": "string", "ExtraInfo84": "string", "ExtraInfo85": "string", "ExtraInfo86": "string", "ExtraInfo87": "string", "ExtraInfo88": "string", "ExtraInfo89": "string", "ExtraInfo90": "string", "ExtraInfo91": "string", "ExtraInfo92": "string", "ExtraInfo93": "string", "ExtraInfo94": "string", "ExtraInfo95": "string", "ExtraInfo96": "string", "ExtraInfo97": "string", "ExtraInfo98": "string", "ExtraInfo99": "string", "ExtraInfo100": "string", "GdprOptIn": 0, "WebsiteUrl": "string", "BoothSize": "string", "TaxExempt": "True" }

Error Responses

  • 400 Bad Request:

    • If [describe the error condition].

Example Error Response:

json { "error": "Bad Request", "message": "The 'parameter_name' parameter is required." }

 

 

', representation=storage}

Related content