Android icon iOS icon Javascript icon PHP icon

Guides

To ensure that our API is healthy, we build everything with our APIs, even our own web platforms. This helps us to maintain our API working all the time and provide every kind of information needed through our API.

To better provide a working flow of usage with our API, some resources are grouped in guides to better explain how they work and how you can extract most of them. The best way to understand how our products connect with each other and how you can better integrate them to achieve your results is through our API documentation and understanding all of the possibilities each resource provides.

We have documentation for root modules (these are your main resources to manage data), and, most of them have submodules attached that allows you to connect two different root modules (for example, we have event, person and eventPerson, the third being a connection between a person and an event). A full list of modules are presented to your left and submodules are indented accordingly.

For each root module, there are four basic operations, represented by your well known CRUD (Create, Read, Update and Delete). We decided to swap some operation names to make it more intuitive. Those are the following operations:

  • create: creates an object;
  • edit: edits an object;
  • remove: removes an object;
  • find: searches for objects;
  • get: gather an object;

For submodules, we still have those basic operations, but with different names. As submodules are relations between two different root modules, we decided to use a connection/relation approach when creating those names:

  • bind: creates a connection;
  • operate: edits a connection;
  • dismiss: removes a connection;
  • find: searches for connections;
  • get: gather a connection;

Finally, we remind you that we are here to help. If you have any questions regarding a specific guide or you want to suggest improvements in our documentation, please send an email to developer@inevent.us so we try to assist you with your need/suggestion with love.

Check-in

For data integration with InEvent for check-in, it is necessary to integrate all read and write aspects of new attendees, in addition to inform new label printing and read accesses to our access control.

The registration and verification of new attendees occurs through methods available on event.person. To create a new attendee, we have some methods on event.person.bind and to read some attendees, on event.person.find or event.person.get. All of these returns relevant informations about the registration process.

At the moment of the printing, it is important to inform new prints on event.person.print. When retrieving information from our APIs, there will be a count of printed labels already printed (it is possible to limit the amount of labels each attendee is allowed to print). To obtain a cache of information prior to check-in, you may use event.person.find with limit=500000 to obtain a simplified representation of attendees data.

All of our generated QR Codes are encrypted inside the qrCode key. They are the same inside the application and on emails sent to attendees. You may reduce the size of this QR Code as well. For security purposes these formats cannot be modified by any third-party, so if you need to use a qrCode, you must use the one available in our platform.

Deep linking

To send information to our mobile app, it is possible to use deep linking, a technique that allows sending data between applications, data that will be parsed during the app boot process. InEvent uses this technique, allowing you to define during the initialization of our mobile app the user tokenID, the selected event and more. For iOS apps, the official URL is:

inevent://

Currently we accept the following parameters: tokenID, eventID, memberID and name. A good example is, with a given eventID of 1, would be:

inevent://?eventID=1

Some specific services, like Gmail or Hotmail do not recognize our deep linking url as valid urls (since inevent is not a valid protocol). So, to achieve better communication with those services, you may use a different protocol and format to communicate with our applications:

https://inevent.us/appURL.php

All parameters specified above sent via query string GET will be replaced automatically with the previous format shown firstly.

Advertising

It is really usual for events to have several sponsors, companies that are interested in displaying their brand during the event. You can create advertisement in our platform for each sponsor, determining their priority and defining if it is a fullscreen ad or a footer ad. These ads are displayed right after the app is opened, or every 10 minutes of direct usage.

To create a new ad, firstly you need to create a sponsor using sponsor.create. With the sponsor created, you now have a sponsorID, an ID that uniquely identifies a sponsor. To create a new ad for this sponsor, you must use ad.create. This ad may have different priorities (weight), that will be used to determine when this ad must be shown. It is possible as well to create a main ad (an ad that displays on event information section of the app). The default format is splash. To modify your ad, you must use ad.edit.

How to

To start using InEvent API, please follow our documentation on the left. Below we have an example that will be disassembled to further explain how it works.

API URL

https://inevent.us/api/

Example of documentation

person.signIn(username, password)

Signs in and returns a tokenID (60-byte string) in case the request has been successful.

usernameGET : person username

passwordPOST : password

Parameters are automatically encoded and sent via HTTPS:

https://inevent.us/api/?action=person.signIn&username=Email

There are three sections: header, parameters and return. Each of them are explained separately below:

  • The header (person.signIn) represents the API call, composed of a namespace (person) -- a resource -- and its method (signIn). This header must be send via query string GET in the URL with key action.
  • The parameters username and password are explained by clicking on the icon %s and how they should be sent, either via query string GET or via body POST encoded as application/x-www-form-urlencoded
  • The return displays which kind of data will be returned.

Marking

Each method presents the following marks to visualy indicate a specific meaning:

  • *: optional parameters;
  • bold: required parameters;
  • italic: return parameters;
  • understroke: endpoint;
  • regular: parameter value;
  • subscript: method of transference.

Tools

For each existing method, it is possible to use inline tools to obtain the following information:

  • : Inline debugger to easily test your code, send additional parameters and obtain your request response.;
  • : Sandbox testing, you just need to inform sandboxGET on your request with value of 1.

Security

The InEvent API utilizes a hybrid RPC-REST with 128bit encrypted connection certified by PositiveSSL CA2.

Return

The returned data may come in different formats, you just need to specify a custom format using the formatGET parameter. The default format is json.

  • json: a json file with count and data as default root elements;
  • excel: a Excel file, with content type of
    Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

Activity

During an event there are many activities which start and take part in specific time periods. Each one receives an identifier allowing to access their information or receive changes on its channels.

Models

{
    "count": 1,
    "data": [
        {
            "activityID": "14",
            "eventID": "1",
            "placeID": "0",
            "name": "Opening",
            "description": "Kits delivery",
            "latitude": "-22.0062",
            "longitude": "-47.8975",
            "location": "",
            "dateBegin": "1376908200",
            "dateEnd": "1376913600",
            "capacity": "0",
            "general": "1",
            "highlight": "0",
            "personID": "0",
            "approved": "-1",
            "priori": "0",
            "stream": "",
            "speakers": [],
            "tags": []
        }
    ]
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}

Push Notification

activity/create

_event

Informs activity activityID creation at event eventID.

{
    "activityID": "integer"
}

activity/edit

_event

Informs activity activityID update at event eventID.

{
    "activityID": "integer"
}

activity/remove

_event

Informs activity activityID removal from event eventID.

{
    "activityID": "integer"
}

Methods

activity.create

( tokenID, eventID, name, *description, *location, *dateBegin, *dateEnd, *capacity )

POST /api/?action=activity.createHTTP/1.1 Host: inevent.us

Creates an activity named name at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : activity name

*descriptionPOST : activity description

*locationPOST : activity location

*dateBeginPOST : activity begin date

*dateEndPOST : activity end date

*capacityPOST : maximum number of people

( tokenID, eventID, path )

POST /api/?action=activity.createHTTP/1.1 Host: inevent.us

Creates multiple activities at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

activity.edit

( tokenID, activityID, key, value, *push )

POST /api/?action=activity.editHTTP/1.1 Host: inevent.us

Edits value value from field key at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

keyGET : field name

{
    "placeID": "place identifier",
    "name": "activity name",
    "description": "activity description",
    "latitude": "activity latitude",
    "longitude": "activity longitude",
    "location": "activity location (address)",
    "dateBegin": "activity begin date",
    "dateEnd": "activity end date",
    "capacity": "maximum number of approved people",
    "oversize": "maximum number of people attending",
    "general": "automatic inscription?",
    "highlight": "activity with highlight?",
    "stream": "streaming link"
}

valuePOST : field value

{
    "placeID": "integer",
    "name": "string",
    "description": "string",
    "latitude": "integer",
    "longitude": "integer",
    "location": "string",
    "dateBegin": "timestamp",
    "dateEnd": "timestamp",
    "capacity": "integer",
    "oversize": "integer",
    "general": "bit",
    "highlight": "bit",
    "stream": "string"
}

*pushGET : push notification send for editing

activity.remove

( tokenID, activityID )

GET /api/?action=activity.removeHTTP/1.1 Host: inevent.us

Removes activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

activity.find

( tokenID, eventID, selection, personID, *dateBegin, *dateEnd )

GET /api/?action=activity.findHTTP/1.1 Host: inevent.us

Returns all activities from person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : activity registered

{
    "all": "all activities",
    "enrolled": "events registered",
    "available": "events not registered"
}

personIDGET : person identifier

*dateBeginGET : begin date

*dateEndGET : end date

( tokenID, eventID, selection, listID, *dateBegin, *dateEnd )

GET /api/?action=activity.findHTTP/1.1 Host: inevent.us

Returns all activities containing list listID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : registered in activity

{
    "all": "all activities",
    "enrolled": "events registered",
    "available": "events not registered"
}

listIDGET : list identifier

*dateBeginGET : begin date

*dateEndGET : end date

( tokenID, eventID, selection, *dateBegin, *dateEnd )

GET /api/?action=activity.findHTTP/1.1 Host: inevent.us

Returns all activities from event eventID to person tokenID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : activity registration

{
    "all": "all activities",
    "all+meeting": "all activities + meetings",
    "approved": "approved registration",
    "enrolled": "registered activities",
    "enrolled+meeting": "registered activities + meetings",
    "available": "activities not registered",
    "denied": "registration rejected",
    "paid": "registration paid",
    "present": "person attending"
}

*dateBeginGET : begin date

*dateEndGET : end date

( eventID, *dateBegin, *dateEnd )

GET /api/?action=activity.findHTTP/1.1 Host: inevent.us

Returns all activities from event eventID if the event is public and visible.

eventIDGET : event identifier

*dateBeginGET : begin date

*dateEndGET : end date

activity.get

( tokenID, activityID, personID )

GET /api/?action=activity.getHTTP/1.1 Host: inevent.us

Returns activity activityID for person personID.

tokenIDGET : token identifier

activityIDGET : activity identifier

personIDGET : person identifier

( tokenID, activityID )

GET /api/?action=activity.getHTTP/1.1 Host: inevent.us

Returns activity activityID, informing if person tokenID is registered.

tokenIDGET : token identifier

activityIDGET : activity identifier

( activityID )

GET /api/?action=activity.getHTTP/1.1 Host: inevent.us

Returns activity activityID.

activityIDGET : activity identifier

activity.copy

( tokenID, activityID )

GET /api/?action=activity.copyHTTP/1.1 Host: inevent.us

Copies activity activityID on the same origin event.

tokenIDGET : token identifier

activityIDGET : activity identifier

activity.delay

( tokenID, activityID, minutes, subsequent )

GET /api/?action=activity.delayHTTP/1.1 Host: inevent.us

Delays activity activityID and, opcionally subsequent, every following activities in minutes minutes.

tokenIDGET : token identifier

activityIDGET : activity identifier

minutesGET : minutes of delay

subsequentGET : following activities?

Activity chains

At the event, several activities can be chained, i.e. we can create an id to chain activities and block users to register in more than one chained activity.

Models

{
    "count": 1,
    "data": [
        {
            "chainID": "1",
            "activityID": "330"
        }
    ]
}

Methods

activity.chain.bind

( tokenID, chainID, activityID )

GET /api/?action=activity.chain.bindHTTP/1.1 Host: inevent.us

Requests activity activityID chaining at chain chainID.

tokenIDGET : token identifier

chainIDGET : chain identifier

activityIDGET : activity identifier

activity.chain.dismiss

( tokenID, chainID, activityID )

GET /api/?action=activity.chain.dismissHTTP/1.1 Host: inevent.us

Removes activity activityID from chain chainID.

tokenIDGET : token identifier

chainIDGET : chain identifier

activityIDGET : activity identifier

activity.chain.find

( tokenID, activityID )

GET /api/?action=activity.chain.findHTTP/1.1 Host: inevent.us

Returns all chains from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

activity.chain.findChainedActivities

( tokenID, activityID )

GET /api/?action=activity.chain.findChainedActivitiesHTTP/1.1 Host: inevent.us

Returns all activities from all chains for activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

Activity lists

Activities can be restricted to people part of a single or several lists.

Models

{
    "count": 1,
    "data": [
        {
            "activityID": "330",
            "listID": "1"
        }
    ]
}

Methods

activity.list.bind

( tokenID, listID, activityID )

GET /api/?action=activity.list.bindHTTP/1.1 Host: inevent.us

Requests list listID creation on activity activityID.

tokenIDGET : token identifier

listIDGET : list identifier

activityIDGET : activity identifier

activity.list.dismiss

( tokenID, listID, activityID )

GET /api/?action=activity.list.dismissHTTP/1.1 Host: inevent.us

Removes list listID from activity activityID.

tokenIDGET : token identifier

listIDGET : list identifier

activityIDGET : activity identifier

activity.list.find

( tokenID, activityID )

GET /api/?action=activity.list.findHTTP/1.1 Host: inevent.us

Returns all lists from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

Activity attendees

Inside of an activity, there are several participants who can access its data and receive authorization to interact on it. Besides of knowing who's registered in the activity, we have access to the waiting list and the registration order.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "position": "330",
            "approved": "1",
            "paid": "0",
            "present": "0",
            "priori": "1",
            "rating": "0",
            "enrollmentID": "1"
        }
    ]
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}

Methods

activity.person.bind

( tokenID, activityID, name, email, *bypassWebhook )

POST /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us

Requests person with name name and email email to join activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

namePOST : person name

emailPOST : person email

*bypassWebhookGET : if there's a registered webhook, a bypass is performed

( tokenID, activityID, personID )

GET /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us

Requests person personID to join activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

personIDGET : person identifier

( tokenID, activityID, personID, *bypassWebhook )

GET /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us

Requests person personID to join activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

personIDGET : person identifier

*bypassWebhookGET : if there's a registered webhook, a bypass is performed

( tokenID, activityID, path )

POST /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us

Requests multiple people to join activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

pathPOST : file path

( tokenID, eventID, content, *bypassWebhook )

POST /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us

Request multiple people to join multiple activities through content.

tokenIDGET : token identifier

eventIDGET : event identifier

contentPOST : json formatted as [{activityID, personID}]

*bypassWebhookGET : if there's a webhook registered, a bypass is performed

( tokenID, activityID )

GET /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us

Requests person tokenID to join activity activityID. On this call is not possible to perform a webhook bypass.

tokenIDGET : token identifier

activityIDGET : activity identifier

activity.person.operate

( tokenID, activityID, key, value, personID )

POST /api/?action=activity.person.operateHTTP/1.1 Host: inevent.us

Edits value value from field key for person personID at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

keyGET : element name

{
    "approved": "approval status",
    "paid": "payment made",
    "present": "attendance",
    "priori": "registration priority"
}

valuePOST : desired action

{
    "approved": "bit",
    "paid": "bit",
    "present": "bit",
    "priori": "bit"
}

personIDGET : person identifier

( tokenID, activityID, key, value )

POST /api/?action=activity.person.operateHTTP/1.1 Host: inevent.us

Edits value value from field key for person tokenID at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

keyGET : element name

{
    "priori": "registration priority"
}

valuePOST : desired action

{
    "priori": "bit"
}

activity.person.dismiss

( tokenID, activityID, personID )

GET /api/?action=activity.person.dismissHTTP/1.1 Host: inevent.us

Requests person personID removal from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

personIDGET : person identifier

( tokenID, activityID, personID, *bypassWebhook )

GET /api/?action=activity.person.dismissHTTP/1.1 Host: inevent.us

Requests person personID removal from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

personIDGET : person identifier

*bypassWebhookGET : if there's a webhook registered, a bypass is performed

( tokenID, eventID, content, *bypassWebhook )

POST /api/?action=activity.person.dismissHTTP/1.1 Host: inevent.us

Requests a multiple people removal from multiple activities through content.

tokenIDGET : token identifier

eventIDGET : event identifier

contentPOST : json formatted as [{activityID, personID}]

*bypassWebhookGET : if there's a webhook registered, a bypass is performed

( tokenID, activityID )

GET /api/?action=activity.person.dismissHTTP/1.1 Host: inevent.us

Requests person tokenID removal from activity activityID. On this call is not possible to perform a webhook bypass

tokenIDGET : token identifier

activityIDGET : activity identifier

activity.person.find

( tokenID, activityID, selection, *order, *query )

GET /api/?action=activity.person.findHTTP/1.1 Host: inevent.us

Returns everyone in activity activityID, filtered by a selection selection and a order order.

tokenIDGET : token identifier

activityIDGET : activity identifier

selectionGET : activity registration

{
    "all": "all activities",
    "approved": "registration approved",
    "denied": "registration rejected",
    "paid": "registration paid",
    "present": "person attending"
}

*orderGET : order based on the column

*queryGET : text for search

activity.person.get

( tokenID, activityID, personID )

GET /api/?action=activity.person.getHTTP/1.1 Host: inevent.us

Returns details from person personID at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

personIDGET : person identifier

( tokenID, activityID )

GET /api/?action=activity.person.getHTTP/1.1 Host: inevent.us

Returns details from person tokenID at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

activity.person.calculate

( tokenID, activityID )

GET /api/?action=activity.person.calculateHTTP/1.1 Host: inevent.us

Calculates the number of participants from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

Activity speakers

In an activity it shows the speakers responsible for speaking on it.

Models

{
    "count": 1,
    "data": [
        {
            "speakerID": "1",
            "eventID": "1",
            "name": "Pedro Góes",
            "headline": "CEO @ InEvent",
            "description": "Company founder",
            "image": "http:\/\/",
            "email": "email@email.com",
            "facebook": "http:\/\/",
            "linkedIn": "http:\/\/",
            "twitter": "http:\/\/"
        }
    ]
}

Methods

activity.speaker.bind

( tokenID, activityID, speakerID )

GET /api/?action=activity.speaker.bindHTTP/1.1 Host: inevent.us

Adds speaker speakerID at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

speakerIDGET : speaker identifier

activity.speaker.dismiss

( tokenID, activityID, speakerID )

GET /api/?action=activity.speaker.dismissHTTP/1.1 Host: inevent.us

Removes speaker speakerID from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

speakerIDGET : speaker identifier

activity.speaker.find

( tokenID, activityID )

GET /api/?action=activity.speaker.findHTTP/1.1 Host: inevent.us

Returns all speakers from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

( tokenID, speakerID )

GET /api/?action=activity.speaker.findHTTP/1.1 Host: inevent.us

Returns all activities from speaker speakerID.

tokenIDGET : token identifier

speakerIDGET : speaker identifier

Activity sponsors

Inside an activity the sponsors will be present.

Models

{
    "count": 1,
    "data": [
        {
            "sponsorID": "1",
            "eventID": "1",
            "companyName": "InEvent",
            "name": "Pedro Góes",
            "telephone": "000-000-0000",
            "email": "email@email.com",
            "website": "www.email.com",
            "bio": "some history",
            "logo": "\/path\/to\/logo",
            "category": "gold"
        }
    ]
}

Methods

activity.sponsor.bind

( tokenID, activityID, sponsorID )

GET /api/?action=activity.sponsor.bindHTTP/1.1 Host: inevent.us

Adds sponsor sponsorID at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

sponsorIDGET : sponsor identifier

activity.sponsor.dismiss

( tokenID, activityID, sponsorID )

GET /api/?action=activity.sponsor.dismissHTTP/1.1 Host: inevent.us

Removes sponsor sponsorID from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

sponsorIDGET : sponsor identifier

activity.sponsor.find

( tokenID, activityID )

GET /api/?action=activity.sponsor.findHTTP/1.1 Host: inevent.us

Returns all sponsors from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

( tokenID, eventID, sponsorID )

GET /api/?action=activity.sponsor.findHTTP/1.1 Host: inevent.us

Returns all activities from sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

Activity tags

Tags associated with the activities, creating options to identify the participants interest on activities.

Models

{
    "count": 1,
    "data": [
        {
            "activityID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

activity.tag.bind

( tokenID, activityID, tagID )

GET /api/?action=activity.tag.bindHTTP/1.1 Host: inevent.us

Adds tag tagID to activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

tagIDGET : tag identifier

activity.tag.dismiss

( tokenID, activityID, tagID )

GET /api/?action=activity.tag.dismissHTTP/1.1 Host: inevent.us

Removes tag tagID from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

tagIDGET : tag identifier

activity.tag.find

( tokenID, activityID )

GET /api/?action=activity.tag.findHTTP/1.1 Host: inevent.us

Returns all activity activityID tags.

tokenIDGET : token identifier

activityIDGET : activity identifier

( activityID )

GET /api/?action=activity.tag.findHTTP/1.1 Host: inevent.us

Returns all activity activityID tags.

activityIDGET : activity identifier

Ad

It's common for an event having several sponsor, companies interested in disclosuring their brands throughout the event. Those communication instruments, ranging from the companies logos to complete advertising contents, are shown each time the application opens, one for each time this event happens.

Models

{
    "count": 1,
    "data": [
        {
            "adID": "1",
            "eventID": "1",
            "sponsorID": "0",
            "image": "uploads\/image.jpg",
            "link": "http:\/\/nytimes.com",
            "weight": "0",
            "main": "1",
            "splash": "1"
        }
    ]
}

Methods

ad.create

( tokenID, eventID, sponsorID )

GET /api/?action=ad.createHTTP/1.1 Host: inevent.us

Creates a new add associated with sponsor sponsorID for event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

ad.edit

( tokenID, adID, key, value )

POST /api/?action=ad.editHTTP/1.1 Host: inevent.us

Edits value value from field key at ad adID.

tokenIDGET : token identifier

adIDGET : ad identifier

keyGET : field name

{
    "sponsorID": "sponsor id",
    "image": "image url",
    "link": "destination url",
    "weight": "ad weight",
    "main": "main, one per event",
    "splash": "full screen"
}

valuePOST : field value

{
    "sponsorID": "integer",
    "image": "url",
    "link": "url",
    "weight": "1..10",
    "main": "bit",
    "splash": "bit"
}

ad.remove

( tokenID, adID )

GET /api/?action=ad.removeHTTP/1.1 Host: inevent.us

Removes ad adID.

tokenIDGET : token identifier

adIDGET : ad identifier

ad.find

( eventID, sponsorID )

GET /api/?action=ad.findHTTP/1.1 Host: inevent.us

Returns all ads from sponsor sponsorID at event eventID.

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

( eventID, selection )

GET /api/?action=ad.findHTTP/1.1 Host: inevent.us

Returns all ads from event eventID.

eventIDGET : event identifier

selectionGET : ad expiration

{
    "all": "all ads",
    "approved": "ads approved"
}

Ally

Allies are professional contacts generated in convenient moments and added to a single list for future contacts. This list can be handle in different ways, even being exported to other means. Since the relation of two allies is bidirectional, people and allies are interchangeable ids.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "headline": "CEO @ InEvent",
            "image": "",
            "telephone": "000-000-0000",
            "city": "New York",
            "cpf": "",
            "facebookID": "2147483647",
            "linkedInID": "0"
        }
    ]
}

Methods

ally.create

( tokenID, allyID )

GET /api/?action=ally.createHTTP/1.1 Host: inevent.us

Ads a connection with person allyID.

tokenIDGET : token identifier

allyIDGET : person identifier

ally.remove

( tokenID, allyID )

GET /api/?action=ally.removeHTTP/1.1 Host: inevent.us

Removes person allyID.

tokenIDGET : token identifier

allyIDGET : person identifier

ally.find

( tokenID, selection, *order )

GET /api/?action=ally.findHTTP/1.1 Host: inevent.us

Returns all allies, filtered by selection selection and optional parameters.

tokenIDGET : token identifier

selectionGET : connection status

{
    "all": "all allies",
    "created": "ally created",
    "contacted": "ally contacted"
}

*orderGET : results order

ally.sync

( tokenID, eventID, content )

POST /api/?action=ally.syncHTTP/1.1 Host: inevent.us

Syncs and normalizes contacts from eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

contentPOST : content as JSON

[
    {
        "linkedIn": "string",
        "telephones": [
            "string",
            "..."
        ],
        "emails": [
            "string",
            "..."
        ]
    }
]

Analytics

A series of requests to extract relevant information from the results obtained in several interactive platforms during all event stages.

Models

{
    "count": 1,
    "data": [
        []
    ]
}

Methods

analytics.get

( tokenID, companyID, *personID, page )

GET /api/?action=analytics.getHTTP/1.1 Host: inevent.us

Gets statistic data on each page page usage.

tokenIDGET : token identifier

companyIDGET : company identifier

*personIDGET : person identifier

pageGET : page name

{
    "budget": "budget analytics"
}

( tokenID, eventID, *personID, page )

GET /api/?action=analytics.getHTTP/1.1 Host: inevent.us

Gets statistic data on each page page usage.

tokenIDGET : token identifier

eventIDGET : event identifier

*personIDGET : person identifier

pageGET : page name

{
    "event": "event",
    "feed": "news feed",
    "admin": "admins",
    "app": "application",
    "people": "people",
    "peopleConnections": "connections",
    "peopleRanking": "ranking",
    "person": "person data",
    "sponsors": "sponsors",
    "sponsorDataCollector": "data collectors",
    "activities": "activities"
}

Beacon

Customers can take advantage of beacons to send targeted push notifications or perform a range of other actions during the event.

Models

{
    "count": 1,
    "data": [
        {
            "beaconID": "1",
            "serial": "1",
            "bleAddress": "b8:27:eb:da:e6:38",
            "iBeaconMinor": "20",
            "wifiAddress": "b8:27:eb:da:e6:38",
            "date": "1415152800"
        }
    ]
}

Methods

beacon.create

( tokenID, serial, iBeaconMinor, bleAddress, wifiAddress )

POST /api/?action=beacon.createHTTP/1.1 Host: inevent.us

Creates a beacon with serial serial, BLE MAC Address bleAddress and AP MAC Address wifiAddress.

tokenIDGET : token identifier

serialPOST : beacon's serial

iBeaconMinorPOST : beacon's minor

bleAddressPOST : beacon's bleAddress

wifiAddressPOST : beacon's wifiAddress

beacon.find

( tokenID )

GET /api/?action=beacon.findHTTP/1.1 Host: inevent.us

Returns all beacons from InEvent.

tokenIDGET : token identifier

Beacon actions

Defines the actions each availble beacon will perform during the event. It's possible to combine several actions in the same beacon, enabling and disabling those actions during the event.

Models

{
    "count": 1,
    "data": [
        {
            "beaconEventID": "1",
            "eventID": "1",
            "beaconID": "2",
            "type": "push",
            "range": "7900",
            "extra": "Hello World"
        }
    ]
}

Methods

beacon.action.bind

( tokenID, beaconEventID, type, range, extra, name )

POST /api/?action=beacon.action.bindHTTP/1.1 Host: inevent.us

Adds an action type when beacon is inside of range range.

tokenIDGET : authentication token

beaconEventIDGET : beacon event identifier

typePOST : action to be performed

{
    "push": "send push notification"
}

rangePOST : maximum distance to beacon

extraPOST : extra value used by the action

namePOST : name used by the action

( tokenID, eventID, minor, type, range, extra, name )

POST /api/?action=beacon.action.bindHTTP/1.1 Host: inevent.us

Adds an action type when beacon is inside of range range.

tokenIDGET : authentication token

eventIDGET : event identifier

minorGET : beacon minor for event

typePOST : action to be performed

{
    "push": "send push notification"
}

rangePOST : maximum distance to beacon

extraPOST : extra value used by the action

namePOST : name used by the action

beacon.action.operate

( tokenID, beaconActionID, key, value )

POST /api/?action=beacon.action.operateHTTP/1.1 Host: inevent.us

Edits value value from field key of action beaconActionID.

tokenIDGET : token identifier

beaconActionIDGET : beacon's action identifier

keyGET : element name

{
    "active": "action status"
}

valuePOST : desired action

{
    "active": "integer"
}

beacon.action.dismiss

( tokenID, beaconActionID )

GET /api/?action=beacon.action.dismissHTTP/1.1 Host: inevent.us

Removes action beaconActionID.

tokenIDGET : authentication token

beaconActionIDGET : beacon's action identifier

beacon.action.find

( tokenID, beaconEventID )

GET /api/?action=beacon.action.findHTTP/1.1 Host: inevent.us

Finds all actions on beacon at event beaconEventID.

tokenIDGET : authentication token

beaconEventIDGET : beacon event identifier

( tokenID, eventID )

GET /api/?action=beacon.action.findHTTP/1.1 Host: inevent.us

Finds all actions at event eventID.

tokenIDGET : authentication token

eventIDGET : beacon's action identifier

Beacon at event

Some event make use of beacons in order to interact with the participants. Those beacons can be added to the customer's package through our team's local mapping, allowing messages customization.

Models

{
    "count": 1,
    "data": [
        {
            "beaconEventID": "1",
            "eventID": "1",
            "beaconID": "2",
            "type": "push",
            "range": "7900",
            "extra": "Hello World"
        }
    ]
}

Methods

beacon.event.bind

( tokenID, eventID, beaconID )

GET /api/?action=beacon.event.bindHTTP/1.1 Host: inevent.us

Adds a beacon beaconID at event eventID.

tokenIDGET : authentication token

eventIDGET : event identifier

beaconIDGET : beacon identifier

( tokenID, eventID, minor )

GET /api/?action=beacon.event.bindHTTP/1.1 Host: inevent.us

Adds a beacon with minor at event eventID.

tokenIDGET : authentication token

eventIDGET : event identifier

minorGET : beacon minor

beacon.event.dismiss

