CENTAMAN API Help Page

Introduction

Welcome to CENTAMAN’s RESTful web API.

UDFBooking

API	Description
GET udf_services/UDFBooking?bookingTypeID={bookingTypeID}	Returns the booking system UDF definitions. HTTP Status Codes: 200: OK - Request satisfied, data included in body. 404: Not Found - There are no UDF's defined. Response Object: Label: The UDF label displayed in Centaman applications. May be used as is or replaced with a custom value. Required: If TRUE, a value must be entered by the end user on add/update operations. IsBookingWaiver: If TRUE, indicates this UDF is defined as a Booking waiver. IsAttendeeUDF: If TRUE, indicates this UDF is an Attendee UDF used in Timed Ticketing transactions that support Attendees. IsMemberWaiver: If TRUE, indicates this UDF is defined as a Membership waiver. FieldName: UDF Field Name is the principal identifier of a UDF. Used when adding/updating UDF values. FieldType: The datatype of the UDF. FieldLength: The maximum number of character can be saved for the UDF. Options: A UDF may be defined with ‘options’ that can be used to populate a UI control (eg: a dropdown or picklist). If no options are returned the field is not a dropdown/picklist. Requires HTTPS, Basic Auth.
POST udf_services/UDFBooking?bookingID={bookingID}&memberCode={memberCode}	Update or insert UDFs for the specified Booking ID. HTTP Status Codes: 200: OK - Request satisfied, data included in body. 400: Bad Request - Failure to update/insert UDF. Check Booking ID. Requires HTTPS, Basic Auth.

API

Description

GET udf_services/UDFBooking?bookingTypeID={bookingTypeID}

Returns the booking system UDF definitions.

HTTP Status Codes:

200: OK - Request satisfied, data included in body.

404: Not Found - There are no UDF's defined.

Response Object:

Label: The UDF label displayed in Centaman applications. May be used as is or replaced with a custom value.

Required: If TRUE, a value must be entered by the end user on add/update operations.

IsBookingWaiver: If TRUE, indicates this UDF is defined as a Booking waiver.

IsAttendeeUDF: If TRUE, indicates this UDF is an Attendee UDF used in Timed Ticketing transactions that support Attendees.

IsMemberWaiver: If TRUE, indicates this UDF is defined as a Membership waiver.

FieldName: UDF Field Name is the principal identifier of a UDF. Used when adding/updating UDF values.

FieldType: The datatype of the UDF.

FieldLength: The maximum number of character can be saved for the UDF.

Options: A UDF may be defined with ‘options’ that can be used to populate a UI control (eg: a dropdown or picklist). If no options are returned the field is not a dropdown/picklist.

Requires HTTPS, Basic Auth.

POST udf_services/UDFBooking?bookingID={bookingID}&memberCode={memberCode}

Update or insert UDFs for the specified Booking ID.

HTTP Status Codes:

200: OK - Request satisfied, data included in body.

400: Bad Request - Failure to update/insert UDF. Check Booking ID.

Requires HTTPS, Basic Auth.

UDFMember

API	Description
GET udf_services/UDFMember?memberCode={memberCode}	Returns the membership system UDF's for the requested Member Code. HTTP Status Codes: 200: OK - Request satisfied, data included in body. 404: Not Found - There are no UDF's defined for the supplied Member Code. Requires HTTPS, Basic Auth.
GET udf_services/UDFMember	Returns the membership system UDF definitions. HTTP Status Codes: 200: OK - Request satisfied, data included in body. 404: Not Found - There are no UDF's defined. Response Object: Label: The UDF label displayed in Centaman applications. May be used as is or replaced with a custom value. Required: If TRUE, a value must be entered by the end user on add/update operations. FieldName: UDF Field Name is the principal identifier of a UDF. Used when adding/updating UDF values. FieldType: The datatype of the UDF. FieldLength: The maximum number of character can be saved for the UDF. Requires HTTPS, Basic Auth.
POST udf_services/UDFMember?memberCode={memberCode}	Update or insert UDFs for the specified Member Code. HTTP Status Codes: 200: OK - Request satisfied, data included in body. 400: Bad Request - Failure to update/insert UDF. Check Member Code. Requires HTTPS, Basic Auth.