Versions Compared

Old Version 6

changes.mady.by.user admin

Saved on

compared with

New Version 7

changes.mady.by.user admin

Saved on

Key

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

...

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
URLhttps://APTExpologic.aptify.com/<APIURL>/AptifyServicesAPI/services/Authentication/Login/SQLNeedsInputWithContainer
Parameters

On Body Tab -> Pass below information

Pass Username as <><Provided username>

And Password as <><Provided password>

Postman Reference

Use the Token ID for authentication which is returned by the POST method.

Image RemovedImage Added


Anchor
_ep
_ep
End Points

...

Requested MethodGET
URLs
  • <API URL>/BadgeOnDemand/Events
  • <API URL>/BadgeOnDemand/Events?event_key=55
  • <API URL>/BadgeOnDemand/Events?last_modified_date=14-14-2018
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 ReferenceImage RemovedImage Added

Badges and Tickets

...

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

    Note
    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 ReferenceImage RemovedImage Added

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

Note

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 ReferenceImage RemovedImage Added