( tokenID, eventID, beaconID )

GET /api/?action=beacon.event.dismissHTTP/1.1 Host: inevent.us

Removes beacon beaconID from event eventID.

tokenIDGET : authentication token

eventIDGET : event identifier

beaconIDGET : beacon identifier

( tokenID, eventID, minor )

GET /api/?action=beacon.event.dismissHTTP/1.1 Host: inevent.us

Removes beacon with minor from event eventID.

tokenIDGET : authentication token

eventIDGET : event identifier

minorGET : beacon minor

beacon.event.find

( tokenID, eventID, selection )

GET /api/?action=beacon.event.findHTTP/1.1 Host: inevent.us

Finds beacons at event eventID.

tokenIDGET : authentication token

eventIDGET : event identifier

selectionGET : options status

{
    "all": "default option",
    "has-action": "only with action"
}

Beacon logs

Stores history of all beacons registered actions along the event.

Models

{
    "count": 1,
    "data": [
        {
            "beaconEventID": "1",
            "eventID": "1",
            "beaconID": "2",
            "type": "push",
            "range": "7900",
            "extra": "Hello World"
        }
    ]
}

Methods

beacon.log.bind

( tokenID, personID, beaconActionID )

GET /api/?action=beacon.log.bindHTTP/1.1 Host: inevent.us

Registers beacon action beaconActionID performed.

tokenIDGET : authentication token

personIDGET : person identifier

beaconActionIDGET : beacon's action identifier

( tokenID, beaconActionID )

GET /api/?action=beacon.log.bindHTTP/1.1 Host: inevent.us

Registers beacon action beaconActionID performed.

tokenIDGET : authentication token

beaconActionIDGET : beacon's action identifier

beacon.log.count

( tokenID, beaconEventID )

GET /api/?action=beacon.log.countHTTP/1.1 Host: inevent.us

Counts all registries from beacon at event beaconEventID.

tokenIDGET : authentication token

beaconEventIDGET : beacon's identifier at event

( tokenID, eventID )

GET /api/?action=beacon.log.countHTTP/1.1 Host: inevent.us

Counts all registries at event eventID.

tokenIDGET : authentication token

eventIDGET : event identifier

Billing

Billing and information control system for email and SMS products, helping organizers communicate with attendees and guests.

Models

{
    "count": 1,
    "data": [
        {
            "billingID": "1",
            "companyID": "1",
            "eventID": "1",
            "product": "email",
            "amount": "500",
            "sent": "11"
        }
    ]
}

Methods

billing.find

( tokenID, eventID )

GET /api/?action=billing.findHTTP/1.1 Host: inevent.us

Returns current amounts available at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Budget

Events got to have a budget controle and we help them in a concise and simple way.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "description": "",
            "type": "",
            "price": "",
            "date": ""
        }
    ]
}

Methods

budget.create

( tokenID, eventID, title, description, type, *category, *supplier, *status, price, date )

POST /api/?action=budget.createHTTP/1.1 Host: inevent.us

Creates a registry of expenditures at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

titlePOST : expense title

descriptionPOST : expense description

typePOST : type of expense

{
    "raw": "generic expense",
    "totalLodging": "total expense with hotels",
    "totalFlight": "total expense with flights",
    "totalShuttle": "total expense with transfers"
}

*categoryPOST : expense category

*supplierPOST : expense supplier

*statusPOST : expense status

pricePOST : expense price

datePOST : expense date

budget.edit

( tokenID, budgetID, key, value )

POST /api/?action=budget.editHTTP/1.1 Host: inevent.us

Edits value value from field key of expense budgetID.

tokenIDGET : token identifier

budgetIDGET : expense identifier

keyGET : field name

{
    "title": "data",
    "description": "data",
    "category": "data",
    "supplier": "data",
    "status": "data",
    "price": "data",
    "date": "data"
}

valuePOST : field value

{
    "title": "data",
    "description": "data",
    "category": "data",
    "supplier": "data",
    "status": "data",
    "price": "data",
    "date": "data"
}

budget.remove

( tokenID, budgetID )

GET /api/?action=budget.removeHTTP/1.1 Host: inevent.us

Removes expense budgetID from event.

tokenIDGET : token identifier

budgetIDGET : expense identifier

budget.get

( tokenID, budgetID )

GET /api/?action=budget.getHTTP/1.1 Host: inevent.us

Returns expense budgetID.

tokenIDGET : token identifier

budgetIDGET : expense identifier

budget.getCategories

( tokenID, eventID )

GET /api/?action=budget.getCategoriesHTTP/1.1 Host: inevent.us

Returns all categories for expenses at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

budget.getSuppliers

( tokenID, eventID )

GET /api/?action=budget.getSuppliersHTTP/1.1 Host: inevent.us

Returns all suppliers for expenses at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

budget.find

( tokenID, eventID )

GET /api/?action=budget.findHTTP/1.1 Host: inevent.us

Returns all expenses at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Budget log

This module helps us to log every change made in a spent.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "personID": "",
            "budgetID": "",
            "key": "",
            "oldValue": "",
            "newValue": "",
            "date": ""
        }
    ]
}

Methods

budget.log.find

( tokenID, eventID, budgetID )

GET /api/?action=budget.log.findHTTP/1.1 Host: inevent.us

Returns all logs for an expenditure budgetID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

budgetIDGET : expense identifier

Case study

After the event, is created a document summarizing its obtained results.

Models

{
    "count": 1,
    "data": [
        {
            "caseID": "1",
            "eventID": "1",
            "attendees": "100",
            "downloads": "400",
            "impressions": "3000",
            "challenges": "Long text.",
            "solution": "Long text.",
            "results": "Long text.",
            "date": "1415152800",
            "active": "1"
        }
    ]
}

Methods

case.edit

( tokenID, eventID, key, value )

POST /api/?action=case.editHTTP/1.1 Host: inevent.us

Edits value value from field key from case study at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : field name

{
    "attendees": "number of participants",
    "downloads": "number of downloads",
    "impressions": "number of prints",
    "headline": "event main summary",
    "challenges": "challenges faced",
    "solution": "solutions used",
    "results": "obtained results",
    "videoKey": "youtube identifier",
    "slideKey": "slideshare identifier"
}

valuePOST : field value

{
    "attendees": "integer",
    "downloads": "integer",
    "impressions": "integer",
    "headline": "string",
    "challenges": "string",
    "solution": "string",
    "results": "string",
    "videoKey": "string",
    "slideKey": "string"
}

case.find

( )

GET /api/?action=case.findHTTP/1.1 Host: inevent.us

Returns all active case studies.

case.get

( eventID )

GET /api/?action=case.getHTTP/1.1 Host: inevent.us

Returns case study at event eventID.

eventIDGET : event identifier

Chain

Creates a chain for event chaining.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "name": "Activity X"
        }
    ]
}

Methods

chain.create

( tokenID, eventID, name, *constraint )

POST /api/?action=chain.createHTTP/1.1 Host: inevent.us

Creates a chain with name name at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : chain name

*constraintPOST : chain rule

chain.remove

( tokenID, chainID )

GET /api/?action=chain.removeHTTP/1.1 Host: inevent.us

Removes chain chainID.

tokenIDGET : token identifier

chainIDGET : activity identifier

chain.find

( tokenID, eventID )

GET /api/?action=chain.findHTTP/1.1 Host: inevent.us

Returns all chains at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Chat

For each event, people can communicate using the instant chat tool. It's an excellent way of creating networking and capturing valuable leads.

Models

{
    "count": 1,
    "data": [
        {
            "chatID": "4",
            "senderID": "1",
            "receiverID": "15",
            "eventID": "6005",
            "message": "Hello, how are you?",
            "date": "1400524839",
            "viewed": "0"
        }
    ]
}

Push Notification

chat/send

_person

Informs the sent of message to person personID.

{
    "personID": "integer"
}

Methods

chat.create

( tokenID, eventID, personID, message )

POST /api/?action=chat.createHTTP/1.1 Host: inevent.us

Sends message message to person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

messagePOST : message (200)

chat.find

( tokenID, eventID, personID )

GET /api/?action=chat.findHTTP/1.1 Host: inevent.us

Returns all messages sent between person tokenID and person personID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID )

GET /api/?action=chat.findHTTP/1.1 Host: inevent.us

Returns everyone which whom person tokenID interacted at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

chat.get

( tokenID, chatID )

GET /api/?action=chat.getHTTP/1.1 Host: inevent.us

Returns message chatID.

tokenIDGET : token identifier

chatIDGET : message identifier

chat.view

( tokenID, eventID, personID )

GET /api/?action=chat.viewHTTP/1.1 Host: inevent.us

Marks conversation between person tokenID with person personID at event eventID as read.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

Chatter

Module destinated to integrations with Salesforce's Chatter, used at an event.

Methods

chatter.get

( tokenID, eventID )

GET /api/?action=chatter.getHTTP/1.1 Host: inevent.us

Returns authentication tokens linked to event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

chatter.unlink

( tokenID, eventID )

GET /api/?action=chatter.unlinkHTTP/1.1 Host: inevent.us

Unlinks Chatter integration from event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

chatter.getCommunities

( tokenID, eventID )

GET /api/?action=chatter.getCommunitiesHTTP/1.1 Host: inevent.us

Returns communities in token context vinculated to Chatter at event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

chatter.getGroups

( tokenID, eventID )

GET /api/?action=chatter.getGroupsHTTP/1.1 Host: inevent.us

Returns groups in token context vinculated to Chatter at event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

chatter.setCommunity

( tokenID, eventID, communityId, communityUrl, communityName )

GET /api/?action=chatter.setCommunityHTTP/1.1 Host: inevent.us

Links a Chatter community with event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

communityIdGET : community identifier

communityUrlGET : community url

communityNameGET : community name

chatter.unsetCommunity

( tokenID, eventID )

GET /api/?action=chatter.unsetCommunityHTTP/1.1 Host: inevent.us

Unlinks Chatter communities from event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

chatter.setGroup

( tokenID, eventID, groupId, groupName )

GET /api/?action=chatter.setGroupHTTP/1.1 Host: inevent.us

Links a Chatter group with event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

groupIdGET : community identifier

groupNameGET : community name

chatter.unsetGroup

( tokenID, eventID )

GET /api/?action=chatter.unsetGroupHTTP/1.1 Host: inevent.us

Unlinks Chatter groups from event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

Check-In/Out

During the event organizers can perform activities and event check-in/out.

Models

{
    "count": 1,
    "data": [
        []
    ]
}

Methods

checklog.checkIn

( tokenID, eventID, activityID, code, date )

GET /api/?action=checklog.checkInHTTP/1.1 Host: inevent.us

Performs check-in of person code at activity activityID from event eventID on time date.

tokenIDGET : token identifier

eventIDGET : event identifier

activityIDGET : activity identifier

codeGET : identification key

dateGET : arrival date

( tokenID, eventID, code, date )

GET /api/?action=checklog.checkInHTTP/1.1 Host: inevent.us

Performs check-in from person code at event eventID on time date.

tokenIDGET : token identifier

eventIDGET : event identifier

codeGET : identification key

dateGET : arrival date

checklog.checkOut

( tokenID, eventID, activityID, code, date )

GET /api/?action=checklog.checkOutHTTP/1.1 Host: inevent.us

Performs check-out from person code at activity activityID at event eventID on time date.

tokenIDGET : token identifier

eventIDGET : event identifier

activityIDGET : activity identifier

codeGET : identification key

dateGET : departure date

( tokenID, eventID, code, date )

GET /api/?action=checklog.checkOutHTTP/1.1 Host: inevent.us

Performs check-in from person code at event eventID on time date.

tokenIDGET : token identifier

eventIDGET : event identifier

codeGET : identification key

dateGET : departure date

checklog.stats

( tokenID, eventID )

GET /api/?action=checklog.statsHTTP/1.1 Host: inevent.us

Gets check-ins/out status and prints at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

checklog.checkedIn

( tokenID, eventID )

GET /api/?action=checklog.checkedInHTTP/1.1 Host: inevent.us

Gets everyone registered at eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

( tokenID, eventID, activityID )

GET /api/?action=checklog.checkedInHTTP/1.1 Host: inevent.us

Gets everyone registered at activity activityID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

activityIDGET : activity identifier

checklog.find

( tokenID, eventID )

GET /api/?action=checklog.findHTTP/1.1 Host: inevent.us

Exports an excel spreadsheet for event eventID given a selection selection.

tokenIDGET : token identifier

eventIDGET : event identifier

Comment

Inside an activity, several comments can be added from different participants in order to discuss a specific subject.

Models

{
    "count": 1,
    "data": [
        {
            "commentID": "1",
            "activityID": "14",
            "personID": "1",
            "personName": "John Smith",
            "text": "First post",
            "date": "1413234163"
        }
    ]
}

Methods

comment.create

( tokenID, activityID, text )

POST /api/?action=comment.createHTTP/1.1 Host: inevent.us

Adds comment text at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

textPOST : comment text

comment.edit

( tokenID, commentID, key, value )

POST /api/?action=comment.editHTTP/1.1 Host: inevent.us

Edits value value from field key from comment commentID.

tokenIDGET : token identifier

commentIDGET : comment identifier

keyGET : field name

{
    "approved": "approved"
}

valuePOST : field value

{
    "approved": "bit"
}

comment.remove

( tokenID, commentID )

GET /api/?action=comment.removeHTTP/1.1 Host: inevent.us

Removes comment commentID.

tokenIDGET : token identifier

commentIDGET : comment identifier

comment.find

( tokenID, activityID, selection )

GET /api/?action=comment.findHTTP/1.1 Host: inevent.us

Returns all comments from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

selectionGET : comments on activity

{
    "all": "all comments",
    "approved+me": "comments approved and participant's own comments"
}

comment.get

( tokenID, commentID )

GET /api/?action=comment.getHTTP/1.1 Host: inevent.us

Returns comment commentID.

tokenIDGET : token identifier

commentIDGET : comment identifier

comment.hashtags

( tokenID, activityID )

GET /api/?action=comment.hashtagsHTTP/1.1 Host: inevent.us

Returns hashtag statistics for an activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

Company

For continuous use of API with exclusive benefits to partners is necessary to create the company inside InEvent's platform, providing a better control over security and uses limitations. For each registered company, a company identifier is generated with its details, members, events and partners.

Models

{
    "count": 1,
    "data": [
        {
            "companyID": "1",
            "shortName": "InEvent",
            "storeTitle": "InEvent - Empowering people on events",
            "appIcon": "uploads\/1396576595.png",
            "storeIcon": "uploads\/1396576595.png",
            "cover": "uploads\/1396576595.png",
            "splash": "uploads\/1396576595.png",
            "bundle": "us.inevent.apps.demo",
            "androidApp": "https:\/\/play.google.com\/store\/apps\/details?id=us.inevent.apps.demo",
            "iosApp": "https:\/\/itunes.apple.com\/ca\/app\/inevent-tour\/id995325465?mt=8",
            "agreement": "https:\/\/path\/to\/agreement",
            "keywords": "app,events,success",
            "backgroundColor": "#A3A3A3",
            "navigationBarBackgroundColor": "#A3A3A3",
            "androidVersion": "1.0",
            "iosVersion": "1.0",
            "language": "1",
            "currency": "USD"
        }
    ]
}

Methods

company.create

( tokenID, shortName, storeTitle )

POST /api/?action=company.createHTTP/1.1 Host: inevent.us

Creates a company shortName.

tokenIDGET : token identifier

shortNamePOST : name os app's icon

storeTitlePOST : name on download stores

( tokenID, path )

POST /api/?action=company.createHTTP/1.1 Host: inevent.us

Creates multiple companies.

tokenIDGET : token identifier

pathPOST : file path

company.edit

( tokenID, companyID, key, value )

POST /api/?action=company.editHTTP/1.1 Host: inevent.us

Edits value value from field key from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

keyGET : field name

{
    "shortName": "app title",
    "storeTitle": "stores title",
    "location": "electronic address",
    "appIcon": "main icon",
    "storeIcon": "store icon",
    "cover": "cover image on opening",
    "bundle": "unique identifier",
    "agreement": "terms of use",
    "keywords": "keywords for stores",
    "backgroundColor": "background color",
    "navigationBarBackgroundColor": "bar color",
    "mainColor": "main color",
    "splash": "splash image",
    "language": "language",
    "androidReview": "android review",
    "iosReview": "iOS review",
    "initialDemo": "show initial demo?"
}

valuePOST : field value

{
    "shortName": "string",
    "storeTitle": "string",
    "location": "string",
    "appIcon": "string",
    "storeIcon": "string",
    "cover": "string",
    "bundle": "string",
    "agreement": "string",
    "keywords": "string",
    "backgroundColor": "string",
    "navigationBarBackgroundColor": "string",
    "mainColor": "string",
    "splash": "string",
    "language": "string",
    "androidReview": "bit",
    "iosReview": "bit",
    "initialDemo": "bit"
}

( onboardingToken, key, value )

POST /api/?action=company.editHTTP/1.1 Host: inevent.us

Edits value value from field key from company with token onboardingToken.

onboardingTokenGET : company identifier

keyGET : field name

{
    "shortName": "app title",
    "storeTitle": "stores title",
    "appIcon": "main icon",
    "storeIcon": "store icon",
    "keywords": "keywords for stores",
    "backgroundColor": "background color",
    "navigationBarBackgroundColor": "bar color",
    "mainColor": "main color",
    "splash": "splash image"
}

valuePOST : field value

{
    "shortName": "string",
    "storeTitle": "string",
    "appIcon": "string",
    "storeIcon": "string",
    "keywords": "string",
    "backgroundColor": "string",
    "navigationBarBackgroundColor": "string",
    "mainColor": "string",
    "splash": "string"
}

company.find

( tokenID, selection )

GET /api/?action=company.findHTTP/1.1 Host: inevent.us

Returns all companies with tokenID access.

tokenIDGET : token identifier

selectionGET : selection

{
    "all": "all companies",
    "live": "on production",
    "androidQueue": "to review",
    "iosQueue": "to review",
    "lacksIcon": "waiting for icon",
    "lacksBundle": "waiting for bundleID",
    "missingLinks": "waiting for stores link",
    "notWhiteLabel": "isn't white label"
}

company.get

( tokenID, companyID )

GET /api/?action=company.getHTTP/1.1 Host: inevent.us

Returns details from company companyID with tokenID access.

tokenIDGET : token identifier

companyIDGET : company identifier

( companyID )

GET /api/?action=company.getHTTP/1.1 Host: inevent.us

Returns details from company companyID.

companyIDGET : company identifier

( tokenID, namespace )

GET /api/?action=company.getHTTP/1.1 Host: inevent.us

Returns details from company with namespace namespace with tokenID access.

tokenIDGET : token identifier

namespaceGET : company namespace

( namespace )

GET /api/?action=company.getHTTP/1.1 Host: inevent.us

Returns details from company with namespace namespace.

namespaceGET : company namespace

( onboardingToken )

GET /api/?action=company.getHTTP/1.1 Host: inevent.us

Returns details from company with onboarding token onboardingToken.

onboardingTokenGET : onboarding token

Company admins

For registered companies, admins are people that make management decisions inside each company. Those can have multiple levels, separating them between staff and coordinators.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "level": "4"
        }
    ]
}
{
    "level": {
        "1": "LEVEL_USER",
        "4": "LEVEL_ADMIN"
    }
}

Methods

company.person.bind

( tokenID, companyID, name, email )

POST /api/?action=company.person.bindHTTP/1.1 Host: inevent.us

Adds a person with name name and email email at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

namePOST : person name

emailPOST : person email

company.person.operate

( tokenID, companyID, key, value, personID )

POST /api/?action=company.person.operateHTTP/1.1 Host: inevent.us

Edits value value from field key to person personID at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

keyGET : element name

{
    "level": "admin privilege"
}

valuePOST : field value

{
    "level": "bit"
}

personIDGET : person identifier

company.person.dismiss

( tokenID, companyID, personID )

GET /api/?action=company.person.dismissHTTP/1.1 Host: inevent.us

Removes person personID from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

personIDGET : person identifier

company.person.find

( tokenID, companyID, selection, *order )

GET /api/?action=company.person.findHTTP/1.1 Host: inevent.us

Returns everyone at company companyID, filtered by a selection selection and order order.

tokenIDGET : token identifier

companyIDGET : company identifier

selectionGET : people at company

{
    "all": "everyone"
}

*orderGET : results order

company.person.sync

( tokenID )

GET /api/?action=company.person.syncHTTP/1.1 Host: inevent.us

Syncs everyone with external management platforms.

tokenIDGET : token identifier

Company events

For a company to perform multiple events, becomes important to handle each one of those broadly. After being added, each event can be reviewed and edited before receiving the final approval.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "5922",
            "name": "party",
            "nickname": "#party",
            "email": "email@email.com",
            "description": "Event description",
            "cover": "https:\/\/",
            "dateBegin": "1396576639",
            "dateEnd": "1399168639",
            "enrollmentBegin": "1396576639",
            "enrollmentEnd": "1399168639",
            "latitude": "0",
            "longitude": "0",
            "spot": "",
            "address": "Address",
            "city": "City",
            "state": "State",
            "fugleman": "Organizer",
            "ticketURL": "",
            "facebook": "",
            "twitter": "",
            "visible": "1",
            "public": "1",
            "sandbox": "0",
            "personID": "-1",
            "level": "4",
            "approved": "1",
            "themes": []
        }
    ]
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}
{
    "level": {
        "1": "LEVEL_USER",
        "4": "LEVEL_ADMIN"
    }
}

Methods

company.event.bind

( tokenID, companyID, name, nickname )

POST /api/?action=company.event.bindHTTP/1.1 Host: inevent.us

Creates an event with name name and nickname nickname at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

namePOST : company name

nicknamePOST : event nickname hashtag

( tokenID, companyID, path )

POST /api/?action=company.event.bindHTTP/1.1 Host: inevent.us

Creates multiple events at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

pathPOST : file path

company.event.dismiss

( tokenID, companyID, eventID )

GET /api/?action=company.event.dismissHTTP/1.1 Host: inevent.us

Removes event eventID from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

eventIDGET : event identifier

company.event.find

( tokenID, companyID, selection, *name, *city, *dateBegin, *dateEnd, *presential, *public, *visible, *templateID, *order, *timezone )

GET /api/?action=company.event.findHTTP/1.1 Host: inevent.us

Returns all events at company companyID, filtered by selection selection and informing if person tokenID is registered.

tokenIDGET : token identifier

companyIDGET : company identifier

selectionGET : event registration

{
    "all": "all events",
    "best-fit": "events open for registration and with priorities (1) events on the next 3 days range (2) future events (3) events attending and (4) other events",
    "approved": "registration approved",
    "enrolled": "events enrolled",
    "denied": "registration rejected",
    "paid": "registration paid",
    "present": "person attending",
    "working": "working as staff or coordinator"
}

*nameGET : event name

*cityGET : city name

*dateBeginGET : event's begin date

*dateEndGET : event's end date

*presentialGET : face-to-face event

*publicGET : public event

*visibleGET : visible event

*templateIDGET : template event

*orderGET : results order

*timezoneGET : Timezone to search the dates of the event

( tokenID, companyID, selection, *name, *dateBegin, *dateEnd )

GET /api/?action=company.event.findHTTP/1.1 Host: inevent.us

Returns all events at company companyID, filtered by selection selection and informing if person tokenID is registered.

tokenIDGET : token identifier

companyIDGET : company identifier

selectionGET : event registration

*nameGET : event name

*dateBeginGET : event's begin date

*dateEndGET : event's end date

( companyID, *name, *city, *dateBegin, *dateEnd, *presential, *public, *visible, *order )

GET /api/?action=company.event.findHTTP/1.1 Host: inevent.us

Returns all events at company companyID.

companyIDGET : company identifier

*nameGET : event name

*cityGET : city name

*dateBeginGET : event's begin date

*dateEndGET : event's end date

*presentialGET : face-to-face event

*publicGET : public event

*visibleGET : visible event

*orderGET : results order

( companyID, *name, *dateBegin, *dateEnd )

GET /api/?action=company.event.findHTTP/1.1 Host: inevent.us

Returns all events at company companyID.

companyIDGET : company identifier

*nameGET : event name

*dateBeginGET : event's begin date

*dateEndGET : event's end date

company.event.get

( tokenID, companyID, eventID )

GET /api/?action=company.event.getHTTP/1.1 Host: inevent.us

Returns event eventID at company companyID, informing if person tokenID is registered.

tokenIDGET : token identifier

companyIDGET : company identifier

eventIDGET : event identifier

( companyID, eventID )

GET /api/?action=company.event.getHTTP/1.1 Host: inevent.us

Returns event eventID at company companyID.

companyIDGET : company identifier

eventIDGET : event identifier

company.event.findAttendees

( tokenID, companyID )

GET /api/?action=company.event.findAttendeesHTTP/1.1 Host: inevent.us

Returns all participants of all events from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

company.event.copy

( tokenID, companyID, eventID )

GET /api/?action=company.event.copyHTTP/1.1 Host: inevent.us

Copies event eventID at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

eventIDGET : event identifier

company.event.budget

( tokenID, companyID )

GET /api/?action=company.event.budgetHTTP/1.1 Host: inevent.us

Returns budget details from each event at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

Company features

Indicates which features are enabled at the platform for a specific event

Models

{
    "count": 1,
    "data": [
        {
            "reports": "1",
            "images": "1",
            "tweets": "1",
            "meetings": "1",
            "whiteLabel": "0"
        }
    ]
}

Methods

company.feature.get

( tokenID, companyID, key )

GET /api/?action=company.feature.getHTTP/1.1 Host: inevent.us

Returns if a particular feature is enabled.

tokenIDGET : token identifier

companyIDGET : event identifier

keyGET : feature key

"Optional; one of the keys from above model. If empty, returns the value for all of them"

company.feature.edit

( tokenID, companyID, key, value )

POST /api/?action=company.feature.editHTTP/1.1 Host: inevent.us

Updates status of a particular feature.

tokenIDGET : token identifier

companyIDGET : event identifier

keyGET : feature key

"one of the keys from above model"

valuePOST : field value

company.feature.available

( tokenID )

GET /api/?action=company.feature.availableHTTP/1.1 Host: inevent.us

Returns all products available at InEvent.

tokenIDGET : token identifier

Company items

Certain applications need additional items in its menu.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "companyID": "1",
            "title": "Recruiting",
            "link": "http:\/\/"
        }
    ]
}

Methods

company.link.create

( tokenID, companyID, title, link )

POST /api/?action=company.link.createHTTP/1.1 Host: inevent.us

Adds item with title title and destination link at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

titlePOST : item title

linkPOST : item url

company.link.remove

( tokenID, companyLinkID )

GET /api/?action=company.link.removeHTTP/1.1 Host: inevent.us

Removes item companyLinkID.

tokenIDGET : token identifier

companyLinkIDGET : item identifier

company.link.find

( companyID )

GET /api/?action=company.link.findHTTP/1.1 Host: inevent.us

Gets all items available at company companyID.

companyIDGET : company identifier

Legal data

We request our clients to give us access to their legal data for apps publishing reason

Models

{
    "count": 1,
    "data": [
        {
            "name": "Pedro Góes",
            "email": "email@email.com",
            "telephone": "000-000-0000",
            "legalId": "99999999"
        }
    ]
}

Methods

company.legal.edit

( tokenID, companyID, key, value )

POST /api/?action=company.legal.editHTTP/1.1 Host: inevent.us

Updates legal data from company companyID on key key with value value.

tokenIDGET : token identifier

companyIDGET : company identifier

keyGET : legal data key

"one of the keys from above model"

valuePOST : field value

company.legal.get

( tokenID, companyID )

GET /api/?action=company.legal.getHTTP/1.1 Host: inevent.us

Returns legal data from company companyID for admin tokenID.

tokenIDGET : token identifier

companyIDGET : company identifier

Company notifications

For each company, certificates are needed to validate access at Apple (APNS) and Google (GCM) servers, and to send notifications to the mobile applications. Each one receives a identifier with the information pair for both mobile OSs.

Methods

company.push.bind

( tokenID, companyID, androidKey, iosPath )

POST /api/?action=company.push.bindHTTP/1.1 Host: inevent.us

Adds a new certificate at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

androidKeyPOST : GCM key

iosPathPOST : APNS path

company.push.dismiss

( tokenID, companyID )

GET /api/?action=company.push.dismissHTTP/1.1 Host: inevent.us

Removes certificate from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

company.push.find

( tokenID, companyID )

GET /api/?action=company.push.findHTTP/1.1 Host: inevent.us

Returns all certificates at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

Company tools

Each company contains exclusive tools which can be controlled by its administrators.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "companyID": "1",
            "feedback": "1",
            "presence": "0",
            "material": "0",
            "question": "1",
            "comment": "1",
            "quiz": "1",
            "speaker": "1",
            "networking": "1",
            "pushNotification": "1",
            "shareOnlyEventDay": "0",
            "searchBar": "1",
            "facebookLogin": "1",
            "linkedInLogin": "1",
            "confirmationEmail": "1",
            "offlinePush": "1",
            "meeting": "1",
            "localTimezone": "0",
            "aboutUs": "1",
            "autoApproveQuestion": "1",
            "autoApproveComment": "1",
            "autoApproveSocialFlow": "1",
            "photo": "1",
            "quickMenu": "1",
            "multipleEvents": "1",
            "sponsors": "1",
            "stream": "1",
            "feed": "0",
            "schedule": "1",
            "linkedInLegacy": "1",
            "hideFullRooms": "0"
        }
    ]
}

