Versions Compared

Old Version 12

changes.mady.by.user admin

Saved on

compared with

New Version 13

changes.mady.by.user admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Requested MethodPOST
URL<APIURL>/Authentication/Login/SQLNeedsInputWithContainerThis 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.

...

Requested MethodGET
URLs
  • <API URL>/BadgeOnDemand/Events
This GET method will fetch events details for all events that are configured in Aptify AMS as meeting product products that have BadgeOnDemand flag enabled AND end date and End Date of the event is greater or equals to today's date.
  • <API URL>/BadgeOnDemand/Events?event_key=55
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 have has BadgeOnDemand flag enabled AND end date and End Date of the event is greater or equals to today's date.
  • <API URL>/BadgeOnDemand/Events?last_modified_datetime=2018-12-10
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 and End Date of the event is greater or equals to today's date AND and modified datetime paramter 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
  • 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

...

Requested MethodGET
URLs  

  • <APIURL>/BadgeOnDemand/BadgesAndTickets?event_key=1

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 and BadgeOnDemand flag enabled AND end date and End Date of the event is greater or equals to today's date.
  • <APIURL>/BadgeOnDemand/BadgesAndTickets?event_key=1&reg_key=2
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 and BadgeOnDemand flag enabled AND end date and End Date of the event is greater or equals to today's date.
  • <APIURL>/BadgeOnDemand/BadgesAndTickets?event_key=1&logical_operator=and&last_name=foo&first_name=bar&company_name=leg

 

Note
  1. Event Key is mandatory for all requests for above GET methods.
  2. For this API URL implementation, only one search field is required however, many can be supplied. 


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 matchs with meeting ID (i.e. event Id ) based on logical operator in the URL with search parameters (First Name, Last Name, Company Name) value matches with registrant data present in Aptify AND and BadgeOnDemand flag enabled AND end date and End Date of the event is greater or equals to today's date.
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

...

Requested MethodPOST
URLs

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

Note

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 the 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
  • 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