This topic provides information regarding the Expo Logic Service End Points that are implemented to achieve the Expo Logic System functionality. The content of this section is described in the following sub-topics:
Overview
In Aptify AMS, the team has implemented the Expo Logic integration for the Badge on Demand (BoD) feature. This BoD feature is to make the events ( i.e. meetings) in Aptify terminology enabled for BoD and send the required information to the Expo Logic system for printing the Badge and capture the printing information in Aptify AMS.
Authentication POST Method
The POST type of request method will be used for Authentication and returning the details with a Token ID. Following are the URL and parameter details used:
| Requested Method | POST | |
| URL | <APIURL>/Authentication/Login/SQLNeedsInputWithContainer | This Post method will get the Token ID that will be used as Authentication for other POST and GET methods to send or receive the required information. "SQLNeedsInputWithContainer <Token ID>" should be value for the AptifyAuthorization key for Authentication with APTIFY system. |
| Parameters | On Body Tab -> Pass below information Username as <Provided username> Password as <Provided password> | |
| Postman Reference | Use the Token ID for authentication which is returned by the POST method.
| |
End Points
Aptify AMS team implemented the below service endpoints based on the information present in the Expo Logic API information document. These endpoints will help in sending and receiving details across the Aptify AMS and the Expo Logic system.
Events
Event methods are used to get the information related to all or specified events. There are 3 different URL’s through which data can be fetched for all events, for a specific one event or by events which are modified after a specified date.
| Requested Method | GET | |
| URLs |
| This GET method will fetch events details for all events that are configured in Aptify AMS as meeting products that have BadgeOnDemand flag enabled and End Date of the event is greater or equals to today's date. |
| This GET method will fetch event details for a particular event for which the event_key parameter value matches meeting ID configured event in Aptify AMS as a meeting product that has BadgeOnDemand flag enabled and End Date of the event is greater or equals to today's date. | |
| This GET method will fetch events details for all events that are configured in Aptify AMS as meeting product that have BadgeOnDemand flag enabled and End Date of the event is greater or equals to today's date and modified datetime parameter value from this URL is less than or equal to modified date for meeting in Aptify AMS (i.e. events which are modified after date present in parameter value). | |
| Parameters |
| |
| Response | { "events": [{ "event_key": 55, "event_code": 55, "event_title": "Sampco 2013 New Student Conference1", "start_datetime": "2018-10-09T07:10:00", "end_datetime": "2018-11-10T07:20:00", "last_modified_datetime": "2018-10-16T19:06:43.253", "confirm_message": "fg FDDGDGFDGDFG WEWERFDGDFGD" }] } | |
| Postman Reference |  | |
Badges and Tickets
The Badge and Tickets methods are used to get the information related to events badges and tickets for all registrants on the event or for a specific registrant in an event. The third URL in the below table can be used to search the registrant badge and ticket information by adding different parameters and logical operators.
| Requested Method | GET | |
| URLs |
| This GET method will fetch all registrant details for a event that is configured in Aptify AMS as meeting product where parameter event_key value matchs with meeting ID (i.e. event Id ) and BadgeOnDemand flag enabled and End Date of the event is greater or equals to today's date. |
| This GET method will fetch a particular registrant details for an event that is configured in Aptify AMS as meeting product where parameter event_key value matchs with meeting ID (i.e. event Id ) AND parameter reg_key value matches with registration ID in Aptify and BadgeOnDemand flag enabled and End Date of the event is greater or equals to today's date. | |
| This GET method will fetch all registrant details for an event that is configured in Aptify AMS as meeting product where parameter event_key value matches with a meeting ID (i.e. event Id ), and logical operator in the URL with search parameters (First Name, Last Name, Company Name) value matches with registrant data present in Aptify and BadgeOnDemand flag enabled and End Date of the event is greater or equals to today's date. | |
| Parameters |
| |
| Response | { "badges": [ { "event_key": 1, "event_title": "Financial Planning", "reg_key": 7570, "badge_number": 7570, "first_name": "Boris", "last_name": "Aaronson", "reg_type_code": "", "badge_name": null, "company_name": null, "badge_title": null, "address1": "5ª Ave. Los Palos Grandes", "address2": "", "city": "Caracas", "state_province": "", "postal_code": "1081", "country": "Venezuela", "work_phone": null, "fax": null, "email": "BAaronson@demodata.aptify.com", "registration_type": "", "annotation": "", "ribbons": "", "cancel_date": "1900-01-01T00:00:00", "do_not_print": true, "no_print_msg": "", "custom01": "", "custom02": "", "custom03": "", "custom04": "", "custom05": "", "custom06": "", "custom07": "", "custom08": "", "custom09": "", "custom10": "" } ] } | |
| Postman Reference |  | |
Print Info
The Print method is used to send the information related to print date, a number of times badge is printed, and any additional printing comments to Aptify AMS. This method will update the relevant data for a specific registrant in Aptify AMS.
| Requested Method | POST | |
| URLs | <APIURL>/BadgeOnDemand/PrintInfo?event_key=63&last_printed_on=10-09-2018&printed_cnt=2®_key=10195&custom=added In above requests for this POST method - event_key, last_printed_on, printed_cnt, and reg_key keys are mandatory.
| This POST method will push the data into Aptify system from Expo Logic system for an event and registrant that matches with event_key and reg_key value with Print Date, Print count and Print Comment passed in the URL irrespective of whether the event is upcoming or completed event. |
| Parameters |
| |
Response | { "message": "Successfully updated print information." } | |
| Postman Reference |  | |