Methods

company.tool.edit

( tokenID, companyID, key, value )

POST /api/?action=company.tool.editHTTP/1.1 Host: inevent.us

Edits value value from field key from tools at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

keyGET : field name

{
    "feedback": "activities and event feedback",
    "presence": "mark attendance on activities",
    "material": "download materials used on activities",
    "question": "send questions at activities",
    "comment": "send comments on activities",
    "quiz": "answer quizzes on activities",
    "meeting": "meetings scheduling",
    "aboutUs": "about InEvent screen",
    "speaker": "speakers list",
    "networking": "participants list",
    "shareOnlyEventDay": "shares event day only",
    "searchBar": "events search bar",
    "facebookLogin": "login via facebook",
    "linkedInLogin": "login via LinkedIn",
    "confirmationEmail": "confirmation email",
    "photo": "event pictures",
    "quickMenu": "quick actions",
    "multipleEvents": "multiple events"
}

valuePOST : field value

{
    "feedback": "integer(1)",
    "presence": "integer(1)",
    "material": "integer(1)",
    "question": "integer(1)",
    "comment": "integer(1)",
    "quiz": "integer(1)",
    "meeting": "integer(1)",
    "aboutUs": "integer(1)",
    "speaker": "integer(1)",
    "networking": "integer(1)",
    "shareOnlyEventDay": "integer(1)",
    "searchBar": "integer(1)",
    "facebookLogin": "integer(1)",
    "linkedInLogin": "integer(1)",
    "confirmationEmail": "integer(1)",
    "photo": "integer(1)",
    "quickMenu": "integer(1)",
    "multipleEvents": "integer(1)"
}

company.tool.get

( companyID )

GET /api/?action=company.tool.getHTTP/1.1 Host: inevent.us

Returns all tools available at company companyID.

companyIDGET : company identifier

company.tool.available

( tokenID )

GET /api/?action=company.tool.availableHTTP/1.1 Host: inevent.us

Returns all tools available for use.

tokenIDGET : token identifier

Discount coupons

It's possible to create discount codes for features

Models

{
    "count": 1,
    "data": [
        {
            "couponID": "1",
            "eventID": "1",
            "code": "78DJX8",
            "discount": "10",
            "used": "1"
        }
    ]
}

Methods

coupon.create

( tokenID, eventID, discount )

POST /api/?action=coupon.createHTTP/1.1 Host: inevent.us

Creates a discount coupon discount at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

discountPOST : discount rate (0-100)

coupon.get

( tokenID, eventID, code )

POST /api/?action=coupon.getHTTP/1.1 Host: inevent.us

Returns coupon code.

tokenIDGET : token identifier

eventIDGET : event identifier

codePOST : unique code

Daemon

This API allows users to adquire notifications sent to our daemons for post-processing

Models

{
    "count": 1,
    "data": [
        {
            "*": "mixed"
        }
    ]
}

Methods

daemon.find

( tokenID, eventID, operation, target )

GET /api/?action=daemon.findHTTP/1.1 Host: inevent.us

Returns pending operations for event eventID, operation operation and target target.

tokenIDGET : token identifier

eventIDGET : event identifier

operationGET : operation

targetGET : target

Download

Downloads are ways of extracting data from the platform based on your compliance rules.

Models

{
    "count": 1,
    "data": [
        {
            "downloadID": "1",
            "companyID": "1",
            "eventID": "1",
            "memberID": "1",
            "title": "Spreadsheet",
            "event": "test",
            "type": "xlsx",
            "url": "https:\/\/",
            "date": "1503027673"
        }
    ]
}

Methods

download.remove

( tokenID, downloadID )

GET /api/?action=download.removeHTTP/1.1 Host: inevent.us

Remove download downloadID from the system.

tokenIDGET : token identifier

downloadIDGET : download identifier

download.find

( tokenID, companyID )

GET /api/?action=download.findHTTP/1.1 Host: inevent.us

Returns all downloads at companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

Email logs

Stores every email ever sent for further reading, checking and compliance. Includes environmental informations, such as openings timestamps and email statuses.

Models

{
    "count": 1,
    "data": [
        {
            "emailLogID": "1",
            "eventID": "1",
            "memberID": "1",
            "listEmailID": "",
            "messageID": "61270c02-def6-4029-9e8b-9be3dc469d0e",
            "from": "Standalone Out ",
            "to": "goes@inevent.us",
            "subject": "Welcome to Standalone Out",
            "status": "delivered",
            "opens": "0",
            "date": "1525269353",
            "personName": "Pedro",
            "listID": "",
            "listName": "",
            "listSubject": "",
            "listSelection": "",
            "listSent": "",
            "body": ""
        }
    ]
}

Methods

email.log.find

( tokenID, eventID, selection, query, subject )

GET /api/?action=email.log.findHTTP/1.1 Host: inevent.us

Returns email logs at event eventID, optionally filtered by query and subject.

tokenIDGET : token identifier

eventIDGET : event

selectionGET : segments

queryGET : search terms

subjectGET : search subject

email.log.get

( tokenID, emailLogID )

GET /api/?action=email.log.getHTTP/1.1 Host: inevent.us

Returns a specific email log emailLogID.

tokenIDGET : token identifier

emailLogIDGET : event log identifier

Error

Disregarging of the developed product, error unfortunately happen and should be given the proper attention. For each error informed, a message, place and occurence moment are obtained.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "0",
            "platform": "ios",
            "message": "aa",
            "date": "2014-05-12 15:04:41",
            "solved": "0"
        }
    ]
}

Methods

error.create

( tokenID, platform, message, *STACK_TRACE, *STACK_TRACE, *INITIAL_CONFIGURATION, *BUILD )

POST /api/?action=error.createHTTP/1.1 Host: inevent.us

Informs occurence of error message while person tokenID used the platform platform.

tokenIDGET : token identifier

platformPOST : error location

messagePOST : error message

*STACK_TRACEPOST : stacktrace generated by ACRA

*STACK_TRACEPOST : stacktrace generated by ACRA

*INITIAL_CONFIGURATIONPOST : cellphone configuration generated by ACRA

*BUILDPOST : OS version generated by ACRA

error.create

( tokenID, json )

POST /api/?action=error.createHTTP/1.1 Host: inevent.us

Informs occurence of error message while person tokenID used the platform platform.

tokenIDGET : token identifier

jsonPOST : json contents from php://input

Event

For each event, we can inform which people and activities are taking part in it. Each event receives an identifier, enabling to access its information, and to add new participantes or see its activities.

Models

{
    "Event": {
        "count": 1,
        "data": [
            {
                "eventID": "1",
                "name": "Aeronautic Engineering Week",
                "nickname": "sea2013",
                "email": "email@email.com",
                "description": "Aeronautic Engineering Week",
                "cover": "uploads\/1384178223.jpg",
                "dateBegin": "1376910000",
                "dateEnd": "1377302400",
                "latitude": "0",
                "longitude": "0",
                "spot": "",
                "address": "MIT",
                "city": "Cambridge",
                "state": "MA",
                "fugleman": "SAAero",
                "ticketURL": "1",
                "facebook": "",
                "twitter": "",
                "visible": "1",
                "public": "1",
                "automaticEnrollment": "1",
                "sandbox": "0",
                "approved": "-1"
            }
        ]
    }
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}

Push Notification

event/edit

_event

Informs event eventID update.

{
    "eventID": "integer"
}

event/remove

_event

Informs event eventID removal.

{
    "eventID": "integer"
}

Methods

event.edit

( tokenID, eventID, key, value )

POST /api/?action=event.editHTTP/1.1 Host: inevent.us

Edits value value from field key from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : field name

{
    "name": "nome",
    "nickname": "hashtag",
    "email": "organization email",
    "description": "general introduction",
    "cover": "cover image",
    "dateBegin": "begin date",
    "dateEnd": "end date",
    "enrollmentBegin": "timestamp from begin of enrollment",
    "enrollmentEnd": "timestamp from end of enrollment",
    "latitude": "latitude",
    "longitude": "longitude",
    "address": "address on map",
    "fugleman": "organization name",
    "ticketURL": "gateway url",
    "website": "website url",
    "accessCode": "event access code",
    "facebook": "facebook page url",
    "twitter": "twitter profile url",
    "wireless": "wireless network information",
    "visible": "visible?",
    "public": "private?",
    "automaticEnrollment": "automatic enrollment?"
}

valuePOST : field value

{
    "name": "string",
    "nickname": "string",
    "email": "string",
    "description": "string",
    "cover": "string",
    "dateBegin": "timestamp",
    "dayBegin": "integer",
    "monthBegin": "integer",
    "hourBegin": "integer",
    "minuteBegin": "integer",
    "dateEnd": "timestamp",
    "dayEnd": "integer",
    "monthEnd": "integer",
    "hourEnd": "integer",
    "minuteEnd": "integer",
    "enrollmentBegin": "timestamp",
    "enrollmentEnd": "timestamp",
    "latitude": "integer",
    "longitude": "integer",
    "address": "string",
    "fugleman": "string",
    "ticketURL": "string",
    "website": "string",
    "accessCode": "1..9999",
    "facebook": "string",
    "twitter": "string",
    "wireless": "string",
    "visible": "integer(1)",
    "public": "integer(1)",
    "automaticEnrollment": "integer(1)"
}

event.get

( tokenID, eventID, personID )

GET /api/?action=event.getHTTP/1.1 Host: inevent.us

Returns event eventID, informing if person personID is registered.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID )

GET /api/?action=event.getHTTP/1.1 Host: inevent.us

Returns event eventID, informing if person tokenID is registered.

tokenIDGET : token identifier

eventIDGET : event identifier

( eventID )

GET /api/?action=event.getHTTP/1.1 Host: inevent.us

Returns event eventID.

eventIDGET : event identifier

event.checkAccessCode

( tokenID, eventID, accessCode )

POST /api/?action=event.checkAccessCodeHTTP/1.1 Host: inevent.us

Informs if access code is correct for event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

accessCodePOST : event access code

event.sendSMS

( eventID, telephone )

POST /api/?action=event.sendSMSHTTP/1.1 Host: inevent.us

Sends a SMS for person with telephone telephone at event eventID.

eventIDGET : event identifier

telephonePOST : telephone number

event.search

( tokenID, eventID, query )

POST /api/?action=event.searchHTTP/1.1 Host: inevent.us

Searchs generic objects inside the event.

tokenIDGET : token identifier

eventIDGET : event identifier

queryPOST : search to be performed

Event applicants

List all candidates willing to get access to the event but still haven't been able to do so, maybe due to payments, maybe regarging their credentials process or even specific business rules.

Models

{
    "count": 1,
    "data": [
        []
    ]
}

Methods

event.applicant.bind

( eventID, name, username, email, password, *role, *company )

POST /api/?action=event.applicant.bindHTTP/1.1 Host: inevent.us

Creates an application at event eventID

eventIDGET : event identifier

namePOST : person name

usernamePOST : person username

emailPOST : person email

passwordPOST : person password

*rolePOST : person role

*companyPOST : person company

( tokenID, eventID, path )

POST /api/?action=event.applicant.bindHTTP/1.1 Host: inevent.us

Creates multiple applicants at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

event.applicant.operate

( tokenID, eventID, name, email )

POST /api/?action=event.applicant.operateHTTP/1.1 Host: inevent.us

Changes an application at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : person name

emailPOST : person email

( tokenID, eventID, content )

POST /api/?action=event.applicant.operateHTTP/1.1 Host: inevent.us

Edits values content for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

contentPOST : key values for editing

event.applicant.dismiss

( tokenID, eventID, personID )

GET /api/?action=event.applicant.dismissHTTP/1.1 Host: inevent.us

Removes an applicant personID from event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

event.applicant.find

( tokenID, eventID, *paginated, *query )

GET /api/?action=event.applicant.findHTTP/1.1 Host: inevent.us

Finds all aplications at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

*paginatedGET : request to be paginated

*queryGET : search field

event.applicant.get

( tokenID, eventID, personID )

GET /api/?action=event.applicant.getHTTP/1.1 Host: inevent.us

Gathers an applicant personID at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID )

GET /api/?action=event.applicant.getHTTP/1.1 Host: inevent.us

Gathers an application at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

event.applicant.approve

( tokenID, eventID, personID )

GET /api/?action=event.applicant.approveHTTP/1.1 Host: inevent.us

Approves an applicant personID at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

Items reservation at event

For each event, partners can buy items inside your event, such as data collectors and beacons. It's necessary to fill a form and pay in order to authorize the sale.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "value": "email@email.com",
            "source": "email",
            "used": "0"
        }
    ]
}

Methods

event.booking.create

( tokenID, eventID, name, email, telephone, company, dataCollectors, liveSupport, extraPhone, extraLive, automaticReport, beacons, pricing )

POST /api/?action=event.booking.createHTTP/1.1 Host: inevent.us

Creates a reservation at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : client name

emailPOST : client email

telephonePOST : client telephone

companyPOST : client company

dataCollectorsPOST : number of data collectors

liveSupportPOST : live support during the event

extraPhonePOST : rented smartphone

extraLivePOST : real-time leads base

automaticReportPOST : end of day automatic report

beaconsPOST : number of beacons

pricingPOST : sale price

event.booking.find

( tokenID, eventID, selection, *query )

GET /api/?action=event.booking.findHTTP/1.1 Host: inevent.us

Returns reservations at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : event reservations

{
    "all": "all reservations",
    "fresh": "new reservations",
    "used": "used reservations"
}

*queryGET : search text

event.booking.get

( tokenID, eventID, value )

GET /api/?action=event.booking.getHTTP/1.1 Host: inevent.us

Returns details from reservation value at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

valueGET : reservation identifier

Custom emails

Emails content sent on each moment can be customized. Each event can have only content type for each one of the available sources.

Models

{
    "count": 1,
    "data": [
        {
            "eventEmailID": "1",
            "eventID": "5927",
            "source": "eve",
            "text": "Thank you ...",
            "listID": "0",
            "date": "0",
            "sent": "0"
        }
    ]
}

Methods

event.email.create

( tokenID, eventID, subject, text, *listID )

POST /api/?action=event.email.createHTTP/1.1 Host: inevent.us

Creates a custom email with subject subject and text text at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

subjectPOST : email subject

textPOST : email content

*listIDPOST : list identifier

event.email.edit

( tokenID, eventID, source, key, value )

POST /api/?action=event.email.editHTTP/1.1 Host: inevent.us

Edits value value from field key from source source at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

sourceGET : email source

keyGET : field name

{
    "text": "content"
}

valuePOST : field value

{
    "text": "string"
}

event.email.find

( tokenID, eventID )

GET /api/?action=event.email.findHTTP/1.1 Host: inevent.us

Returns all emails from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

event.email.get

( tokenID, eventEmailID )

GET /api/?action=event.email.getHTTP/1.1 Host: inevent.us

Returns email eventEmailID.

tokenIDGET : token identifier

eventEmailIDGET : email identifier

event.email.try

( tokenID, eventID, source )

GET /api/?action=event.email.tryHTTP/1.1 Host: inevent.us

Sends a test email from source source to event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

sourceGET : email source

event.email.dispatch

( tokenID, eventEmailID )

POST /api/?action=event.email.dispatchHTTP/1.1 Host: inevent.us

Sends an email eventEmailID to everyone in the event or list. Allowed only for custom emails.

tokenIDGET : token identifier

eventEmailIDPOST : email identifier at event

Emails blacklist

Blacklists are useful to ensure that people that decide to not receive any communication will have their right complied regarding all applicable legislations and privacy acts.

Models

{
    "count": 1,
    "data": [
        {
            "eventBlacklistID": "28962",
            "eventID": "6173",
            "email": "",
            "date": "1516294405"
        }
    ]
}

Methods

event.blacklist.remove

( tokenID, eventBlacklistID )

GET /api/?action=event.blacklist.removeHTTP/1.1 Host: inevent.us

Removes email eventBlacklistID.

tokenIDGET : token identifier

eventBlacklistIDGET : event email identifier

event.blacklist.find

( tokenID, eventID, *query )

GET /api/?action=event.blacklist.findHTTP/1.1 Host: inevent.us

Returns all unsubscribed emails from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

*queryGET : search text

Emails sanity

The emails sanity is verified taking use of AI and another attributes to ensure your email delivery and avoid SPAM.

Models

{
    "count": 1,
    "data": [
        {
            "eventSanityID": "28962",
            "eventID": "6173",
            "email": "",
            "clean": "1",
            "reason": "",
            "date": "1516294405"
        }
    ]
}

Methods

event.sanity.operate

( tokenID, eventSanityID, key, value )

POST /api/?action=event.sanity.operateHTTP/1.1 Host: inevent.us

Edits value value from field key from email email.

tokenIDGET : token identifier

eventSanityIDGET : event email identifier

keyGET : field name

{
    "clean": "email risk"
}

valuePOST : field value

{
    "clean": "bit"
}

event.sanity.find

( tokenID, eventID, selection, *query )

GET /api/?action=event.sanity.findHTTP/1.1 Host: inevent.us

Returns all emails from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : search selection

{
    "all": "all emails",
    "safe-emails": "emails good for delivery",
    "spam-emails": "emails not allowed"
}

*queryGET : search text

Event senders

Customize the email address signature for each specific person communications.

Models

{
    "count": 1,
    "data": [
        {
            "senderID": "1",
            "eventID": "1",
            "personID": "1",
            "senderName": "John",
            "senderEmail": "john@inevent.us",
            "senderDNS": "-1",
            "name": "Robert",
            "username": "robert@inevent.us"
        }
    ]
}

Methods

event.sender.edit

( tokenID, eventID, key, value, personID )

POST /api/?action=event.sender.editHTTP/1.1 Host: inevent.us

Edits value value from field key for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : element name

valuePOST : element value

personIDGET : person identifier

event.sender.find

( tokenID, eventID, selection, *query )

GET /api/?action=event.sender.findHTTP/1.1 Host: inevent.us

Returns signatures at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : event signatures

{
    "all": "all signatures"
}

*queryGET : search text

event.sender.get

( tokenID, eventID, personID )

GET /api/?action=event.sender.getHTTP/1.1 Host: inevent.us

Returns signature for personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

event.sender.refresh

( tokenID, eventID, personID )

GET /api/?action=event.sender.refreshHTTP/1.1 Host: inevent.us

Refreshes signature for personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

Event guests

Small corporate events may allow registrants to include guests in their registration, such as spouse, children, business partners, etc.

Models

{
    "count": 1,
    "data": [
        {
            "eventGuestID": "1",
            "personID": "1330",
            "hostID": "449",
            "name": "Mauricio Giordano",
            "email": "giordano@inevent.us",
            "date": "1234121151"
        }
    ]
}

Methods

event.guest.bind

( tokenID, eventID, hostID, name, *email )

POST /api/?action=event.guest.bindHTTP/1.1 Host: inevent.us

Creates an guest at event eventID for host hostID

tokenIDGET : token identifier

eventIDGET : event identifier

hostIDGET : host identifier

namePOST : guest name

*emailPOST : guest email

( tokenID, eventID, name, *email )

POST /api/?action=event.guest.bindHTTP/1.1 Host: inevent.us

Creates an guest at event eventID for host tokenID

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : guest name

*emailPOST : guest email

event.guest.operate

( tokenID, eventID, personID, *hostID, content )

POST /api/?action=event.guest.operateHTTP/1.1 Host: inevent.us

Edits values content for guest personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : guest identifier

*hostIDGET : host identifier

contentPOST : key values for editing

event.guest.dismiss

( tokenID, eventID, personID, *hostID )

GET /api/?action=event.guest.dismissHTTP/1.1 Host: inevent.us

Removes a guest personID from event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : guest identifier

*hostIDGET : host identifier

event.guest.find

( tokenID, eventID, *paginated, *query )

GET /api/?action=event.guest.findHTTP/1.1 Host: inevent.us

Finds all guests at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

*paginatedGET : request to be paginated

*queryGET : search field

event.guest.get

( tokenID, eventID, personID, *hostID )

GET /api/?action=event.guest.getHTTP/1.1 Host: inevent.us

Gathers a guest personID at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : guest identifier

*hostIDGET : host identifier

Event hotsite

Event hotsite setup. Allows the definition of which sections will be active and its order on the hotsite.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "section": "speakers",
            "position": "2",
            "name": "Some name",
            "text": "Some text or link"
        }
    ]
}

Methods

event.hotsite.create

( eventID, section, position, *name, *text )

POST /api/?action=event.hotsite.createHTTP/1.1 Host: inevent.us

Adds section section on hotsite at event eventID.

eventIDGET : event identifier

sectionGET : section name

positionPOST : order among the sections

*namePOST : section name

*textPOST : section text

event.hotsite.edit

( eventID, section, position, text )

POST /api/?action=event.hotsite.editHTTP/1.1 Host: inevent.us

Changes order of section section on hotsite at event eventID.

eventIDGET : event identifier

sectionGET : section name

positionPOST : order among the sections

textPOST : section text

event.hotsite.remove

( eventID, section )

GET /api/?action=event.hotsite.removeHTTP/1.1 Host: inevent.us

Removes section section from event eventID hotsite.

eventIDGET : event identifier

sectionGET : section name

event.hotsite.find

( eventID )

GET /api/?action=event.hotsite.findHTTP/1.1 Host: inevent.us

Returns all sections linked to event eventID hotsite.

eventIDGET : event identifier

event.hotsite.get

( eventID, section )

GET /api/?action=event.hotsite.getHTTP/1.1 Host: inevent.us

Returns section section linked to event eventID hotsite.

eventIDGET : event identifier

sectionGET : section name

event.hotsite.getConfig

( eventID )

GET /api/?action=event.hotsite.getConfigHTTP/1.1 Host: inevent.us

Returns current configurations from event eventID hotsite.

eventIDGET : event identifier

event.hotsite.setConfig

( eventID, key, value )

POST /api/?action=event.hotsite.setConfigHTTP/1.1 Host: inevent.us

Configures hotsite elements from event eventID.

eventIDGET : event identifier

keyGET : field name

{
    "template": "template name",
    "saveTheDate": "activates Save the Date",
    "registrationLink": "registration link",
    "sponsorCategory": "activates sponsor divided by categories",
    "countdown": "activates countdown",
    "newsletterListId": "newsletter list identifier",
    "googleAnalytics": "google analytics code",
    "backgroundColor": "background color",
    "navigationBarBackgroundColor": "bar color",
    "mainColor": "main color",
    "registration": "activates registration link"
}

valuePOST : field value

{
    "template": "string",
    "saveTheDate": "boolean",
    "registrationLink": "string",
    "sponsorCategory": "boolean",
    "countdown": "boolean",
    "newsletterListId": "integer",
    "googleAnalytics": "string",
    "backgroundColor": "string",
    "navigationBarBackgroundColor": "string",
    "mainColor": "string",
    "registration": "boolean"
}

Event invites

For each event, we can invite people to register through our standard registration form.

Models

{
    "count": 1,
    "data": [
        {
            "inviteID": "1",
            "eventID": "1",
            "personID": "1",
            "inviteName": "Robert",
            "inviteEmail": "robert@inevent.us",
            "inviteRole": "CFO",
            "inviteCompany": "InEvent",
            "inviteTelephone": "",
            "used": "0",
            "rsvp": "-1",
            "name": "",
            "username": "robert@inevent.us",
            "assistantEmail": "john@inevent.us",
            "date": ""
        }
    ]
}

Methods

event.invite.create

( tokenID, eventID, email )

POST /api/?action=event.invite.createHTTP/1.1 Host: inevent.us

Creates an invite at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

emailPOST : invite email

( tokenID, eventID, path )

POST /api/?action=event.invite.createHTTP/1.1 Host: inevent.us

Creates multiple invites at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

event.invite.edit

( tokenID, eventID, key, value, personID )

POST /api/?action=event.invite.editHTTP/1.1 Host: inevent.us

Edits value value from field key for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : element name

valuePOST : desired action

personIDGET : person identifier

event.invite.remove

( tokenID, eventID, personID )

GET /api/?action=event.invite.removeHTTP/1.1 Host: inevent.us

Removes person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

event.invite.find

( tokenID, eventID, selection, *query )

GET /api/?action=event.invite.findHTTP/1.1 Host: inevent.us

Returns invites at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : event invites

{
    "all": "all invites",
    "fresh": "new invites",
    "used": "used invites"
}

*queryGET : search text

event.invite.get

( eventID, email )

GET /api/?action=event.invite.getHTTP/1.1 Host: inevent.us

Returns details of invite email at event eventID.

eventIDGET : event identifier

emailGET : invite email

event.invite.rsvp

( eventID, email )

GET /api/?action=event.invite.rsvpHTTP/1.1 Host: inevent.us

Updates rsvp for invite email at event eventID.

eventIDGET : event identifier

emailGET : invite email

event.invite.available

( eventID, email )

GET /api/?action=event.invite.availableHTTP/1.1 Host: inevent.us

Verifies if invite email is available for event eventID.

eventIDGET : event identifier

emailGET : invite email

Emails notification

Notifications are triggers sent to the event organizers when determined actions occur on the platform.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "eventID": "6173",
            "memberID": "1",
            "applicantAdded": "0",
            "attendeeAdded": "1",
            "eventAlmostFull": "1",
            "eventCapacity": "1"
        }
    ]
}

Methods

event.notification.operate

( tokenID, eventID, key, value, personID )

POST /api/?action=event.notification.operateHTTP/1.1 Host: inevent.us

Edits value value from field key for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : field name

valuePOST : field value

personIDGET : person identifier

event.notification.get

( tokenID, eventID, personID )

GET /api/?action=event.notification.getHTTP/1.1 Host: inevent.us

Returns notifications of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

Event attendees

For each event we can inform which people and activities are taking place inside of it. Add new people or seeing their activities, when with correct access permission, is simple.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "headline": "CEO @ InEvent",
            "image": "https:\/\/",
            "telephone": "+1 (999) 999 9999",
            "city": "New York",
            "facebookID": "0",
            "linkedInID": "0",
            "enrollmentID": "359",
            "approved": "1",
            "level": "1",
            "paid": "0",
            "present": "0",
            "private": "0"
        }
    ]
}
{
    "approved": {
        "-1": "not registered",
        "0": "registered and not approved",
        "1": "registered and approved"
    }
}
{
    "level": {
        "1": "LEVEL_USER",
        "4": "LEVEL_ADMIN"
    }
}

Methods

event.person.bind

( tokenID, eventID, name, username, *password, *role, *company, *accessCode )

POST /api/?action=event.person.bindHTTP/1.1 Host: inevent.us

Requests person with name name and user username to join event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : person name

usernamePOST : person username

*passwordPOST : person password

*rolePOST : person role

*companyPOST : person company

*accessCodePOST : event access code

( eventID, invite, email, *name, *password, *role, *company, *rsvp )

POST /api/?action=event.person.bindHTTP/1.1 Host: inevent.us

Requests person with invite invite to join event eventID.

eventIDGET : event identifier

invitePOST : access invite

emailPOST : person email

*namePOST : person name

*passwordPOST : person password

*rolePOST : person role

*companyPOST : person company

*rsvpPOST : person rsvp

( tokenID, eventID, path )

POST /api/?action=event.person.bindHTTP/1.1 Host: inevent.us

Requests multiple people to join event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

( tokenID, eventID, *accessCode )

POST /api/?action=event.person.bindHTTP/1.1 Host: inevent.us

Requests person tokenID to join event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

*accessCodePOST : event access code

event.person.operate

( tokenID, eventID, key, value, personID )

POST /api/?action=event.person.operateHTTP/1.1 Host: inevent.us

Edits value value from field key for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : element name

{
    "private": "perfil invisible",
    "rsvp": "person rsvp",
    "present": "attendance on event",
    "level": "admin privilege",
    "meetingQuotaID": "meeting quota",
    "meetingAutoConfirm": "confirm meeting automatically"
}

valuePOST : desired action

{
    "private": "bit",
    "rsvp": "bit",
    "present": "bit",
    "level": "1: user | 4: admin | 9: collector",
    "meetingQuotaID": "integer(11)",
    "meetingAutoConfirm": "bit"
}

personIDGET : person identifier

( tokenID, eventID, key, value )

POST /api/?action=event.person.operateHTTP/1.1 Host: inevent.us

Edits value value from field key for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : element name

{
    "private": "invisible profile",
    "rsvp": "person rsvp",
    "present": "attendance on event"
}

valuePOST : desired action

{
    "private": "bit",
    "rsvp": "bit",
    "present": "bit"
}

( tokenID, eventID, content, *personID )

POST /api/?action=event.person.operateHTTP/1.1 Host: inevent.us

Edits values content for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

contentPOST : key values for editing

*personIDGET : person identifier

event.person.dismiss

( tokenID, eventID, personID )

GET /api/?action=event.person.dismissHTTP/1.1 Host: inevent.us

Requests removal of person personID from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID, content )

GET /api/?action=event.person.dismissHTTP/1.1 Host: inevent.us

Requests removal of people content from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

contentGET : json formatted as [{personID}]

( tokenID, eventID )

GET /api/?action=event.person.dismissHTTP/1.1 Host: inevent.us

Requests removal of person tokenID from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

event.person.find

( tokenID, eventID, selection, *order, *query, *match, *fullProfile )

GET /api/?action=event.person.findHTTP/1.1 Host: inevent.us

