If you have a comment on this topic, contact Aptify Documentation. If you want to return to the Aptify Community Site, please click here.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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 MethodPOST
URL<APIURL>/Authentication/Login/SQLNeedsInputWithContainer
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 MethodGET
URLs
  • <API URL>/BadgeOnDemand/Events
  • <API URL>/BadgeOnDemand/Events?event_key=55
  • <API URL>/BadgeOnDemand/Events?last_modified_datetime=2018-12-10
Parameters
  • event_key (This event key refers to meetings setup in Aptify AMS)
  • last_modified_date (This date refers to modified date on the different meeting record in the Aptify AMS)
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 MethodGET
URLs
  • <APIURL>/BadgeOnDemand/BadgesAndTickets?event_key=1
  • <APIURL>/BadgeOnDemand/BadgesAndTickets?event_key=1&reg_key=2
  • <APIURL>/BadgeOnDemand/BadgesAndTickets?event_key=1&logical_operator=and&last_name=foo&first_name=bar&company_name=leg

    1. Event Key is mandatory for all requests for this GET method.
    2. For the above third API URL implementation, only one search field is required however, many can be supplied. 
Parameters
  • event_key (This event key refers to meetings set up in Aptify AMS)
  • reg_key (This reg key refers to registrant’s registration record against the meeting in Aptify AMS)
  • logical_operator
  • last_name (This parameter refers to registrant’s Last name in the Aptify AMS)
  • first_name (This parameter refers to registrant’s First name in the Aptify AMS)
  • company_name (This parameter refers to registrant’s Company name in the Aptify AMS)
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 MethodPOST
URLs

<APIURL>/BadgeOnDemand/PrintInfo?event_key=63&last_printed_on=10-09-2018&printed_cnt=2&reg_key=10195&custom=added

In above requests for this POST method - event_key, last_printed_on, printed_cnt, and reg_key keys are mandatory.

 


Parameters
  • event_key (This event key refers to meetings set up in Aptify AMS)
  • last_printed_on (This date refers Badge Printed Date on registration record in Aptify AMS)
  • printed_cnt (This parameter refers Badge Printing Count on registration record in Aptify AMS)
  • reg_key (This reg key refers to registrant’s registration record against the meeting in Aptify AMS)
  • custom (This parameter refers Badge Printing Comment on registration record in Aptify AMS)

Response

{

    "message": "Successfully updated print information."

}

Postman Reference
  • No labels