Abandonment Read
Summary:
This endpoint will provide you Abandonment data and record count.
EndPoints:
Abandonment Get
Abandonment Get Count
Response:
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) |
String | Attendees Email address. | |
TempBadge | Integer | Temporary badge number provided while the attendee is shopping. |
TempOrder | Integer | Temporary order number. Valid until a permanent order number is created. |
Badge | Integer | A unique ID provided to an Attendee |
DateSent | String | Date and time the data is sent. |
UniqueID | String | Unique transaction ID |
EventPK | Integer | Event Primary key. |
AbandonmentAnswerID | Integer | Why was the card abandoned |
RegistrationTemp |
| All the fields below are part of RegistrationTemp section. |
EventCode | String | An 8 alpha numerical code provided to an event. (EX.AFTS0124 = 4 letter event code and month and year of the event) |
RegTimeStamp | String | Date and time stamp when the Attendee registered for the event. |
Modified_TS | String | Date and time the data was modified. |
Badge | Integer | A unique ID provided to an Attendee |
uid | String | Unique user ID provided to the Attendee. |
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 | Attendees professional title |
Company | String | Company Attendees works for or represents |
Street | String | Attendees street name and building number |
Street2 | String | Attendees additional address information |
Street3 | String | Attendees additional address information |
City | String | Attendees city of residence |
State | String | Attendees State of residence |
Zipcode | String | Attendees postal code |
Country | String | Attendees country of residence |
Phone | String | Attendees phone number |
CellPhone | String | Attendees mobile phone number |
EXT | String | Attendees phone extension |
Fax | String | Attendees fax number |
String | Attendees email | |
AlternativeEmail | String | Attendees secondary email |
WebsiteURL | String | Extra data field requested by clients. Primarily used for Attendees company website. |
Association | String | Defined by the client and is often the clients member number for the registrant or something similar. |
CASLOptIn | String | Canadian Anti-Spam Legislation opt in flag |
MethodID | Integer | Method how registration was received. |
EB | String | Username for manually entered registrations. |
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. |
VIPCode | String | Promo code to provide discounts to the customer. |
BatchTag | String | Tag assigned to record based on method. |
BadgePrinted | String | Last Date and Time badge was printed. |
BadgePrinted_Org | String | First Date and Time badge was printed. |
BadgePrinted_Cnt | Integer | Count of how many times badge was printed. |
GuestOf | String | Guest of which Attendee |
EmailConf | String | Email confirmation send date and time |
FaxConf | String | Fax confirmation send date and time |
MailConf | String | Mail confirmation send date and time |
Ordernumber | String | Unique number provided to an order |
HandicapBtn | String | Extra data field requested by clients. Used to indicate if service is required. |
HandicapText | String | Extra data field requested by clients. Used to capture service required. |
ThirdPartyKey | String | Extra data field requested by clients. Used to store third party key. |
Suffix | String | Suffix for the Attendee (Ex. JR. III) |
Prefix | String | Prefix for the Attendee (Ex. DR, MS, MR) |
Region | String | Extra data field requested by clients. |
Reg_notes | String | Registration notes |
GDPROptIn | Integer | EU General Data Protection Regulation opt in flag |
GDPR | Integer | Flag indicating if the registrant’s country is covered by the General Data Protection Regulation |
ExtraInfo Fields | String | Extra Data fields requested by clients. |
Base URL
The base URL for all API endpoints is:
https://bridge.cdsreg.com/
GetAbandonment
[Description of the endpoint's purpose and functionality.]
URL:
https://bridge.cdsreg.com/Abandonment/Get
Method: GET
Parameters:
Start Date: The date selected by the user. This represents the beginning of the date range and corresponds to the registration timestamp.
End Date: The date selected by the user. This represents the end of the date range and corresponds to the registration timestamp.
Record Limit: The number of records the user wishes to pull.
Page: The page number to be sent.
Auth Key: Authentication Key provided by CDS. This key can be used in Swagger for testing purposes
Example Request:
curl -X 'GET' \
'https://bridge.cdsreg.com/Abandonment/Get?StartDate=1%2F1%2F2023&EndDate=12%2F31%2F2023&RecordLimit=1000&Page=10&AuthKey=(Omitted)' \
-H 'accept: text/plain'
Example Response:
{
"RecordCount": 0,
"StatusCode": 0,
"ReturnMessages": [
"string"
],
"Success": true,
"OperationId": "string",
"Abandonments": [
{
"ShowCode": "string",
"Email": "string",
"TempBadge": 0,
"TempOrder": 0,
"Badge": 0,
"DateSent": "2024-04-03T14:13:45.066Z",
"UniqueId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"EventPk": 0,
"AbandonmentAnswerId": 0,
"RegistrationTemp": {
"EventCode": "string",
"RegTimeStamp": "2024-04-03T14:13:45.066Z",
"Modified_TS": "2024-04-03T14:13:45.066Z",
"Badge": 0,
"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"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": "string",
"AlternateEmail": "string",
"WebsiteURL": "string",
"Association": "string",
"CASLOptIn": "string",
"MethodId": 0,
"EB": "string",
"RegClass": "string",
"Promo1": "string",
"Promo2": "string",
"VIPCode": "string",
"BatchTag": "string",
"Verified": "2024-04-03T14:13:45.066Z",
"BadgePrinted": "2024-04-03T14:13:45.066Z",
"BadgePrinted_Org": "2024-04-03T14:13:45.066Z",
"BadgePrinted_Cnt": 0,
"GuestOf": 0,
"EmailConf": "2024-04-03T14:13:45.066Z",
"FaxConf": "2024-04-03T14:13:45.066Z",
"MailConf": "2024-04-03T14:13:45.066Z",
"OrderNumber": 0,
"HandicapBtn": "string",
"HandicapText": "string",
"ThirdPartyKey": "string",
"Suffix": "string",
"Prefix": "string",
"Region": "string",
"Reg_Notes": "string",
"GDPROptIn": 0,
"GDPR": 0,
"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",
"ExtraInfo_Media1": "string",
"ExtraInfo_Media2": "string",
"ExtraInfo_Media3": "string"
}
}
]
}
AbandonmentGetCount
[Description of another endpoint with its purpose and functionality.]
URL:
https://bridge.cdsreg.com/Abandonment/GetCount
Method: PUT
Parameters:
Start Date: The date selected by the user. This represents the beginning of the date range and corresponds to the registration timestamp.
End Date: The date selected by the user. This represents the end of the date range and corresponds to the registration timestamp.
Record Limit: The number of records the user wishes to pull.
Page: The page number to be sent.
Auth Key: Authentication Key provided by CDS. This key can be used in Swagger for testing purp
Example Request:
curl -X 'GET' \
'https://bridge.cdsreg.com/Abandonment/GetCount?StartDate=5%2F1%2F2023&EndDate=8%2F30%2F2023&RecordLimit=20&Page=2&AuthKey=(Omitted)' \
-H 'accept: text/plain'
Example Response:
"RecordCount": 0,
"StatusCode": 0,
"ReturnMessages": [
"string"
],
"Success": true,
"OperationId": "string",
"Abandonments": []
Error Responses
400 Bad Request:
If [describe the error condition].
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": []