Returns everyone at event eventID, filtered by a selection selection and order order.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : people at event

{
    "all": "all events",
    "admin": "admins",
    "approved": "registration approved",
    "denied": "registration rejected",
    "downloaded": "application downloaded",
    "not-downloaded": "application not downloaded",
    "printed": "badges printed",
    "not-printed": "badges not printed",
    "safe-emails": "emails validated as safe",
    "spam-emails": "SPAM risk emails"
}

*orderGET : order based on column

*queryGET : search text

*matchGET : exact match

*fullProfileGET : full profile for each person -- this will cap your results to 20.

event.person.get

( tokenID, feedbackID, value )

GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us

Returns details of person with value value on field feedbackID.

tokenIDGET : token identifier

feedbackIDGET : field identifier

valueGET : field value

( tokenID, eventID, email )

GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us

Returns details of person email at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

emailGET : person email

( tokenID, eventID, personID )

GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us

Returns details of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID, qrCode )

GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us

Retuens details of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

qrCodeGET : person qrCode

( tokenID, eventID, nfc )

GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us

Returns details of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

nfcGET : person nfc wristband

( tokenID, eventID )

GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us

Returns details of person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

event.person.remember

( tokenID, eventID )

GET /api/?action=event.person.rememberHTTP/1.1 Host: inevent.us

Sends email reminder for event eventID participants.

tokenIDGET : token identifier

eventIDGET : event identifier

event.person.rsvp

( tokenID, eventID )

GET /api/?action=event.person.rsvpHTTP/1.1 Host: inevent.us

Notifies all people who didn't reply their rsvp at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

event.person.qrCode

( tokenID, eventID, *query, *match )

GET /api/?action=event.person.qrCodeHTTP/1.1 Host: inevent.us

Generates all QR Codes for people at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

*queryGET : search text

*matchGET : exact match

( tokenID, eventID, personID )

GET /api/?action=event.person.qrCodeHTTP/1.1 Host: inevent.us

Generates all QR Codes of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

event.person.print

( tokenID, eventID, personID )

GET /api/?action=event.person.printHTTP/1.1 Host: inevent.us

Informs that person personID QR code was printed at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

event.person.printed

( tokenID, eventID )

GET /api/?action=event.person.printedHTTP/1.1 Host: inevent.us

Returns badges printed beyond cap at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

event.person.voucher

( tokenID, eventID )

GET /api/?action=event.person.voucherHTTP/1.1 Host: inevent.us

Obtains voucher information for person at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

Event pipelines

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "headline": "CEO @ InEvent",
            "image": "https:\/\/",
            "telephone": "+1 (999) 999 9999",
            "city": "San Francisco",
            "facebookID": "0",
            "linkedInID": "0",
            "enrollmentID": "359",
            "approved": "1",
            "level": "1",
            "paid": "0",
            "present": "0",
            "private": "0"
        }
    ]
}

Methods

event.pipeline.find

( tokenID, eventID )

GET /api/?action=event.pipeline.findHTTP/1.1 Host: inevent.us

Obtains a pipeline for event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

Printer on event

Some events use printers to print participants badges.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "type": "qr",
            "title": "name",
            "subtitle": "headline"
        }
    ]
}

Methods

event.printer.edit

( tokenID, eventID, key, value )

POST /api/?action=event.printer.editHTTP/1.1 Host: inevent.us

Changes a field key with value value for printing at event eventID.

tokenIDGET : authentication token

eventIDGET : event identifier

keyGET : key to be changed

{
    "type": "print type",
    "title": "primary text",
    "subtitle": "secundary text"
}

valuePOST : key value

{
    "type": "0111-6111",
    "title": "name|role|company|headline",
    "subtitle": "name|role|company|headline"
}

event.printer.get

( tokenID, eventID )

GET /api/?action=event.printer.getHTTP/1.1 Host: inevent.us

Gets printing configuration for event eventID.

tokenIDGET : authentication token

eventIDGET : event identifier

Event tabs

Particular applications need its tabs to contain different names / representations.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "eventID": "1",
            "tab": "event",
            "textPT": "Evento",
            "textEN": "Event",
            "textES": "Evento"
        }
    ]
}

Methods

event.tab.create

( tokenID, eventID, title, link )

POST /api/?action=event.tab.createHTTP/1.1 Host: inevent.us

Creates title title with link link at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

titlePOST : tab title

linkPOST : tab link

event.tab.edit

( tokenID, eventID, tab, language, value )

POST /api/?action=event.tab.editHTTP/1.1 Host: inevent.us

Edits value value from tab tab for language language at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

tabGET : tab name

{
    "event": "",
    "feed": "",
    "schedule": "",
    "networking": "",
    "notification": "",
    "more": "",
    "speaker": "",
    "photo": "",
    "sponsor": "",
    "material": ""
}

languageGET : language to be edited

valuePOST : tab text

event.tab.remove

( tokenID, eventTabID )

GET /api/?action=event.tab.removeHTTP/1.1 Host: inevent.us

Removes tab eventTabID.

tokenIDGET : token identifier

eventTabIDGET : tab identifier

event.tab.get

( eventID )

GET /api/?action=event.tab.getHTTP/1.1 Host: inevent.us

Returns all tabs from event eventID.

eventIDGET : event identifier

Event tags

Tags associated with events, creating possibilities to determine interests from the event participants.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

event.tag.bind

( tokenID, eventID, tagID )

GET /api/?action=event.tag.bindHTTP/1.1 Host: inevent.us

Links tag tagID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

tagIDGET : tag identifier

event.tag.dismiss

( tokenID, eventID, tagID )

GET /api/?action=event.tag.dismissHTTP/1.1 Host: inevent.us

Unlinks tag tagID from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

tagIDGET : tag identifier

event.tag.find

( tokenID, eventID )

GET /api/?action=event.tag.findHTTP/1.1 Host: inevent.us

Returns all event eventID tags.

tokenIDGET : token identifier

eventIDGET : event identifier

( eventID )

GET /api/?action=event.tag.findHTTP/1.1 Host: inevent.us

Returns all event eventID tags.

eventIDGET : event identifier

Event themes

Themes are essential on finding an event. They help to define the event's flavor, creating its own identity and categories.

Methods

event.theme.operate

( tokenID, eventID, operation, key, value )

POST /api/?action=event.theme.operateHTTP/1.1 Host: inevent.us

Sends operation operation to value value on field key at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

operationGET : desired action

{
    "add": "add new themes to event",
    "remove": "remove themes from event"
}

keyGET : element type

{
    "theme": "theme name",
    "themeID": "theme identifier"
}

valuePOST : field value

{
    "theme": "string",
    "themeID": "integer"
}

Event tools

Each event contains exclusive tools which can be controlled by its admins.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "eventID": "1",
            "presence": "0"
        }
    ]
}

Methods

event.tool.edit

( tokenID, eventID, key, value )

POST /api/?action=event.tool.editHTTP/1.1 Host: inevent.us

Edits value value from field key at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : element name

valuePOST : element value

event.tool.get

( eventID )

GET /api/?action=event.tool.getHTTP/1.1 Host: inevent.us

Returns all tools available at event eventID.

eventIDGET : event identifier

Eventbrite

Module destinated to integration between InEvent events and Eventbrite events.

Methods

eventbrite.get

( tokenID, eventID )

GET /api/?action=eventbrite.getHTTP/1.1 Host: inevent.us

Obtains integration data from Eventbrite with event eventID.

tokenIDGET : admin token

eventIDGET : event identifier

eventbrite.linkField

( tokenID, eventID, feedbackID, ebFieldID )

POST /api/?action=eventbrite.linkFieldHTTP/1.1 Host: inevent.us

Links a field feedbackID from event eventID registration form with a Eventbrite field ebFieldID.

tokenIDGET : admin token

eventIDGET : event identifier

feedbackIDPOST : InEvent field identifier

ebFieldIDPOST : Eventbrite field identifier

Facebook

The content below refers to operations about the social network Facebook. The data obtained from it are not that useful as the ones from LinkedIn, but the possibility to use a higher volume contacts network is interesting to correlate some professional interests. The needed permissions to be requested are email, name and picture.

Methods

facebook.signIn

( facebookToken )

GET /api/?action=facebook.signInHTTP/1.1 Host: inevent.us

Starts a session from a person, based on token facebookToken.

facebookTokenGET : authentication token given by Facebook

Feed

A stream of posts that can be published by the organization or directly inside the app. Beyond that, it is possible for users to interact with published contents.

Models

{
    "count": 1,
    "data": [
        {
            "feedID": "4",
            "companyID": "1",
            "eventID": "1242",
            "memberID": "4242",
            "title": "Welcome to title",
            "text": "Great to have you!",
            "picture": "",
            "video": "",
            "actionTitle": "",
            "actionUrl": "",
            "externalTitle": "",
            "externalPicture": "",
            "externalUrl": "",
            "shares": "",
            "date": ""
        }
    ]
}

Push Notification

feed/comment

_feed

Notifies that person personID commented on your post or in any post that you interacted with.

{
    "eventID": "integer",
    "personID": "integer"
}

feed/like

_feed

Notifies that person personID liked your post.

{
    "eventID": "integer",
    "personID": "integer"
}

Methods

feed.create

( tokenID, eventID, text, *picture, *video, *externalUrl )

POST /api/?action=feed.createHTTP/1.1 Host: inevent.us

Creates a post with contents text at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

textPOST : post contents

*picturePOST : picture url

*videoPOST : video url

*externalUrlPOST : url for an external resource

feed.edit

( tokenID, feedID, key, value )

POST /api/?action=feed.editHTTP/1.1 Host: inevent.us

Edits a field of post feedID.

tokenIDGET : token identifier

feedIDGET : post identifier

keyGET : field name

valuePOST : field value

feed.remove

( tokenID, feedID )

GET /api/?action=feed.removeHTTP/1.1 Host: inevent.us

Removes post feedID.

tokenIDGET : token identifier

feedIDGET : post identifier

feed.find

( tokenID, eventID, selection, *query )

GET /api/?action=feed.findHTTP/1.1 Host: inevent.us

Returns all posts for event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : selection scope

{
    "all": "all posts",
    "approved+me": "approved posts and your posts"
}

*queryGET : query text

( eventID, *query )

GET /api/?action=feed.findHTTP/1.1 Host: inevent.us

Returns all public posts for event eventID.

eventIDGET : event identifier

*queryGET : query text

feed.get

( tokenID, feedID )

GET /api/?action=feed.getHTTP/1.1 Host: inevent.us

Returns post feedID.

tokenIDGET : token identifier

feedIDGET : post identifier

feed.share

( tokenID, feedID )

GET /api/?action=feed.shareHTTP/1.1 Host: inevent.us

Shares post feedID.

tokenIDGET : token identifier

feedIDGET : post identifier

feed.like

( tokenID, feedID )

GET /api/?action=feed.likeHTTP/1.1 Host: inevent.us

Likes post feedID.

tokenIDGET : token identifier

feedIDGET : post identifier

feed.unlike

( tokenID, feedID )

GET /api/?action=feed.unlikeHTTP/1.1 Host: inevent.us

Unlikes post feedID.

tokenIDGET : token identifier

feedIDGET : post identifier

feed.report

( tokenID, feedID )

GET /api/?action=feed.reportHTTP/1.1 Host: inevent.us

Reports post feedID as inappropriate.

tokenIDGET : token identifier

feedIDGET : post identifier

feed.preview

( tokenID, eventID, url )

GET /api/?action=feed.previewHTTP/1.1 Host: inevent.us

Generates a preview for link url at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

urlGET : preview link

Post comments

In each feed post there is the possibility to comment on it.

Models

{
    "count": 1,
    "data": [
        {
            "feedCommentID": "3",
            "feedID": "5",
            "memberID": "1",
            "text": "Hello World",
            "date": "666111666"
        }
    ]
}

Methods

feed.comment.create

( tokenID, feedID, text )

POST /api/?action=feed.comment.createHTTP/1.1 Host: inevent.us

Creates a new comment with contents text at post feedID.

tokenIDGET : token identifier

feedIDGET : feed identifier

textPOST : comment text

feed.comment.edit

( tokenID, feedCommentID, key, value )

POST /api/?action=feed.comment.editHTTP/1.1 Host: inevent.us

Edits value value from field key of comment feedCommentID.

tokenIDGET : token identifier

feedCommentIDGET : comment identifier

keyGET : field name

valuePOST : field value

feed.comment.remove

( tokenID, feedCommentID )

GET /api/?action=feed.comment.removeHTTP/1.1 Host: inevent.us

Removes comment feedCommentID.

tokenIDGET : token identifier

feedCommentIDGET : comment identifier

feed.comment.find

( tokenID, feedID )

GET /api/?action=feed.comment.findHTTP/1.1 Host: inevent.us

Gathers all post feedID comments

tokenIDGET : token identifier

feedIDGET : feed identifier

feed.comment.report

( tokenID, feedCommentID )

GET /api/?action=feed.comment.reportHTTP/1.1 Host: inevent.us

Reports a comment feedCommentID as inappropriate.

tokenIDGET : token identifier

feedCommentIDGET : comment identifier

Feedback

Feedbacks are questionnaires with several questions to evaluate something. For each feedback, it is possible to retrieve different kinds of data. This API is used for custom fields and forms as well.

Models

{
    "count": 1,
    "data": [
        {
            "feedbackID": "5",
            "eventID": "3",
            "activityID": "3",
            "textPT": "Pergunta",
            "textEN": "Question",
            "textES": "Pregunta",
            "type": "text",
            "value": "0",
            "preQualify": "0",
            "required": "0",
            "members": [
                {
                    "personID": "5",
                    "personName": "Pedro Góes",
                    "value": "1"
                }
            ]
        }
    ]
}

Push Notification

feedback/event.create

_event

Notifies creation of new feedback questionnaire for event eventID.

{
    "eventID": "integer"
}

feedback/activity.create

_activity

Notifies creation of new feedback questionnaire for activity activityID.

{
    "activityID": "integer"
}

Methods

feedback.create

( tokenID, eventID, text, type, *preQualify )

POST /api/?action=feedback.createHTTP/1.1 Host: inevent.us

Creates a new feedback at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

textPOST : feedback text

typePOST : feedback type

{
    "type": "string(bool|integer|text|multiple|select)"
}

*preQualifyPOST : pre-qualify

( tokenID, activityID, text, type )

POST /api/?action=feedback.createHTTP/1.1 Host: inevent.us

Creates a new feedback at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

textPOST : feedback text

typePOST : feedback type

{
    "type": "string(bool|integer|text|multiple|select)"
}

( tokenID, meetingID, text, type )

POST /api/?action=feedback.createHTTP/1.1 Host: inevent.us

Creates a new feedback at meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

textPOST : feedback text

typePOST : feedback type

{
    "type": "string(bool|integer|text|multiple|select)"
}

( tokenID, formID, text, type )

POST /api/?action=feedback.createHTTP/1.1 Host: inevent.us

Creates a new feedback at form formID.

tokenIDGET : token identifier

formIDGET : form identifier

textPOST : feedback text

typePOST : feedback type

{
    "type": "string(bool|integer|text|multiple|select)"
}

feedback.edit

( tokenID, feedbackID, key, value )

POST /api/?action=feedback.editHTTP/1.1 Host: inevent.us

Edits value value from field key of feedback feedbackID.

tokenIDGET : token identifier

feedbackIDGET : feedback identifier

keyGET : field name

{
    "textPT": "texto em português",
    "textEN": "english text",
    "textES": "texto en español",
    "type": "type",
    "preQualify": "initial flow",
    "required": "is it required"
}

valuePOST : field value

{
    "textPT": "string",
    "textEN": "string",
    "textES": "string",
    "type": "string(bool|integer|text|multiple|select)",
    "preQualify": "bit",
    "required": "bit"
}

feedback.remove

( tokenID, feedbackID )

GET /api/?action=feedback.removeHTTP/1.1 Host: inevent.us

Removes feedback feedbackID.

tokenIDGET : token identifier

feedbackIDGET : feedback identifier

feedback.find

( tokenID, eventID, selection )

GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us

Gathers all feedbacks posted at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : feedbacks scope

{
    "preQualify": "pre-qualify feedback",
    "event": "event feedbacks",
    "event+activities": "event feedbacks and activity's",
    "event+preQualify": "event feedbacks and pre-qualify's"
}

( tokenID, activityID )

GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us

Gathers all feedbacks posted at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

( tokenID, meetingID )

GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us

Gathers all feedbacks posted at meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

( tokenID, formID )

GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us

Gathers all feedbacks posted at form formID.

tokenIDGET : token identifier

formIDGET : form identifier

feedback.get

( tokenID, feedbackID )

GET /api/?action=feedback.getHTTP/1.1 Host: inevent.us

Gathers feedback feedbackID.

tokenIDGET : token identifier

feedbackIDGET : feedback identifier

feedback.pushNotification

( tokenID, activityID )

GET /api/?action=feedback.pushNotificationHTTP/1.1 Host: inevent.us

Sends a notification for all attendees of activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

( tokenID, eventID )

GET /api/?action=feedback.pushNotificationHTTP/1.1 Host: inevent.us

Sends a notification for all attendees of event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

feedback.respond

( tokenID, eventID, content )

POST /api/?action=feedback.respondHTTP/1.1 Host: inevent.us

Answers single or several feedbacks at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

contentPOST : JSON content

[
    {
        "feedbackID": "integer",
        "value": "string or array (if feedback.type = 'multiple')"
    }
]

Feedback options

Some feedbacks requires a specific set of answers like a select box or a multiple choice element.

Models

{
    "count": 1,
    "data": [
        {
            "feedbackOptionID": "3",
            "feedbackID": "5",
            "textPT": "Biscoito",
            "textEN": "Biscuit",
            "textES": "Galletas"
        },
        {
            "feedbackOptionID": "4",
            "feedbackID": "5",
            "textPT": "Bolacha",
            "textEN": "Cracker",
            "textES": "Bolacha"
        }
    ]
}

Methods

feedback.option.create

( tokenID, feedbackID, textPT, *textEN, *textES )

POST /api/?action=feedback.option.createHTTP/1.1 Host: inevent.us

Creates a new option at feedback feedbackID.

tokenIDGET : token identifier

feedbackIDGET : feedback identifier

textPTPOST : feedback text

*textENPOST : feedback text

*textESPOST : feedback text

feedback.option.edit

( tokenID, feedbackOptionID, key, value )

POST /api/?action=feedback.option.editHTTP/1.1 Host: inevent.us

Edits value value from field key of feedback option feedbackOptionID.

tokenIDGET : token identifier

feedbackOptionIDGET : feedback option identifier

keyGET : field name

{
    "textPT": "answer in portuguese",
    "textEN": "answer in english",
    "textES": "answer in spanish"
}

valuePOST : field value

{
    "textPT": "string",
    "textEN": "string",
    "textES": "string"
}

feedback.option.remove

( tokenID, feedbackOptionID )

GET /api/?action=feedback.option.removeHTTP/1.1 Host: inevent.us

Removes feedback option feedbackOptionID.

tokenIDGET : token identifier

feedbackOptionIDGET : feedback option identifier

feedback.option.find

( tokenID, feedbackID )

GET /api/?action=feedback.option.findHTTP/1.1 Host: inevent.us

Gathers all options for feedback feedbackID.

tokenIDGET : token identifier

feedbackIDGET : feedback identifier

feedback.option.get

( tokenID, feedbackOptionID )

GET /api/?action=feedback.option.getHTTP/1.1 Host: inevent.us

Gathers feedback option feedbackOptionID.

tokenIDGET : token identifier

feedbackOptionIDGET : feedback option identifier

feedback.option.clear

( tokenID, feedbackID )

GET /api/?action=feedback.option.clearHTTP/1.1 Host: inevent.us

Removes all feedback feedbackID options.

tokenIDGET : token identifier

feedbackIDGET : feedback identifier

Feedback submissions

List of submissions for a group of feedbacks.

Models

{
    "count": 1,
    "data": [
        {
            "feedbackSubmissionID": "3",
            "personID": "5",
            "status": "submitted",
            "answers": [],
            "data": "1212512"
        }
    ]
}

Methods

feedback.submission.find

( tokenID, eventID, *selection, *paginated )

GET /api/?action=feedback.submission.findHTTP/1.1 Host: inevent.us

Gathers all feedback submissions for event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

*selectionGET : selection identifier

*paginatedGET : should be paginated

( tokenID, formID, *paginated )

GET /api/?action=feedback.submission.findHTTP/1.1 Host: inevent.us

Gathers all feedback submissions for form formID.

tokenIDGET : token identifier

formIDGET : form identifier

*paginatedGET : should be paginated

feedback.submission.get

( tokenID, feedbackSubmissionID )

GET /api/?action=feedback.submission.getHTTP/1.1 Host: inevent.us

Gathers a feedback submission feedbackSubmissionID.

tokenIDGET : token identifier

feedbackSubmissionIDGET : feedback submission identifier

File

Cloud storage of files, in a secure and reliable environment. Every file created has its on public shuffled url. Files must be sent using content-type of application/octet-stream

Methods

file.create

( tokenID, companyID, name, file, width, height )

POST /api/?action=file.createHTTP/1.1 Host: inevent.us

Creates and process a file named name with size width by height at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

nameGET : file name

filePOST : binary file

widthGET : image width

heightGET : image height

( onboardingToken, name, width, height, file )

POST /api/?action=file.createHTTP/1.1 Host: inevent.us

Creates and process a file named name with size width by height.

onboardingTokenGET : token de onboarding

nameGET : file name

widthGET : image width

heightGET : image height

filePOST : binary file

file.crop

( tokenID, companyID, url, width, height, xpos, ypos )

GET /api/?action=file.cropHTTP/1.1 Host: inevent.us

Crops an image.

tokenIDGET : token identifier

companyIDGET : company identifier

urlGET : file name

widthGET : file width

heightGET : file height

xposGET : crop x pos

yposGET : crop y pos

Flight

Events may provide flights for their attendees and manage all of their costs.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "personID": "",
            "airline": "",
            "number": "",
            "gate": "",
            "airportBegin": "",
            "airportEnd": "",
            "dateBegin": "",
            "dateEnd": "",
            "price": "",
            "eTicket": "",
            "date": "1415152800"
        }
    ]
}

Methods

flight.create

( tokenID, eventID, personID, airline, number, gate, seat, ticketType, airportBegin, airportEnd, dateBegin, dateEnd, dateIssue, price, priceConversion, insurance, eTicket, confirmation )

POST /api/?action=flight.createHTTP/1.1 Host: inevent.us

Creates a flight entry at event eventID for person personID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

airlinePOST : airline company

numberPOST : flight number

gatePOST : flight gate

seatPOST : flight seat

ticketTypePOST : ticket type

airportBeginPOST : airport of departure

airportEndPOST : airport of arrival

dateBeginPOST : date and time of departure

dateEndPOST : date and time of arrival

dateIssuePOST : ticket issue date

pricePOST : flight price

priceConversionPOST : price conversion

insurancePOST : insurance agency

eTicketPOST : electronic ticket

confirmationPOST : confirmation code

( tokenID, eventID, email, airline, number, gate, ticketType, airportBegin, airportEnd, dateBegin, dateEnd, dateIssue, price, priceConversion, insurance, eTicket, confirmation )

POST /api/?action=flight.createHTTP/1.1 Host: inevent.us

Creates a flight entry at event eventID for person email.

tokenIDGET : token identifier

eventIDGET : event identifier

emailPOST : email da pessoa

airlinePOST : airline company

numberPOST : flight number

gatePOST : flight gate

ticketTypePOST : ticket type

airportBeginPOST : airport of departure

airportEndPOST : airport of arrival

dateBeginPOST : date and time of departure

dateEndPOST : date and time of arrival

dateIssuePOST : ticket issue date

pricePOST : flight price

priceConversionPOST : price conversion

insurancePOST : insurance agency

eTicketPOST : electronic ticket

confirmationPOST : confirmation code

( tokenID, eventID, path )

POST /api/?action=flight.createHTTP/1.1 Host: inevent.us

Creates multiple flights at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

flight.edit

( tokenID, flightID, key, value )

POST /api/?action=flight.editHTTP/1.1 Host: inevent.us

Edits value value from field key of flight flightID.

tokenIDGET : token identifier

flightIDGET : flight identifier

keyGET : field name

{
    "personID": "person identifier",
    "airline": "data",
    "number": "data",
    "gate": "data",
    "seat": "data",
    "ticketType": "data",
    "airportBegin": "data",
    "airportEnd": "data",
    "dateBegin": "data",
    "dateEnd": "data",
    "dateIssue": "data",
    "price": "data",
    "priceConversion": "data",
    "insurance": "data",
    "eTicket": "data",
    "confirmation": "data"
}

valuePOST : field value

{
    "personID": "person identifier",
    "airline": "data",
    "number": "data",
    "gate": "data",
    "seat": "data",
    "ticketType": "data",
    "airportBegin": "data",
    "airportEnd": "data",
    "dateBegin": "data",
    "dateEnd": "data",
    "dateIssue": "data",
    "price": "data",
    "priceConversion": "data",
    "insurance": "data",
    "eTicket": "data",
    "confirmation": "data"
}

flight.remove

( tokenID, flightID )

GET /api/?action=flight.removeHTTP/1.1 Host: inevent.us

Removes flight flightID from event.

tokenIDGET : token identifier

flightIDGET : flight identifier

flight.find

( tokenID, eventID, personID )

GET /api/?action=flight.findHTTP/1.1 Host: inevent.us

Gathers all flights of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID, *selection, *query )

GET /api/?action=flight.findHTTP/1.1 Host: inevent.us

Gathers all flights from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

*selectionGET : specific selection

{
    "all": "all flights"
}

*queryGET : query text

flight.stats

( tokenID, eventID )

GET /api/?action=flight.statsHTTP/1.1 Host: inevent.us

Gathers all flight statistics at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Flow

For all interactions that occurs during the event, it is necessary to send notifications. For each object, it type allows developers to disguise their types. It is also sent a specific date for each object so developers can identify when they were created or updated.

Models

{
    "count": 1,
    "data": [
        {
            "type": {
                "activity": "current activity",
                "news": "important news",
                "question": "live questions",
                "feedback": "live feedbacks"
            },
            "timestamp": "object date"
        }
    ]
}

Methods

flow.find

( tokenID, eventID, selection )

GET /api/?action=flow.findHTTP/1.1 Host: inevent.us

Gathers interactions flow for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : feed type

{
    "internal": "all notifications"
}

Form

Forms are a great way to obtain information from attendees, new applicants, ticket sales, event briefings, supplier briefings, and a lot more.

Models

{
    "count": 1,
    "data": [
        {
            "formID": "5",
            "eventID": "3",
            "title": "Initial form",
            "description": "message flow",
            "date": "1241241512",
            "feedbacks": [
                {
                    "feedbackID": "5",
                    "eventID": "3",
                    "activityID": "3",
                    "textPT": "Pergunta",
                    "textEN": "Question",
                    "textES": "Pregunta",
                    "type": "text",
                    "value": "0",
                    "preQualify": "0",
                    "required": "0",
                    "members": [
                        {
                            "personID": "5",
                            "personName": "Pedro Góes",
                            "value": "1"
                        }
                    ]
                }
            ]
        }
    ]
}

Methods

form.create

( tokenID, companyID, title, type, *description )

POST /api/?action=form.createHTTP/1.1 Host: inevent.us

Creates a new form at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

titlePOST : form title

typePOST : type of form

{
    "event-request": "event requisition form",
    "custom": "custom generic form"
}

*descriptionPOST : form description

( tokenID, eventID, title, *description )

POST /api/?action=form.createHTTP/1.1 Host: inevent.us

Creates a new form at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

titlePOST : form title

*descriptionPOST : form description

form.edit

( tokenID, formID, key, value )

POST /api/?action=form.editHTTP/1.1 Host: inevent.us

Edits value value from field key of form formID.

tokenIDGET : token identifier

formIDGET : form identifier

keyGET : field name

{
    "title": "form title",
    "description": "form description"
}

valuePOST : field value

{
    "title": "string",
    "description": "string"
}

form.remove

( tokenID, formID )

GET /api/?action=form.removeHTTP/1.1 Host: inevent.us

Removes form formID.

tokenIDGET : token identifier

formIDGET : form identifier

form.find

( tokenID, companyID, selection )

GET /api/?action=form.findHTTP/1.1 Host: inevent.us

Gathers all forms created at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

selectionGET : filter

{
    "all": "all forms for company",
    "custom": "custom forms for company",
    "event-request": "event requisition forms for company"
}

( tokenID, eventID )

GET /api/?action=form.findHTTP/1.1 Host: inevent.us

Gathers all forms created at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

form.get

( tokenID, formID )

GET /api/?action=form.getHTTP/1.1 Host: inevent.us

Gathers form formID.

tokenIDGET : token identifier

formIDGET : form identifier

form.respondRegistration

( *tokenID, eventID, ticketPersonID, ticketToken, feedbackContent, *email, *username, *firstName, *lastName, *password, *role, *company, *guestContent )

POST /api/?action=form.respondRegistrationHTTP/1.1 Host: inevent.us

Responds form for event eventID registration with ticket invitation ticketToken.

*tokenIDGET : token identifier

eventIDGET : event identifier

ticketPersonIDGET : ticket identifier

ticketTokenPOST : ticket token identifier

feedbackContentPOST : feedback content field

*emailPOST : email field

*usernamePOST : username field

*firstNamePOST : first name field

