Promo Read

By Anand Mehta
1 min

Summary

image-20240321-202938.png

This API will let you:

  • Get all available promo codes.

 

EndPoints:

  • Promo/GetAvailable

Response

Field

Data Type

Definition

PromoCode

String

Promotional code to provide discounts to the registrant

Description

String

Description of the promotional code

Grouping

Integer

 ID applied to a group of promotional codes with the same discount attributes

Base URL

The base URL for all API endpoints is:

https://bridge.cdsreg.com/

/Promo/GetAvailable

 

  • URL: https://bridge.cdsreg.com/Promo/GetAvailable

  • Method: Get

  • Parameters

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

Example Request:

curl -X 'GET' \ 'https://bridge.cdsreg.com/Promo/GetAvailable?AuthKey=(Omitted)' \ -H 'accept: text/plain'

Example Response:

{ "RecordCount": 0, "StatusCode": 0, "ReturnMessages": [ "string" ], "Success": true, "OperationId": "string", "AvailablePromos": [ { "PromoCode": "string", "Description": "string", "Grouping": 0 } ] }

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