*lastNamePOST : last name field

*passwordPOST : password field

*rolePOST : role field

*companyPOST : company field

*guestContentPOST : guest content field

( *tokenID, eventID, feedbackContent, *invite, *email, *username, *firstName, *lastName, *password, *role, *company, *rsvp, *guestContent )

POST /api/?action=form.respondRegistrationHTTP/1.1 Host: inevent.us

Responds form for event eventID registration.

*tokenIDGET : token identifier

eventIDGET : event identifier

feedbackContentPOST : feedback content field

*invitePOST : invite field

*emailPOST : email field

*usernamePOST : username field

*firstNamePOST : first name field

*lastNamePOST : last name field

*passwordPOST : password field

*rolePOST : role field

*companyPOST : company field

*rsvpPOST : event identifier

*guestContentPOST : guest content field

Form lists

Forms can be restricted to people part of a single or several lists.

Models

{
    "count": 1,
    "data": [
        {
            "formID": "330",
            "listID": "1"
        }
    ]
}

Methods

form.list.bind

( tokenID, listID, formID )

GET /api/?action=form.list.bindHTTP/1.1 Host: inevent.us

Requests list listID creation on form formID.

tokenIDGET : token identifier

listIDGET : list identifier

formIDGET : form identifier

form.list.dismiss

( tokenID, listID, formID )

GET /api/?action=form.list.dismissHTTP/1.1 Host: inevent.us

Removes list listID from form formID.

tokenIDGET : token identifier

listIDGET : list identifier

formIDGET : form identifier

form.list.find

( tokenID, formID )

GET /api/?action=form.list.findHTTP/1.1 Host: inevent.us

Returns all lists from form formID.

tokenIDGET : token identifier

formIDGET : form identifier

Gamification

Event organizers may make use of gamification systems to engage their attendees in their mobile app. It is a great way to give away prizes for most engaged attendees at event as well.

Models

{
    "count": 1,
    "data": [
        {
            "gamificationID": "2",
            "eventID": "6508",
            "name": "2nd mission",
            "description": "Send a chat message for someone at the event.",
            "points": "10",
            "date": "1488218414"
        }
    ]
}

Methods

gamification.create

( tokenID, eventID, name, description, points )

POST /api/?action=gamification.createHTTP/1.1 Host: inevent.us

Creates a mission at event eventID with name name, description description and points points.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : mission name

descriptionPOST : mission description

pointsPOST : mission points

gamification.edit

( tokenID, gamificationID, key, value )

POST /api/?action=gamification.editHTTP/1.1 Host: inevent.us

Edits value value from field key of mission gamificationID.

tokenIDGET : token identifier

gamificationIDGET : mission identifier

keyGET : field name

{
    "name": "name",
    "description": "description",
    "points": "points"
}

valuePOST : field value

{
    "name": "string",
    "description": "string",
    "points": "integer"
}

gamification.remove

( tokenID, gamificationID )

GET /api/?action=gamification.removeHTTP/1.1 Host: inevent.us

Removes mission gamificationID.

tokenIDGET : token identifier

gamificationIDGET : mission identifier

gamification.find

( tokenID, eventID )

GET /api/?action=gamification.findHTTP/1.1 Host: inevent.us

Gathers all missions at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

gamification.get

( tokenID, gamificationID )

GET /api/?action=gamification.getHTTP/1.1 Host: inevent.us

Gathers mission gamificationID.

tokenIDGET : token identifier

gamificationIDGET : mission identifier

gamification.leaderboard

( tokenID, eventID )

GET /api/?action=gamification.leaderboardHTTP/1.1 Host: inevent.us

Gathers leaderboard for all missions at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Person missions

For each mission at event, attendees can complete them to earn points.

Models

{
    "count": 1,
    "data": [
        {
            "beaconEventID": "1",
            "eventID": "1",
            "beaconID": "2",
            "type": "push",
            "range": "7900",
            "extra": "Hello World"
        }
    ]
}

Methods

gamification.person.bind

( tokenID, gamificationID )

GET /api/?action=gamification.person.bindHTTP/1.1 Host: inevent.us

Adds a mission gamificationID for person.

tokenIDGET : token identifier

gamificationIDGET : mission identifier

gamification.person.operate

( tokenID, gamificationID, key, value, personID )

POST /api/?action=gamification.person.operateHTTP/1.1 Host: inevent.us

Edits value value from field key of mission gamificationID for person personID.

tokenIDGET : token identifier

gamificationIDGET : mission identifier

keyGET : field name

{
    "confirmed": "confirms the mission"
}

valuePOST : field value

{
    "confirmed": "integer"
}

personIDGET : person identifier

gamification.person.dismiss

( tokenID, gamificationID )

GET /api/?action=gamification.person.dismissHTTP/1.1 Host: inevent.us

Removes mission gamificationID from person.

tokenIDGET : token identifier

gamificationIDGET : mission identifier

gamification.person.find

( tokenID, gamificationID, selection )

GET /api/?action=gamification.person.findHTTP/1.1 Host: inevent.us

Gathers all people that finished mission gamificationID.

tokenIDGET : token identifier

gamificationIDGET : mission identifier

selectionGET : selection of missions

{
    "all": "default option",
    "confirmed": "only confirmed people"
}

gamification.person.get

( tokenID, eventID, personID )

GET /api/?action=gamification.person.getHTTP/1.1 Host: inevent.us

Gathers all finished missions for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

Image library

While creating an event, it may be useful to upload all images necessary to fill your speakers and sponsors pages. This is a library that you can use any image in several resources from your event.

Models

{
    "count": 1,
    "data": [
        {
            "imageID": "1",
            "eventID": "1",
            "name": "picture-1.png",
            "url": "https:\/\/....\/images\/picture.png"
        }
    ]
}

Methods

image.create

( tokenID, eventID, name, url )

POST /api/?action=image.createHTTP/1.1 Host: inevent.us

Adds an image to event eventID library.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : image name

urlPOST : image url

image.edit

( tokenID, imageID, key, value )

POST /api/?action=image.editHTTP/1.1 Host: inevent.us

Edits value value from field key of image imageID.

tokenIDGET : token identifier

imageIDGET : image identifier

keyGET : field name

{
    "name": "image name",
    "url": "image url"
}

valuePOST : field value

{
    "name": "string",
    "url": "string"
}

image.remove

( tokenID, imageID )

GET /api/?action=image.removeHTTP/1.1 Host: inevent.us

Removes image imageID.

tokenIDGET : token identifier

imageIDGET : image identifier

image.find

( tokenID, eventID )

GET /api/?action=image.findHTTP/1.1 Host: inevent.us

Gathers all images at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

image.get

( tokenID, imageID )

GET /api/?action=image.getHTTP/1.1 Host: inevent.us

Gathers image imageID.

tokenIDGET : token identifier

imageIDGET : image identifier

Landing

It is possible to create several distinct landings for a given event, with complete custom HTML and hosted on our platform. You may set a specific domain for each landing, and these landings may have several pages as well.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "1",
            "landingID": "1",
            "name": "InEvent",
            "cname": "inevent.us"
        }
    ]
}

Methods

landing.create

( tokenID, eventID, name, cname )

POST /api/?action=landing.createHTTP/1.1 Host: inevent.us

Creates a landing at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : landing title

cnamePOST : landing domain

landing.edit

( tokenID, landingID, key, value )

POST /api/?action=landing.editHTTP/1.1 Host: inevent.us

Edits value value from field key of landing landingID.

tokenIDGET : token identifier

landingIDGET : landing identifier

keyGET : field key

{
    "name": "landing title",
    "cname": "landing domain"
}

valuePOST : field value

{
    "name": "string",
    "cname": "string"
}

landing.remove

( tokenID, landingID )

GET /api/?action=landing.removeHTTP/1.1 Host: inevent.us

Removes landing landingID.

tokenIDGET : token identifier

landingIDGET : landing identifier

landing.find

( tokenID, eventID )

GET /api/?action=landing.findHTTP/1.1 Host: inevent.us

Gathers all landings at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

landing.get

( tokenID, landingID )

GET /api/?action=landing.getHTTP/1.1 Host: inevent.us

Gathers landing landingID.

tokenIDGET : token identifier

landingIDGET : landing identifier

landing.put

( tokenID, landingID, file, url )

POST /api/?action=landing.putHTTP/1.1 Host: inevent.us

Creates or edits a file in landing landingID.

tokenIDGET : token identifier

landingIDGET : landing identifier

filePOST : file name

urlPOST : file url

landing.delete

( tokenID, landingID, file )

POST /api/?action=landing.deleteHTTP/1.1 Host: inevent.us

Deletes a file in landing landingID.

tokenIDGET : token identifier

landingIDGET : landing identifier

filePOST : file name

Landing pages

In a specific landing, it is possible to create several pages with distinct paths.

Models

{
    "count": 1,
    "data": [
        {
            "landingPageID": "1",
            "landingID": "1",
            "path": "\/faq\/",
            "file": "faq.html"
        }
    ]
}

Methods

landing.page.bind

( tokenID, landingID, path, file )

POST /api/?action=landing.page.bindHTTP/1.1 Host: inevent.us

Creates a page in landing landingID.

tokenIDGET : token identifier

landingIDGET : landing identifier

pathPOST : file url

filePOST : file name

landing.page.operate

( tokenID, landingPageID, key, value )

POST /api/?action=landing.page.operateHTTP/1.1 Host: inevent.us

Edits value value from field key in landing page landingPageID.

tokenIDGET : token identifier

landingPageIDGET : landing page identifier

keyGET : field name

{
    "path": "file url",
    "file": "file name"
}

valuePOST : field value

{
    "path": "string",
    "file": "string"
}

landing.page.dismiss

( tokenID, landingPageID )

GET /api/?action=landing.page.dismissHTTP/1.1 Host: inevent.us

Removes landing page landingPageID.

tokenIDGET : token identifier

landingPageIDGET : landing page identifier

landing.page.find

( tokenID, landingID )

GET /api/?action=landing.page.findHTTP/1.1 Host: inevent.us

Gathers all pages from landing landingID.

tokenIDGET : token identifier

landingIDGET : landing identifier

landing.page.get

( tokenID, landingPageID )

GET /api/?action=landing.page.getHTTP/1.1 Host: inevent.us

Gathers landing page landingPageID.

tokenIDGET : token identifier

landingPageIDGET : landing page identifier

License

Validate the current available licenses on the platform

Models

{
    "count": 1,
    "data": [
        {
            "licenseID": "1",
            "course": "InEvent Certified",
            "score": "99",
            "date": "1538073319"
        }
    ]
}

Methods

license.create

( tokenID, personID, license, course, score )

POST /api/?action=license.createHTTP/1.1 Host: inevent.us

Creates license for person personID.

tokenIDGET : token identifier

personIDPOST : person identifier

licensePOST : number or unique code

coursePOST : achievement title

scorePOST : achievement points (0-100)

( tokenID, username, license, course, score )

POST /api/?action=license.createHTTP/1.1 Host: inevent.us

Creates license for person username.

tokenIDGET : token identifier

usernamePOST : person username

licensePOST : number or unique code

coursePOST : achievement title

scorePOST : achievement points (0-100)

license.get

( license )

GET /api/?action=license.getHTTP/1.1 Host: inevent.us

Returns license license.

licenseGET : unique license

license.request

( license, leadEmail )

POST /api/?action=license.requestHTTP/1.1 Host: inevent.us

Requests more information on license license.

licenseGET : unique license

leadEmailPOST : lead email

LinkedIn

The content below pertains to operations on the professional LinkedIn network. It is essential that relational data be obtained on the various interests of a person so that the possibilities present in an event can be correlated. The required permissions that must be requested are r_basicprofile, r_fullprofile, r_network and r_emailaddress.

Methods

linkedin.signIn

( linkedInToken )

GET /api/?action=linkedin.signInHTTP/1.1 Host: inevent.us

Creates a session with LinkedIn using OAuth v2.0.

linkedInTokenGET : LinkedIn token provided by LinkedIn platform

Segmentation lists

Segmentation lists are great way to distinct specific group of leads for your event and even for your company. You can create a segmentation list in your company and use in all of your events every time you want.

Models

{
    "count": 1,
    "data": [
        {
            "listID": "4",
            "eventID": "1",
            "name": "Marketing",
            "color": "#ff0000"
        }
    ]
}

Methods

list.create

( tokenID, eventID, name, color )

POST /api/?action=list.createHTTP/1.1 Host: inevent.us

Creates a segmentation list with name name and color color at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : name of the list

colorPOST : list color

( tokenID, companyID, name, color )

POST /api/?action=list.createHTTP/1.1 Host: inevent.us

Creates a segmentation list with name name and color color at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

namePOST : list name

colorPOST : list color

list.edit

( tokenID, listID, key, value )

POST /api/?action=list.editHTTP/1.1 Host: inevent.us

Edits value value from field key of segmentation list listID.

tokenIDGET : token identifier

listIDGET : list identifier

keyGET : field name

{
    "name": "list name",
    "color": "list color"
}

valuePOST : field value

{
    "name": "string",
    "color": "string"
}

list.remove

( tokenID, listID )

GET /api/?action=list.removeHTTP/1.1 Host: inevent.us

Removes segmentation list listID.

tokenIDGET : token identifier

listIDGET : list identifier

list.find

( tokenID, eventID, *selection )

GET /api/?action=list.findHTTP/1.1 Host: inevent.us

Gathers all segmentation lists at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

*selectionGET : specific selection

{
    "all": "all lists",
    "public": "public lists",
    "minimal": "lists with reduced payload (all lists)"
}

( tokenID, companyID, *selection )

GET /api/?action=list.findHTTP/1.1 Host: inevent.us

Gathers all segmentation lists at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

*selectionGET : specific selection

{
    "all": "all lists",
    "public": "public lists",
    "minimal": "lists with reduced payload (all lists)"
}

list.get

( tokenID, listID )

GET /api/?action=list.getHTTP/1.1 Host: inevent.us

Gathers segmentation list listID.

tokenIDGET : token identifier

listIDGET : list identifier

list.copy

( tokenID, eventID, listID )

GET /api/?action=list.copyHTTP/1.1 Host: inevent.us

Imports a segmentation list listID from your company to event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

listIDGET : list identifier

list.import

( tokenID, eventID, sourceID, targetID )

GET /api/?action=list.importHTTP/1.1 Host: inevent.us

Imports data to list targetID from a segmentation list sourceID.

tokenIDGET : token identifier

eventIDGET : event identifier

sourceIDGET : list identifier

targetIDGET : list identifier

Email for segmentation lists

Manage emails for specific segmentation lists, allowing you to send emails for specific groups of people.

Models

{
    "count": 1,
    "data": [
        {
            "listEmailID": "16",
            "listID": "16",
            "eventID": "4",
            "subject": "Hello World",
            "html": "

Hello World some text might go here<\/p>", "sent": "0", "date": "124151252" } ] }

Methods

list.email.create

( tokenID, listID, subject, html )

POST /api/?action=list.email.createHTTP/1.1 Host: inevent.us

Creates an email at list listID.

tokenIDGET : token identifier

listIDGET : list identifier

subjectPOST : email subject

htmlPOST : email contents

( tokenID, eventID, subject, html, selection )

POST /api/?action=list.email.createHTTP/1.1 Host: inevent.us

Creates an email at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

subjectPOST : email subject

htmlPOST : email contents

selectionPOST : specific selection

{
    "all-attendees": "all attendees",
    "all-invited": "all invitees"
}

list.email.edit

( tokenID, listEmailID, key, *value )

POST /api/?action=list.email.editHTTP/1.1 Host: inevent.us

Edits value value from field key at email from list listEmailID.

tokenIDGET : token identifier

listEmailIDGET : list identifier

keyGET : field name

{
    "subject": "email subject",
    "html": "email contents"
}

*valuePOST : field value

{
    "subject": "string",
    "html": "string"
}

list.email.remove

( tokenID, listEmailID )

GET /api/?action=list.email.removeHTTP/1.1 Host: inevent.us

Removes email listEmailID.

tokenIDGET : token identifier

listEmailIDGET : list email identifier

list.email.find

( tokenID, listID )

GET /api/?action=list.email.findHTTP/1.1 Host: inevent.us

Gathers all emails at list listID.

tokenIDGET : token identifier

listIDGET : list identifier

( tokenID, eventID, selection )

GET /api/?action=list.email.findHTTP/1.1 Host: inevent.us

Gathers all emails at event eventID without a list linked.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : specific selection

{
    "all-attendees": "all attendees",
    "all-invited": "all invitees"
}

list.email.get

( tokenID, listEmailID )

GET /api/?action=list.email.getHTTP/1.1 Host: inevent.us

Returns email listEmailID.

tokenIDGET : token identifier

listEmailIDGET : list email identifier

list.email.send

( tokenID, listEmailID )

GET /api/?action=list.email.sendHTTP/1.1 Host: inevent.us

Sends email listEmailID.

tokenIDGET : token identifier

listEmailIDGET : list email identifier

list.email.copy

( tokenID, listEmailID, *listID, *selection )

GET /api/?action=list.email.copyHTTP/1.1 Host: inevent.us

Copies email listEmailID for a new draft.

tokenIDGET : token identifier

listEmailIDGET : list email identifier

*listIDGET : list identifier

*selectionGET : specific selection

list.email.preview

( tokenID, listEmailID )

GET /api/?action=list.email.previewHTTP/1.1 Host: inevent.us

Sends a preview email listEmailID for yourself.

tokenIDGET : token identifier

listEmailIDGET : list email identifier

list.email.stats

( tokenID, listEmailID )

GET /api/?action=list.email.statsHTTP/1.1 Host: inevent.us

Gathers all email statistics at email listEmailID.

tokenIDGET : token identifier

listEmailIDGET : list email identifier

People at segmentation lists

Adds people to a segmentation list so you can manage to send emails, sms and use them as you wish.

Models

{
    "count": 1,
    "data": [
        {
            "listPersonID": "16",
            "listID": "16",
            "personID": "4",
            "date": "124151252"
        }
    ]
}

Methods

list.person.bind

( tokenID, listID, personID )

GET /api/?action=list.person.bindHTTP/1.1 Host: inevent.us

Adds person personID in list listID.

tokenIDGET : token identifier

listIDGET : list identifier

personIDGET : person identifier

( tokenID, listID, content )

POST /api/?action=list.person.bindHTTP/1.1 Host: inevent.us

Adds people content in list listID.

tokenIDGET : token identifier

listIDGET : list identifier

contentPOST : people identifiers

( tokenID, listID, name, username )

POST /api/?action=list.person.bindHTTP/1.1 Host: inevent.us

Adds person with name name and username username in list listID.

tokenIDGET : token identifier

listIDGET : list identifier

namePOST : person name

usernamePOST : person username or email

( listID, *name, email )

POST /api/?action=list.person.bindHTTP/1.1 Host: inevent.us

Adds person email in list listID.

listIDGET : list identifier

*namePOST : person name

emailPOST : person username or email

( tokenID, listID, path )

POST /api/?action=list.person.bindHTTP/1.1 Host: inevent.us

Adds people as excel sheet path in list listID.

tokenIDGET : token identifier

listIDGET : list identifier

pathPOST : people excel sheet url

list.person.dismiss

( tokenID, listID, personID )

GET /api/?action=list.person.dismissHTTP/1.1 Host: inevent.us

Removes person personID from list listID.

tokenIDGET : token identifier

listIDGET : list identifier

personIDGET : person identifier

( tokenID, listID, content )

POST /api/?action=list.person.dismissHTTP/1.1 Host: inevent.us

Removes people content from list listID.

tokenIDGET : token identifier

listIDGET : list identifier

contentPOST : people identifiers

list.person.find

( tokenID, listID, *query )

GET /api/?action=list.person.findHTTP/1.1 Host: inevent.us

Gathers all people in list listID.

tokenIDGET : token identifier

listIDGET : list identifier

*queryGET : search text

SMS for segmentation lists

Manage sms for specific segmentation lists, allowing you to send sms for specific groups of people.

Models

{
    "count": 1,
    "data": [
        {
            "listPushID": "16",
            "listID": "16",
            "eventID": "4",
            "text": "Hello World",
            "sent": "0",
            "date": "124151252"
        }
    ]
}

Methods

list.sms.create

( tokenID, *listID, *selection, text )

POST /api/?action=list.sms.createHTTP/1.1 Host: inevent.us

Creates a new sms in list listID.

tokenIDGET : token identifier

*listIDGET : list identifier

*selectionGET : specific selection

textPOST : sms contents

list.sms.edit

( tokenID, listSmsID, key, value )

POST /api/?action=list.sms.editHTTP/1.1 Host: inevent.us

Edits value value from field key from sms at list listSmsID.

tokenIDGET : token identifier

listSmsIDGET : sms at list identifier

keyGET : field name

{
    "text": "sms contents"
}

valuePOST : field value

{
    "text": "string"
}

list.sms.remove

( tokenID, listSmsID )

GET /api/?action=list.sms.removeHTTP/1.1 Host: inevent.us

Removes sms at list listSmsID.

tokenIDGET : token identifier

listSmsIDGET : sms at list identifier

list.sms.find

( tokenID, listID )

GET /api/?action=list.sms.findHTTP/1.1 Host: inevent.us

Gathers all sms at list listID.

tokenIDGET : token identifier

listIDGET : list identifier

( tokenID, eventID, selection )

GET /api/?action=list.sms.findHTTP/1.1 Host: inevent.us

Gathers all sms at event eventID without a list linked.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : specific selection

{
    "all-attendees": "all attendees",
    "all-invited": "all invitees"
}

list.sms.preview

( tokenID, listSmsID )

GET /api/?action=list.sms.previewHTTP/1.1 Host: inevent.us

Sends a preview for sms at listlistSmsID.

tokenIDGET : token identifier

listSmsIDGET : sms at list identifier

list.sms.send

( tokenID, listSmsID )

GET /api/?action=list.sms.sendHTTP/1.1 Host: inevent.us

Sends sms at list listSmsID.

tokenIDGET : token identifier

listSmsIDGET : sms at list identifier

Literature

On our landing page we provide exclusive and qualified content for our visitors.

Models

{
    "count": 1,
    "data": [
        {
            "literatureID": "4",
            "title": "1",
            "picture": "1242",
            "url": "4242",
            "date": "Test title",
            "position": "Test content"
        }
    ]
}

Methods

literature.create

( tokenID, url, category )

POST /api/?action=literature.createHTTP/1.1 Host: inevent.us

Creates a literature with external url url.

tokenIDGET : token identifier

urlPOST : external url

categoryPOST : literature category

{
    "ebook": "E-Book",
    "article": "Article",
    "video": "Video"
}

literature.remove

( tokenID, literatureID )

GET /api/?action=literature.removeHTTP/1.1 Host: inevent.us

Removes literature literatureID.

tokenIDGET : token identifier

literatureIDGET : literature identifier

literature.find

( )

GET /api/?action=literature.findHTTP/1.1 Host: inevent.us

Gathers all literatures.

Lodging

You may provide lodging for your attendees during your event.

Models

{
    "count": 1,
    "data": [
        {
            "lodgingID": "3",
            "eventID": "1",
            "name": "Room #15",
            "description": "Two-bed room",
            "address": "5th Street",
            "capacity": "2"
        }
    ]
}

Methods

lodging.create

( tokenID, eventID, name, capacity, price, *description, *address )

POST /api/?action=lodging.createHTTP/1.1 Host: inevent.us

Creates a room with name name and capacity capacity at event eventID .

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : room name

capacityPOST : max number of people allowed inside the room

pricePOST : room price

*descriptionPOST : room description

*addressPOST : hotel address

( tokenID, eventID, path )

POST /api/?action=lodging.createHTTP/1.1 Host: inevent.us

Creates multiple rooms at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : excel sheet url

lodging.edit

( tokenID, lodgingID, key, value )

POST /api/?action=lodging.editHTTP/1.1 Host: inevent.us

Edits value value from field key of room lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

keyGET : field name

{
    "name": "name",
    "description": "description",
    "address": "address",
    "capacity": "capacity of people"
}

valuePOST : field value

{
    "name": "string",
    "description": "string",
    "address": "string",
    "capacity": "integer"
}

lodging.remove

( tokenID, lodgingID )

GET /api/?action=lodging.removeHTTP/1.1 Host: inevent.us

Removes lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

lodging.find

( tokenID, eventID, selection )

GET /api/?action=lodging.findHTTP/1.1 Host: inevent.us

Gathers all rooms at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : specific selection

{
    "all": "all rooms",
    "empty": "available rooms"
}

lodging.get

( tokenID, lodgingID )

GET /api/?action=lodging.getHTTP/1.1 Host: inevent.us

Gathers room lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

People at lodging

Defines which people are allowed inside the lodging.

Models

{
    "count": 1,
    "data": [
        {
            "lodgingPersonID": "16",
            "lodgingID": "4",
            "personID": "1330",
            "date": "124151252",
            "checkIn": "124151252",
            "checkOut": "124151252"
        }
    ]
}

Push Notification

lodging.person/added

_person

Notifies person personID about their allocation at lodging lodgingID.

{
    "lodgingID": "integer",
    "personID": "integer"
}

lodging.person/invited

_person

Notifies person personID about an invitation for lodging lodgingID.

{
    "lodgingID": "integer",
    "personID": "integer"
}

lodging.person/confirmed

_person

Notifies person that person personID accepted your invitation for lodging lodgingID.

{
    "lodgingID": "integer",
    "personID": "integer"
}

lodging.person/rejected

_person

Notifies person that person personID rejected your invitation for lodging lodgingID.

{
    "lodgingID": "integer",
    "personID": "integer"
}

Methods

lodging.person.bind

( tokenID, lodgingID )

GET /api/?action=lodging.person.bindHTTP/1.1 Host: inevent.us

Adds person tokenID to lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

( tokenID, lodgingID, personID )

GET /api/?action=lodging.person.bindHTTP/1.1 Host: inevent.us

Adds person personID to lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

personIDGET : person identifier

lodging.person.dismiss

( tokenID, lodgingID )

GET /api/?action=lodging.person.dismissHTTP/1.1 Host: inevent.us

Removes person tokenID at lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

( tokenID, lodgingID, personID )

GET /api/?action=lodging.person.dismissHTTP/1.1 Host: inevent.us

Removes personID at lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

personIDGET : person identifier

lodging.person.find

( tokenID, lodgingID )

GET /api/?action=lodging.person.findHTTP/1.1 Host: inevent.us

Gathers all people at lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

( tokenID, eventID, selection, *query )

GET /api/?action=lodging.person.findHTTP/1.1 Host: inevent.us

Gathers all people at event eventID filtered by lodging.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : search

{
    "all": "all attendees",
    "hosted": "only hosted attendees",
    "non-hosted": "only non-hosted attendees"
}

*queryGET : query text

lodging.person.get

( tokenID, eventID )

GET /api/?action=lodging.person.getHTTP/1.1 Host: inevent.us

Gathers lodging for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

( tokenID, eventID, personID )

GET /api/?action=lodging.person.getHTTP/1.1 Host: inevent.us

Gathers lodging for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

lodging.person.invite

( tokenID, lodgingID, personID )

GET /api/?action=lodging.person.inviteHTTP/1.1 Host: inevent.us

Invites personID for lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

personIDGET : person identifier

( tokenID, eventID, personID )

GET /api/?action=lodging.person.inviteHTTP/1.1 Host: inevent.us

Invites person personID for lodging at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

lodging.person.inviteConfirm

( tokenID, lodgingID )

GET /api/?action=lodging.person.inviteConfirmHTTP/1.1 Host: inevent.us

Confirms invitation at lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

lodging.person.inviteReject

( tokenID, lodgingID )

GET /api/?action=lodging.person.inviteRejectHTTP/1.1 Host: inevent.us

Rejects invitation at lodging lodgingID.

tokenIDGET : token identifier

lodgingIDGET : lodging identifier

lodging.person.invites

( tokenID, eventID )

GET /api/?action=lodging.person.invitesHTTP/1.1 Host: inevent.us

Gathers all invitations for lodgings at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Marketo

Module specific for Marketo integrations. Our Marketo integration allows you to link lists from marketo with us, simultaneously synchronizing leads from Marketo to our platform.

Methods

marketo.edit

( tokenID, companyID, key, value )

POST /api/?action=marketo.editHTTP/1.1 Host: inevent.us

Edits value value from field key from Marketo linked at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

keyGET : field name

{
    "autoLinkEvents": "should automatically link Marketo lists with Event main list",
    "autoLinkMode": "mode of linkage",
    "autoLinkFolderId": "list will be created at folder"
}

valuePOST : field value

{
    "autoLinkEvents": "boolean",
    "autoLinkMode": "r|w|rw",
    "autoLinkFolderId": "integer"
}

marketo.get

( tokenID, companyID )

GET /api/?action=marketo.getHTTP/1.1 Host: inevent.us

Gathers Marketo integration details from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

( tokenID, eventID )

GET /api/?action=marketo.getHTTP/1.1 Host: inevent.us

Gathers Marketo integration details for event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

marketo.linkAccount

( tokenID, companyID, clientId, clientSecret, munchkinId )

POST /api/?action=marketo.linkAccountHTTP/1.1 Host: inevent.us

Links a Marketo account with company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

clientIdPOST : Marketo client identifier

clientSecretPOST : Marketo client secret

munchkinIdPOST : Marketo munchkin identifier

marketo.unlinkAccount

( tokenID, companyID )

GET /api/?action=marketo.unlinkAccountHTTP/1.1 Host: inevent.us

Unlinks a Marketo account from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

marketo.getFolders

( tokenID, companyID )

GET /api/?action=marketo.getFoldersHTTP/1.1 Host: inevent.us

Get a list of folders available for linkage from Marketo at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

marketo.getChannels

( tokenID, companyID )

GET /api/?action=marketo.getChannelsHTTP/1.1 Host: inevent.us

Get a list of channels available for linkage from Marketo at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

marketo.getTags

( tokenID, companyID )

GET /api/?action=marketo.getTagsHTTP/1.1 Host: inevent.us

Get a list of tags available for linkage from Marketo at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

marketo.getTypes

( tokenID )

GET /api/?action=marketo.getTypesHTTP/1.1 Host: inevent.us

Get a list of types available for linkage from Marketo.

tokenIDGET : token identifier

marketo.getProgram

( tokenID, companyID, name )

GET /api/?action=marketo.getProgramHTTP/1.1 Host: inevent.us

Get a program by its name from Marketo.

tokenIDGET : token identifier

companyIDGET : company identifier

nameGET : program name

marketo.import

( tokenID, eventID, mktListID, target, *targetID )

GET /api/?action=marketo.importHTTP/1.1 Host: inevent.us

Import list leads from Marketo mktListID to a target and targetID.

tokenIDGET : token identifier

eventIDGET : event identifier

mktListIDGET : marketo list identifier

targetGET : target list

{
    "event.person": "attendees list",
    "event.invite": "invitees list",
    "list": "custom list (requires targetID)"
}

*targetIDGET : target list id

Marketo Field

This module allows you to link an InEvent field with a Marketo field.

Methods

marketo.field.bind

( tokenID, eventID, feedbackID, mkFieldId )

POST /api/?action=marketo.field.bindHTTP/1.1 Host: inevent.us

Links a Marketo field to event eventID and a field feedbackID.

tokenIDGET : token identifier

eventIDGET : event identifier

feedbackIDPOST : InEvent field identifier

mkFieldIdPOST : Marketo field identifier

marketo.field.dismiss

( tokenID, marketoFieldID )

GET /api/?action=marketo.field.dismissHTTP/1.1 Host: inevent.us

Unlinks a Marketo field marketoFieldID from event.

tokenIDGET : token identifier

marketoFieldIDGET : linkage identifier

( tokenID, feedbackID )

GET /api/?action=marketo.field.dismissHTTP/1.1 Host: inevent.us

Unlinks a Marketo field linked with feedbackID from event.

tokenIDGET : token identifier

feedbackIDGET : feedback identifier

marketo.field.find

( tokenID, eventID )

GET /api/?action=marketo.field.findHTTP/1.1 Host: inevent.us

Finds all linked fields between Marketo and InEvent at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

marketo.field.get

( tokenID, marketoFieldID )

GET /api/?action=marketo.field.getHTTP/1.1 Host: inevent.us

Get a specific linkage field marketoFieldID between Marketo and InEvent.

tokenIDGET : token identifier

marketoFieldIDGET : linkage identifier

Marketo Link

This module allows you to link an InEvent list with a Marketo list.

Methods

marketo.link.bind

( tokenID, eventID, listID, linkId, mode )

POST /api/?action=marketo.link.bindHTTP/1.1 Host: inevent.us

Links a Marketo list to event eventID and a list listID.

tokenIDGET : token identifier

eventIDGET : event identifier

listIDPOST : InEvent list identifier

linkIdPOST : Marketo list identifier

modePOST : linkage mode

{
    "r": "read only (InEvent reads from Marketo)",
    "w": "write only (InEvent writes to Marketo)",
    "rw": "read\/write (InEvent reads and writes on Marketo)"
}

( tokenID, eventID, linkId, mode )

POST /api/?action=marketo.link.bindHTTP/1.1 Host: inevent.us

Links a Marketo program to event eventID attendees list.

tokenIDGET : token identifier

eventIDGET : event identifier

linkIdPOST : Marketo program identifier

modePOST : linkage mode

{
    "r": "read only (InEvent reads from Marketo)",
    "w": "write only (InEvent writes to Marketo)",
    "rw": "read\/write (InEvent reads and writes on Marketo)"
}

marketo.link.operate

( tokenID, marketoLinkID, key, value )

POST /api/?action=marketo.link.operateHTTP/1.1 Host: inevent.us

Edits value value from field key for a linkage marketoLinkID.

tokenIDGET : token identifier

marketoLinkIDGET : activity identifier

keyGET : element name

{
    "mode": "approval status"
}

valuePOST : desired action

{
    "r": "read only (InEvent reads from Marketo)",
    "w": "write only (InEvent writes to Marketo)",
    "rw": "read\/write (InEvent reads and writes on Marketo)"
}

marketo.link.dismiss

( tokenID, marketoLinkID )

GET /api/?action=marketo.link.dismissHTTP/1.1 Host: inevent.us

Unlinks a Marketo list marketoLinkID from event.

tokenIDGET : token identifier

marketoLinkIDGET : linkage identifier

marketo.link.find

( tokenID, eventID )

GET /api/?action=marketo.link.findHTTP/1.1 Host: inevent.us

Finds all linked lists between Marketo and InEvent at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

marketo.link.get

( tokenID, marketoLinkID )

GET /api/?action=marketo.link.getHTTP/1.1 Host: inevent.us

Get a specific linkage list marketoLinkID between Marketo and InEvent.

tokenIDGET : token identifier

marketoLinkIDGET : linkage identifier

marketo.link.sync

( tokenID, marketoLinkID )

GET /api/?action=marketo.link.syncHTTP/1.1 Host: inevent.us

Forces a synchronization between Marketo and InEvent for linkage list marketoLinkID.

tokenIDGET : token identifier

marketoLinkIDGET : linkage identifier

Material

In each activity you can share materials such as documents, presentations and images. This allows multiple resources to quickly become accessible to many people within the event, minimizing the data loss process. Each material receives an unique url.

Models

{
    "count": 1,
    "data": [
        {
            "materialID": "1",
            "activityID": "1012",
            "name": "file.pdf",
            "extension": "",
            "url": "https:\/\/www.dropbox.com\/s\/",
            "date": "1385523142"
        }
    ]
}

Methods

material.create

( tokenID, activityID, name, extension, url )

POST /api/?action=material.createHTTP/1.1 Host: inevent.us

Creates a material with name name and hosted at url at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

namePOST : file name

extensionPOST : file extension

urlPOST : file url

( tokenID, eventID, name, extension, url )

POST /api/?action=material.createHTTP/1.1 Host: inevent.us

Creates a material with name name and hosted at url at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : file name

extensionPOST : file extension

urlPOST : file url

material.remove

( tokenID, materialID )

GET /api/?action=material.removeHTTP/1.1 Host: inevent.us

Removes material materialID.

tokenIDGET : token identifier

materialIDGET : material identifier

material.find

( tokenID, activityID )

GET /api/?action=material.findHTTP/1.1 Host: inevent.us

Gathers all materials from activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

( tokenID, eventID )

GET /api/?action=material.findHTTP/1.1 Host: inevent.us

Gathers all materials from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

material.get

( tokenID, materialID )

GET /api/?action=material.getHTTP/1.1 Host: inevent.us

Gathers material materialID.

tokenIDGET : token identifier

materialIDGET : material identifier

Material tags

You can tag each material so it is easier for attendees to find a specific material and for organizers to better manage their materials.

Models

{
    "count": 1,
    "data": [
        {
            "materialID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

material.tag.bind

( tokenID, materialID, tagID )

GET /api/?action=material.tag.bindHTTP/1.1 Host: inevent.us

Creates tag tagID at material materialID.

tokenIDGET : token identifier

materialIDGET : material identifier

tagIDGET : tag identifier

material.tag.dismiss

( tokenID, materialID, tagID )

GET /api/?action=material.tag.dismissHTTP/1.1 Host: inevent.us

Removes tag tagID from material materialID.

tokenIDGET : token identifier

materialIDGET : material identifier

tagIDGET : tag identifier

material.tag.find

( tokenID, materialID )

GET /api/?action=material.tag.findHTTP/1.1 Host: inevent.us

Gathers all tags for material materialID.

tokenIDGET : token identifier

materialIDGET : material identifier

Meeting

During the participating events (guests) they can schedule meetings with other participants of the event (hosts). Hosts set the times and guests can schedule meetings at these times.

Models

{
    "count": 1,
    "data": [
        {
            "meetingID": "4",
            "eventID": "6026",
            "personID": "449",
            "dateBegin": "1449803077",
            "dateEnd": "1449806377",
            "spot": "Room #25",
            "capacity": "2",
            "maySubscribe": 1,
            "guests": [
                {
                    "meetingPersonID": "12",
                    "personID": "525",
                    "personName": "Dave Grohl",
                    "status": "1",
                    "checkIn": "0"
                },
                {
                    "meetingPersonID": "16",
                    "personID": "1330",
                    "personName": "Josh Homme",
                    "status": "1",
                    "checkIn": "1"
                }
            ]
        }
    ]
}

Push Notification

meeting/change

_guest

Informs person personID that the meeting meetingID has been updated.

{
    "meetingID": "integer"
}

Methods

meeting.create

( tokenID, eventID, dateBegin, dateEnd, spot, capacity )

POST /api/?action=meeting.createHTTP/1.1 Host: inevent.us

Creates a time slot that starts at dateBegin and ends at dateEnd for meetings located at spot for host tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

dateBeginPOST : time that the meeting starts

dateEndPOST : time that the meeting ends

spotPOST : meeting place

capacityPOST : amount of people allowed to participate at the meeting

( tokenID, eventID, dateBegin, dateEnd, spot, capacity, personID )

POST /api/?action=meeting.createHTTP/1.1 Host: inevent.us

Creates a time slot that starts at dateBegin and ends at dateEnd for meetings located at spot for host personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

dateBeginPOST : time that the meeting starts

dateEndPOST : time that the meeting ends

spotPOST : meeting place

capacityPOST : amount of people allowed to participate at the meeting

personIDGET : host identifier

( tokenID, eventID, path )

POST /api/?action=meeting.createHTTP/1.1 Host: inevent.us

Creates multiple meetings at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : meetings excel sheet url

meeting.edit

( tokenID, meetingID, key, value )

POST /api/?action=meeting.editHTTP/1.1 Host: inevent.us

Edits value value from field key of meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

keyGET : field name

{
    "dateBegin": "date and time",
    "dateEnd": "date and time",
    "spot": "place"
}

valuePOST : field value

{
    "dateBegin": "integer(11)",
    "dateEnd": "integer(11)",
    "spot": "string"
}

meeting.remove

( tokenID, meetingID )

GET /api/?action=meeting.removeHTTP/1.1 Host: inevent.us

Removes meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

meeting.find

( tokenID, eventID, personID, *dateBegin, *dateEnd )

GET /api/?action=meeting.findHTTP/1.1 Host: inevent.us

Gathers all meetings at event eventID hosted by personID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

*dateBeginGET : date and time of start

*dateEndGET : date and time of end

( tokenID, eventID, *dateBegin, *dateEnd )

GET /api/?action=meeting.findHTTP/1.1 Host: inevent.us

Gathers all meetings at event eventID related to tokenID.

tokenIDGET : token identifier

eventIDGET : event identifier

*dateBeginGET : date and time of start

*dateEndGET : date and time of end

meeting.get

( tokenID, meetingID )

GET /api/?action=meeting.getHTTP/1.1 Host: inevent.us

Gathers meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

meeting.fill

( tokenID, eventID, minutes )

POST /api/?action=meeting.fillHTTP/1.1 Host: inevent.us

Fill all meetings at event eventID with intervals of minutes.

tokenIDGET : token identifier

eventIDGET : event identifier

minutesPOST : intervals of x minutes

Meeting feedbacks

At the end of the meeting, people that participated may send a feedback.

Models

{
    "count": 1,
    "data": [
        {
            "meetingFeedbackID": "16",
            "meetingID": "4",
            "personID": "1330",
            "text": "Awesome meeting!"
        }
    ]
}

Push Notification

meeting/feedback

_host|guest

Notifies people from meeting to send their feedback.

{
    "meetingID": "integer",
    "personID": "integer"
}

Methods

meeting.feedback.create

( tokenID, meetingID, text )

POST /api/?action=meeting.feedback.createHTTP/1.1 Host: inevent.us

Creates a feedback with text text for the meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

textPOST : feedback text

meeting.feedback.find

( tokenID, meetingID )

GET /api/?action=meeting.feedback.findHTTP/1.1 Host: inevent.us

Gathers all feedbacks for meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

Meeting people

Meetings marked during the event can be changed, confirmed, rejected or canceled depending on host or guest actions.

Models

{
    "count": 1,
    "data": [
        {
            "meetingPersonID": "16",
            "meetingID": "4",
            "personID": "1330",
            "status": "1",
            "checkIn": 1
        }
    ]
}

Push Notification

meeting/ask

_host

Notifies host hostID of meeting that person personID wishes to participate as guest.

{
    "meetingID": "integer",
    "personID": "integer"
}

meeting/confirm

_guest

Notifies guest personID that meeting meetingID has been confirmed.

{
    "meetingID": "integer"
}

meeting/revoke

_guest

Notifies guest personID that meeting meetingID has been rejected.

{
    "meetingID": "integer"
}

Methods

meeting.person.bind

( tokenID, meetingID )

GET /api/?action=meeting.person.bindHTTP/1.1 Host: inevent.us

Adds guest tokenID to meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

( tokenID, meetingID, personID )

GET /api/?action=meeting.person.bindHTTP/1.1 Host: inevent.us

Adds guest personID to meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

personIDGET : person identifier

meeting.person.confirm

( tokenID, meetingID, personID )

GET /api/?action=meeting.person.confirmHTTP/1.1 Host: inevent.us

Confirms meeting meetingID with guest personID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

personIDGET : host identifier

meeting.person.revoke

( tokenID, meetingID, personID )

GET /api/?action=meeting.person.revokeHTTP/1.1 Host: inevent.us

Rejects meeting meetingID with guest personID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

personIDGET : host identifier

meeting.person.dismiss

( tokenID, meetingID )

GET /api/?action=meeting.person.dismissHTTP/1.1 Host: inevent.us

Cancels their presence at meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

( tokenID, meetingID, personID )

GET /api/?action=meeting.person.dismissHTTP/1.1 Host: inevent.us

Cancels their presence at meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

personIDGET : person identifier

meeting.person.checkIn

( tokenID, meetingID )

GET /api/?action=meeting.person.checkInHTTP/1.1 Host: inevent.us

Confirms their presence at meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

( tokenID, meetingID, personID )

GET /api/?action=meeting.person.checkInHTTP/1.1 Host: inevent.us

Confirms their presence at meeting meetingID.

tokenIDGET : token identifier

meetingIDGET : meeting identifier

personIDGET : person identifier

Meeting quotas

For each attendee of the event, there is a maximum number of meetings you can dial with the hosts. This number is defined through quotas, which can be created and assigned to different participants. Participants without quotas can not schedule any meetings.

Models

{
    "count": 1,
    "data": [
        {
            "meetingQuotaID": "1",
            "eventID": "1",
            "name": "Gold package",
            "amount": "10"
        }
    ]
}

Methods

meeting.quota.create

( tokenID, eventID, name, amount )

POST /api/?action=meeting.quota.createHTTP/1.1 Host: inevent.us

Creates a quota with name name and amount of meetings amount at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : quota name

amountPOST : amount of meetings for quota

meeting.quota.get

( tokenID, meetingQuotaID )

GET /api/?action=meeting.quota.getHTTP/1.1 Host: inevent.us

Gathers quota meetingQuotaID.

tokenIDGET : token identifier

meetingQuotaIDGET : quota identifier

meeting.quota.find

( tokenID, eventID )

GET /api/?action=meeting.quota.findHTTP/1.1 Host: inevent.us

Gathers all quotas at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

meeting.quota.edit

( tokenID, meetingQuotaID, key, value )

POST /api/?action=meeting.quota.editHTTP/1.1 Host: inevent.us

Edits value value from field key of quota meetingQuotaID.

tokenIDGET : token identifier

meetingQuotaIDGET : quota identifier

keyGET : field name

{
    "name": "quota name",
    "amount": "amount of meetings"
}

valuePOST : field value

{
    "name": "string",
    "amount": "integer(11)"
}

meeting.quota.remove

( tokenID, eventID, meetingQuotaID )

GET /api/?action=meeting.quota.removeHTTP/1.1 Host: inevent.us

Removes quota meetingQuotaID from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

meetingQuotaIDGET : quota identifier

Moip

Module destinated for integrations between InEvent and Moip.

Methods

moip.get

( tokenID, eventID )

GET /api/?action=moip.getHTTP/1.1 Host: inevent.us

Gathers data from Moip integration at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

moip.edit

( tokenID, eventID, key, value )

POST /api/?action=moip.editHTTP/1.1 Host: inevent.us

Edits data from Moip integration at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : field name

{
    "installments": "number of maximum installments"
}

valuePOST : field value

{
    "installments": "integer (from 1 to 12)"
}

moip.linkAccount

( tokenID, eventID, apiKey, apiToken, sandbox )

POST /api/?action=moip.linkAccountHTTP/1.1 Host: inevent.us

Links a Moip account with event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

apiKeyPOST : Moip api key

apiTokenPOST : Moip api token

sandboxPOST : sandbox environment or production (1 or 0)

moip.unlinkAccount

( tokenID, eventID )

GET /api/?action=moip.unlinkAccountHTTP/1.1 Host: inevent.us

Unlinks a Moip account from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

News

For each event, it is necessary to actively communicate everything that occurs at exact moments. For each news, you are allowed to choose your recipient, such as people from the entire event, activity or even individually.

Models

{
    "count": 1,
    "data": [
        {
            "newsID": "4",
            "eventID": "1",
            "activityID": "15",
            "senderID": "0",
            "senderRole": "1",
            "receiverID": "0",
            "message": "Event is starting!",
            "date": "1400524839",
            "sent": true,
            "activityName": "Opening",
            "senderName": null,
            "receiverName": null
        }
    ]
}
{
    "senderRole": {
        "1": "ROLE_ATTENDEE",
        "2": "ROLE_STAFF",
        "4": "ROLE_COORDINATOR"
    }
}

Push Notification

news/event.create

_event

Notifies message for event eventID.

{
    "eventID": "integer"
}

news/activity.create

_event

Notifies message for activity activityID at event eventID.

{
    "activityID": "integer"
}

news/person.create

_person

Notifies message for person personID.

{
    "personID": "integer"
}

news/list.create

_list

Notifies message for list listID.

{
    "listID": "integer"
}

Methods

news.create

( tokenID, eventID, personID, message, *scheduled, *date )

POST /api/?action=news.createHTTP/1.1 Host: inevent.us

Sends a message message for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : recipient identifier

messagePOST : message (140)

*scheduledPOST : if message should be schedule or not (default: 0)

[
    0,
    1
]

*datePOST : date for message to be sent (ignored in case schedule == 0)

( tokenID, eventID, message, *scheduled, *date )

POST /api/?action=news.createHTTP/1.1 Host: inevent.us

Sends message message for all people at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

messagePOST : message (140)

*scheduledPOST : if message should be schedule or not (default: 0)

[
    0,
    1
]

*datePOST : date for message to be sent (ignored in case schedule == 0)

( tokenID, activityID, message, *scheduled, *date )

POST /api/?action=news.createHTTP/1.1 Host: inevent.us

Sends message message for all people at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

messagePOST : message (140)

*scheduledPOST : if message should be schedule or not (default: 0)

[
    0,
    1
]

*datePOST : date for message to be sent (ignored in case schedule == 0)

( tokenID, listID, message, *scheduled, *date )

POST /api/?action=news.createHTTP/1.1 Host: inevent.us

Sends message message for all people at list listID.

tokenIDGET : token identifier

listIDGET : list identifier

messagePOST : message (140)

*scheduledPOST : if message should be schedule or not (default: 0)

[
    0,
    1
]

*datePOST : date for message to be sent (ignored in case schedule == 0)

news.edit

( newsID, key, value )

POST /api/?action=news.editHTTP/1.1 Host: inevent.us

Edits value value from field key of news newsID.

newsIDGET : news identifier

keyGET : field name

valuePOST : field value

news.remove

( tokenID, newsID )

GET /api/?action=news.removeHTTP/1.1 Host: inevent.us

Removes news newsID.

tokenIDGET : token identifier

newsIDGET : news identifier

news.find

( tokenID, eventID, personID )

GET /api/?action=news.findHTTP/1.1 Host: inevent.us

Gathers all news sent between person with tokenID and person personID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID, selection )

GET /api/?action=news.findHTTP/1.1 Host: inevent.us

Gathers all news at event eventID, filtered by selection selection.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : message receiver

{
    "all": "all messages",
    "self": "messages sent specifically for person with tokenID"
}

( tokenID, activityID )

GET /api/?action=news.findHTTP/1.1 Host: inevent.us

Gathers all news at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

( tokenID, listID )

GET /api/?action=news.findHTTP/1.1 Host: inevent.us

Gathers all news at list listID.

tokenIDGET : token identifier

listIDGET : list identifier

news.get

( newsID )

GET /api/?action=news.getHTTP/1.1 Host: inevent.us

Gathers news newsID.

newsIDGET : news identifier

Note

Within the event, it is important to save and document each communication made with the participant through notes.

Models

{
    "count": 1,
    "data": [
        {
            "noteID": "1",
            "personName": "Pedro Góes",
            "personID": "1",
            "text": "Confirmed his presence",
            "date": "1400025600"
        }
    ]
}

Methods

note.create

( tokenID, eventID, personID, text )

POST /api/?action=note.createHTTP/1.1 Host: inevent.us

Creates a note for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

textPOST : note text

note.find

( tokenID, eventID, personID )

GET /api/?action=note.findHTTP/1.1 Host: inevent.us

Gathers all notes of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID )

GET /api/?action=note.findHTTP/1.1 Host: inevent.us

Gathers all at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Payment

Every product from the event generates a log of purchase.

Methods

payment.create

( tokenID, eventID, username, tickets, *name, *email, *password )

POST /api/?action=payment.createHTTP/1.1 Host: inevent.us

Create a static payment for a new person at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

usernamePOST : person username

ticketsPOST : json content with tickets

*namePOST : person name

*emailPOST : person email

*passwordPOST : person password

payment.find

( tokenID, eventID, *query )

GET /api/?action=payment.findHTTP/1.1 Host: inevent.us

Gathers all payments made at event eventID with a search query.

tokenIDGET : token identifier

eventIDGET : event identifier

*queryGET : query text

Person

People are the most important part of any platform, the beings capable of making all the decisions made there. They can manipulate your present data and virtually all other operations with their tokens.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "name": "Pedro Góes",
            "email": "email@email.com",
            "headline": "CEO @ InEvent",
            "summary": "",
            "industry": "Technological Innovation",
            "image": "https:\/\/",
            "url": "http:\/\/pedrogoes.info\/",
            "telephone": "000-000-0000",
            "city": "United States",
            "facebookID": "0",
            "linkedInID": "0"
        }
    ]
}

Push Notification

person/promote

_person

Informs person personID was promoted at event eventID.

{
    "eventID": "integer"
}

person/demote

_person

Informs person personID was downgraded at event eventID.

{
    "eventID": "integer"
}

Methods

person.create

( name, username, password, *language )

POST /api/?action=person.createHTTP/1.1 Host: inevent.us

Creates an account for a person named name, user username and password password.

namePOST : person name

usernamePOST : person user

passwordPOST : person password

*languagePOST : (en|es|pt)

person.edit

( tokenID, key, value )

POST /api/?action=person.editHTTP/1.1 Host: inevent.us

Updates value value at field key for person tokenID.

tokenIDGET : token identifier

keyGET : field name

valuePOST : field value

{
    "name": "string",
    "email": "string",
    "role": "string",
    "company": "string",
    "image": "string",
    "telephone": "string",
    "city": "string",
    "cpf": "integer(11)",
    "public": "bit",
    "language": "(en|es|pt)"
}

( tokenID, key, value, personID )

POST /api/?action=person.editHTTP/1.1 Host: inevent.us

Updates value value at field key of person personID.

tokenIDGET : token identifier

keyGET : field name

valuePOST : field value

{
    "name": "string",
    "email": "string",
    "password": "string",
    "role": "string",
    "company": "string",
    "language": "(en|es|pt)"
}

personIDGET : person identifier

( tokenID, content )

POST /api/?action=person.editHTTP/1.1 Host: inevent.us

Updates content of person personID.

tokenIDGET : token identifier

contentPOST : json content

person.get

( tokenID )

GET /api/?action=person.getHTTP/1.1 Host: inevent.us

Returns person tokenID.

tokenIDGET : token identifier

( tokenID, personID )

GET /api/?action=person.getHTTP/1.1 Host: inevent.us

Returns person personID.

tokenIDGET : token identifier

personIDGET : person identifier

person.signIn

( username, password )

POST /api/?action=person.signInHTTP/1.1 Host: inevent.us

Begins a session for person username and password password.

usernameGET : person username

passwordPOST : person password

( username, secretCode )

POST /api/?action=person.signInHTTP/1.1 Host: inevent.us

Begins a limited session for person username and code secretCode.

usernameGET : person username

secretCodePOST : person temporary code

( username, password, companyID )

POST /api/?action=person.signInHTTP/1.1 Host: inevent.us

Begins a limited session for person username and password password at company companyID.

usernameGET : person username

passwordPOST : person password

companyIDGET : company identifier

( username, password, *companyID, *verifyBy )

POST /api/?action=person.signInHTTP/1.1 Host: inevent.us

Requests a secure code at session for person username and password password.

usernameGET : person username

passwordPOST : person password

*companyIDGET : company identifier

*verifyByGET : verification scope

{
    "email": "will send an email with code",
    "telephone": "will send a sms with code"
}

( username, password, *companyID, *verifyBy, *code )

POST /api/?action=person.signInHTTP/1.1 Host: inevent.us

Informs a secure code at session for person username and password password.

usernameGET : person username

passwordPOST : person password

*companyIDGET : company identifier

*verifyByGET : verification scope

{
    "email": "will send an email with code",
    "telephone": "will send a sms with code"
}

*codeGET : code verification

person.externalSignIn

( username, password, company )

POST /api/?action=person.externalSignInHTTP/1.1 Host: inevent.us

Begins an external session for person username, password password and company company.

usernameGET : person username

passwordPOST : person password

companyGET : company key

person.enableTwoFactor

( tokenID, verifyBy )

GET /api/?action=person.enableTwoFactorHTTP/1.1 Host: inevent.us

Enables two-factor authentication for user.

tokenIDGET : token identifier

verifyByGET : verification scope

{
    "email": "will send an email with code",
    "telephone": "will send a sms with code"
}

( tokenID, verifyBy, *code )

GET /api/?action=person.enableTwoFactorHTTP/1.1 Host: inevent.us

Confirms two-factor authentication for user.

tokenIDGET : token identifier

verifyByGET : verification scope

{
    "email": "will send an email with code",
    "telephone": "will send a sms with code"
}

*codeGET : code verification

person.disableTwoFactor

( tokenID )

GET /api/?action=person.disableTwoFactorHTTP/1.1 Host: inevent.us

Disables two-factor authentication for user.

tokenIDGET : token identifier

person.sendRecovery

( tokenID, companyID )

GET /api/?action=person.sendRecoveryHTTP/1.1 Host: inevent.us

Sends a recovery email password for authenticated person.

tokenIDGET : token identifier

companyIDGET : company identifier

( tokenID, eventID )

GET /api/?action=person.sendRecoveryHTTP/1.1 Host: inevent.us

Sends a recovery email password for authenticated person.

tokenIDGET : token identifier

eventIDGET : event identifier

( username, companyID )

GET /api/?action=person.sendRecoveryHTTP/1.1 Host: inevent.us

Sends a recovery email password for person username.

usernameGET : person username

companyIDGET : company identifier

( username, eventID )

GET /api/?action=person.sendRecoveryHTTP/1.1 Host: inevent.us

Sends a recovery email password for person username.

usernameGET : person username

eventIDGET : event identifier

person.changePassword

( tokenID, oldPassword, newPassword )

POST /api/?action=person.changePasswordHTTP/1.1 Host: inevent.us

Changes an old password oldPassword for new password newPassword.

tokenIDGET : token identifier

oldPasswordPOST : old password

newPasswordPOST : new password

( tokenID, newPassword )

POST /api/?action=person.changePasswordHTTP/1.1 Host: inevent.us

Changes password for person tokenID.

tokenIDGET : id de autenticação especial

newPasswordPOST : new password

person.changeLevel

( tokenID, personID, newLevel )

POST /api/?action=person.changeLevelHTTP/1.1 Host: inevent.us

Changes person personID level.

tokenIDGET : token identifier

personIDGET : person identifier

newLevelPOST : person level

( tokenID, username, newLevel )

POST /api/?action=person.changeLevelHTTP/1.1 Host: inevent.us

Changes person username level.

tokenIDGET : token identifier

usernameGET : person username

newLevelPOST : person level

person.terminate

( tokenID, password )

POST /api/?action=person.terminateHTTP/1.1 Host: inevent.us

Wipes person tokenID data.

tokenIDGET : token identifier

passwordPOST : person password

person.sendFeedback

( tokenID, companyID, message )

POST /api/?action=person.sendFeedbackHTTP/1.1 Host: inevent.us

Sends a feedback message.

tokenIDGET : token identifier

companyIDGET : company identifier

messagePOST : person feedback

Person badges

Badges are counters for tracking how many notifications each device has for a given module, including unseen notifications from different events.

Models

{
    "count": 1,
    "data": [
        {
            "memberBadgeID": "2",
            "personBadgeID": "2",
            "personID": "1",
            "eventID": "1",
            "target": "networking",
            "count": "0"
        }
    ]
}

Methods

person.badge.find

( tokenID, eventID )

GET /api/?action=person.badge.findHTTP/1.1 Host: inevent.us

Verifies counter badges for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

person.badge.get

( tokenID, eventID, target )

GET /api/?action=person.badge.getHTTP/1.1 Host: inevent.us

Verifies counter badge from target target for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

targetGET : target module

person.badge.clear

( tokenID, eventID, target )

GET /api/?action=person.badge.clearHTTP/1.1 Host: inevent.us

Cleans counter badge from target target of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

targetGET : target module

Person devices

Devices can be selected and stored for notification deliveries and statistical purposes.

Models

{
    "count": 1,
    "data": [
        {
            "deviceID": "0",
            "personID": "1300",
            "companyID": "1",
            "model": "0",
            "deviceKey": "ASFasft3121414AF=asF=-12=340124FIJASF@!#$"
        }
    ]
}

Methods

person.device.bind

( tokenID, companyID, model, deviceKey )

POST /api/?action=person.device.bindHTTP/1.1 Host: inevent.us

Creates a device deviceKey for person tokenID.

tokenIDGET : token identifier

companyIDGET : company identifier

modelPOST : phone model (0: Android, 1: iOS)

deviceKeyPOST : GCM/APNS authentication key

person.device.dismiss

( tokenID, companyID, model, deviceKey )

POST /api/?action=person.device.dismissHTTP/1.1 Host: inevent.us

Removes device deviceKey.

tokenIDGET : token identifier

companyIDGET : company identifier

modelPOST : phone model (0: Android, 1: iOS)

deviceKeyPOST : GCM/APNS authentication key

Person favorites

Favorites are leads selected from attendees interest through leads collectors or networking apps.

Models

{
    "count": 1,
    "data": [
        {
            "memberFavoriteID": "1"
        }
    ]
}

Methods

person.favorite.bind

( tokenID, eventID, personID )

GET /api/?action=person.favorite.bindHTTP/1.1 Host: inevent.us

Creates favorite personID for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID, code, source )

GET /api/?action=person.favorite.bindHTTP/1.1 Host: inevent.us

Creates favorite code for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

codeGET : code identifier

sourceGET : list type

{
    "networking": "manual (default)",
    "scanner": "QR scanner"
}

( tokenID, eventID, code, source, *grade, *note )

POST /api/?action=person.favorite.bindHTTP/1.1 Host: inevent.us

Creates favorite code for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

codeGET : code identifier

sourceGET : list type

{
    "networking": "manual (default)",
    "scanner": "QR scanner"
}

*gradePOST : rating

*notePOST : text comment

person.favorite.operate

( tokenID, eventID, key, value, personID )

POST /api/?action=person.favorite.operateHTTP/1.1 Host: inevent.us

Updates value value at field key of favorite tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

keyGET : element name

{
    "grade": "rating"
}

valuePOST : element value

{
    "grade": "integer"
}

personIDGET : person identifier

person.favorite.dismiss

( tokenID, eventID, personID )

GET /api/?action=person.favorite.dismissHTTP/1.1 Host: inevent.us

Removes favorite personID from person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

person.favorite.find

( tokenID, eventID )

GET /api/?action=person.favorite.findHTTP/1.1 Host: inevent.us

Returns all favorites for person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Person streams

Within an activity, you can create a live stream any safe content to your audience. Participants can watch the stream, and in this module, views are counted and logged for compliance.

Models

{
    "count": 1,
    "data": [
        {
            "activityID": "1",
            "personID": "1",
            "dateBegin": "1",
            "dateEnd": "1",
            "engagement": "1"
        }
    ]
}

Methods

person.stream.edit

( tokenID, activityID, key, value )

POST /api/?action=person.stream.editHTTP/1.1 Host: inevent.us

Updates value value at field key at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

keyGET : field name

{
    "dateBegin": "stream start",
    "dateEnd": "stream end"
}

valuePOST : field value

{
    "dateBegin": "timestamp",
    "dateEnd": "timestamp"
}

person.stream.get

( tokenID, activityID, personID )

GET /api/?action=person.stream.getHTTP/1.1 Host: inevent.us

Returns person personID at stream activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

personIDGET : person identifier

Person tags

Tags associated with the profile of each person in an event, generating networking experiences among the participants.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

person.tag.bind

( tokenID, tagID, personID )

GET /api/?action=person.tag.bindHTTP/1.1 Host: inevent.us

Creates tag tagID for person personID.

tokenIDGET : token identifier

tagIDGET : tag identifier

personIDGET : person identifier

( tokenID, tagID )

GET /api/?action=person.tag.bindHTTP/1.1 Host: inevent.us

Creates tag tagID for person tokenID.

tokenIDGET : token identifier

tagIDGET : tag identifier

( tokenID, content )

POST /api/?action=person.tag.bindHTTP/1.1 Host: inevent.us

Creates tags content for person tokenID.

tokenIDGET : token identifier

contentPOST : json content

person.tag.dismiss

( tokenID, tagID, personID )

GET /api/?action=person.tag.dismissHTTP/1.1 Host: inevent.us

Removes tag tagID from person personID.

tokenIDGET : token identifier

tagIDGET : tag identifier

personIDGET : person identifier

( tokenID, tagID )

GET /api/?action=person.tag.dismissHTTP/1.1 Host: inevent.us

Removes tag tagID from person tokenID.

tokenIDGET : token identifier

tagIDGET : tag identifier

person.tag.find

( tokenID, eventID )

GET /api/?action=person.tag.findHTTP/1.1 Host: inevent.us

Returns all person tags at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Photo

Within the event, visual communication is facilitated by an exclusive sequence of photos. While Facebook does not implement on your servers the ability to access such photos by a #hashtag, you need to create your own API to manage such features. Each photo is given a directly associated with a unique url.

Models

{
    "count": 1,
    "data": [
        {
            "photoID": "3",
            "eventID": "1",
            "url": "https:\/\/fbcdn-sphotos-h-a.akamaihd.net\/hphotos-ak-prn1\/s720x720\/556836_10152382307825884_1751135038_n.jpg",
            "date": "1384209522"
        }
    ]
}

Methods

photo.create

( tokenID, eventID, url )

POST /api/?action=photo.createHTTP/1.1 Host: inevent.us

Creates photo at url url at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

urlPOST : photo url

photo.remove

( tokenID, photoID )

GET /api/?action=photo.removeHTTP/1.1 Host: inevent.us

Removes photo photoID.

tokenIDGET : token identifier

photoIDGET : photo identifier

photo.find

( tokenID, eventID )

GET /api/?action=photo.findHTTP/1.1 Host: inevent.us

Returns all photos at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

photo.get

( tokenID, photoID )

GET /api/?action=photo.getHTTP/1.1 Host: inevent.us

Returns photo photoID.

tokenIDGET : token identifier

photoIDGET : photo identifier

Place

Within the event there may be several locations, stages, areas, etc.

Models

{
    "count": 1,
    "data": [
        {
            "placeID": "3",
            "eventID": "1",
            "name": "Stage"
        }
    ]
}

Methods

place.create

( tokenID, eventID, name )

POST /api/?action=place.createHTTP/1.1 Host: inevent.us

Creates place named name at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : place name

place.remove

( tokenID, placeID )

GET /api/?action=place.removeHTTP/1.1 Host: inevent.us

Removes place placeID.

tokenIDGET : token identifier

placeIDGET : place identifier

place.find

( tokenID, eventID )

GET /api/?action=place.findHTTP/1.1 Host: inevent.us

Returns all places at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

place.get

( tokenID, placeID )

GET /api/?action=place.getHTTP/1.1 Host: inevent.us

Returns place placeID.

tokenIDGET : token identifier

placeIDGET : place identifier

Placeholder

Fixed signs can be customized to contain information tailored to the needs of each event. Thus, placeholders are ways of replacing these fixed texts. There are specific types that can be used, listed within the options for creating a placeholder.

Models

{
    "count": 1,
    "data": [
        {
            "placeholderID": "1",
            "companyID": "32",
            "eventID": "6173",
            "type": "formName",
            "value": "Default title",
            "date": "1492481793"
        }
    ]
}

Methods

placeholder.create

( tokenID, eventID, type, *value )

POST /api/?action=placeholder.createHTTP/1.1 Host: inevent.us

Creates a placeholder at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

typePOST : placeholder type

*valuePOST : placeholder value

( tokenID, companyID, type, *value )

POST /api/?action=placeholder.createHTTP/1.1 Host: inevent.us

Creates a placeholder at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

typePOST : placeholder type

*valuePOST : placeholder value

placeholder.remove

( tokenID, placeholderID )

GET /api/?action=placeholder.removeHTTP/1.1 Host: inevent.us

Removes placeholder placeholderID.

tokenIDGET : token identifier

placeholderIDGET : placeholder identifier

placeholder.find

( companyID )

GET /api/?action=placeholder.findHTTP/1.1 Host: inevent.us

Returns all placeholders from company companyID.

companyIDGET : company identifier

( tokenID, eventID )

GET /api/?action=placeholder.findHTTP/1.1 Host: inevent.us

Returns all placeholders from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

placeholder.get

( tokenID, placeholderID )

GET /api/?action=placeholder.getHTTP/1.1 Host: inevent.us

Returns placeholder placeholderID.

tokenIDGET : token identifier

placeholderIDGET : placeholder identifier

Profile

Set usage profile for event or business administrators.

Models

{
    "count": 1,
    "data": [
        {
            "companyID": "",
            "eventID": "",
            "name": ""
        }
    ]
}

Methods

profile.create

( tokenID, companyID, name )

POST /api/?action=profile.createHTTP/1.1 Host: inevent.us

Creates a profile for admins of company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

namePOST : profile name

( tokenID, eventID, name )

POST /api/?action=profile.createHTTP/1.1 Host: inevent.us

Creates a profile for admins of event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : profile name

profile.edit

( tokenID, profileID, key, value )

POST /api/?action=profile.editHTTP/1.1 Host: inevent.us

Edits value value from field key of profile profileID.

tokenIDGET : token identifier

profileIDGET : profile identifier

keyGET : field name

{
    "name": "profile name",
    "description": "profile description"
}

valuePOST : field value

{
    "name": "string",
    "description": "string"
}

profile.remove

( tokenID, profileID )

GET /api/?action=profile.removeHTTP/1.1 Host: inevent.us

Removes profile profileID.

tokenIDGET : token identifier

profileIDGET : profile identifier

profile.find

( tokenID, companyID )

GET /api/?action=profile.findHTTP/1.1 Host: inevent.us

Returns all profiles for company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

( tokenID, eventID )

GET /api/?action=profile.findHTTP/1.1 Host: inevent.us

Returns all profiles for event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Profile permissions

Set permissions for the usage profile.

Models

{
    "count": 1,
    "data": [
        {
            "profilePermissionID": "",
            "profileID": "",
            "key": ""
        }
    ]
}

Methods

profile.permission.bind

( tokenID, profileID, key )

POST /api/?action=profile.permission.bindHTTP/1.1 Host: inevent.us

Creates a permission for profile profileID.

tokenIDGET : token identifier

profileIDGET : profile identifier

keyPOST : permission key

profile.permission.dismiss

( tokenID, profileID, key )

GET /api/?action=profile.permission.dismissHTTP/1.1 Host: inevent.us

Removes permission key from profile profileID.

tokenIDGET : token identifier

profileIDGET : profile identifier

keyGET : permission key

profile.permission.find

( tokenID, profileID )

GET /api/?action=profile.permission.findHTTP/1.1 Host: inevent.us

Returns all permissions from profile profileID.

tokenIDGET : token identifier

profileIDGET : profile identifier

Profile admins

Manage admins for different usage profiles.

Models

{
    "count": 1,
    "data": [
        {
            "profilePermissionID": "",
            "profileID": "",
            "personID": ""
        }
    ]
}

Methods

profile.person.bind

( tokenID, profileID, personID )

GET /api/?action=profile.person.bindHTTP/1.1 Host: inevent.us

Creates person personID at profile profileID.

tokenIDGET : token identifier

profileIDGET : profile identifier

personIDGET : person identifier

profile.person.dismiss

( tokenID, profileID, personID )

GET /api/?action=profile.person.dismissHTTP/1.1 Host: inevent.us

Removes person personID from profile profileID.

tokenIDGET : token identifier

profileIDGET : profile identifier

personIDGET : person identifier

profile.person.find

( tokenID, profileID )

GET /api/?action=profile.person.findHTTP/1.1 Host: inevent.us

Returns everyone on profile profileID.

tokenIDGET : token identifier

profileIDGET : profile identifier

Question

Within the activity, several actions may occur, such as questions to interact with the audience present.

Models

{
    "count": 1,
    "data": [
        {
            "questionID": "1",
            "personName": "InEvent",
            "personID": "1",
            "text": "Who is speaking?",
            "date": "1400025600",
            "approved": "0",
            "votes": "1",
            "upvoted": "0"
        }
    ]
}

Methods

question.create

( tokenID, activityID, text )

POST /api/?action=question.createHTTP/1.1 Host: inevent.us

Creates a question at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

textPOST : question text

question.edit

( tokenID, questionID, key, value )

POST /api/?action=question.editHTTP/1.1 Host: inevent.us

Updates value value at field key at question questionID.

tokenIDGET : token identifier

questionIDGET : question identifier

keyGET : field name

{
    "approved": "approved"
}

valuePOST : field value

{
    "approved": "bit"
}

question.remove

( tokenID, questionID )

GET /api/?action=question.removeHTTP/1.1 Host: inevent.us

Removea question questionID.

tokenIDGET : token identifier

questionIDGET : question identifier

question.find

( tokenID, activityID, selection )

GET /api/?action=question.findHTTP/1.1 Host: inevent.us

Returns all questions at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

selectionGET : selection

{
    "all": "all questions",
    "approved+me": "questions approved plus mine"
}

( tokenID, eventID )

GET /api/?action=question.findHTTP/1.1 Host: inevent.us

Returns all questions at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

question.get

( tokenID, questionID )

GET /api/?action=question.getHTTP/1.1 Host: inevent.us

Returns question questionID.

tokenIDGET : token identifier

questionIDGET : question identifier

question.upvote

( tokenID, questionID )

GET /api/?action=question.upvoteHTTP/1.1 Host: inevent.us

Gives a positive vote to question questionID.

tokenIDGET : token identifier

questionIDGET : question identifier

question.downvote

( tokenID, questionID )

GET /api/?action=question.downvoteHTTP/1.1 Host: inevent.us

Removes positive vote from question questionID.

tokenIDGET : token identifier

questionIDGET : question identifier

Screen

Records user screen for internal usage.

Models

{
    "count": 1,
    "data": [
        {
            "companyID": "",
            "eventID": "",
            "personID": "",
            "page": "",
            "json": "",
            "date": "1415152800"
        }
    ]
}

Methods

screen.create

( tokenID, companyID, page, json )

POST /api/?action=screen.createHTTP/1.1 Host: inevent.us

Creates a screen recording at companyID on page page with contents json.

tokenIDGET : token identifier

companyIDGET : company identifier

pagePOST : page recorded

jsonPOST : recording contents

( tokenID, eventID, page, json )

POST /api/?action=screen.createHTTP/1.1 Host: inevent.us

Creates a screen recording at eventID on page page with contents json.

tokenIDGET : token identifier

eventIDGET : event identifier

pagePOST : page recorded

jsonPOST : recording contents

screen.find

( tokenID, companyID, page )

GET /api/?action=screen.findHTTP/1.1 Host: inevent.us

Finds screen recordings at companyID on page page.

tokenIDGET : token identifier

companyIDGET : company identifier

pageGET : page recorded

( tokenID, eventID, page )

GET /api/?action=screen.findHTTP/1.1 Host: inevent.us

Finds screen recordings at eventID on page page.

tokenIDGET : token identifier

eventIDGET : company identifier

pageGET : page recorded

Transfer

Events can provide transfer options for your participants and manage all expenses incurred.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "personID": "",
            "departure": "",
            "arrival": "",
            "dateBegin": "",
            "dateEnd": "",
            "confirmation": "",
            "licensePlate": "",
            "carModel": "",
            "driverName": "",
            "price": "",
            "date": "1415152800"
        }
    ]
}

Methods

shuttle.create

( tokenID, eventID, personID, departure, arrival, dateBegin, dateEnd, price, *licensePlate, *carModel, *driverName, *confirmation )

POST /api/?action=shuttle.createHTTP/1.1 Host: inevent.us

Creates a transfer at event eventID for person personID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

departurePOST : transfer departure location

arrivalPOST : transfer arrival location

dateBeginPOST : transfer departure date

dateEndPOST : transfer arrival date

pricePOST : transfer pricing

*licensePlatePOST : car plate

*carModelPOST : car model

*driverNamePOST : driver name

*confirmationPOST : transfer confirmation code

( tokenID, eventID, email, departure, arrival, dateBegin, dateEnd, price, *licensePlate, *carModel, *driverName, *confirmation )

POST /api/?action=shuttle.createHTTP/1.1 Host: inevent.us

Creates a transfer at event eventID for person email.

tokenIDGET : token identifier

eventIDGET : event identifier

emailPOST : email da pessoa

departurePOST : transfer departure location

arrivalPOST : transfer arrival location

dateBeginPOST : transfer departure date

dateEndPOST : transfer arrival date

pricePOST : transfer pricing

*licensePlatePOST : car plate

*carModelPOST : car model

*driverNamePOST : driver name

*confirmationPOST : transfer confirmation code

( tokenID, eventID, path )

POST /api/?action=shuttle.createHTTP/1.1 Host: inevent.us

Creates multiple transfers at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

shuttle.edit

( tokenID, shuttleID, key, value )

POST /api/?action=shuttle.editHTTP/1.1 Host: inevent.us

Edits value value from field key of shuttle shuttleID.

tokenIDGET : token identifier

shuttleIDGET : shuttle identifier

keyGET : field name

valuePOST : field value

shuttle.remove

( tokenID, shuttleID )

GET /api/?action=shuttle.removeHTTP/1.1 Host: inevent.us

Removes transfer shuttleID from event.

tokenIDGET : token identifier

shuttleIDGET : transfer identifier

shuttle.find

( tokenID, eventID, personID )

GET /api/?action=shuttle.findHTTP/1.1 Host: inevent.us

Returns all transfers of person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID, selection )

GET /api/?action=shuttle.findHTTP/1.1 Host: inevent.us

Returns all transfers from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : search selection

{
    "all": "all transfers"
}

( tokenID, eventID )

GET /api/?action=shuttle.findHTTP/1.1 Host: inevent.us

Returns all transfers from person tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Speaker

During an event, there are several speakers who will be able to present during the activities. Each one is assigned can be associated with various activities.

Models

{
    "count": 1,
    "data": [
        {
            "speakerID": "1",
            "eventID": "1",
            "name": "InEvent",
            "headline": "InEvent",
            "description": "InEvent",
            "position": "3",
            "image": "http:\/\/",
            "email": "email@email.com",
            "facebook": "http:\/\/",
            "linkedIn": "http:\/\/",
            "twitter": "http:\/\/",
            "activities": [
                {
                    "activityID": "5"
                },
                {
                    "activityID": "7"
                }
            ]
        }
    ]
}

Methods

speaker.create

( tokenID, eventID, name, *headline, *image )

POST /api/?action=speaker.createHTTP/1.1 Host: inevent.us

Creates a speaker named name at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : speaker name

*headlinePOST : speaker headline

*imagePOST : speaker image

( tokenID, eventID, path )

POST /api/?action=speaker.createHTTP/1.1 Host: inevent.us

Creates multiple speakers at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

speaker.edit

( tokenID, speakerID, key, value )

POST /api/?action=speaker.editHTTP/1.1 Host: inevent.us

Updates value value at field key of speaker speakerID.

tokenIDGET : token identifier

speakerIDGET : speaker identifier

keyGET : field name

{
    "name": "name",
    "headline": "role and company",
    "description": "description",
    "position": "enrollment number",
    "image": "image",
    "email": "email",
    "facebook": "url",
    "linkedIn": "url",
    "twitter": "url"
}

valuePOST : field value

{
    "name": "string",
    "headline": "string",
    "description": "string",
    "position": "integer",
    "image": "string",
    "email": "string",
    "facebook": "string",
    "linkedIn": "string",
    "twitter": "string"
}

speaker.remove

( tokenID, speakerID )

GET /api/?action=speaker.removeHTTP/1.1 Host: inevent.us

Removes speaker speakerID.

tokenIDGET : token identifier

speakerIDGET : speaker identifier

speaker.find

( tokenID, companyID )

GET /api/?action=speaker.findHTTP/1.1 Host: inevent.us

Returns all speakers from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

( tokenID, eventID )

GET /api/?action=speaker.findHTTP/1.1 Host: inevent.us

Returns all speakers from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

( eventID )

GET /api/?action=speaker.findHTTP/1.1 Host: inevent.us

Returns all speakers from event eventID which are visible and public.

eventIDGET : event identifier

speaker.get

( tokenID, speakerID )

GET /api/?action=speaker.getHTTP/1.1 Host: inevent.us

Returns speaker speakerID.

tokenIDGET : token identifier

speakerIDGET : speaker identifier

( speakerID )

GET /api/?action=speaker.getHTTP/1.1 Host: inevent.us

Returns speaker speakerID which is visible and public.

speakerIDGET : speaker identifier

Speaker tags

Tags associated to the speaker, bringing search capabilities and tagging methods to information and selection.

Models

{
    "count": 1,
    "data": [
        {
            "speakerID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

speaker.tag.bind

( tokenID, speakerID, tagID )

GET /api/?action=speaker.tag.bindHTTP/1.1 Host: inevent.us

Creates tag tagID at speaker speakerID.

tokenIDGET : token identifier

speakerIDGET : speaker identifier

tagIDGET : tag identifier

speaker.tag.dismiss

( tokenID, speakerID, tagID )

GET /api/?action=speaker.tag.dismissHTTP/1.1 Host: inevent.us

Removes tag tagID from speaker speakerID.

tokenIDGET : token identifier

speakerIDGET : speaker identifier

tagIDGET : tag identifier

speaker.tag.find

( tokenID, speakerID )

GET /api/?action=speaker.tag.findHTTP/1.1 Host: inevent.us

Returns all speaker speakerID tags.

tokenIDGET : token identifier

speakerIDGET : speaker identifier

( speakerID )

GET /api/?action=speaker.tag.findHTTP/1.1 Host: inevent.us

Returns all speaker speakerID tags.

speakerIDGET : speaker identifier

Sponsor

Sponsors are part of large events such as fairs or congresses. They have the power to expose your brand in a number of ways, using the various details in your profile.

Models

{
    "count": 1,
    "data": [
        {
            "sponsorID": "1",
            "eventID": "1",
            "companyName": "InEvent",
            "contactName": "InEvent",
            "telephone": "000-000-0000",
            "email": "email@email.com",
            "website": "www.email.com",
            "bio": "some history",
            "logo": "\/path\/to\/logo",
            "category": "gold"
        }
    ]
}

Methods

sponsor.create

( tokenID, eventID, companyName, *contactName, *telephone, *email, *website, *bio, *logo, *category )

POST /api/?action=sponsor.createHTTP/1.1 Host: inevent.us

Creates a sponsor at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

companyNamePOST : company name

*contactNamePOST : contact name

*telephonePOST : contact telephone

*emailPOST : contact email

*websitePOST : sponsor website

*bioPOST : sponsor bio

*logoPOST : sponsor logo url

*categoryPOST : sponsor category

( tokenID, eventID, path )

POST /api/?action=sponsor.createHTTP/1.1 Host: inevent.us

Creates multiple sponsors at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file url

sponsor.edit

( tokenID, eventID, sponsorID, key, value )

POST /api/?action=sponsor.editHTTP/1.1 Host: inevent.us

Updates value value at field key of sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

keyGET : field name

{
    "companyName": "string",
    "name": "string",
    "telephone": "string",
    "email": "string",
    "website": "string",
    "bio": "string",
    "logo": "string",
    "category": "string",
    "visible": "string"
}

valuePOST : field value

sponsor.remove

( tokenID, eventID, sponsorID )

GET /api/?action=sponsor.removeHTTP/1.1 Host: inevent.us

Removes sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

sponsor.find

( tokenID, companyID )

GET /api/?action=sponsor.findHTTP/1.1 Host: inevent.us

Returns all sponsors from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

( tokenID, eventID, categorized, *companyName, *name, *email, *telephone, *order )

GET /api/?action=sponsor.findHTTP/1.1 Host: inevent.us

Returns all sponsors from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

categorizedGET : categories format

*companyNameGET : company name

*nameGET : contact name

*emailGET : contact email

*telephoneGET : contact telephone

*orderGET : order

( tokenID, eventID, categorized )

GET /api/?action=sponsor.findHTTP/1.1 Host: inevent.us

Returns all sponsors from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

categorizedGET : categories format

( eventID, categorized, *companyName, *name, *email, *telephone, *order )

GET /api/?action=sponsor.findHTTP/1.1 Host: inevent.us

Returns all sponsors from event eventID which are visible and public.

eventIDGET : event identifier

categorizedGET : categories format

*companyNameGET : company name

*nameGET : contact name

*emailGET : contact email

*telephoneGET : contact telephone

*orderGET : order

( eventID, categorized )

GET /api/?action=sponsor.findHTTP/1.1 Host: inevent.us

Returns all sponsors from event eventID which are visible and public.

eventIDGET : event identifier

categorizedGET : categories format

sponsor.get

( tokenID, sponsorID )

GET /api/?action=sponsor.getHTTP/1.1 Host: inevent.us

Returns sponsor sponsorID.

tokenIDGET : token identifier

sponsorIDGET : sponsor identifier

( sponsorID )

GET /api/?action=sponsor.getHTTP/1.1 Host: inevent.us

Returns sponsor sponsorID which is visible and public.

sponsorIDGET : sponsor identifier

sponsor.favorites

( tokenID, eventID, sponsorID )

GET /api/?action=sponsor.favoritesHTTP/1.1 Host: inevent.us

Returns all sponsor sponsorID favorites.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

sponsor.remainingQuota

( tokenID, eventID )

GET /api/?action=sponsor.remainingQuotaHTTP/1.1 Host: inevent.us

Retorna as sponsor quotas for persn personID.

tokenIDGET : token identifier

eventIDGET : event identifier

Sponsor categories

Organize categories of event sponsors.

Models

{
    "count": 1,
    "data": [
        {
            "sponsorCategoryID": 1,
            "eventID": "1",
            "name": "Gold",
            "position": 1
        }
    ]
}

Methods

sponsor.category.create

( tokenID, eventID, name, *position )

POST /api/?action=sponsor.category.createHTTP/1.1 Host: inevent.us

Creates sponsor category at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : category name

*positionPOST : category order

sponsor.category.edit

( tokenID, eventID, sponsorCategoryID, key, value )

POST /api/?action=sponsor.category.editHTTP/1.1 Host: inevent.us

Updates value value at field key at category sponsorCategoryID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorCategoryIDGET : category identifier

keyGET : field name

{
    "name": "string",
    "position": "integer"
}

valuePOST : field value

sponsor.category.remove

( tokenID, eventID, sponsorCategoryID )

GET /api/?action=sponsor.category.removeHTTP/1.1 Host: inevent.us

Removes category sponsorCategoryID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorCategoryIDGET : category identifier

sponsor.category.get

( tokenID, eventID, name )

GET /api/?action=sponsor.category.getHTTP/1.1 Host: inevent.us

Returns sponsor category at event eventID with name name.

tokenIDGET : token identifier

eventIDGET : event identifier

nameGET : category name

sponsor.category.find

( tokenID, eventID )

GET /api/?action=sponsor.category.findHTTP/1.1 Host: inevent.us

Returns all sponsor categories at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Sponsor invites

Guests associated with a particular sponsor may receive different notifications upon arrival and departure of the event.

Models

{
    "count": 1,
    "data": [
        {
            "personID": "1",
            "sponsorID": "1579"
        }
    ]
}

Methods

sponsor.invite.bind

( tokenID, eventID, sponsorID, name, username )

POST /api/?action=sponsor.invite.bindHTTP/1.1 Host: inevent.us

Creates a person named name and user username at sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

namePOST : person name

usernamePOST : pessoa username

sponsor.invite.dismiss

( tokenID, eventID, sponsorID, personID )

GET /api/?action=sponsor.invite.dismissHTTP/1.1 Host: inevent.us

Removes person personID from sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

personIDGET : person identifier

sponsor.invite.find

( tokenID, eventID, sponsorID )

GET /api/?action=sponsor.invite.findHTTP/1.1 Host: inevent.us

Returns all sponsor sponsorID invites.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

Sponsor admins

Sponsor administrators can access special features such as lead collector, receive notifications of guest arrivals, or manage their leads at the event.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "5919",
            "sponsorID": "1579",
            "personID": "1"
        }
    ]
}

Methods

sponsor.person.bind

( tokenID, eventID, sponsorID, name, username )

POST /api/?action=sponsor.person.bindHTTP/1.1 Host: inevent.us

Creates a person named name and user username at sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

namePOST : person name

usernamePOST : person username

( tokenID, eventID, sponsorID, personID )

GET /api/?action=sponsor.person.bindHTTP/1.1 Host: inevent.us

Creates person personID at sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

personIDGET : person identifier

( tokenID, eventID, path )

POST /api/?action=sponsor.person.bindHTTP/1.1 Host: inevent.us

Creates multiple sponsor admins at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

sponsor.person.dismiss

( tokenID, eventID, sponsorID, personID )

GET /api/?action=sponsor.person.dismissHTTP/1.1 Host: inevent.us

Removes person personID from sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

personIDGET : person identifier

sponsor.person.find

( tokenID, eventID, sponsorID )

GET /api/?action=sponsor.person.findHTTP/1.1 Host: inevent.us

Returns everyone at sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

sponsor.person.get

( tokenID, eventID, sponsorID, personID )

GET /api/?action=sponsor.person.getHTTP/1.1 Host: inevent.us

Returns person personID at sponsor sponsorID.

tokenIDGET : token identifier

eventIDGET : event identifier

sponsorIDGET : sponsor identifier

personIDGET : person identifier

Sponsor tags

Tags associated to the sponsor, generating facilities in determining the interests of the participants in the materials.

Models

{
    "count": 1,
    "data": [
        {
            "sponsorID": "1",
            "tagID": "1300"
        }
    ]
}

Methods

sponsor.tag.bind

( tokenID, sponsorID, tagID )

GET /api/?action=sponsor.tag.bindHTTP/1.1 Host: inevent.us

Creates tag tagID at sponsor sponsorID.

tokenIDGET : token identifier

sponsorIDGET : sponsor identifier

tagIDGET : tag identifier

sponsor.tag.dismiss

( tokenID, sponsorID, tagID )

GET /api/?action=sponsor.tag.dismissHTTP/1.1 Host: inevent.us

Removes tag tagID from sponsor sponsorID.

tokenIDGET : token identifier

sponsorIDGET : sponsor identifier

tagIDGET : tag identifier

sponsor.tag.find

( tokenID, sponsorID )

GET /api/?action=sponsor.tag.findHTTP/1.1 Host: inevent.us

Returns all sponsor sponsorID tags.

tokenIDGET : token identifier

sponsorIDGET : sponsor identifier

( sponsorID )

GET /api/?action=sponsor.tag.findHTTP/1.1 Host: inevent.us

Returns all sponsor sponsorID tags.

sponsorIDGET : sponsor identifier

Quiz

Within the activity, several actions may occur, such as to interact with the audience present. For each quiz, you can enter a response by choosing one of the available options.

Models

{
    "count": 1,
    "data": [
        {
            "quizID": "5",
            "activityID": "3",
            "text": "Question",
            "active": "0",
            "public": "0",
            "hasAnswered": "0",
            "personAnswer": "0",
            "answers": "2",
            "options": [
                {
                    "quizOptionID": "5",
                    "text": "Answer"
                }
            ],
            "results": [
                {
                    "quizOptionID": "5",
                    "count": "2"
                }
            ],
            "members": [
                {
                    "quizOptionID": "5",
                    "personID": "36",
                    "personName": "InEvent"
                }
            ]
        }
    ]
}

Push Notification

quiz/create

_activity

Notifies quiz quizID creation.

{
    "quizID": "integer"
}

Methods

quiz.create

( tokenID, activityID, text )

POST /api/?action=quiz.createHTTP/1.1 Host: inevent.us

Creates quiz at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

textPOST : quiz text=

quiz.edit

( tokenID, quizID, key, value )

POST /api/?action=quiz.editHTTP/1.1 Host: inevent.us

Updates value value at field key at quiz quizID.

tokenIDGET : token identifier

quizIDGET : quiz identifier

keyGET : field name

{
    "text": "text",
    "active": "active",
    "public": "public"
}

valuePOST : field value

{
    "text": "string",
    "active": "integer",
    "public": "integer"
}

quiz.remove

( tokenID, quizID )

GET /api/?action=quiz.removeHTTP/1.1 Host: inevent.us

Removes quiz quizID.

tokenIDGET : token identifier

quizIDGET : quiz identifier

quiz.find

( tokenID, activityID )

GET /api/?action=quiz.findHTTP/1.1 Host: inevent.us

Returns all quizzes at activity activityID.

tokenIDGET : token identifier

activityIDGET : activity identifier

( tokenID, eventID, *answers )

GET /api/?action=quiz.findHTTP/1.1 Host: inevent.us

Returns all quizzes at eventID activities.

tokenIDGET : token identifier

eventIDGET : event identifier

*answersGET : optional answers

quiz.get

( tokenID, quizID, *answers )

GET /api/?action=quiz.getHTTP/1.1 Host: inevent.us

Returns quiz quizID.

tokenIDGET : token identifier

quizIDGET : quiz identifier

*answersGET : optional answers

quiz.pushNotification

( tokenID, quizID )

GET /api/?action=quiz.pushNotificationHTTP/1.1 Host: inevent.us

Sends a push notification for all quiz quizID attendees.

tokenIDGET : token identifier

quizIDGET : quiz identifier

quiz.respond

( tokenID, quizOptionID )

GET /api/?action=quiz.respondHTTP/1.1 Host: inevent.us

Answer quiz quizID with option quizOptionID.

tokenIDGET : token identifier

quizOptionIDGET : quiz option identifier

Quiz options

For each quiz, several options may be accompanied by their respective texts.

Methods

quiz.option.create

( tokenID, quizID, *text, *image )

POST /api/?action=quiz.option.createHTTP/1.1 Host: inevent.us

Creates option at quiz quizID.

tokenIDGET : token identifier

quizIDGET : quiz identifier

*textPOST : option text

*imagePOST : option image

quiz.option.remove

( tokenID, quizOptionID )

GET /api/?action=quiz.option.removeHTTP/1.1 Host: inevent.us

Removes option quizOptionID.

tokenIDGET : token identifier

quizOptionIDGET : quiz option identifier

Tag

Within the event, there are tags that can be associated with different parts of the event, such as activities and people.

Models

{
    "count": 1,
    "data": [
        {
            "tagID": "3",
            "eventID": "1",
            "name": "Marketing",
            "color": "#333333",
            "type": "person"
        }
    ]
}

Methods

tag.create

( tokenID, companyID, name, color )

POST /api/?action=tag.createHTTP/1.1 Host: inevent.us

Adds tag name with color color to company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

namePOST : tag name

colorPOST : tag color

( tokenID, eventID, name, color )

POST /api/?action=tag.createHTTP/1.1 Host: inevent.us

Adds tag name with color color to event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : tag name

colorPOST : tag color

tag.edit

( tokenID, tagID, key, value )

POST /api/?action=tag.editHTTP/1.1 Host: inevent.us

Updates value value at field key at tag tagID.

tokenIDGET : token identifier

tagIDGET : tag identifier

keyGET : field name

{
    "name": "name",
    "color": "color",
    "type": "tipo de tag"
}

valuePOST : field value

{
    "name": "string",
    "color": "string",
    "type": "enum(person|activity|both)"
}

tag.remove

( tokenID, tagID )

GET /api/?action=tag.removeHTTP/1.1 Host: inevent.us

Removes tag tagID.

tokenIDGET : token identifier

tagIDGET : tag identifier

tag.find

( tokenID, companyID, *selection )

GET /api/?action=tag.findHTTP/1.1 Host: inevent.us

Returns all tags at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

*selectionGET : tags selection

{
    "all": "all tags",
    "person": "people tags",
    "activity": "activities tags"
}

( tokenID, eventID, *selection )

GET /api/?action=tag.findHTTP/1.1 Host: inevent.us

Returns all tags at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

*selectionGET : tags selection

{
    "all": "all tags",
    "person": "people tags",
    "activity": "activities tags"
}

tag.get

( tokenID, tagID )

GET /api/?action=tag.getHTTP/1.1 Host: inevent.us

Returns tag tagID.

tokenIDGET : token identifier

tagIDGET : tag identifier

Tasks

Create and manage tasks assigned to multiple stakeholders at the event, including any general or specific activity required for the event success.

Models

{
    "count": 1,
    "data": [
        []
    ]
}

Methods

task.create

( tokenID, eventID, name )

POST /api/?action=task.createHTTP/1.1 Host: inevent.us

Creates a task at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : task name

( tokenID, eventID, path )

POST /api/?action=task.createHTTP/1.1 Host: inevent.us

Creates multiple tasks at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : file path

task.edit

( tokenID, taskID, key, value )

POST /api/?action=task.editHTTP/1.1 Host: inevent.us

Changes a task taskID at event eventID

tokenIDGET : token identifier

taskIDGET : task identifier

keyGET : field name

valuePOST : field value

task.remove

( tokenID, eventID, taskID )

GET /api/?action=task.removeHTTP/1.1 Host: inevent.us

Removes a task taskID from event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

taskIDGET : task identifier

task.find

( tokenID, eventID, *paginated, *query )

GET /api/?action=task.findHTTP/1.1 Host: inevent.us

Finds all tasks at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

*paginatedGET : request to be paginated

*queryGET : search field

task.get

( tokenID, eventID, taskID )

GET /api/?action=task.getHTTP/1.1 Host: inevent.us

Gathers a task taskID at event eventID

tokenIDGET : token identifier

eventIDGET : event identifier

taskIDGET : task identifier

Event templates

Create templates to easily generate events with the same type using the same company.

Models

{
    "count": 1,
    "data": [
        {
            "eventTemplateID": "28962",
            "eventID": "6173",
            "template": "",
            "clean": "1",
            "reason": "",
            "date": "1516294405"
        }
    ]
}

Methods

template.event.create

( tokenID, companyID, name, color )

POST /api/?action=template.event.createHTTP/1.1 Host: inevent.us

Creates template name at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

namePOST : template name

colorPOST : template color

template.event.edit

( tokenID, templateEventID, key, value )

POST /api/?action=template.event.editHTTP/1.1 Host: inevent.us

Edits value value from field key from template templateEventID.

tokenIDGET : token identifier

templateEventIDGET : template identifier

keyGET : field name

{
    "name": "template name"
}

valuePOST : field value

{
    "name": "string"
}

template.event.find

( tokenID, companyID )

GET /api/?action=template.event.findHTTP/1.1 Host: inevent.us

Returns all templates from company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

template.event.get

( tokenID, templateEventID )

GET /api/?action=template.event.getHTTP/1.1 Host: inevent.us

Returns template templateEventID.

tokenIDGET : token identifier

templateEventIDGET : template identifier

Theme

Events are always associated with ideas and trends. To better connect the different structures in an event, whether the event itself, its activities or its participants, themes are ways to offer a context more suitable for this purpose.

Models

{
    "count": 1,
    "data": [
        {
            "id": "1",
            "name": "Business management"
        }
    ]
}

Methods

theme.find

( )

GET /api/?action=theme.findHTTP/1.1 Host: inevent.us

Returns all themes.

( name )

GET /api/?action=theme.findHTTP/1.1 Host: inevent.us

Returns all themes for query searchQuery.

nameGET : query search

theme.get

( themeID )

GET /api/?action=theme.getHTTP/1.1 Host: inevent.us

Returns theme themeID.

themeIDGET : theme identifier

Ticket

In order to access an event, tickets may be required to control sales and event revenue. Each sale has its limits defined by start / end dates, or which one exhaust first.

Models

{
    "count": 1,
    "data": [
        {
            "ticketID": "1",
            "name": "First batch",
            "description": "Early bidder access",
            "dateBegin": "1400248133",
            "dateEnd": "1400248133",
            "capacity": "200",
            "price": "20",
            "batch": "1",
            "sold": "190"
        }
    ]
}

Methods

ticket.create

( tokenID, eventID, name )

POST /api/?action=ticket.createHTTP/1.1 Host: inevent.us

Creates a ticket at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

namePOST : ticket title

( tokenID, eventID, path )

POST /api/?action=ticket.createHTTP/1.1 Host: inevent.us

Creates a ticket at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

pathPOST : sheet url

ticket.edit

( tokenID, ticketID, key, value )

POST /api/?action=ticket.editHTTP/1.1 Host: inevent.us

Updates value value at field key at event eventID.

tokenIDGET : token identifier

ticketIDGET : ticket identifier

keyGET : field name

{
    "name": "batch name",
    "description": "ticket description",
    "dateBegin": "ticket sales begin",
    "dateEnd": "ticket sales end",
    "capacity": "ticket capacity",
    "price": "ticket pricing"
}

valuePOST : field value

{
    "name": "string",
    "description": "string",
    "dateBegin": "timestamp",
    "dateEnd": "timestamp",
    "capacity": "integer",
    "price": "float"
}

ticket.remove

( tokenID, ticketID )

GET /api/?action=ticket.removeHTTP/1.1 Host: inevent.us

Removes ticket ticketID.

tokenIDGET : token identifier

ticketIDGET : ticket identifier

ticket.find

( tokenID, eventID )

GET /api/?action=ticket.findHTTP/1.1 Host: inevent.us

Returns all tickets at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

( eventID )

GET /api/?action=ticket.findHTTP/1.1 Host: inevent.us

Returns all tickets at event eventID.

eventIDGET : event identifier

ticket.get

( tokenID, ticketID )

GET /api/?action=ticket.getHTTP/1.1 Host: inevent.us

Returns ticket ticketID.

tokenIDGET : token identifier

ticketIDGET : ticket identifier

ticket.pay

( tokenID, eventID, content )

POST /api/?action=ticket.payHTTP/1.1 Host: inevent.us

Pays for a ticket batch.

tokenIDGET : token identifier

eventIDGET : event identifier

contentPOST : json com os dados

ticket.lastBilling

( tokenID, eventID )

GET /api/?action=ticket.lastBillingHTTP/1.1 Host: inevent.us

Returns most recent billing details for tokenID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Ticket discounts

Each ticket may apply additional discounts for different sets and business rules.

Models

{
    "count": 1,
    "data": [
        {
            "ticketDiscountID": "1",
            "ticketID": "1",
            "tickets": "5",
            "discount": "10"
        }
    ]
}

Methods

ticket.discount.bind

( tokenID, ticketID, tickets, discount )

POST /api/?action=ticket.discount.bindHTTP/1.1 Host: inevent.us

Creates a discount for tickets with percentage discount for ticket ticketID.

tokenIDGET : token identifier

ticketIDGET : ticket identifier

ticketsPOST : ticket activation amount

discountPOST : discount percentage

ticket.discount.dismiss

( tokenID, ticketDiscountID )

GET /api/?action=ticket.discount.dismissHTTP/1.1 Host: inevent.us

Removes discount ticketDiscountID from its ticket.

tokenIDGET : token identifier

ticketDiscountIDGET : discount identifier

ticket.discount.find

( ticketID )

GET /api/?action=ticket.discount.findHTTP/1.1 Host: inevent.us

Returns all discounts for ticket ticketID

ticketIDGET : ticket identifier

Ticket lists

Each ticket may have associated lists in which only they will have access to purchase tickets.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "333",
            "ticketID": "33",
            "listID": "3"
        }
    ]
}

Methods

ticket.list.bind

( tokenID, listID, ticketID )

GET /api/?action=ticket.list.bindHTTP/1.1 Host: inevent.us

Requests ticket ticketID insertion on list listID.

tokenIDGET : token identifier

listIDGET : list identifier

ticketIDGET : ticket identifier

ticket.list.dismiss

( tokenID, listID, ticketID )

GET /api/?action=ticket.list.dismissHTTP/1.1 Host: inevent.us

Removes ticket ticketID from list listID.

tokenIDGET : token identifier

listIDGET : list identifier

ticketIDGET : ticket identifier

ticket.list.find

( tokenID, ticketID )

GET /api/?action=ticket.list.findHTTP/1.1 Host: inevent.us

Returns all lists from ticket ticketID.

tokenIDGET : token identifier

ticketIDGET : ticket identifier

Ticket buyers

Buyers for each ticket have a series of attached information providing dates, usage, activations, names, descriptions and additional details for your event management.

Models

{
    "count": 1,
    "data": [
        {
            "ticketPersonID": "23",
            "ticketID": "146",
            "personID": "1",
            "paymentID": "",
            "eventID": "6173",
            "name": "TICKET ALL",
            "description": "",
            "entrance": "Portão C",
            "price": "0",
            "ready": "1",
            "inUse": "1",
            "inviteEmail": "",
            "dateCreated": "1519140621",
            "dateUpdated": "1519140621",
            "inUsePersonID": "",
            "personName": "",
            "personEmail": "",
            "chainName": ""
        }
    ]
}

Methods

ticket.person.find

( tokenID, eventID, personID )

GET /api/?action=ticket.person.findHTTP/1.1 Host: inevent.us

Returns all tickets for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, eventID )

GET /api/?action=ticket.person.findHTTP/1.1 Host: inevent.us

Returns all ticket buyers at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

ticket.person.invite

( tokenID, ticketPersonID, immediateFill, name, email )

POST /api/?action=ticket.person.inviteHTTP/1.1 Host: inevent.us

Invites person with name name and email email to ticket purchase ticketID.

tokenIDGET : token identifier

ticketPersonIDGET : ticket purchase identifier

immediateFillPOST : fill invite

namePOST : invite name

emailPOST : invite email

ticket.person.acceptInvite

( tokenID, ticketPersonID, ticketToken, password, name, username, role, company )

POST /api/?action=ticket.person.acceptInviteHTTP/1.1 Host: inevent.us

Accepts an invite sent for ticket purchase ticketPersonID.

tokenIDGET : token identifier

ticketPersonIDGET : ticket purchase identifier

ticketTokenPOST : access token

passwordPOST : person password

namePOST : person name

usernamePOST : person username

rolePOST : person role

companyPOST : person company

ticket.person.cancelInvite

( tokenID, ticketPersonID )

GET /api/?action=ticket.person.cancelInviteHTTP/1.1 Host: inevent.us

Cancels and releases ticket purchase ticketPersonID.

tokenIDGET : token identifier

ticketPersonIDGET : ticket purchase identifier

ticket.person.makeDefault

( tokenID, ticketPersonID )

GET /api/?action=ticket.person.makeDefaultHTTP/1.1 Host: inevent.us

Assigns ticket purchase ticketPersonID to purchase owner.

tokenIDGET : token identifier

ticketPersonIDGET : ticket purchase identifier

Tracking

Within the event, it will be possible to track all the data. In this module will save any types of statistical data, from how many people saw a banner to how many people liked a certain activity.

Models

{
    "count": 1,
    "data": [
        {
            "trackingID": "1",
            "eventID": "1",
            "personID": "1330",
            "target": "activity.get",
            "targetID": "950",
            "date": "1384209522"
        }
    ]
}

Methods

tracking.create

( tokenID, eventID, target, targetID, date )

POST /api/?action=tracking.createHTTP/1.1 Host: inevent.us

Adds tracking information from person tokenID to event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

targetPOST : target module

targetIDPOST : target identifier

datePOST : date

( tokenID, content )

POST /api/?action=tracking.createHTTP/1.1 Host: inevent.us

Adds tracking information to event eventID.

tokenIDGET : token identifier

contentPOST : json content

[
    {
        "eventID": "integer",
        "target": "string",
        "targetID": "integer",
        "date": "integer"
    }
]

tracking.find

( tokenID, eventID, selection )

GET /api/?action=tracking.findHTTP/1.1 Host: inevent.us

Returns all tracking from event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

selectionGET : selection

{
    "count": "data count",
    "count-hour": "data count per hour"
}

( tokenID, eventID, *selection, *root, *module )

GET /api/?action=tracking.findHTTP/1.1 Host: inevent.us

Returns all tracking from eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

*selectionGET : selection

{
    "count": "data count",
    "count-hour": "data count per hour"
}

*rootGET : root data

*moduleGET : data module split by commas

tracking.get

( tokenID, trackingID )

GET /api/?action=tracking.getHTTP/1.1 Host: inevent.us

Returns tracking trackingID.

tokenIDGET : token identifier

trackingIDGET : tracking identifier

Trigger

At events, we can create triggers, in which an action results in a reaction. For instance, when we fill a form, it can trigger an email to be sent. Multiple reactions can be triggered based on a single action.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "action": "",
            "actionID": "",
            "reaction": "",
            "reactionID": "",
            "date": ""
        }
    ]
}

Methods

trigger.create

( tokenID, eventID, actionType, actionID, reactionType, reactionID )

POST /api/?action=trigger.createHTTP/1.1 Host: inevent.us

Creates a trigger at event eventID with action actionType and reaction reactionType.

tokenIDGET : token identifier

eventIDGET : event identifier

actionTypePOST : available actions

{
    "form": "fill form"
}

actionIDPOST : action identifier

reactionTypePOST : available reactions

{
    "email": "send email"
}

reactionIDPOST : reaction identifier

trigger.remove

( tokenID, triggerID )

GET /api/?action=trigger.removeHTTP/1.1 Host: inevent.us

Removes trigger triggerID from event.

tokenIDGET : token identifier

triggerIDGET : trigger identifier

( tokenID, eventID, reaction, reactionID )

GET /api/?action=trigger.removeHTTP/1.1 Host: inevent.us

Removes trigger with reaction and reactionID from eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

reactionGET : reaction text

reactionIDGET : reaction text id

trigger.find

( tokenID, eventID )

GET /api/?action=trigger.findHTTP/1.1 Host: inevent.us

Returns all triggers at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

Trigger logs

Each trigger reaction must be saved in log format for future data compliance.

Models

{
    "count": 1,
    "data": [
        {
            "triggerID": "",
            "personID": "",
            "date": ""
        }
    ]
}

Methods

trigger.log.bind

( tokenID, triggerID, personID )

GET /api/?action=trigger.log.bindHTTP/1.1 Host: inevent.us

Creates a log for trigger triggerID for person personID.

tokenIDGET : token identifier

triggerIDGET : trigger identifier

personIDGET : person identifier

trigger.log.dismiss

( tokenID, eventID, triggerLogID, personID )

GET /api/?action=trigger.log.dismissHTTP/1.1 Host: inevent.us

Removes trigger log triggerLogID for person personID.

tokenIDGET : token identifier

eventIDGET : event identifier

triggerLogIDGET : trigger log identifier

personIDGET : person identifier

trigger.log.find

( tokenID, eventID, personID )

GET /api/?action=trigger.log.findHTTP/1.1 Host: inevent.us

Returns all logs for person personID at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

personIDGET : person identifier

( tokenID, triggerID )

GET /api/?action=trigger.log.findHTTP/1.1 Host: inevent.us

Returns all trigger logs for trigger triggerID.

tokenIDGET : token identifier

triggerIDGET : trigger identifier

Twitter

Data feed provided from social network Twitter to the InEvent platform.

Methods

twitter.signIn

( accessToken, accessTokenSecret )

GET /api/?action=twitter.signInHTTP/1.1 Host: inevent.us

Starts a session with accessToken and accessTokenSecret.

accessTokenGET : Twitter authentication token

accessTokenSecretGET : Twitter authentication secret

Upload

Uploads are ways of bulk importing data to the platform based on your compliance rules.

Models

{
    "count": 1,
    "data": [
        {
            "uploadID": "1",
            "companyID": "1",
            "eventID": "1",
            "memberID": "1",
            "title": "Spreadsheet",
            "event": "test",
            "type": "xlsx",
            "url": "https:\/\/",
            "date": "1503027673"
        }
    ]
}

Methods

upload.remove

( tokenID, uploadID )

GET /api/?action=upload.removeHTTP/1.1 Host: inevent.us

Remove upload uploadID from the system.

tokenIDGET : token identifier

uploadIDGET : upload identifier

upload.find

( tokenID, companyID )

GET /api/?action=upload.findHTTP/1.1 Host: inevent.us

Returns all uploads at companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

Version

Control all versions of InEvent applications associated with the operating systems available for each company.

Models

{
    "count": 1,
    "data": [
        {
            "companyID": "266",
            "version": "3.2.2",
            "date": "1461886683",
            "status": "zombie"
        }
    ]
}

Methods

version.create

( tokenID, companyID, platform, version, build )

POST /api/?action=version.createHTTP/1.1 Host: inevent.us

Informs the most recent app version for platform platform at company companyID.

tokenIDGET : token identifier

companyIDGET : company identifier

platformPOST : app platform

{
    "ios": "ios",
    "android": "android"
}

versionPOST : most recent versoon

buildPOST : app build version

version.get

( companyID, platform )

GET /api/?action=version.getHTTP/1.1 Host: inevent.us

Verifies all app versions for platform platform at company companyID.

companyIDGET : company identifier

platformGET : app platform

Webhook

Developers can create webhooks to better integrate their systems with InEvent.

Models

{
    "count": 1,
    "data": [
        {
            "eventID": "",
            "type": "",
            "url": "",
            "date": ""
        }
    ]
}

Methods

webhook.create

( tokenID, eventID, type, url )

POST /api/?action=webhook.createHTTP/1.1 Host: inevent.us

Creates a webhook with type type and url at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

typePOST : request type

{
    "activityEnrollment": "requests for activities enrollment",
    "activityDismissal": "requests for activities dismissals"
}

urlPOST : call url

webhook.remove

( tokenID, webhookID )

GET /api/?action=webhook.removeHTTP/1.1 Host: inevent.us

Removes webhook webhookID from event.

tokenIDGET : token identifier

webhookIDGET : id do webhook

webhook.find

( tokenID, eventID )

GET /api/?action=webhook.findHTTP/1.1 Host: inevent.us

Returns all webhooks registered at event eventID.

tokenIDGET : token identifier

eventIDGET : event identifier

webhook.requestExample

( tokenID, webhookID )

GET /api/?action=webhook.requestExampleHTTP/1.1 Host: inevent.us

Returns an example request for webhook webhookID.

tokenIDGET : token identifier

webhookIDGET : id do webhook

webhook.responseExample

( tokenID, webhookID )

GET /api/?action=webhook.responseExampleHTTP/1.1 Host: inevent.us

Returns an example body for webhook webhookID.

tokenIDGET : token identifier

webhookIDGET : id do webhook

Usage

To start using InEvent API with our (SDK), please select the desired device. As usage instructions varies from platform to platform, how-to's and samples are available in each link separately.

Android

Available on Github: https://github.com/trilhagroup/InEvent-android-sdk

iOS

Available on Github: https://github.com/trilhagroup/InEvent-ios-sdk

JS

Available on Github: https://github.com/trilhagroup/InEvent-js-sdk

PHP

Available on Github: https://github.com/trilhagroup/InEvent-php-sdk

Usage

To start using InEvent API with our (SDK), please select the desired device. As usage instructions varies from platform to platform, how-to's and samples are available in each link separately.

Android

Available on Github: https://github.com/trilhagroup/InEvent-android-sdk

iOS

Available on Github: https://github.com/trilhagroup/InEvent-ios-sdk

JS

Available on Github: https://github.com/trilhagroup/InEvent-js-sdk

PHP

Available on Github: https://github.com/trilhagroup/InEvent-php-sdk

Browser

To define the correct browser your request is being executed on, you may provide a browserGET attribute with user agent, version, etc. For mobile devices using our SDKs, you may provide something like 'Android Oreo 8.0, Galaxy S9' to identify as a browser. If this attribute is not sent, we'll try to determine your browser by using cookies or headers.

Example of usage

https://inevent.us/api/?action=...&browser=chrome,69.0,macintosh,webkit

Usage specification

browserGET : Browser identification string

Sandbox

Para facilitar o teste das operações, é oferecido o uso da opção sandbox. Como o InEvent foi desenhado para que a grande maioria das operações ocorram dentro de eventos específicos, o modo sandbox cria um evento privado com acesso a todas as ferramentas, permitindo que as operações sejam realizadas sem acesso público ou dependência de pagamentos.

Indicativo de uso

Os métodos compatíveis estarão marcados com o ícone logo após sua declaração. Sem a marcação, não há diferença se o modo sandbox está ativado ou não.

Exemplo de uso

https://inevent.us/api/?action=...&sandbox=1

Especificações de uso

sandboxGET : 0 ou 1, indicando o estado do sandbox

Dicas

  • Teste todas as operações antes de enviar um código para produção;
  • O sandbox não é persistente e retorna para seu estado padrão todos os dias entre 48h e 72h após ter sido criado, removendo todos os eventos em modo sandbox;
  • O sandbox é atômico, ou seja, seu evento possui só pode ser editado por você e pelas pessoas para quem ofereceu acesso.

Pagination

The number of results retrieved in our API can exceed acceptable limits, either for performance concerns or for high amounds of data transfer. With pagination it is possible to access all needed data and retrieve specific portions of data with higher performance.

Only a handful of modules are available to be paginated. Please check the information in the module of your choice to see if you can made use of this feature.

Usage indication

Methods that are compatible with pagination are marked with this icon right after its declaration. Modules that are not marked will ignore limit and offset attributes.

Example of usage

https://inevent.us/api/?action=...&offset=1000&limit=200

Getting started

offsetGET : number of data to ignore, counting from start

limitGET : amount of data to receive, limited to 200 at most

Timezone

To define the correct way to display time and dates, it is necessary to use the correct timezone that the user is placed. The timezone notations must follow the IANA zone (aka Olson timezone) to be correctly processed

Example of usage

https://inevent.us/api/?action=...&timezone=America/Los_Angeles

Usage specification

timezoneGET : IANA key of timezone to be used