Guías

Para garantizar que nuestra API está sano, todo lo construimos con nuestro API, incluso nuestras propias plataformas web. Esto nos ayuda a mantener nuestra API trabajando todo el tiempo y ofrecer todo tipo de información necesaria a través de nuestro API.

Para mejor proveer un flujo de trabajo de uso de nuestra API, algunos recursos se agrupan en guías para explicar mejor cómo funcionan y cómo pueden extraer la mayoría de ellos. La mejor manera de entender cómo nuestros productos conectan entre sí y cómo mejor puede integrar para lograr los resultados es a través de la documentación de la API y entender todas las posibilidades de cada recurso proporciona.

Tenemos documentación de módulos de raíz (estos son los principales recursos para administrar los datos), y la mayoría de ellos tienen submódulos adjuntadas que permite conectar dos módulos diferentes de la raíz (por ejemplo, tenemos evento, persona y eventPerson, la tercera siendo una conexión entre una persona y un evento). Una lista completa de los módulos se presentan a su izquierda y submódulos se sangran por consiguiente.

Para cada módulo de la raíz, existen cuatro operaciones básicas, representadas por su conocido CRUD (crear, leer, actualizar y borrar). Hemos decidido cambiar algunos nombres de operación para hacerlo más intuitivo. Estas son las siguientes operaciones:

  • create: crea un objeto;
  • edit: edita un objeto;
  • remove: elimina un objeto;
  • find: busca objetos;
  • get: recoger un objeto;

Para submódulos, que todavía tienen las operaciones básicas, pero con diferentes nombres. Como submódulos son las relaciones entre los dos módulos de raíz diferente, decidimos utilizar un enfoque de conexión/relación al crear esos nombres:

  • bind: crea una conexión;
  • operate: edita una conexión;
  • dismiss: elimina una conexión;
  • find: busca las conexiones;
  • get: reunir una conexión;

Por último, le recordamos que estamos aquí para ayudarle. Si tienes alguna pregunta sobre una guía específica o quieres sugerir mejoras en nuestra documentación, por favor envía un correo electrónico a developer@inevent.com para que podamos ayudarte con tu necesidad/sugerencia con amor.

Entrada

Para la integración de datos con InEvent para el check-in, es necesario integrar todos leer y escribir aspectos de nuevos asistentes, además de informar a la nueva etiqueta de impresión y lectura accede a nuestro control de acceso.

El registro y verificación de nuevos asistentes se produce a través de los métodos disponibles en event.person. Para crear a un nuevo asistente, tenemos algunos métodos en event.person.bind y leer algunos asistentes, en event.person.find o event.person.get. Todos estos devuelve informaciones relevantes sobre el proceso de registro.

En el momento de la impresión, es importante informar a nuevas impresiones en event.person.print. Al recuperar la información de nuestras APIs, habrá un conteo de etiquetas impresas ya impreso (es posible limitar la cantidad de cada participante se le permite imprimir etiquetas). Para obtener una memoria caché de información antes de check-in, puede usar event.person.find con límite = 500000 para obtener una representación simplificada de los datos de los asistentes.

Todos nuestros códigos QR generados están encriptados dentro de la clave del qrCode . Son los mismos dentro de la aplicación y en correos electrónicos enviados a los asistentes. Usted puede reducir el tamaño de este código QR. Por motivos de seguridad que estos formatos no pueden ser modificados por un tercero, así que si usted necesita utilizar un qrCode, debe utilizar uno disponible en nuestra plataforma.

Enlace profundo

Para enviar información a nuestra aplicación móvil, es posible utilizar enlaces profundos, una técnica que permite enviar datos entre aplicaciones, datos que serán analizados durante el proceso de inicio de la aplicación. InEvent utiliza esta técnica, lo que le permite definir durante la inicialización de nuestra aplicación móvil el tokenID del usuario, el evento seleccionado y más. Para las aplicaciones de iOS, la URL oficial es:

inevent://

Actualmente aceptamos los siguientes parámetros: tokenID , eventID , memberID y name . Un buen ejemplo es, con un eventID dado de 1, sería:

inevent://?eventID=1

Algunos servicios específicos, como Gmail o Hotmail no reconocen nuestra profunda vinculación url como URL válidas (ya que inevent no un protocolo válido). Por lo tanto, para lograr mejor comunicación con los servicios, usted puede utilizar un protocolo diferente y un formato para comunicarse con nuestras aplicaciones:

https://inevent.us/appURL.php

Todos los parámetros especificados anteriormente enviaron por la cadena de consulta que obtener será reemplazado automáticamente con el formato anterior que se muestra en primer lugar.

Publicidad

Es muy habitual para los eventos que varios patrocinadores, empresas que están interesadas en mostrar su marca durante el evento. Puede crear anuncio en nuestra plataforma para cada patrocinador, determinar su prioridad y definir si es un anuncio en pantalla completa o un anuncio de pie de página. Estos anuncios aparecen justo después de la aplicación se abre, o cada 10 minutos de uso directo.

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.

Capacidad (cuántas personas pueden participar)

Para comenzar a utilizar InEvent API, siga nuestra documentación a la izquierda. A continuación tenemos un ejemplo que se desmontará para explicar mejor cómo funciona.

URL de la API

https://inevent.us/api/

Ejemplo de documentación

person.signIn(username, password)

Señales en y devuelve una tokenID (cadena de 60 bytes) en caso de que la solicitud ha sido exitosa.

usernameGET : username de la persona

passwordPOST : contraseña

Parámetros automáticamente son codificados y enviados a través de HTTPS:

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

Hay tres secciones: cabecera, parámetros y retorno. Cada uno de ellos se explican por separado a continuación:

  • La cabecera (person.signIn) representa la llamada a la API, compuesta por un espacio de nombres (persona) -- un recurso -- y su método (signIn). Esta cabecera debe enviarse mediante la cadena de consulta QUERY en la URL con la acción clave.
  • Los parámetros nombre de usuario y contraseña se explican haciendo clic en el icono %s y cómo deben enviarse, ya sea a través de la cadena de consulta QUERY o a través del cuerpo BODY codificado como application/x-www-form-urlencoded
  • El regreso muestra qué tipo de datos será devueltos.

Marcaje

Cada uno presenta método la siguiente marca a visualmente indica un significado específico:

  • *: parámetros opcionales;
  • negrita: parámetros requeridos;
  • cursiva: retorno de parámetros;
  • understroke: endpoint;
  • regular: valor de parámetro;
  • subíndice: método de transferencia.

Herramientas

Para cada método existente, es posible utilizar herramientas en línea para obtener la siguiente información:

  • : Depurador en línea fácilmente probar tu código, enviar parámetros adicionales y obtener respuesta de su solicitud.;
  • : Prueba de Sandbox, solo necesita informar a sandbox GET en su solicitud con valor de 1.

Seguridad

La API InEvent utiliza un RPC-REST híbrido con conexión encriptada de 128 bits certificada por PositiveSSL CA2.

Volver

Los datos devueltos pueden venir en diferentes formatos, basta con especificar un formato personalizado mediante el parámetro de formato dehaz . El formato predeterminado es json.

  • json: un archivo json con la cuenta y los datos por defecto de elementos de raíz;
  • excel: un archivo de Excel, con el tipo de contenido de
    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 )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.create&tokenID=&eventID= \   -d "name="
$response = InEvent\Activity::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => ""
]);

Creates an activity named name at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : activity name

*descriptionBODY : activity description

*locationBODY : activity location

*dateBeginBODY : activity begin date

*dateEndBODY : activity end date

*capacityBODY : maximum number of people

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.create&tokenID=&eventID= \   -d "path="
$response = InEvent\Activity::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple activities at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

activity.edit

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

  • Info
  • Curl
  • PHP
POST /api/?action=activity.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.edit&tokenID=&activityID=&key= \   -d "value="
$response = InEvent\Activity::edit($client, [
  "tokenID" => "",
  "activityID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

keyQUERY : 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"
}

valueBODY : 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"
}

*pushQUERY : push notification send for editing

activity.remove

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.remove&tokenID=&activityID=
$response = InEvent\Activity::remove($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Removes activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.find

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

  • Info
  • Curl
  • PHP
GET /api/?action=activity.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.find&tokenID=&eventID=&selection=&personID=
$response = InEvent\Activity::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => "",
  "personID" => ""
]);

Returns all activities from person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : activity registered

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

personIDQUERY : person identifier

*dateBeginQUERY : begin date

*dateEndQUERY : end date

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

  • Info
  • Curl
  • PHP
GET /api/?action=activity.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.find&tokenID=&eventID=&selection=&listID=
$response = InEvent\Activity::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => "",
  "listID" => ""
]);

Returns all activities containing list listID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : registered in activity

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

listIDQUERY : list identifier

*dateBeginQUERY : begin date

*dateEndQUERY : end date

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

  • Info
  • Curl
  • PHP
GET /api/?action=activity.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.find&tokenID=&eventID=&selection=
$response = InEvent\Activity::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns all activities from event eventID to person tokenID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : 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"
}

*dateBeginQUERY : begin date

*dateEndQUERY : end date

( eventID, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.find&eventID=
$response = InEvent\Activity::find($client, [
  "eventID" => ""
]);

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

eventIDQUERY : event identifier

*dateBeginQUERY : begin date

*dateEndQUERY : end date

activity.get

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.get&tokenID=&activityID=&personID=
$response = InEvent\Activity::get($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Returns activity activityID for person personID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.get&tokenID=&activityID=
$response = InEvent\Activity::get($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns activity activityID, informing if person tokenID is registered.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.get&activityID=
$response = InEvent\Activity::get($client, [
  "activityID" => ""
]);

Returns activity activityID.

activityIDQUERY : activity identifier

activity.copy

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.copyHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.copy&tokenID=&activityID=
$response = InEvent\Activity::copy($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Copies activity activityID on the same origin event.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.delay

( tokenID, activityID, minutes, subsequent )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.delayHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.delay&tokenID=&activityID=&minutes=&subsequent=
$response = InEvent\Activity::delay($client, [
  "tokenID" => "",
  "activityID" => "",
  "minutes" => "",
  "subsequent" => ""
]);

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

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

minutesQUERY : minutes of delay

subsequentQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.chain.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.chain.bind&tokenID=&chainID=&activityID=
$response = InEvent\Activity.chain::bind($client, [
  "tokenID" => "",
  "chainID" => "",
  "activityID" => ""
]);

Requests activity activityID chaining at chain chainID.

tokenIDQUERY : token identifier

chainIDQUERY : chain identifier

activityIDQUERY : activity identifier

activity.chain.dismiss

( tokenID, chainID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.chain.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.chain.dismiss&tokenID=&chainID=&activityID=
$response = InEvent\Activity.chain::dismiss($client, [
  "tokenID" => "",
  "chainID" => "",
  "activityID" => ""
]);

Removes activity activityID from chain chainID.

tokenIDQUERY : token identifier

chainIDQUERY : chain identifier

activityIDQUERY : activity identifier

activity.chain.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.chain.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.chain.find&tokenID=&activityID=
$response = InEvent\Activity.chain::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all chains from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.chain.findChainedActivities

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.chain.findChainedActivitiesHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.chain.findChainedActivities&tokenID=&activityID=
$response = InEvent\Activity.chain::findChainedActivities($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all activities from all chains for activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.list.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.list.bind&tokenID=&listID=&activityID=
$response = InEvent\Activity.list::bind($client, [
  "tokenID" => "",
  "listID" => "",
  "activityID" => ""
]);

Requests list listID creation on activity activityID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

activityIDQUERY : activity identifier

activity.list.dismiss

( tokenID, listID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.list.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.list.dismiss&tokenID=&listID=&activityID=
$response = InEvent\Activity.list::dismiss($client, [
  "tokenID" => "",
  "listID" => "",
  "activityID" => ""
]);

Removes list listID from activity activityID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

activityIDQUERY : activity identifier

activity.list.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.list.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.list.find&tokenID=&activityID=
$response = InEvent\Activity.list::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all lists from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.person.bind&tokenID=&activityID= \   -d "name=&email="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "name" => "",
  "email" => ""
]);

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

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

nameBODY : person name

emailBODY : person email

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

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.bind&tokenID=&activityID=&personID=
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Requests person personID to join activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

( tokenID, activityID, personID, *bypassWebhook )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.bind&tokenID=&activityID=&personID=
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Requests person personID to join activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

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

( tokenID, activityID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.person.bind&tokenID=&activityID= \   -d "path="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "path" => ""
]);

Requests multiple people to join activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

pathBODY : file path

( tokenID, eventID, content, *bypassWebhook )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.person.bind&tokenID=&eventID= \   -d "content="
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Request multiple people to join multiple activities through content.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

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

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

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.bind&tokenID=&activityID=
$response = InEvent\Activity.person::bind($client, [
  "tokenID" => "",
  "activityID" => ""
]);

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

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.person.operate

( tokenID, activityID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.person.operate&tokenID=&activityID=&key=&personID= \   -d "value="
$response = InEvent\Activity.person::operate($client, [
  "tokenID" => "",
  "activityID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

keyQUERY : element name

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

valueBODY : desired action

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

personIDQUERY : person identifier

( tokenID, activityID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.person.operate&tokenID=&activityID=&key= \   -d "value="
$response = InEvent\Activity.person::operate($client, [
  "tokenID" => "",
  "activityID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

keyQUERY : element name

{
    "priori": "registration priority"
}

valueBODY : desired action

{
    "priori": "bit"
}

activity.person.dismiss

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.dismiss&tokenID=&activityID=&personID=
$response = InEvent\Activity.person::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Requests person personID removal from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

( tokenID, activityID, personID, *bypassWebhook )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.dismiss&tokenID=&activityID=&personID=
$response = InEvent\Activity.person::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Requests person personID removal from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

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

( tokenID, eventID, content, *bypassWebhook )

  • Info
  • Curl
  • PHP
POST /api/?action=activity.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=activity.person.dismiss&tokenID=&eventID= \   -d "content="
$response = InEvent\Activity.person::dismiss($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Requests a multiple people removal from multiple activities through content.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

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

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

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.dismiss&tokenID=&activityID=
$response = InEvent\Activity.person::dismiss($client, [
  "tokenID" => "",
  "activityID" => ""
]);

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

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.person.find

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

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.find&tokenID=&activityID=&selection=
$response = InEvent\Activity.person::find($client, [
  "tokenID" => "",
  "activityID" => "",
  "selection" => ""
]);

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

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

selectionQUERY : activity registration

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

*orderQUERY : order based on the column

*queryQUERY : text for search

activity.person.get

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.get&tokenID=&activityID=&personID=
$response = InEvent\Activity.person::get($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Returns details from person personID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : person identifier

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.get&tokenID=&activityID=
$response = InEvent\Activity.person::get($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns details from person tokenID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

activity.person.calculate

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.person.calculateHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.person.calculate&tokenID=&activityID=
$response = InEvent\Activity.person::calculate($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Calculates the number of participants from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : 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",
            "category": "Category",
            "image": "http:\/\/",
            "email": "email@email.com",
            "facebook": "http:\/\/",
            "linkedIn": "http:\/\/",
            "twitter": "http:\/\/"
        }
    ]
}

Methods

activity.speaker.bind

( tokenID, activityID, speakerID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.speaker.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.speaker.bind&tokenID=&activityID=&speakerID=
$response = InEvent\Activity.speaker::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "speakerID" => ""
]);

Adds speaker speakerID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

speakerIDQUERY : speaker identifier

activity.speaker.dismiss

( tokenID, activityID, speakerID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.speaker.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.speaker.dismiss&tokenID=&activityID=&speakerID=
$response = InEvent\Activity.speaker::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "speakerID" => ""
]);

Removes speaker speakerID from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

speakerIDQUERY : speaker identifier

activity.speaker.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.speaker.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.speaker.find&tokenID=&activityID=
$response = InEvent\Activity.speaker::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all speakers from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, speakerID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.speaker.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.speaker.find&tokenID=&speakerID=
$response = InEvent\Activity.speaker::find($client, [
  "tokenID" => "",
  "speakerID" => ""
]);

Returns all activities from speaker speakerID.

tokenIDQUERY : token identifier

speakerIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.sponsor.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.sponsor.bind&tokenID=&activityID=&sponsorID=
$response = InEvent\Activity.sponsor::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "sponsorID" => ""
]);

Adds sponsor sponsorID at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

sponsorIDQUERY : sponsor identifier

activity.sponsor.dismiss

( tokenID, activityID, sponsorID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.sponsor.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.sponsor.dismiss&tokenID=&activityID=&sponsorID=
$response = InEvent\Activity.sponsor::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "sponsorID" => ""
]);

Removes sponsor sponsorID from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

sponsorIDQUERY : sponsor identifier

activity.sponsor.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.sponsor.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.sponsor.find&tokenID=&activityID=
$response = InEvent\Activity.sponsor::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all sponsors from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, eventID, sponsorID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.sponsor.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.sponsor.find&tokenID=&eventID=&sponsorID=
$response = InEvent\Activity.sponsor::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "sponsorID" => ""
]);

Returns all activities from sponsor sponsorID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sponsorIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.tag.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.tag.bind&tokenID=&activityID=&tagID=
$response = InEvent\Activity.tag::bind($client, [
  "tokenID" => "",
  "activityID" => "",
  "tagID" => ""
]);

Adds tag tagID to activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

tagIDQUERY : tag identifier

activity.tag.dismiss

( tokenID, activityID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.tag.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.tag.dismiss&tokenID=&activityID=&tagID=
$response = InEvent\Activity.tag::dismiss($client, [
  "tokenID" => "",
  "activityID" => "",
  "tagID" => ""
]);

Removes tag tagID from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

tagIDQUERY : tag identifier

activity.tag.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.tag.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.tag.find&tokenID=&activityID=
$response = InEvent\Activity.tag::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns all activity activityID tags.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=activity.tag.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=activity.tag.find&activityID=
$response = InEvent\Activity.tag::find($client, [
  "activityID" => ""
]);

Returns all activity activityID tags.

activityIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=ad.createHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=ad.create&tokenID=&eventID=&sponsorID=
$response = InEvent\Ad::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "sponsorID" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sponsorIDQUERY : sponsor identifier

ad.edit

( tokenID, adID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=ad.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=ad.edit&tokenID=&adID=&key= \   -d "value="
$response = InEvent\Ad::edit($client, [
  "tokenID" => "",
  "adID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key at ad adID.

tokenIDQUERY : token identifier

adIDQUERY : ad identifier

keyQUERY : field name

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

valueBODY : field value

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

ad.remove

( tokenID, adID )

  • Info
  • Curl
  • PHP
GET /api/?action=ad.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=ad.remove&tokenID=&adID=
$response = InEvent\Ad::remove($client, [
  "tokenID" => "",
  "adID" => ""
]);

Removes ad adID.

tokenIDQUERY : token identifier

adIDQUERY : ad identifier

ad.find

( eventID, sponsorID )

  • Info
  • Curl
  • PHP
GET /api/?action=ad.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=ad.find&eventID=&sponsorID=
$response = InEvent\Ad::find($client, [
  "eventID" => "",
  "sponsorID" => ""
]);

Returns all ads from sponsor sponsorID at event eventID.

eventIDQUERY : event identifier

sponsorIDQUERY : sponsor identifier

( eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=ad.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=ad.find&eventID=&selection=
$response = InEvent\Ad::find($client, [
  "eventID" => "",
  "selection" => ""
]);

Returns all ads from event eventID.

eventIDQUERY : event identifier

selectionQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=ally.createHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=ally.create&tokenID=&allyID=
$response = InEvent\Ally::create($client, [
  "tokenID" => "",
  "allyID" => ""
]);

Ads a connection with person allyID.

tokenIDQUERY : token identifier

allyIDQUERY : person identifier

ally.remove

( tokenID, allyID )

  • Info
  • Curl
  • PHP
GET /api/?action=ally.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=ally.remove&tokenID=&allyID=
$response = InEvent\Ally::remove($client, [
  "tokenID" => "",
  "allyID" => ""
]);

Removes person allyID.

tokenIDQUERY : token identifier

allyIDQUERY : person identifier

ally.find

( tokenID, selection, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=ally.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=ally.find&tokenID=&selection=
$response = InEvent\Ally::find($client, [
  "tokenID" => "",
  "selection" => ""
]);

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

tokenIDQUERY : token identifier

selectionQUERY : connection status

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

*orderQUERY : results order

ally.sync

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=ally.syncHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=ally.sync&tokenID=&eventID= \   -d "content="
$response = InEvent\Ally::sync($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Syncs and normalizes contacts from eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=analytics.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=analytics.get&tokenID=&companyID=&page=
$response = InEvent\Analytics::get($client, [
  "tokenID" => "",
  "companyID" => "",
  "page" => ""
]);

Gets statistic data on each page page usage.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

*personIDQUERY : person identifier

pageQUERY : page name

{
    "budget": "budget analytics"
}

( tokenID, eventID, *personID, page )

  • Info
  • Curl
  • PHP
GET /api/?action=analytics.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=analytics.get&tokenID=&eventID=&page=
$response = InEvent\Analytics::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "page" => ""
]);

Gets statistic data on each page page usage.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*personIDQUERY : person identifier

pageQUERY : 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"
}

App

Third party vendors may have their own connectors with InEvent API.

Models

{
    "count": 1,
    "data": [
        {
            "memberID": "",
            "title": "",
            "description": "",
            "icon": "",
            "returnUrl": "",
            "date": ""
        }
    ]
}

Methods

app.create

( tokenID, title )

  • Info
  • Curl
  • PHP
POST /api/?action=app.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=app.create&tokenID= \   -d "title="
$response = InEvent\App::create($client, [
  "tokenID" => ""
], [
  "title" => ""
]);

Creates an app with title title for developer.

tokenIDQUERY : token identifier

titleBODY : app title

app.edit

( tokenID, appID, key, *value )

  • Info
  • Curl
  • PHP
POST /api/?action=app.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=app.edit&tokenID=&appID=&key= \   -d ""
$response = InEvent\App::edit($client, [
  "tokenID" => "",
  "appID" => "",
  "key" => ""
], [

]);

Edits value value from field key at app appID.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

keyQUERY : field name

{
    "title": "app title",
    "description": "app description",
    "icon": "app icon",
    "returnUrl": "app return path"
}

*valueBODY : field value

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

app.remove

( tokenID, appID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=app.remove&tokenID=&appID=
$response = InEvent\App::remove($client, [
  "tokenID" => "",
  "appID" => ""
]);

Removes an app appID.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

app.find

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=app.find&tokenID=
$response = InEvent\App::find($client, [
  "tokenID" => ""
]);

Returns all apps for developer.

tokenIDQUERY : token identifier

app.get

( tokenID, appID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=app.get&tokenID=&appID=
$response = InEvent\App::get($client, [
  "tokenID" => "",
  "appID" => ""
]);

Returns an app appID for developer.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

App Person

Third party vendors may have their own connectors with InEvent API.

Models

{
    "count": 1,
    "data": [
        {
            "appID": "",
            "memberID": "",
            "date": ""
        }
    ]
}

Methods

app.person.bind

( tokenID, appID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=app.person.bind&tokenID=&appID=
$response = InEvent\App.person::bind($client, [
  "tokenID" => "",
  "appID" => ""
]);

Authenticates person with app appID.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

app.person.dismiss

( tokenID, appID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=app.person.dismiss&tokenID=&appID=
$response = InEvent\App.person::dismiss($client, [
  "tokenID" => "",
  "appID" => ""
]);

Removes an app appID for person.

tokenIDQUERY : token identifier

appIDQUERY : app identifier

app.person.find

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=app.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=app.person.find&tokenID=
$response = InEvent\App.person::find($client, [
  "tokenID" => ""
]);

Returns all apps authenticated for person.

tokenIDQUERY : token identifier

Audit

Control over information is essential for large companies and their compliance programs. Using the audit log you will be able to review relevant changes at a specific event.

Models

{
    "count": 1,
    "data": [
        {
            "auditID": "1",
            "companyID": "1",
            "eventID": "1",
            "memberID": "1",
            "target": "member",
            "targetID": "1",
            "action": "",
            "referer": "",
            "from": "",
            "to": "event.person.bind",
            "date": "1527689871"
        }
    ]
}

Methods

audit.find

( tokenID, companyID, *query, *queryKey, *queryContent )

  • Info
  • Curl
  • PHP
POST /api/?action=audit.findHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=audit.find&tokenID=&companyID= \   -d ""
$response = InEvent\Audit::find($client, [
  "tokenID" => "",
  "companyID" => ""
], [

]);

Gathers all audits at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

*queryQUERY : search query

*queryKeyQUERY : search key

{
    "target": "string",
    "targetID": "integer",
    "action": "string",
    "referer": "string",
    "from": "string",
    "to": "string"
}

*queryContentBODY : search key and values as AND operation

[
    {
        "query": "event.person.bind",
        "queryKey": "target"
    },
    {
        "query": "1924",
        "queryKey": "targetID"
    }
]

( tokenID, eventID, *query, *queryKey, *queryContent )

  • Info
  • Curl
  • PHP
POST /api/?action=audit.findHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=audit.find&tokenID=&eventID= \   -d ""
$response = InEvent\Audit::find($client, [
  "tokenID" => "",
  "eventID" => ""
], [

]);

Gathers all audits at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*queryQUERY : search query

*queryKeyQUERY : search key

{
    "target": "string",
    "targetID": "integer",
    "action": "string",
    "referer": "string",
    "from": "string",
    "to": "string"
}

*queryContentBODY : search key and values as AND operation

[
    {
        "query": "company.person.bind",
        "queryKey": "target"
    },
    {
        "query": "1924",
        "queryKey": "targetID"
    }
]

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 )

  • Info
  • Curl
  • PHP
POST /api/?action=beacon.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=beacon.create&tokenID= \   -d "serial=&iBeaconMinor=&bleAddress=&wifiAddress="
$response = InEvent\Beacon::create($client, [
  "tokenID" => ""
], [
  "serial" => "",
  "iBeaconMinor" => "",
  "bleAddress" => "",
  "wifiAddress" => ""
]);

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

tokenIDQUERY : token identifier

serialBODY : beacon's serial

iBeaconMinorBODY : beacon's minor

bleAddressBODY : beacon's bleAddress

wifiAddressBODY : beacon's wifiAddress

beacon.find

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.find&tokenID=
$response = InEvent\Beacon::find($client, [
  "tokenID" => ""
]);

Returns all beacons from InEvent.

tokenIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=beacon.action.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=beacon.action.bind&tokenID=&beaconEventID= \   -d "type=&range=&extra=&name="
$response = InEvent\Beacon.action::bind($client, [
  "tokenID" => "",
  "beaconEventID" => ""
], [
  "type" => "",
  "range" => "",
  "extra" => "",
  "name" => ""
]);

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

tokenIDQUERY : authentication token

beaconEventIDQUERY : beacon event identifier

typeBODY : action to be performed

{
    "push": "send push notification"
}

rangeBODY : maximum distance to beacon

extraBODY : extra value used by the action

nameBODY : name used by the action

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

  • Info
  • Curl
  • PHP
POST /api/?action=beacon.action.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=beacon.action.bind&tokenID=&eventID=&minor= \   -d "type=&range=&extra=&name="
$response = InEvent\Beacon.action::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "minor" => ""
], [
  "type" => "",
  "range" => "",
  "extra" => "",
  "name" => ""
]);

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

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

minorQUERY : beacon minor for event

typeBODY : action to be performed

{
    "push": "send push notification"
}

rangeBODY : maximum distance to beacon

extraBODY : extra value used by the action

nameBODY : name used by the action

beacon.action.operate

( tokenID, beaconActionID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=beacon.action.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=beacon.action.operate&tokenID=&beaconActionID=&key= \   -d "value="
$response = InEvent\Beacon.action::operate($client, [
  "tokenID" => "",
  "beaconActionID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of action beaconActionID.

tokenIDQUERY : token identifier

beaconActionIDQUERY : beacon's action identifier

keyQUERY : element name

{
    "active": "action status"
}

valueBODY : desired action

{
    "active": "integer"
}

beacon.action.dismiss

( tokenID, beaconActionID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.action.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.action.dismiss&tokenID=&beaconActionID=
$response = InEvent\Beacon.action::dismiss($client, [
  "tokenID" => "",
  "beaconActionID" => ""
]);

Removes action beaconActionID.

tokenIDQUERY : authentication token

beaconActionIDQUERY : beacon's action identifier

beacon.action.find

( tokenID, beaconEventID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.action.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.action.find&tokenID=&beaconEventID=
$response = InEvent\Beacon.action::find($client, [
  "tokenID" => "",
  "beaconEventID" => ""
]);

Finds all actions on beacon at event beaconEventID.

tokenIDQUERY : authentication token

beaconEventIDQUERY : beacon event identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.action.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.action.find&tokenID=&eventID=
$response = InEvent\Beacon.action::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all actions at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.event.bind&tokenID=&eventID=&beaconID=
$response = InEvent\Beacon.event::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "beaconID" => ""
]);

Adds a beacon beaconID at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

beaconIDQUERY : beacon identifier

( tokenID, eventID, minor )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.event.bind&tokenID=&eventID=&minor=
$response = InEvent\Beacon.event::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "minor" => ""
]);

Adds a beacon with minor at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

minorQUERY : beacon minor

beacon.event.dismiss

( tokenID, eventID, beaconID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.event.dismiss&tokenID=&eventID=&beaconID=
$response = InEvent\Beacon.event::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "beaconID" => ""
]);

Removes beacon beaconID from event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

beaconIDQUERY : beacon identifier

( tokenID, eventID, minor )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.event.dismiss&tokenID=&eventID=&minor=
$response = InEvent\Beacon.event::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "minor" => ""
]);

Removes beacon with minor from event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

minorQUERY : beacon minor

beacon.event.find

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.event.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.event.find&tokenID=&eventID=&selection=
$response = InEvent\Beacon.event::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Finds beacons at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

selectionQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.log.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.log.bind&tokenID=&personID=&beaconActionID=
$response = InEvent\Beacon.log::bind($client, [
  "tokenID" => "",
  "personID" => "",
  "beaconActionID" => ""
]);

Registers beacon action beaconActionID performed.

tokenIDQUERY : authentication token

personIDQUERY : person identifier

beaconActionIDQUERY : beacon's action identifier

( tokenID, beaconActionID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.log.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.log.bind&tokenID=&beaconActionID=
$response = InEvent\Beacon.log::bind($client, [
  "tokenID" => "",
  "beaconActionID" => ""
]);

Registers beacon action beaconActionID performed.

tokenIDQUERY : authentication token

beaconActionIDQUERY : beacon's action identifier

beacon.log.count

( tokenID, beaconEventID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.log.countHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.log.count&tokenID=&beaconEventID=
$response = InEvent\Beacon.log::count($client, [
  "tokenID" => "",
  "beaconEventID" => ""
]);

Counts all registries from beacon at event beaconEventID.

tokenIDQUERY : authentication token

beaconEventIDQUERY : beacon's identifier at event

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=beacon.log.countHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=beacon.log.count&tokenID=&eventID=
$response = InEvent\Beacon.log::count($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Counts all registries at event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : 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, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=billing.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=billing.find&tokenID=&companyID=
$response = InEvent\Billing::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns current amounts available at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=billing.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=billing.find&tokenID=&eventID=
$response = InEvent\Billing::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns current amounts available at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=budget.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=budget.create&tokenID=&eventID= \   -d "title=&description=&type=&price=&date="
$response = InEvent\Budget::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "title" => "",
  "description" => "",
  "type" => "",
  "price" => "",
  "date" => ""
]);

Creates a registry of expenditures at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

titleBODY : expense title

descriptionBODY : expense description

typeBODY : type of expense

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

*categoryBODY : expense category

*supplierBODY : expense supplier

*statusBODY : expense status

priceBODY : expense price

dateBODY : expense date

budget.edit

( tokenID, budgetID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=budget.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=budget.edit&tokenID=&budgetID=&key= \   -d "value="
$response = InEvent\Budget::edit($client, [
  "tokenID" => "",
  "budgetID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of expense budgetID.

tokenIDQUERY : token identifier

budgetIDQUERY : expense identifier

keyQUERY : field name

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

valueBODY : field value

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

budget.remove

( tokenID, budgetID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=budget.remove&tokenID=&budgetID=
$response = InEvent\Budget::remove($client, [
  "tokenID" => "",
  "budgetID" => ""
]);

Removes expense budgetID from event.

tokenIDQUERY : token identifier

budgetIDQUERY : expense identifier

budget.get

( tokenID, budgetID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=budget.get&tokenID=&budgetID=
$response = InEvent\Budget::get($client, [
  "tokenID" => "",
  "budgetID" => ""
]);

Returns expense budgetID.

tokenIDQUERY : token identifier

budgetIDQUERY : expense identifier

budget.getCategories

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.getCategoriesHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=budget.getCategories&tokenID=&eventID=
$response = InEvent\Budget::getCategories($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all categories for expenses at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

budget.getSuppliers

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.getSuppliersHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=budget.getSuppliers&tokenID=&eventID=
$response = InEvent\Budget::getSuppliers($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all suppliers for expenses at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

budget.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=budget.find&tokenID=&eventID=
$response = InEvent\Budget::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all expenses at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=budget.log.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=budget.log.find&tokenID=&eventID=&budgetID=
$response = InEvent\Budget.log::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "budgetID" => ""
]);

Returns all logs for an expenditure budgetID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

budgetIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=case.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=case.edit&tokenID=&eventID=&key= \   -d "value="
$response = InEvent\Case::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : 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"
}

valueBODY : field value

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

case.find

( )

  • Info
  • Curl
  • PHP
GET /api/?action=case.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=case.find
$response = InEvent\Case::find($client, [

]);

Returns all active case studies.

case.get

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=case.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=case.get&eventID=
$response = InEvent\Case::get($client, [
  "eventID" => ""
]);

Returns case study at event eventID.

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=chain.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=chain.create&tokenID=&eventID= \   -d "name="
$response = InEvent\Chain::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => ""
]);

Creates a chain with name name at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : chain name

*constraintBODY : chain rule

chain.remove

( tokenID, chainID )

  • Info
  • Curl
  • PHP
GET /api/?action=chain.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chain.remove&tokenID=&chainID=
$response = InEvent\Chain::remove($client, [
  "tokenID" => "",
  "chainID" => ""
]);

Removes chain chainID.

tokenIDQUERY : token identifier

chainIDQUERY : activity identifier

chain.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chain.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chain.find&tokenID=&eventID=
$response = InEvent\Chain::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all chains at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=chat.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=chat.create&tokenID=&eventID=&personID= \   -d "message="
$response = InEvent\Chat::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "message" => ""
]);

Sends message message to person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

messageBODY : message (200)

chat.find

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=chat.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chat.find&tokenID=&eventID=&personID=
$response = InEvent\Chat::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns all messages sent between person tokenID and person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chat.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chat.find&tokenID=&eventID=
$response = InEvent\Chat::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns everyone which whom person tokenID interacted at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

chat.get

( tokenID, chatID )

  • Info
  • Curl
  • PHP
GET /api/?action=chat.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chat.get&tokenID=&chatID=
$response = InEvent\Chat::get($client, [
  "tokenID" => "",
  "chatID" => ""
]);

Returns message chatID.

tokenIDQUERY : token identifier

chatIDQUERY : message identifier

chat.view

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=chat.viewHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chat.view&tokenID=&eventID=&personID=
$response = InEvent\Chat::view($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

Chatter

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

Methods

chatter.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chatter.get&tokenID=&eventID=
$response = InEvent\Chatter::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns authentication tokens linked to event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.unlink

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.unlinkHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chatter.unlink&tokenID=&eventID=
$response = InEvent\Chatter::unlink($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unlinks Chatter integration from event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.getCommunities

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.getCommunitiesHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chatter.getCommunities&tokenID=&eventID=
$response = InEvent\Chatter::getCommunities($client, [
  "tokenID" => "",
  "eventID" => ""
]);

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

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.getGroups

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.getGroupsHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chatter.getGroups&tokenID=&eventID=
$response = InEvent\Chatter::getGroups($client, [
  "tokenID" => "",
  "eventID" => ""
]);

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

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.setCommunity

( tokenID, eventID, communityId, communityUrl, communityName )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.setCommunityHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chatter.setCommunity&tokenID=&eventID=&communityId=&communityUrl=&communityName=
$response = InEvent\Chatter::setCommunity($client, [
  "tokenID" => "",
  "eventID" => "",
  "communityId" => "",
  "communityUrl" => "",
  "communityName" => ""
]);

Links a Chatter community with event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

communityIdQUERY : community identifier

communityUrlQUERY : community url

communityNameQUERY : community name

chatter.unsetCommunity

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.unsetCommunityHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chatter.unsetCommunity&tokenID=&eventID=
$response = InEvent\Chatter::unsetCommunity($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unlinks Chatter communities from event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

chatter.setGroup

( tokenID, eventID, groupId, groupName )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.setGroupHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chatter.setGroup&tokenID=&eventID=&groupId=&groupName=
$response = InEvent\Chatter::setGroup($client, [
  "tokenID" => "",
  "eventID" => "",
  "groupId" => "",
  "groupName" => ""
]);

Links a Chatter group with event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

groupIdQUERY : community identifier

groupNameQUERY : community name

chatter.unsetGroup

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=chatter.unsetGroupHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=chatter.unsetGroup&tokenID=&eventID=
$response = InEvent\Chatter::unsetGroup($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unlinks Chatter groups from event eventID.

tokenIDQUERY : admin token

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkInHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=checklog.checkIn&tokenID=&eventID=&activityID=&code=&date=
$response = InEvent\Checklog::checkIn($client, [
  "tokenID" => "",
  "eventID" => "",
  "activityID" => "",
  "code" => "",
  "date" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

activityIDQUERY : activity identifier

codeQUERY : identification key

dateQUERY : arrival date

( tokenID, eventID, code, date )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkInHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=checklog.checkIn&tokenID=&eventID=&code=&date=
$response = InEvent\Checklog::checkIn($client, [
  "tokenID" => "",
  "eventID" => "",
  "code" => "",
  "date" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

codeQUERY : identification key

dateQUERY : arrival date

checklog.checkOut

( tokenID, eventID, activityID, code, date )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkOutHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=checklog.checkOut&tokenID=&eventID=&activityID=&code=&date=
$response = InEvent\Checklog::checkOut($client, [
  "tokenID" => "",
  "eventID" => "",
  "activityID" => "",
  "code" => "",
  "date" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

activityIDQUERY : activity identifier

codeQUERY : identification key

dateQUERY : departure date

( tokenID, eventID, code, date )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkOutHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=checklog.checkOut&tokenID=&eventID=&code=&date=
$response = InEvent\Checklog::checkOut($client, [
  "tokenID" => "",
  "eventID" => "",
  "code" => "",
  "date" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

codeQUERY : identification key

dateQUERY : departure date

checklog.stats

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.statsHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=checklog.stats&tokenID=&eventID=
$response = InEvent\Checklog::stats($client, [
  "tokenID" => "",
  "eventID" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

checklog.checkedIn

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkedInHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=checklog.checkedIn&tokenID=&eventID=
$response = InEvent\Checklog::checkedIn($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gets everyone registered at eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

( tokenID, eventID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.checkedInHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=checklog.checkedIn&tokenID=&eventID=&activityID=
$response = InEvent\Checklog::checkedIn($client, [
  "tokenID" => "",
  "eventID" => "",
  "activityID" => ""
]);

Gets everyone registered at activity activityID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

activityIDQUERY : activity identifier

checklog.find

( tokenID, eventID, *selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=checklog.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=checklog.find&tokenID=&eventID=
$response = InEvent\Checklog::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : which contents should return

{
    "all": "all logs",
    "printed": "logs for printed badges"
}

*queryQUERY : search query

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 )

  • Info
  • Curl
  • PHP
POST /api/?action=comment.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=comment.create&tokenID=&activityID= \   -d "text="
$response = InEvent\Comment::create($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "text" => ""
]);

Adds comment text at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

textBODY : comment text

comment.edit

( tokenID, commentID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=comment.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=comment.edit&tokenID=&commentID=&key= \   -d "value="
$response = InEvent\Comment::edit($client, [
  "tokenID" => "",
  "commentID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from comment commentID.

tokenIDQUERY : token identifier

commentIDQUERY : comment identifier

keyQUERY : field name

{
    "approved": "approved"
}

valueBODY : field value

{
    "approved": "bit"
}

comment.remove

( tokenID, commentID )

  • Info
  • Curl
  • PHP
GET /api/?action=comment.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=comment.remove&tokenID=&commentID=
$response = InEvent\Comment::remove($client, [
  "tokenID" => "",
  "commentID" => ""
]);

Removes comment commentID.

tokenIDQUERY : token identifier

commentIDQUERY : comment identifier

comment.find

( tokenID, activityID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=comment.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=comment.find&tokenID=&activityID=&selection=
$response = InEvent\Comment::find($client, [
  "tokenID" => "",
  "activityID" => "",
  "selection" => ""
]);

Returns all comments from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

selectionQUERY : comments on activity

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

comment.get

( tokenID, commentID )

  • Info
  • Curl
  • PHP
GET /api/?action=comment.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=comment.get&tokenID=&commentID=
$response = InEvent\Comment::get($client, [
  "tokenID" => "",
  "commentID" => ""
]);

Returns comment commentID.

tokenIDQUERY : token identifier

commentIDQUERY : comment identifier

comment.hashtags

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=comment.hashtagsHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=comment.hashtags&tokenID=&activityID=
$response = InEvent\Comment::hashtags($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Returns hashtag statistics for an activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : 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",
            "androidBundle": "us.inevent.apps.demo",
            "iosBundle": "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 )

  • Info
  • Curl
  • PHP
POST /api/?action=company.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.create&tokenID= \   -d "shortName=&storeTitle="
$response = InEvent\Company::create($client, [
  "tokenID" => ""
], [
  "shortName" => "",
  "storeTitle" => ""
]);

Creates a company shortName.

tokenIDQUERY : token identifier

shortNameBODY : name os app's icon

storeTitleBODY : name on download stores

( tokenID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=company.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.create&tokenID= \   -d "path="
$response = InEvent\Company::create($client, [
  "tokenID" => ""
], [
  "path" => ""
]);

Creates multiple companies.

tokenIDQUERY : token identifier

pathBODY : file path

company.edit

( tokenID, companyID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=company.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.edit&tokenID=&companyID=&key= \   -d "value="
$response = InEvent\Company::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : field name

{
    "shortName": "app title",
    "storeTitle": "stores title",
    "location": "electronic address",
    "appIcon": "main icon",
    "storeIcon": "store icon",
    "cover": "cover image on opening",
    "androidBundle": "android identifier",
    "iosBundle": "iOS 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?"
}

valueBODY : field value

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

( onboardingToken, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=company.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.edit&onboardingToken=&key= \   -d "value="
$response = InEvent\Company::edit($client, [
  "onboardingToken" => "",
  "key" => ""
], [
  "value" => ""
]);

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

onboardingTokenQUERY : company identifier

keyQUERY : 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"
}

valueBODY : field value

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

company.find

( tokenID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=company.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.find&tokenID=&selection=
$response = InEvent\Company::find($client, [
  "tokenID" => "",
  "selection" => ""
]);

Returns all companies with tokenID access.

tokenIDQUERY : token identifier

selectionQUERY : selection

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

company.get

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.get&tokenID=&companyID=
$response = InEvent\Company::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns details from company companyID with tokenID access.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.get&companyID=
$response = InEvent\Company::get($client, [
  "companyID" => ""
]);

Returns details from company companyID.

companyIDQUERY : company identifier

( tokenID, namespace )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.get&tokenID=&namespace=
$response = InEvent\Company::get($client, [
  "tokenID" => "",
  "namespace" => ""
]);

Returns details from company with namespace namespace with tokenID access.

tokenIDQUERY : token identifier

namespaceQUERY : company namespace

( namespace )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.get&namespace=
$response = InEvent\Company::get($client, [
  "namespace" => ""
]);

Returns details from company with namespace namespace.

namespaceQUERY : company namespace

( onboardingToken )

  • Info
  • Curl
  • PHP
GET /api/?action=company.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.get&onboardingToken=
$response = InEvent\Company::get($client, [
  "onboardingToken" => ""
]);

Returns details from company with onboarding token onboardingToken.

onboardingTokenQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=company.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.person.bind&tokenID=&companyID= \   -d "name=&email="
$response = InEvent\Company.person::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => "",
  "email" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameBODY : person name

emailBODY : person email

company.person.operate

( tokenID, companyID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=company.person.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.person.operate&tokenID=&companyID=&key=&personID= \   -d "value="
$response = InEvent\Company.person::operate($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : element name

{
    "level": "admin privilege"
}

valueBODY : field value

{
    "level": "bit"
}

personIDQUERY : person identifier

company.person.dismiss

( tokenID, companyID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.person.dismiss&tokenID=&companyID=&personID=
$response = InEvent\Company.person::dismiss($client, [
  "tokenID" => "",
  "companyID" => "",
  "personID" => ""
]);

Removes person personID from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

personIDQUERY : person identifier

company.person.find

( tokenID, companyID, selection, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=company.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.person.find&tokenID=&companyID=&selection=
$response = InEvent\Company.person::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "selection" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

selectionQUERY : people at company

{
    "all": "everyone"
}

*orderQUERY : results order

company.person.sync

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.person.syncHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.person.sync&tokenID=
$response = InEvent\Company.person::sync($client, [
  "tokenID" => ""
]);

Syncs everyone with external management platforms.

tokenIDQUERY : token identifier

company.person.journey

( tokenID, companyID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.person.journeyHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.person.journey&tokenID=&companyID=&personID=
$response = InEvent\Company.person::journey($client, [
  "tokenID" => "",
  "companyID" => "",
  "personID" => ""
]);

Gathers person journey throughout company's events.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

personIDQUERY : person 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=company.event.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.event.bind&tokenID=&companyID= \   -d "name=&nickname="
$response = InEvent\Company.event::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => "",
  "nickname" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameBODY : company name

nicknameBODY : event nickname hashtag

( tokenID, companyID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=company.event.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.event.bind&tokenID=&companyID= \   -d "path="
$response = InEvent\Company.event::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "path" => ""
]);

Creates multiple events at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

pathBODY : file path

company.event.dismiss

( tokenID, companyID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.dismiss&tokenID=&companyID=&eventID=
$response = InEvent\Company.event::dismiss($client, [
  "tokenID" => "",
  "companyID" => "",
  "eventID" => ""
]);

Removes event eventID from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

eventIDQUERY : event identifier

company.event.find

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

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.find&tokenID=&companyID=&selection=
$response = InEvent\Company.event::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "selection" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

selectionQUERY : 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"
}

*nameQUERY : event name

*cityQUERY : city name

*dateBeginQUERY : event's begin date

*dateEndQUERY : event's end date

*presentialQUERY : face-to-face event

*publicQUERY : public event

*visibleQUERY : visible event

*templateIDQUERY : template event

*placeIDQUERY : place for event

*orderQUERY : results order

*timezoneQUERY : timezone to search the dates of the event

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

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.find&tokenID=&companyID=&selection=
$response = InEvent\Company.event::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "selection" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

selectionQUERY : event registration

*nameQUERY : event name

*dateBeginQUERY : event's begin date

*dateEndQUERY : event's end date

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

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.find&companyID=
$response = InEvent\Company.event::find($client, [
  "companyID" => ""
]);

Returns all events at company companyID.

companyIDQUERY : company identifier

*nameQUERY : event name

*cityQUERY : city name

*dateBeginQUERY : event's begin date

*dateEndQUERY : event's end date

*presentialQUERY : face-to-face event

*publicQUERY : public event

*visibleQUERY : visible event

*orderQUERY : results order

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

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.find&companyID=
$response = InEvent\Company.event::find($client, [
  "companyID" => ""
]);

Returns all events at company companyID.

companyIDQUERY : company identifier

*nameQUERY : event name

*dateBeginQUERY : event's begin date

*dateEndQUERY : event's end date

company.event.get

( tokenID, companyID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.get&tokenID=&companyID=&eventID=
$response = InEvent\Company.event::get($client, [
  "tokenID" => "",
  "companyID" => "",
  "eventID" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

eventIDQUERY : event identifier

( companyID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.get&companyID=&eventID=
$response = InEvent\Company.event::get($client, [
  "companyID" => "",
  "eventID" => ""
]);

Returns event eventID at company companyID.

companyIDQUERY : company identifier

eventIDQUERY : event identifier

company.event.findAttendees

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.findAttendeesHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.findAttendees&tokenID=&companyID=
$response = InEvent\Company.event::findAttendees($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all participants of all events from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

company.event.copy

( tokenID, companyID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.copyHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.copy&tokenID=&companyID=&eventID=
$response = InEvent\Company.event::copy($client, [
  "tokenID" => "",
  "companyID" => "",
  "eventID" => ""
]);

Copies event eventID at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

eventIDQUERY : event identifier

company.event.budget

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.budgetHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.budget&tokenID=&companyID=
$response = InEvent\Company.event::budget($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns budget details from each event at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

company.event.assignOwner

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.assignOwnerHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.assignOwner&tokenID=&eventID=&personID=
$response = InEvent\Company.event::assignOwner($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Asigns a company member as administrator and owner of eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

company.event.pin

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.pinHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.pin&tokenID=&eventID=
$response = InEvent\Company.event::pin($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Pins event eventID for admin panel.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

company.event.unpin

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.event.unpinHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.event.unpin&tokenID=&eventID=
$response = InEvent\Company.event::unpin($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unpins event eventID for admin panel.

tokenIDQUERY : token identifier

eventIDQUERY : event 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=company.feature.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.feature.get&tokenID=&companyID=&key=
$response = InEvent\Company.feature::get($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
]);

Returns if a particular feature is enabled.

tokenIDQUERY : token identifier

companyIDQUERY : event identifier

keyQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=company.feature.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.feature.edit&tokenID=&companyID=&key= \   -d "value="
$response = InEvent\Company.feature::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Updates status of a particular feature.

tokenIDQUERY : token identifier

companyIDQUERY : event identifier

keyQUERY : feature key

"one of the keys from above model"

valueBODY : field value

company.feature.available

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.feature.availableHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.feature.available&tokenID=
$response = InEvent\Company.feature::available($client, [
  "tokenID" => ""
]);

Returns all products available at InEvent.

tokenIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=company.link.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.link.create&tokenID=&companyID= \   -d "title=&link="
$response = InEvent\Company.link::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "title" => "",
  "link" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

titleBODY : item title

linkBODY : item url

company.link.remove

( tokenID, companyLinkID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.link.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.link.remove&tokenID=&companyLinkID=
$response = InEvent\Company.link::remove($client, [
  "tokenID" => "",
  "companyLinkID" => ""
]);

Removes item companyLinkID.

tokenIDQUERY : token identifier

companyLinkIDQUERY : item identifier

company.link.find

( companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.link.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.link.find&companyID=
$response = InEvent\Company.link::find($client, [
  "companyID" => ""
]);

Gets all items available at company companyID.

companyIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=company.legal.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.legal.edit&tokenID=&companyID=&key= \   -d "value="
$response = InEvent\Company.legal::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : legal data key

"one of the keys from above model"

valueBODY : field value

company.legal.get

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.legal.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.legal.get&tokenID=&companyID=
$response = InEvent\Company.legal::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns legal data from company companyID for admin tokenID.

tokenIDQUERY : token identifier

companyIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=company.push.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.push.bind&tokenID=&companyID= \   -d "androidKey=&iosPath="
$response = InEvent\Company.push::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "androidKey" => "",
  "iosPath" => ""
]);

Adds a new certificate at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

androidKeyBODY : GCM key

iosPathBODY : APNS path

company.push.dismiss

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.push.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.push.dismiss&tokenID=&companyID=
$response = InEvent\Company.push::dismiss($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Removes certificate from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

company.push.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.push.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.push.find&tokenID=&companyID=
$response = InEvent\Company.push::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all certificates at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=company.tool.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=company.tool.edit&tokenID=&companyID=&key= \   -d "value="
$response = InEvent\Company.tool::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : 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"
}

valueBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=company.tool.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.tool.get&companyID=
$response = InEvent\Company.tool::get($client, [
  "companyID" => ""
]);

Returns all tools available at company companyID.

companyIDQUERY : company identifier

company.tool.available

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=company.tool.availableHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=company.tool.available&tokenID=
$response = InEvent\Company.tool::available($client, [
  "tokenID" => ""
]);

Returns all tools available for use.

tokenIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=coupon.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=coupon.create&tokenID=&eventID= \   -d "discount="
$response = InEvent\Coupon::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "discount" => ""
]);

Creates a discount coupon discount at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

discountBODY : discount rate (0-100)

coupon.get

( tokenID, eventID, code )

  • Info
  • Curl
  • PHP
POST /api/?action=coupon.getHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=coupon.get&tokenID=&eventID= \   -d "code="
$response = InEvent\Coupon::get($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "code" => ""
]);

Returns coupon code.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

codeBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=daemon.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=daemon.find&tokenID=&eventID=&operation=&target=
$response = InEvent\Daemon::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "operation" => "",
  "target" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

operationQUERY : operation

targetQUERY : target

daemon.bulk

( tokenID, *companyID, eventID, target, *targetID, *resourceID, resourceType, resources, extra )

  • Info
  • Curl
  • PHP
POST /api/?action=daemon.bulkHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=daemon.bulk&tokenID=&eventID=&target=&resourceType= \   -d "resources=&extra="
$response = InEvent\Daemon::bulk($client, [
  "tokenID" => "",
  "eventID" => "",
  "target" => "",
  "resourceType" => ""
], [
  "resources" => "",
  "extra" => ""
]);

Run bulk operation for several resources

tokenIDQUERY : token identifier

*companyIDQUERY : company identifier

eventIDQUERY : event identifier

targetQUERY : operation target

*targetIDQUERY : operation target id

*resourceIDQUERY : operation resource id

resourceTypeQUERY : operation resource type

resourcesBODY : operation resources

extraBODY : extra information

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 )

  • Info
  • Curl
  • PHP
GET /api/?action=download.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=download.remove&tokenID=&downloadID=
$response = InEvent\Download::remove($client, [
  "tokenID" => "",
  "downloadID" => ""
]);

Remove download downloadID from the system.

tokenIDQUERY : token identifier

downloadIDQUERY : download identifier

download.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=download.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=download.find&tokenID=&companyID=
$response = InEvent\Download::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all downloads at companyID.

tokenIDQUERY : token identifier

companyIDQUERY : 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": "robert@inevent.com",
            "subject": "Welcome to Standalone Out",
            "status": "delivered",
            "opens": "0",
            "date": "1525269353",
            "personName": "Robert",
            "listID": "",
            "listName": "",
            "listSubject": "",
            "listSelection": "",
            "listSent": "",
            "body": ""
        }
    ]
}

Methods

email.log.find

( tokenID, eventID, selection, query, subject )

  • Info
  • Curl
  • PHP
GET /api/?action=email.log.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=email.log.find&tokenID=&eventID=&selection=&query=&subject=
$response = InEvent\Email.log::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => "",
  "query" => "",
  "subject" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event

selectionQUERY : segments

queryQUERY : search terms

subjectQUERY : search subject

email.log.get

( tokenID, emailLogID )

  • Info
  • Curl
  • PHP
GET /api/?action=email.log.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=email.log.get&tokenID=&emailLogID=
$response = InEvent\Email.log::get($client, [
  "tokenID" => "",
  "emailLogID" => ""
]);

Returns a specific email log emailLogID.

tokenIDQUERY : token identifier

emailLogIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=error.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=error.create&tokenID= \   -d "platform=&message="
$response = InEvent\Error::create($client, [
  "tokenID" => ""
], [
  "platform" => "",
  "message" => ""
]);

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

tokenIDQUERY : token identifier

platformBODY : error location

messageBODY : error message

*STACK_TRACEBODY : stacktrace generated by ACRA

*STACK_TRACEBODY : stacktrace generated by ACRA

*INITIAL_CONFIGURATIONBODY : cellphone configuration generated by ACRA

*BUILDBODY : OS version generated by ACRA

error.create

( tokenID, json )

  • Info
  • Curl
  • PHP
POST /api/?action=error.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=error.create&tokenID= \   -d "json="
$response = InEvent\Error::create($client, [
  "tokenID" => ""
], [
  "json" => ""
]);

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

tokenIDQUERY : token identifier

jsonBODY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.edit&tokenID=&eventID=&key= \   -d "value="
$response = InEvent\Event::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : 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?"
}

valueBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=event.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.get&tokenID=&eventID=&personID=
$response = InEvent\Event::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns event eventID, informing if person personID is registered.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.get&tokenID=&eventID=
$response = InEvent\Event::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns event eventID, informing if person tokenID is registered.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.get&eventID=
$response = InEvent\Event::get($client, [
  "eventID" => ""
]);

Returns event eventID.

eventIDQUERY : event identifier

event.checkAccessCode

( tokenID, eventID, accessCode )

  • Info
  • Curl
  • PHP
POST /api/?action=event.checkAccessCodeHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.checkAccessCode&tokenID=&eventID= \   -d "accessCode="
$response = InEvent\Event::checkAccessCode($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "accessCode" => ""
]);

Informs if access code is correct for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

accessCodeBODY : event access code

event.sendSMS

( eventID, telephone )

  • Info
  • Curl
  • PHP
POST /api/?action=event.sendSMSHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.sendSMS&eventID= \   -d "telephone="
$response = InEvent\Event::sendSMS($client, [
  "eventID" => ""
], [
  "telephone" => ""
]);

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

eventIDQUERY : event identifier

telephoneBODY : telephone number

event.search

( tokenID, eventID, query )

  • Info
  • Curl
  • PHP
POST /api/?action=event.searchHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.search&tokenID=&eventID= \   -d "query="
$response = InEvent\Event::search($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "query" => ""
]);

Searchs generic objects inside the event.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

queryBODY : 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, *telephone )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.applicant.bind&eventID= \   -d "name=&username=&email=&password="
$response = InEvent\Event.applicant::bind($client, [
  "eventID" => ""
], [
  "name" => "",
  "username" => "",
  "email" => "",
  "password" => ""
]);

Creates an application at event eventID

eventIDQUERY : event identifier

nameBODY : person name

usernameBODY : person username

emailBODY : person email

passwordBODY : person password

*roleBODY : person role

*companyBODY : person company

*telephoneBODY : person telephone

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.applicant.bind&tokenID=&eventID= \   -d "path="
$response = InEvent\Event.applicant::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple applicants at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

event.applicant.operate

( tokenID, eventID, firstName, lastName, email )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.applicant.operate&tokenID=&eventID= \   -d "firstName=&lastName=&email="
$response = InEvent\Event.applicant::operate($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "firstName" => "",
  "lastName" => "",
  "email" => ""
]);

Changes an application at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

firstNameBODY : person first name

lastNameBODY : person last name

emailBODY : person email

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=event.applicant.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.applicant.operate&tokenID=&eventID= \   -d "content="
$response = InEvent\Event.applicant::operate($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Edits values content for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : key values for editing

event.applicant.dismiss

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.applicant.dismiss&tokenID=&eventID=&personID=
$response = InEvent\Event.applicant::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Removes an applicant personID from event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.applicant.find

( tokenID, eventID, *paginated, *query, *sort, *order )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.applicant.find&tokenID=&eventID=
$response = InEvent\Event.applicant::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all aplications at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*paginatedQUERY : request to be paginated

*queryQUERY : search field

*sortQUERY : sort search (fullName, firstName, lastName, email, personID)

*orderQUERY : order search ('ASC' or 'DESC')

event.applicant.get

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.applicant.get&tokenID=&eventID=&personID=
$response = InEvent\Event.applicant::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers an applicant personID at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.applicant.get&tokenID=&eventID=
$response = InEvent\Event.applicant::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers an application at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.applicant.approve

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.applicant.approveHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.applicant.approve&tokenID=&eventID=&personID=
$response = InEvent\Event.applicant::approve($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Approves an applicant personID at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.booking.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.booking.create&tokenID=&eventID= \   -d "name=&email=&telephone=&company=&dataCollectors=&liveSupport=&extraPhone=&extraLive=&automaticReport=&beacons=&pricing="
$response = InEvent\Event.booking::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "email" => "",
  "telephone" => "",
  "company" => "",
  "dataCollectors" => "",
  "liveSupport" => "",
  "extraPhone" => "",
  "extraLive" => "",
  "automaticReport" => "",
  "beacons" => "",
  "pricing" => ""
]);

Creates a reservation at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : client name

emailBODY : client email

telephoneBODY : client telephone

companyBODY : client company

dataCollectorsBODY : number of data collectors

liveSupportBODY : live support during the event

extraPhoneBODY : rented smartphone

extraLiveBODY : real-time leads base

automaticReportBODY : end of day automatic report

beaconsBODY : number of beacons

pricingBODY : sale price

event.booking.find

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.booking.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.booking.find&tokenID=&eventID=&selection=
$response = InEvent\Event.booking::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns reservations at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : event reservations

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

*queryQUERY : search text

event.booking.get

( tokenID, eventID, value )

  • Info
  • Curl
  • PHP
GET /api/?action=event.booking.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.booking.get&tokenID=&eventID=&value=
$response = InEvent\Event.booking::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "value" => ""
]);

Returns details from reservation value at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

valueQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.email.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.email.create&tokenID=&eventID= \   -d "subject=&text="
$response = InEvent\Event.email::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "subject" => "",
  "text" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

subjectBODY : email subject

textBODY : email content

*listIDBODY : list identifier

event.email.edit

( tokenID, eventID, source, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.email.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.email.edit&tokenID=&eventID=&source=&key= \   -d "value="
$response = InEvent\Event.email::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "source" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sourceQUERY : email source

keyQUERY : field name

{
    "text": "content"
}

valueBODY : field value

{
    "text": "string"
}

event.email.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.email.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.email.find&tokenID=&eventID=
$response = InEvent\Event.email::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all emails from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.email.get

( tokenID, eventEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.email.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.email.get&tokenID=&eventEmailID=
$response = InEvent\Event.email::get($client, [
  "tokenID" => "",
  "eventEmailID" => ""
]);

Returns email eventEmailID.

tokenIDQUERY : token identifier

eventEmailIDQUERY : email identifier

event.email.try

( tokenID, eventID, source )

  • Info
  • Curl
  • PHP
GET /api/?action=event.email.tryHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.email.try&tokenID=&eventID=&source=
$response = InEvent\Event.email::try($client, [
  "tokenID" => "",
  "eventID" => "",
  "source" => ""
]);

Sends a test email from source source to event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sourceQUERY : email source

event.email.dispatch

( tokenID, eventEmailID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.email.dispatchHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.email.dispatch&tokenID= \   -d "eventEmailID="
$response = InEvent\Event.email::dispatch($client, [
  "tokenID" => ""
], [
  "eventEmailID" => ""
]);

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

tokenIDQUERY : token identifier

eventEmailIDBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=event.blacklist.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.blacklist.remove&tokenID=&eventBlacklistID=
$response = InEvent\Event.blacklist::remove($client, [
  "tokenID" => "",
  "eventBlacklistID" => ""
]);

Removes email eventBlacklistID.

tokenIDQUERY : token identifier

eventBlacklistIDQUERY : event email identifier

event.blacklist.find

( tokenID, eventID, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.blacklist.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.blacklist.find&tokenID=&eventID=
$response = InEvent\Event.blacklist::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all unsubscribed emails from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*queryQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.sanity.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.sanity.operate&tokenID=&eventSanityID=&key= \   -d "value="
$response = InEvent\Event.sanity::operate($client, [
  "tokenID" => "",
  "eventSanityID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key from email email.

tokenIDQUERY : token identifier

eventSanityIDQUERY : event email identifier

keyQUERY : field name

{
    "clean": "email risk"
}

valueBODY : field value

{
    "clean": "bit"
}

event.sanity.find

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.sanity.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.sanity.find&tokenID=&eventID=&selection=
$response = InEvent\Event.sanity::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns all emails from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : search selection

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

*queryQUERY : 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.com",
            "senderDNS": "-1",
            "name": "Robert",
            "username": "robert@inevent.com"
        }
    ]
}

Methods

event.sender.edit

( tokenID, eventID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.sender.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.sender.edit&tokenID=&eventID=&key=&personID= \   -d "value="
$response = InEvent\Event.sender::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

valueBODY : element value

personIDQUERY : person identifier

event.sender.find

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.sender.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.sender.find&tokenID=&eventID=&selection=
$response = InEvent\Event.sender::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns signatures at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : event signatures

{
    "all": "all signatures"
}

*queryQUERY : search text

event.sender.get

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.sender.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.sender.get&tokenID=&eventID=&personID=
$response = InEvent\Event.sender::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns signature for personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.sender.refresh

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.sender.refreshHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.sender.refresh&tokenID=&eventID=&personID=
$response = InEvent\Event.sender::refresh($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Refreshes signature for personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : 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": "1",
            "hostID": "1",
            "name": "Robert",
            "email": "robert@inevent.com",
            "date": "1234121151"
        }
    ]
}

Methods

event.guest.bind

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

  • Info
  • Curl
  • PHP
POST /api/?action=event.guest.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.guest.bind&tokenID=&eventID=&hostID= \   -d "name="
$response = InEvent\Event.guest::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "hostID" => ""
], [
  "name" => ""
]);

Creates an guest at event eventID for host hostID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

hostIDQUERY : host identifier

nameBODY : guest name

*emailBODY : guest email

( tokenID, eventID, name, *email )

  • Info
  • Curl
  • PHP
POST /api/?action=event.guest.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.guest.bind&tokenID=&eventID= \   -d "name="
$response = InEvent\Event.guest::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => ""
]);

Creates an guest at event eventID for host tokenID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : guest name

*emailBODY : guest email

event.guest.operate

( tokenID, eventID, personID, *hostID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.guest.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.guest.operate&tokenID=&eventID=&personID=&key= \   -d "value="
$response = InEvent\Event.guest::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : guest identifier

*hostIDQUERY : host identifier

keyQUERY : element name

valueBODY : desired action

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

  • Info
  • Curl
  • PHP
POST /api/?action=event.guest.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.guest.operate&tokenID=&eventID=&personID= \   -d "content="
$response = InEvent\Event.guest::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "content" => ""
]);

Edits values content for guest personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : guest identifier

*hostIDQUERY : host identifier

contentBODY : key values for editing

event.guest.dismiss

( tokenID, eventID, personID, *hostID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.guest.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.guest.dismiss&tokenID=&eventID=&personID=
$response = InEvent\Event.guest::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Removes a guest personID from event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : guest identifier

*hostIDQUERY : host identifier

event.guest.find

( tokenID, eventID, *paginated, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.guest.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.guest.find&tokenID=&eventID=
$response = InEvent\Event.guest::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all guests at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*paginatedQUERY : request to be paginated

*queryQUERY : search field

event.guest.get

( tokenID, eventID, personID, *hostID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.guest.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.guest.get&tokenID=&eventID=&personID=
$response = InEvent\Event.guest::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers a guest personID at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : guest identifier

*hostIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.hotsite.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.hotsite.create&eventID=§ion= \   -d "position="
$response = InEvent\Event.hotsite::create($client, [
  "eventID" => "",
  "section" => ""
], [
  "position" => ""
]);

Adds section section on hotsite at event eventID.

eventIDQUERY : event identifier

sectionQUERY : section name

positionBODY : order among the sections

*nameBODY : section name

*textBODY : section text

event.hotsite.edit

( eventID, section, position, text )

  • Info
  • Curl
  • PHP
POST /api/?action=event.hotsite.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.hotsite.edit&eventID=§ion= \   -d "position=&text="
$response = InEvent\Event.hotsite::edit($client, [
  "eventID" => "",
  "section" => ""
], [
  "position" => "",
  "text" => ""
]);

Changes order of section section on hotsite at event eventID.

eventIDQUERY : event identifier

sectionQUERY : section name

positionBODY : order among the sections

textBODY : section text

event.hotsite.remove

( eventID, section )

  • Info
  • Curl
  • PHP
GET /api/?action=event.hotsite.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.hotsite.remove&eventID=§ion=
$response = InEvent\Event.hotsite::remove($client, [
  "eventID" => "",
  "section" => ""
]);

Removes section section from event eventID hotsite.

eventIDQUERY : event identifier

sectionQUERY : section name

event.hotsite.find

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.hotsite.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.hotsite.find&eventID=
$response = InEvent\Event.hotsite::find($client, [
  "eventID" => ""
]);

Returns all sections linked to event eventID hotsite.

eventIDQUERY : event identifier

event.hotsite.get

( eventID, section )

  • Info
  • Curl
  • PHP
GET /api/?action=event.hotsite.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.hotsite.get&eventID=§ion=
$response = InEvent\Event.hotsite::get($client, [
  "eventID" => "",
  "section" => ""
]);

Returns section section linked to event eventID hotsite.

eventIDQUERY : event identifier

sectionQUERY : section name

event.hotsite.getConfig

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.hotsite.getConfigHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.hotsite.getConfig&eventID=
$response = InEvent\Event.hotsite::getConfig($client, [
  "eventID" => ""
]);

Returns current configurations from event eventID hotsite.

eventIDQUERY : event identifier

event.hotsite.setConfig

( eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.hotsite.setConfigHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.hotsite.setConfig&eventID=&key= \   -d "value="
$response = InEvent\Event.hotsite::setConfig($client, [
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Configures hotsite elements from event eventID.

eventIDQUERY : event identifier

keyQUERY : 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",
    "backgroundColor": "background color",
    "navigationBarBackgroundColor": "bar color",
    "mainColor": "main color",
    "registration": "activates registration link"
}

valueBODY : field value

{
    "template": "string",
    "saveTheDate": "boolean",
    "registrationLink": "string",
    "sponsorCategory": "boolean",
    "countdown": "boolean",
    "newsletterListId": "integer",
    "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.com",
            "inviteRole": "CFO",
            "inviteCompany": "InEvent",
            "inviteTelephone": "",
            "used": "0",
            "rsvp": "-1",
            "name": "",
            "username": "robert@inevent.com",
            "assistantEmail": "john@inevent.com",
            "date": ""
        }
    ]
}

Methods

event.invite.create

( tokenID, eventID, email )

  • Info
  • Curl
  • PHP
POST /api/?action=event.invite.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.invite.create&tokenID=&eventID= \   -d "email="
$response = InEvent\Event.invite::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "email" => ""
]);

Creates an invite at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailBODY : invite email

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=event.invite.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.invite.create&tokenID=&eventID= \   -d "path="
$response = InEvent\Event.invite::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple invites at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

event.invite.edit

( tokenID, eventID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.invite.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.invite.edit&tokenID=&eventID=&key=&personID= \   -d "value="
$response = InEvent\Event.invite::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

valueBODY : desired action

personIDQUERY : person identifier

event.invite.remove

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.invite.remove&tokenID=&eventID=&personID=
$response = InEvent\Event.invite::remove($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Removes person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.invite.find

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.invite.find&tokenID=&eventID=&selection=
$response = InEvent\Event.invite::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns invites at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : event invites

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

*queryQUERY : search text

event.invite.get

( tokenID, eventID, email )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.invite.get&tokenID=&eventID=&email=
$response = InEvent\Event.invite::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "email" => ""
]);

Returns details of invite email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailQUERY : invite email

( eventID, email )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.invite.get&eventID=&email=
$response = InEvent\Event.invite::get($client, [
  "eventID" => "",
  "email" => ""
]);

Returns details of invite email at event eventID.

eventIDQUERY : event identifier

emailQUERY : invite email

event.invite.rsvp

( tokenID, eventID, email )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.rsvpHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.invite.rsvp&tokenID=&eventID=&email=
$response = InEvent\Event.invite::rsvp($client, [
  "tokenID" => "",
  "eventID" => "",
  "email" => ""
]);

Updates rsvp for invite email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailQUERY : invite email

( eventID, email )

  • Info
  • Curl
  • PHP
GET /api/?action=event.invite.rsvpHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.invite.rsvp&eventID=&email=
$response = InEvent\Event.invite::rsvp($client, [
  "eventID" => "",
  "email" => ""
]);

Updates rsvp for invite email at event eventID.

eventIDQUERY : event identifier

emailQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.notification.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.notification.operate&tokenID=&eventID=&key=&personID= \   -d "value="
$response = InEvent\Event.notification::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : field name

valueBODY : field value

personIDQUERY : person identifier

event.notification.get

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.notification.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.notification.get&tokenID=&eventID=&personID=
$response = InEvent\Event.notification::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns notifications of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.person.bind&tokenID=&eventID= \   -d "name=&username="
$response = InEvent\Event.person::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "username" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : person name

usernameBODY : person username

*passwordBODY : person password

*roleBODY : person role

*companyBODY : person company

*accessCodeBODY : event access code

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

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.person.bind&eventID= \   -d "invite=&email="
$response = InEvent\Event.person::bind($client, [
  "eventID" => ""
], [
  "invite" => "",
  "email" => ""
]);

Requests person with invite invite to join event eventID.

eventIDQUERY : event identifier

inviteBODY : access invite

emailBODY : person email

*nameBODY : person name

*passwordBODY : person password

*roleBODY : person role

*companyBODY : person company

*rsvpBODY : person rsvp

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.person.bind&tokenID=&eventID= \   -d "path="
$response = InEvent\Event.person::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Requests multiple people to join event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

( tokenID, eventID, *accessCode )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.person.bind&tokenID=&eventID= \   -d ""
$response = InEvent\Event.person::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [

]);

Requests person tokenID to join event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*accessCodeBODY : event access code

event.person.operate

( tokenID, eventID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.person.operate&tokenID=&eventID=&key=&personID= \   -d "value="
$response = InEvent\Event.person::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

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

valueBODY : desired action

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

personIDQUERY : person identifier

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.person.operate&tokenID=&eventID=&key= \   -d "value="
$response = InEvent\Event.person::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

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

valueBODY : desired action

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

( tokenID, eventID, content, *personID )

  • Info
  • Curl
  • PHP
POST /api/?action=event.person.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.person.operate&tokenID=&eventID= \   -d "content="
$response = InEvent\Event.person::operate($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Edits values content for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : array of key values for editing

{
    "key": "string",
    "value": "string"
}

*personIDQUERY : person identifier

event.person.dismiss

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.dismiss&tokenID=&eventID=&personID=
$response = InEvent\Event.person::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Requests removal of person personID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.dismiss&tokenID=&eventID=&content=
$response = InEvent\Event.person::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "content" => ""
]);

Requests removal of people content from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentQUERY : json formatted as [{personID}]

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.dismiss&tokenID=&eventID=
$response = InEvent\Event.person::dismiss($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Requests removal of person tokenID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.person.find

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

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.find&tokenID=&eventID=&selection=
$response = InEvent\Event.person::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : 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"
}

*orderQUERY : order based on column

*orderDirectionQUERY : order direction based on column

*queryQUERY : search text

*queryKeyQUERY : search key

*matchQUERY : exact match

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

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.find&tokenID=&eventID=&selection=
$response = InEvent\Event.person::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : people at event

*queryQUERY : search text

event.person.get

( tokenID, feedbackID, value )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.get&tokenID=&feedbackID=&value=
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "feedbackID" => "",
  "value" => ""
]);

Returns details of person with value value on field feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : field identifier

valueQUERY : field value

( tokenID, eventID, email )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.get&tokenID=&eventID=&email=
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "email" => ""
]);

Returns details of person email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailQUERY : person email

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.get&tokenID=&eventID=&personID=
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Returns details of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, qrCode )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.get&tokenID=&eventID=&qrCode=
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "qrCode" => ""
]);

Retuens details of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

qrCodeQUERY : person qrCode

( tokenID, eventID, nfc )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.get&tokenID=&eventID=&nfc=
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "nfc" => ""
]);

Returns details of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nfcQUERY : person nfc wristband

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.get&tokenID=&eventID=
$response = InEvent\Event.person::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns details of person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.person.remember

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.rememberHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.remember&tokenID=&eventID=
$response = InEvent\Event.person::remember($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Sends email reminder for event eventID participants.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.person.qrCode

( tokenID, eventID, *query, *match )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.qrCodeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.qrCode&tokenID=&eventID=
$response = InEvent\Event.person::qrCode($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Generates all QR Codes for people at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*queryQUERY : search text

*matchQUERY : exact match

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.qrCodeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.qrCode&tokenID=&eventID=&personID=
$response = InEvent\Event.person::qrCode($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Generates all QR Codes of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.person.print

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.printHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.print&tokenID=&eventID=&personID=
$response = InEvent\Event.person::print($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

event.person.printed

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.printedHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.printed&tokenID=&eventID=
$response = InEvent\Event.person::printed($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns badges printed beyond cap at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

event.person.voucher

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.person.voucherHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.person.voucher&tokenID=&eventID=
$response = InEvent\Event.person::voucher($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Obtains voucher information for person at event eventID

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=event.pipeline.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.pipeline.find&tokenID=&eventID=
$response = InEvent\Event.pipeline::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Obtains a pipeline for event eventID

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.printer.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.printer.edit&tokenID=&eventID=&key= \   -d "value="
$response = InEvent\Event.printer::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : authentication token

eventIDQUERY : event identifier

keyQUERY : key to be changed

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

valueBODY : key value

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

event.printer.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.printer.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.printer.get&tokenID=&eventID=
$response = InEvent\Event.printer::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gets printing configuration for event eventID.

tokenIDQUERY : authentication token

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.tab.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.tab.create&tokenID=&eventID= \   -d "title=&link="
$response = InEvent\Event.tab::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "title" => "",
  "link" => ""
]);

Creates title title with link link at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

titleBODY : tab title

linkBODY : tab link

event.tab.edit

( tokenID, eventID, tab, language, value )

  • Info
  • Curl
  • PHP
POST /api/?action=event.tab.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.tab.edit&tokenID=&eventID=&tab=&language= \   -d "value="
$response = InEvent\Event.tab::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "tab" => "",
  "language" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

tabQUERY : tab name

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

languageQUERY : language to be edited

valueBODY : tab text

event.tab.remove

( tokenID, eventTabID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tab.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.tab.remove&tokenID=&eventTabID=
$response = InEvent\Event.tab::remove($client, [
  "tokenID" => "",
  "eventTabID" => ""
]);

Removes tab eventTabID.

tokenIDQUERY : token identifier

eventTabIDQUERY : tab identifier

event.tab.get

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tab.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.tab.get&eventID=
$response = InEvent\Event.tab::get($client, [
  "eventID" => ""
]);

Returns all tabs from event eventID.

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tag.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.tag.bind&tokenID=&eventID=&tagID=
$response = InEvent\Event.tag::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "tagID" => ""
]);

Links tag tagID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

tagIDQUERY : tag identifier

event.tag.dismiss

( tokenID, eventID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tag.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.tag.dismiss&tokenID=&eventID=&tagID=
$response = InEvent\Event.tag::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "tagID" => ""
]);

Unlinks tag tagID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

tagIDQUERY : tag identifier

event.tag.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tag.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.tag.find&tokenID=&eventID=
$response = InEvent\Event.tag::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all event eventID tags.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tag.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.tag.find&eventID=
$response = InEvent\Event.tag::find($client, [
  "eventID" => ""
]);

Returns all event eventID tags.

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.theme.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.theme.operate&tokenID=&eventID=&operation=&key= \   -d "value="
$response = InEvent\Event.theme::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "operation" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

operationQUERY : desired action

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

keyQUERY : element type

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

valueBODY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=event.tool.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=event.tool.edit&tokenID=&eventID=&key= \   -d "value="
$response = InEvent\Event.tool::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

valueBODY : element value

event.tool.get

( eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=event.tool.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=event.tool.get&eventID=
$response = InEvent\Event.tool::get($client, [
  "eventID" => ""
]);

Returns all tools available at event eventID.

eventIDQUERY : event identifier

Eventbrite

Module destinated to integration between InEvent events and Eventbrite events.

Methods

eventbrite.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=eventbrite.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=eventbrite.get&tokenID=&eventID=
$response = InEvent\Eventbrite::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Obtains integration data from Eventbrite with event eventID.

tokenIDQUERY : admin token

eventIDQUERY : event identifier

eventbrite.linkField

( tokenID, eventID, feedbackID, ebFieldID )

  • Info
  • Curl
  • PHP
POST /api/?action=eventbrite.linkFieldHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=eventbrite.linkField&tokenID=&eventID= \   -d "feedbackID=&ebFieldID="
$response = InEvent\Eventbrite::linkField($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "feedbackID" => "",
  "ebFieldID" => ""
]);

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

tokenIDQUERY : admin token

eventIDQUERY : event identifier

feedbackIDBODY : InEvent field identifier

ebFieldIDBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=facebook.signInHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=facebook.signIn&facebookToken=
$response = InEvent\Facebook::signIn($client, [
  "facebookToken" => ""
]);

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

facebookTokenQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=feed.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feed.create&tokenID=&eventID= \   -d "text="
$response = InEvent\Feed::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "text" => ""
]);

Creates a post with contents text at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

textBODY : post contents

*pictureBODY : picture url

*videoBODY : video url

*externalUrlBODY : url for an external resource

feed.edit

( tokenID, feedID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=feed.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feed.edit&tokenID=&feedID=&key= \   -d "value="
$response = InEvent\Feed::edit($client, [
  "tokenID" => "",
  "feedID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits a field of post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

keyQUERY : field name

valueBODY : field value

feed.remove

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.remove&tokenID=&feedID=
$response = InEvent\Feed::remove($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Removes post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.find

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.find&tokenID=&eventID=&selection=
$response = InEvent\Feed::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Returns all posts for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : selection scope

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

*queryQUERY : query text

( eventID, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.find&eventID=
$response = InEvent\Feed::find($client, [
  "eventID" => ""
]);

Returns all public posts for event eventID.

eventIDQUERY : event identifier

*queryQUERY : query text

feed.get

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.get&tokenID=&feedID=
$response = InEvent\Feed::get($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Returns post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.share

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.shareHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.share&tokenID=&feedID=
$response = InEvent\Feed::share($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Shares post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.like

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.likeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.like&tokenID=&feedID=
$response = InEvent\Feed::like($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Likes post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.unlike

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.unlikeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.unlike&tokenID=&feedID=
$response = InEvent\Feed::unlike($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Unlikes post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.report

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.reportHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.report&tokenID=&feedID=
$response = InEvent\Feed::report($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Reports post feedID as inappropriate.

tokenIDQUERY : token identifier

feedIDQUERY : post identifier

feed.preview

( tokenID, eventID, url )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.previewHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.preview&tokenID=&eventID=&url=
$response = InEvent\Feed::preview($client, [
  "tokenID" => "",
  "eventID" => "",
  "url" => ""
]);

Generates a preview for link url at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

urlQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=feed.comment.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feed.comment.create&tokenID=&feedID= \   -d "text="
$response = InEvent\Feed.comment::create($client, [
  "tokenID" => "",
  "feedID" => ""
], [
  "text" => ""
]);

Creates a new comment with contents text at post feedID.

tokenIDQUERY : token identifier

feedIDQUERY : feed identifier

textBODY : comment text

feed.comment.edit

( tokenID, feedCommentID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=feed.comment.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feed.comment.edit&tokenID=&feedCommentID=&key= \   -d "value="
$response = InEvent\Feed.comment::edit($client, [
  "tokenID" => "",
  "feedCommentID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of comment feedCommentID.

tokenIDQUERY : token identifier

feedCommentIDQUERY : comment identifier

keyQUERY : field name

valueBODY : field value

feed.comment.remove

( tokenID, feedCommentID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.comment.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.comment.remove&tokenID=&feedCommentID=
$response = InEvent\Feed.comment::remove($client, [
  "tokenID" => "",
  "feedCommentID" => ""
]);

Removes comment feedCommentID.

tokenIDQUERY : token identifier

feedCommentIDQUERY : comment identifier

feed.comment.find

( tokenID, feedID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.comment.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.comment.find&tokenID=&feedID=
$response = InEvent\Feed.comment::find($client, [
  "tokenID" => "",
  "feedID" => ""
]);

Gathers all post feedID comments

tokenIDQUERY : token identifier

feedIDQUERY : feed identifier

feed.comment.report

( tokenID, feedCommentID )

  • Info
  • Curl
  • PHP
GET /api/?action=feed.comment.reportHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feed.comment.report&tokenID=&feedCommentID=
$response = InEvent\Feed.comment::report($client, [
  "tokenID" => "",
  "feedCommentID" => ""
]);

Reports a comment feedCommentID as inappropriate.

tokenIDQUERY : token identifier

feedCommentIDQUERY : 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",
            "subtitlePT": "Legenda",
            "subtitleEN": "Subtitle",
            "subtitleES": "Subtítulo",
            "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, *subtitle, type, *preQualify )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.create&tokenID=&eventID= \   -d "text=&type="
$response = InEvent\Feedback::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "text" => "",
  "type" => ""
]);

Creates a new feedback at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

textBODY : feedback text

*subtitleBODY : feedback subtitle

typeBODY : feedback type

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

*preQualifyBODY : pre-qualify

( tokenID, activityID, text, *subtitle, type )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.create&tokenID=&activityID= \   -d "text=&type="
$response = InEvent\Feedback::create($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "text" => "",
  "type" => ""
]);

Creates a new feedback at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

textBODY : feedback text

*subtitleBODY : feedback subtitle

typeBODY : feedback type

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

( tokenID, meetingID, text, *subtitle, type )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.create&tokenID=&meetingID= \   -d "text=&type="
$response = InEvent\Feedback::create($client, [
  "tokenID" => "",
  "meetingID" => ""
], [
  "text" => "",
  "type" => ""
]);

Creates a new feedback at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

textBODY : feedback text

*subtitleBODY : feedback subtitle

typeBODY : feedback type

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

( tokenID, formID, text, *subtitle, type )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.create&tokenID=&formID= \   -d "text=&type="
$response = InEvent\Feedback::create($client, [
  "tokenID" => "",
  "formID" => ""
], [
  "text" => "",
  "type" => ""
]);

Creates a new feedback at form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

textBODY : feedback text

*subtitleBODY : feedback subtitle

typeBODY : feedback type

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

feedback.edit

( tokenID, feedbackID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.edit&tokenID=&feedbackID=&key= \   -d "value="
$response = InEvent\Feedback::edit($client, [
  "tokenID" => "",
  "feedbackID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

keyQUERY : field name

{
    "textPT": "texto em português",
    "textEN": "english text",
    "textES": "texto en español",
    "subtitlePT": "legenda em português",
    "subtitleEN": "english subtitle",
    "subtitleES": "subtítulo en español",
    "type": "type",
    "preQualify": "initial flow",
    "required": "is it required"
}

valueBODY : field value

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

feedback.remove

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.remove&tokenID=&feedbackID=
$response = InEvent\Feedback::remove($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Removes feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

feedback.find

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.find&tokenID=&eventID=&selection=
$response = InEvent\Feedback::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all feedbacks posted at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : feedbacks scope

{
    "preQualify": "pre-qualify feedback",
    "event": "event feedbacks",
    "event+activities": "event feedbacks and activities",
    "event+preQualify": "event feedbacks and pre-qualify",
    "registration": "event registration form",
    "guest": "event guest registration form",
    "registration-guest": "event registration form",
    "event-all": "event feedbacks"
}

( eventID, selection, invite )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.find&eventID=&selection=&invite=
$response = InEvent\Feedback::find($client, [
  "eventID" => "",
  "selection" => "",
  "invite" => ""
]);

Gathers all feedbacks posted at event eventID.

eventIDQUERY : event identifier

selectionQUERY : feedbacks scope

inviteQUERY : invite field

( eventID, selection, ticketToken )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.find&eventID=&selection=&ticketToken=
$response = InEvent\Feedback::find($client, [
  "eventID" => "",
  "selection" => "",
  "ticketToken" => ""
]);

Gathers all feedbacks posted at event eventID.

eventIDQUERY : event identifier

selectionQUERY : feedbacks scope

ticketTokenQUERY : ticket token identifier

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.find&tokenID=&activityID=
$response = InEvent\Feedback::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Gathers all feedbacks posted at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.find&tokenID=&meetingID=
$response = InEvent\Feedback::find($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Gathers all feedbacks posted at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

( tokenID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.find&tokenID=&formID=
$response = InEvent\Feedback::find($client, [
  "tokenID" => "",
  "formID" => ""
]);

Gathers all feedbacks posted at form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

feedback.get

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.get&tokenID=&feedbackID=
$response = InEvent\Feedback::get($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Gathers feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

feedback.pushNotification

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.pushNotificationHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.pushNotification&tokenID=&activityID=
$response = InEvent\Feedback::pushNotification($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Sends a notification for all attendees of activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.pushNotificationHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.pushNotification&tokenID=&eventID=
$response = InEvent\Feedback::pushNotification($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Sends a notification for all attendees of event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

feedback.respond

( tokenID, eventID, content, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.respondHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.respond&tokenID=&eventID=&personID= \   -d "content="
$response = InEvent\Feedback::respond($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "content" => ""
]);

Answers single or several feedbacks at event eventID for person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : JSON content

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

personIDQUERY : person identifier

( tokenID, eventID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.respondHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.respond&tokenID=&eventID= \   -d "content="
$response = InEvent\Feedback::respond($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "content" => ""
]);

Answers single or several feedbacks at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

contentBODY : JSON content

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

( eventID, content, invite )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.respondHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.respond&eventID=&invite= \   -d "content="
$response = InEvent\Feedback::respond($client, [
  "eventID" => "",
  "invite" => ""
], [
  "content" => ""
]);

Answers single or several feedbacks at event eventID for person invite.

eventIDQUERY : event identifier

contentBODY : JSON content

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

inviteQUERY : invite field

( eventID, content, personID, password )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.respondHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.respond&eventID=&personID= \   -d "content=&password="
$response = InEvent\Feedback::respond($client, [
  "eventID" => "",
  "personID" => ""
], [
  "content" => "",
  "password" => ""
]);

Answers single or several feedbacks at event eventID for person personID with password.

eventIDQUERY : event identifier

contentBODY : JSON content

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

personIDQUERY : person identifier

passwordBODY : person password

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 )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.option.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.option.create&tokenID=&feedbackID= \   -d "textPT="
$response = InEvent\Feedback.option::create($client, [
  "tokenID" => "",
  "feedbackID" => ""
], [
  "textPT" => ""
]);

Creates a new option at feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

textPTBODY : feedback text

*textENBODY : feedback text

*textESBODY : feedback text

feedback.option.edit

( tokenID, feedbackOptionID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=feedback.option.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=feedback.option.edit&tokenID=&feedbackOptionID=&key= \   -d "value="
$response = InEvent\Feedback.option::edit($client, [
  "tokenID" => "",
  "feedbackOptionID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of feedback option feedbackOptionID.

tokenIDQUERY : token identifier

feedbackOptionIDQUERY : feedback option identifier

keyQUERY : field name

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

valueBODY : field value

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

feedback.option.remove

( tokenID, feedbackOptionID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.option.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.option.remove&tokenID=&feedbackOptionID=
$response = InEvent\Feedback.option::remove($client, [
  "tokenID" => "",
  "feedbackOptionID" => ""
]);

Removes feedback option feedbackOptionID.

tokenIDQUERY : token identifier

feedbackOptionIDQUERY : feedback option identifier

feedback.option.find

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.option.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.option.find&tokenID=&feedbackID=
$response = InEvent\Feedback.option::find($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Gathers all options for feedback feedbackID.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

feedback.option.get

( tokenID, feedbackOptionID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.option.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.option.get&tokenID=&feedbackOptionID=
$response = InEvent\Feedback.option::get($client, [
  "tokenID" => "",
  "feedbackOptionID" => ""
]);

Gathers feedback option feedbackOptionID.

tokenIDQUERY : token identifier

feedbackOptionIDQUERY : feedback option identifier

feedback.option.clear

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.option.clearHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.option.clear&tokenID=&feedbackID=
$response = InEvent\Feedback.option::clear($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Removes all feedback feedbackID options.

tokenIDQUERY : token identifier

feedbackIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.submission.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.submission.find&tokenID=&eventID=
$response = InEvent\Feedback.submission::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all feedback submissions for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : selection identifier

*paginatedQUERY : should be paginated

( tokenID, activityID, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.submission.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.submission.find&tokenID=&activityID=
$response = InEvent\Feedback.submission::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Gathers all feedback submissions for activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

*paginatedQUERY : should be paginated

( tokenID, formID, *paginated )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.submission.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.submission.find&tokenID=&formID=
$response = InEvent\Feedback.submission::find($client, [
  "tokenID" => "",
  "formID" => ""
]);

Gathers all feedback submissions for form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

*paginatedQUERY : should be paginated

feedback.submission.get

( tokenID, feedbackSubmissionID )

  • Info
  • Curl
  • PHP
GET /api/?action=feedback.submission.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=feedback.submission.get&tokenID=&feedbackSubmissionID=
$response = InEvent\Feedback.submission::get($client, [
  "tokenID" => "",
  "feedbackSubmissionID" => ""
]);

Gathers a feedback submission feedbackSubmissionID.

tokenIDQUERY : token identifier

feedbackSubmissionIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=file.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=file.create&tokenID=&companyID=&name=&width=&height= \   -d "file="
$response = InEvent\File::create($client, [
  "tokenID" => "",
  "companyID" => "",
  "name" => "",
  "width" => "",
  "height" => ""
], [
  "file" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameQUERY : file name

fileBODY : binary file

widthQUERY : image width

heightQUERY : image height

( onboardingToken, name, width, height, file )

  • Info
  • Curl
  • PHP
POST /api/?action=file.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=file.create&onboardingToken=&name=&width=&height= \   -d "file="
$response = InEvent\File::create($client, [
  "onboardingToken" => "",
  "name" => "",
  "width" => "",
  "height" => ""
], [
  "file" => ""
]);

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

onboardingTokenQUERY : token de onboarding

nameQUERY : file name

widthQUERY : image width

heightQUERY : image height

fileBODY : binary file

file.crop

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

  • Info
  • Curl
  • PHP
GET /api/?action=file.cropHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=file.crop&tokenID=&companyID=&url=&width=&height=&xpos=&ypos=
$response = InEvent\File::crop($client, [
  "tokenID" => "",
  "companyID" => "",
  "url" => "",
  "width" => "",
  "height" => "",
  "xpos" => "",
  "ypos" => ""
]);

Crops an image.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

urlQUERY : file name

widthQUERY : file width

heightQUERY : file height

xposQUERY : crop x pos

yposQUERY : 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, *message )

  • Info
  • Curl
  • PHP
POST /api/?action=flight.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=flight.create&tokenID=&eventID=&personID= \   -d "airline=&number=&gate=&seat=&ticketType=&airportBegin=&airportEnd=&dateBegin=&dateEnd=&dateIssue="
$response = InEvent\Flight::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "airline" => "",
  "number" => "",
  "gate" => "",
  "seat" => "",
  "ticketType" => "",
  "airportBegin" => "",
  "airportEnd" => "",
  "dateBegin" => "",
  "dateEnd" => "",
  "dateIssue" => ""
]);

Creates a flight entry at event eventID for person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

airlineBODY : airline company

numberBODY : flight number

gateBODY : flight gate

seatBODY : flight seat

ticketTypeBODY : ticket type

airportBeginBODY : airport of departure

airportEndBODY : airport of arrival

dateBeginBODY : date and time of departure

dateEndBODY : date and time of arrival

dateIssueBODY : ticket issue date

*priceBODY : flight price

*priceConversionBODY : price conversion

*insuranceBODY : insurance agency

*eTicketBODY : electronic ticket

*confirmationBODY : confirmation code

*messageBODY : custom messages

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

  • Info
  • Curl
  • PHP
POST /api/?action=flight.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=flight.create&tokenID=&eventID= \   -d "email=&airline=&number=&gate=&ticketType=&airportBegin=&airportEnd=&dateBegin=&dateEnd=&dateIssue="
$response = InEvent\Flight::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "email" => "",
  "airline" => "",
  "number" => "",
  "gate" => "",
  "ticketType" => "",
  "airportBegin" => "",
  "airportEnd" => "",
  "dateBegin" => "",
  "dateEnd" => "",
  "dateIssue" => ""
]);

Creates a flight entry at event eventID for person email.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

emailBODY : email da pessoa

airlineBODY : airline company

numberBODY : flight number

gateBODY : flight gate

ticketTypeBODY : ticket type

airportBeginBODY : airport of departure

airportEndBODY : airport of arrival

dateBeginBODY : date and time of departure

dateEndBODY : date and time of arrival

dateIssueBODY : ticket issue date

*priceBODY : flight price

*priceConversionBODY : price conversion

*insuranceBODY : insurance agency

*eTicketBODY : electronic ticket

*confirmationBODY : confirmation code

*messageBODY : custom messages

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=flight.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=flight.create&tokenID=&eventID= \   -d "path="
$response = InEvent\Flight::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple flights at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : file path

flight.edit

( tokenID, flightID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=flight.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=flight.edit&tokenID=&flightID=&key= \   -d "value="
$response = InEvent\Flight::edit($client, [
  "tokenID" => "",
  "flightID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of flight flightID.

tokenIDQUERY : token identifier

flightIDQUERY : flight identifier

keyQUERY : 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"
}

valueBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=flight.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=flight.remove&tokenID=&flightID=
$response = InEvent\Flight::remove($client, [
  "tokenID" => "",
  "flightID" => ""
]);

Removes flight flightID from event.

tokenIDQUERY : token identifier

flightIDQUERY : flight identifier

flight.find

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=flight.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=flight.find&tokenID=&eventID=&personID=
$response = InEvent\Flight::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers all flights of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, *selection, *query, *queryKey )

  • Info
  • Curl
  • PHP
GET /api/?action=flight.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=flight.find&tokenID=&eventID=
$response = InEvent\Flight::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all flights from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : specific selection

{
    "all": "all flights"
}

*queryQUERY : query text

*queryKeyQUERY : query key

flight.stats

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=flight.statsHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=flight.stats&tokenID=&eventID=
$response = InEvent\Flight::stats($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all flight statistics at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=flow.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=flow.find&tokenID=&eventID=&selection=
$response = InEvent\Flow::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers interactions flow for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=form.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=form.create&tokenID=&companyID= \   -d "title=&type="
$response = InEvent\Form::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "title" => "",
  "type" => ""
]);

Creates a new form at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

titleBODY : form title

typeBODY : type of form

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

*descriptionBODY : form description

( tokenID, eventID, title, *description )

  • Info
  • Curl
  • PHP
POST /api/?action=form.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=form.create&tokenID=&eventID= \   -d "title="
$response = InEvent\Form::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "title" => ""
]);

Creates a new form at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

titleBODY : form title

*descriptionBODY : form description

form.edit

( tokenID, formID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=form.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=form.edit&tokenID=&formID=&key= \   -d "value="
$response = InEvent\Form::edit($client, [
  "tokenID" => "",
  "formID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

keyQUERY : field name

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

valueBODY : field value

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

form.remove

( tokenID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=form.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=form.remove&tokenID=&formID=
$response = InEvent\Form::remove($client, [
  "tokenID" => "",
  "formID" => ""
]);

Removes form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

form.find

( tokenID, companyID, selection, *complementRegistration )

  • Info
  • Curl
  • PHP
GET /api/?action=form.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=form.find&tokenID=&companyID=&selection=
$response = InEvent\Form::find($client, [
  "tokenID" => "",
  "companyID" => "",
  "selection" => ""
]);

Gathers all forms created at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

selectionQUERY : filter

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

*complementRegistrationQUERY : Return the forms with or without the flag 'complement registration form'.

( tokenID, eventID, *complementRegistration )

  • Info
  • Curl
  • PHP
GET /api/?action=form.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=form.find&tokenID=&eventID=
$response = InEvent\Form::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all forms created at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*complementRegistrationQUERY : Return the forms with or without the flag 'complement registration form'.

form.get

( tokenID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=form.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=form.get&tokenID=&formID=
$response = InEvent\Form::get($client, [
  "tokenID" => "",
  "formID" => ""
]);

Gathers form formID.

tokenIDQUERY : token identifier

formIDQUERY : form identifier

form.respondRegistration

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

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondRegistrationHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=form.respondRegistration&eventID=&ticketPersonID= \   -d "ticketToken=&feedbackContent="
$response = InEvent\Form::respondRegistration($client, [
  "eventID" => "",
  "ticketPersonID" => ""
], [
  "ticketToken" => "",
  "feedbackContent" => ""
]);

Responds form for event eventID registration with ticket invitation ticketToken.

*tokenIDQUERY : token identifier

eventIDQUERY : event identifier

ticketPersonIDQUERY : ticket identifier

ticketTokenBODY : ticket token identifier

feedbackContentBODY : feedback content field

*emailBODY : email field

*usernameBODY : username field

*firstNameBODY : first name field

*lastNameBODY : last name field

*passwordBODY : password field

*roleBODY : role field

*companyBODY : company field

*guestContentBODY : guest content field

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

  • Info
  • Curl
  • PHP
POST /api/?action=form.respondRegistrationHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=form.respondRegistration&eventID= \   -d "feedbackContent="
$response = InEvent\Form::respondRegistration($client, [
  "eventID" => ""
], [
  "feedbackContent" => ""
]);

Responds form for event eventID registration.

*tokenIDQUERY : token identifier

eventIDQUERY : event identifier

feedbackContentBODY : feedback content field

*inviteBODY : invite field

*emailBODY : email field

*usernameBODY : username field

*firstNameBODY : first name field

*lastNameBODY : last name field

*passwordBODY : password field

*roleBODY : role field

*companyBODY : company field

*rsvpBODY : event identifier

*guestContentBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=form.list.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=form.list.bind&tokenID=&listID=&formID=
$response = InEvent\Form.list::bind($client, [
  "tokenID" => "",
  "listID" => "",
  "formID" => ""
]);

Requests list listID creation on form formID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

formIDQUERY : form identifier

form.list.dismiss

( tokenID, listID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=form.list.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=form.list.dismiss&tokenID=&listID=&formID=
$response = InEvent\Form.list::dismiss($client, [
  "tokenID" => "",
  "listID" => "",
  "formID" => ""
]);

Removes list listID from form formID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

formIDQUERY : form identifier

form.list.find

( tokenID, formID )

  • Info
  • Curl
  • PHP
GET /api/?action=form.list.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=form.list.find&tokenID=&formID=
$response = InEvent\Form.list::find($client, [
  "tokenID" => "",
  "formID" => ""
]);

Returns all lists from form formID.

tokenIDQUERY : token identifier

formIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=gamification.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=gamification.create&tokenID=&eventID= \   -d "name=&description=&points="
$response = InEvent\Gamification::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "description" => "",
  "points" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : mission name

descriptionBODY : mission description

pointsBODY : mission points

gamification.edit

( tokenID, gamificationID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=gamification.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=gamification.edit&tokenID=&gamificationID=&key= \   -d "value="
$response = InEvent\Gamification::edit($client, [
  "tokenID" => "",
  "gamificationID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of mission gamificationID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

keyQUERY : field name

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

valueBODY : field value

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

gamification.remove

( tokenID, gamificationID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=gamification.remove&tokenID=&gamificationID=
$response = InEvent\Gamification::remove($client, [
  "tokenID" => "",
  "gamificationID" => ""
]);

Removes mission gamificationID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

gamification.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=gamification.find&tokenID=&eventID=
$response = InEvent\Gamification::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all missions at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

gamification.get

( tokenID, gamificationID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=gamification.get&tokenID=&gamificationID=
$response = InEvent\Gamification::get($client, [
  "tokenID" => "",
  "gamificationID" => ""
]);

Gathers mission gamificationID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

gamification.leaderboard

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.leaderboardHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=gamification.leaderboard&tokenID=&eventID=
$response = InEvent\Gamification::leaderboard($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers leaderboard for all missions at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=gamification.person.bind&tokenID=&gamificationID=
$response = InEvent\Gamification.person::bind($client, [
  "tokenID" => "",
  "gamificationID" => ""
]);

Adds a mission gamificationID for person.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

gamification.person.operate

( tokenID, gamificationID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=gamification.person.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=gamification.person.operate&tokenID=&gamificationID=&key=&personID= \   -d "value="
$response = InEvent\Gamification.person::operate($client, [
  "tokenID" => "",
  "gamificationID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

keyQUERY : field name

{
    "confirmed": "confirms the mission"
}

valueBODY : field value

{
    "confirmed": "integer"
}

personIDQUERY : person identifier

gamification.person.dismiss

( tokenID, gamificationID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=gamification.person.dismiss&tokenID=&gamificationID=
$response = InEvent\Gamification.person::dismiss($client, [
  "tokenID" => "",
  "gamificationID" => ""
]);

Removes mission gamificationID from person.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

gamification.person.find

( tokenID, gamificationID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=gamification.person.find&tokenID=&gamificationID=&selection=
$response = InEvent\Gamification.person::find($client, [
  "tokenID" => "",
  "gamificationID" => "",
  "selection" => ""
]);

Gathers all people that finished mission gamificationID.

tokenIDQUERY : token identifier

gamificationIDQUERY : mission identifier

selectionQUERY : selection of missions

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

gamification.person.get

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=gamification.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=gamification.person.get&tokenID=&eventID=&personID=
$response = InEvent\Gamification.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers all finished missions for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=image.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=image.create&tokenID=&eventID= \   -d "name=&url="
$response = InEvent\Image::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "url" => ""
]);

Adds an image to event eventID library.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : image name

urlBODY : image url

image.edit

( tokenID, imageID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=image.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=image.edit&tokenID=&imageID=&key= \   -d "value="
$response = InEvent\Image::edit($client, [
  "tokenID" => "",
  "imageID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of image imageID.

tokenIDQUERY : token identifier

imageIDQUERY : image identifier

keyQUERY : field name

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

valueBODY : field value

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

image.remove

( tokenID, imageID )

  • Info
  • Curl
  • PHP
GET /api/?action=image.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=image.remove&tokenID=&imageID=
$response = InEvent\Image::remove($client, [
  "tokenID" => "",
  "imageID" => ""
]);

Removes image imageID.

tokenIDQUERY : token identifier

imageIDQUERY : image identifier

image.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=image.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=image.find&tokenID=&eventID=
$response = InEvent\Image::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all images at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

image.get

( tokenID, imageID )

  • Info
  • Curl
  • PHP
GET /api/?action=image.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=image.get&tokenID=&imageID=
$response = InEvent\Image::get($client, [
  "tokenID" => "",
  "imageID" => ""
]);

Gathers image imageID.

tokenIDQUERY : token identifier

imageIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=landing.create&tokenID=&eventID= \   -d "name=&cname="
$response = InEvent\Landing::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "cname" => ""
]);

Creates a landing at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : landing title

cnameBODY : landing domain

landing.edit

( tokenID, landingID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=landing.edit&tokenID=&landingID=&key= \   -d "value="
$response = InEvent\Landing::edit($client, [
  "tokenID" => "",
  "landingID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

keyQUERY : field key

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

valueBODY : field value

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

landing.remove

( tokenID, landingID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=landing.remove&tokenID=&landingID=
$response = InEvent\Landing::remove($client, [
  "tokenID" => "",
  "landingID" => ""
]);

Removes landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

landing.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=landing.find&tokenID=&eventID=
$response = InEvent\Landing::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all landings at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

landing.get

( tokenID, landingID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=landing.get&tokenID=&landingID=
$response = InEvent\Landing::get($client, [
  "tokenID" => "",
  "landingID" => ""
]);

Gathers landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

landing.put

( tokenID, landingID, file, url )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.putHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=landing.put&tokenID=&landingID= \   -d "file=&url="
$response = InEvent\Landing::put($client, [
  "tokenID" => "",
  "landingID" => ""
], [
  "file" => "",
  "url" => ""
]);

Creates or edits a file in landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

fileBODY : file name

urlBODY : file url

landing.delete

( tokenID, landingID, file )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.deleteHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=landing.delete&tokenID=&landingID= \   -d "file="
$response = InEvent\Landing::delete($client, [
  "tokenID" => "",
  "landingID" => ""
], [
  "file" => ""
]);

Deletes a file in landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

fileBODY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.page.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=landing.page.bind&tokenID=&landingID= \   -d "path=&file="
$response = InEvent\Landing.page::bind($client, [
  "tokenID" => "",
  "landingID" => ""
], [
  "path" => "",
  "file" => ""
]);

Creates a page in landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

pathBODY : file url

fileBODY : file name

landing.page.operate

( tokenID, landingPageID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=landing.page.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=landing.page.operate&tokenID=&landingPageID=&key= \   -d "value="
$response = InEvent\Landing.page::operate($client, [
  "tokenID" => "",
  "landingPageID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key in landing page landingPageID.

tokenIDQUERY : token identifier

landingPageIDQUERY : landing page identifier

keyQUERY : field name

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

valueBODY : field value

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

landing.page.dismiss

( tokenID, landingPageID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.page.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=landing.page.dismiss&tokenID=&landingPageID=
$response = InEvent\Landing.page::dismiss($client, [
  "tokenID" => "",
  "landingPageID" => ""
]);

Removes landing page landingPageID.

tokenIDQUERY : token identifier

landingPageIDQUERY : landing page identifier

landing.page.find

( tokenID, landingID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.page.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=landing.page.find&tokenID=&landingID=
$response = InEvent\Landing.page::find($client, [
  "tokenID" => "",
  "landingID" => ""
]);

Gathers all pages from landing landingID.

tokenIDQUERY : token identifier

landingIDQUERY : landing identifier

landing.page.get

( tokenID, landingPageID )

  • Info
  • Curl
  • PHP
GET /api/?action=landing.page.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=landing.page.get&tokenID=&landingPageID=
$response = InEvent\Landing.page::get($client, [
  "tokenID" => "",
  "landingPageID" => ""
]);

Gathers landing page landingPageID.

tokenIDQUERY : token identifier

landingPageIDQUERY : 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, username, course, location )

  • Info
  • Curl
  • PHP
POST /api/?action=license.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=license.create&tokenID= \   -d "username=&course=&location="
$response = InEvent\License::create($client, [
  "tokenID" => ""
], [
  "username" => "",
  "course" => "",
  "location" => ""
]);

Creates license for person username.

tokenIDQUERY : token identifier

usernameBODY : person username

courseBODY : achievement title

locationBODY : global location

license.edit

( tokenID, number, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=license.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=license.edit&tokenID=&number=&key= \   -d "value="
$response = InEvent\License::edit($client, [
  "tokenID" => "",
  "number" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of license number.

tokenIDQUERY : token identifier

numberQUERY : license number

keyQUERY : field name

valueBODY : field value

license.remove

( tokenID, number )

  • Info
  • Curl
  • PHP
GET /api/?action=license.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=license.remove&tokenID=&number=
$response = InEvent\License::remove($client, [
  "tokenID" => "",
  "number" => ""
]);

Removes license number.

tokenIDQUERY : token identifier

numberQUERY : license number

license.find

( query )

  • Info
  • Curl
  • PHP
GET /api/?action=license.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=license.find&query=
$response = InEvent\License::find($client, [
  "query" => ""
]);

Returns licenses for query query.

queryQUERY : search terms

license.get

( number )

  • Info
  • Curl
  • PHP
GET /api/?action=license.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=license.get&number=
$response = InEvent\License::get($client, [
  "number" => ""
]);

Returns license number.

numberQUERY : unique license

license.request

( number, leadEmail )

  • Info
  • Curl
  • PHP
POST /api/?action=license.requestHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=license.request&number= \   -d "leadEmail="
$response = InEvent\License::request($client, [
  "number" => ""
], [
  "leadEmail" => ""
]);

Requests more information on license number.

numberQUERY : unique license

leadEmailBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=linkedin.signInHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=linkedin.signIn&linkedInToken=
$response = InEvent\Linkedin::signIn($client, [
  "linkedInToken" => ""
]);

Creates a session with LinkedIn using OAuth v2.0.

linkedInTokenQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=list.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.create&tokenID=&eventID= \   -d "name=&color="
$response = InEvent\List::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "color" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : name of the list

colorBODY : list color

( tokenID, companyID, name, color )

  • Info
  • Curl
  • PHP
POST /api/?action=list.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.create&tokenID=&companyID= \   -d "name=&color="
$response = InEvent\List::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => "",
  "color" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameBODY : list name

colorBODY : list color

list.edit

( tokenID, listID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=list.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.edit&tokenID=&listID=&key= \   -d "value="
$response = InEvent\List::edit($client, [
  "tokenID" => "",
  "listID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of segmentation list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

keyQUERY : field name

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

valueBODY : field value

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

list.remove

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.remove&tokenID=&listID=
$response = InEvent\List::remove($client, [
  "tokenID" => "",
  "listID" => ""
]);

Removes segmentation list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

list.find

( tokenID, eventID, *selection )

  • Info
  • Curl
  • PHP
GET /api/?action=list.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.find&tokenID=&eventID=
$response = InEvent\List::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all segmentation lists at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*selectionQUERY : specific selection

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

( tokenID, companyID, *selection )

  • Info
  • Curl
  • PHP
GET /api/?action=list.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.find&tokenID=&companyID=
$response = InEvent\List::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Gathers all segmentation lists at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

*selectionQUERY : specific selection

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

list.get

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.get&tokenID=&listID=
$response = InEvent\List::get($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers segmentation list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

list.copy

( tokenID, eventID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.copyHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.copy&tokenID=&eventID=&listID=
$response = InEvent\List::copy($client, [
  "tokenID" => "",
  "eventID" => "",
  "listID" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

listIDQUERY : list identifier

list.import

( tokenID, eventID, sourceID, targetID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.importHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.import&tokenID=&eventID=&sourceID=&targetID=
$response = InEvent\List::import($client, [
  "tokenID" => "",
  "eventID" => "",
  "sourceID" => "",
  "targetID" => ""
]);

Imports data to list targetID from a segmentation list sourceID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sourceIDQUERY : list identifier

targetIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=list.email.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.email.create&tokenID=&listID= \   -d "subject=&html="
$response = InEvent\List.email::create($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "subject" => "",
  "html" => ""
]);

Creates an email at list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

subjectBODY : email subject

htmlBODY : email contents

( tokenID, eventID, subject, html, selection )

  • Info
  • Curl
  • PHP
POST /api/?action=list.email.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.email.create&tokenID=&eventID= \   -d "subject=&html=&selection="
$response = InEvent\List.email::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "subject" => "",
  "html" => "",
  "selection" => ""
]);

Creates an email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

subjectBODY : email subject

htmlBODY : email contents

selectionBODY : specific selection

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

( tokenID, eventID, source )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.createHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.email.create&tokenID=&eventID=&source=
$response = InEvent\List.email::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "source" => ""
]);

Creates an automatic email at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

sourceQUERY : email source

list.email.edit

( tokenID, listEmailID, key, *value )

  • Info
  • Curl
  • PHP
POST /api/?action=list.email.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.email.edit&tokenID=&listEmailID=&key= \   -d ""
$response = InEvent\List.email::edit($client, [
  "tokenID" => "",
  "listEmailID" => "",
  "key" => ""
], [

]);

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

tokenIDQUERY : token identifier

listEmailIDQUERY : list identifier

keyQUERY : field name

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

*valueBODY : field value

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

list.email.remove

( tokenID, listEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.email.remove&tokenID=&listEmailID=
$response = InEvent\List.email::remove($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Removes email listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

list.email.find

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.email.find&tokenID=&listID=
$response = InEvent\List.email::find($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers all emails at list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.email.find&tokenID=&eventID=&selection=
$response = InEvent\List.email::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all emails at event eventID without a list linked.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : specific selection

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

list.email.get

( tokenID, listEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.email.get&tokenID=&listEmailID=
$response = InEvent\List.email::get($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Returns email listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

list.email.send

( tokenID, listEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.sendHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.email.send&tokenID=&listEmailID=
$response = InEvent\List.email::send($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Sends email listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

list.email.copy

( tokenID, listEmailID, *subject, *listID, *selection )

  • Info
  • Curl
  • PHP
POST /api/?action=list.email.copyHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.email.copy&tokenID=&listEmailID= \   -d ""
$response = InEvent\List.email::copy($client, [
  "tokenID" => "",
  "listEmailID" => ""
], [

]);

Copies email listEmailID for a new draft.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

*subjectBODY : list email subject

*listIDQUERY : list identifier

*selectionQUERY : specific selection

list.email.preview

( tokenID, listEmailID, *personID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.previewHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.email.preview&tokenID=&listEmailID=
$response = InEvent\List.email::preview($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Sends a preview email listEmailID for yourself.

tokenIDQUERY : token identifier

listEmailIDQUERY : list email identifier

*personIDQUERY : person whom should receive the email

list.email.stats

( tokenID, listEmailID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.email.statsHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.email.stats&tokenID=&listEmailID=
$response = InEvent\List.email::stats($client, [
  "tokenID" => "",
  "listEmailID" => ""
]);

Gathers all email statistics at email listEmailID.

tokenIDQUERY : token identifier

listEmailIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=list.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.person.bind&tokenID=&listID=&personID=
$response = InEvent\List.person::bind($client, [
  "tokenID" => "",
  "listID" => "",
  "personID" => ""
]);

Adds person personID in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

personIDQUERY : person identifier

( tokenID, listID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.person.bind&tokenID=&listID= \   -d "content="
$response = InEvent\List.person::bind($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "content" => ""
]);

Adds people content in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

contentBODY : people identifiers

( tokenID, listID, name, username )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.person.bind&tokenID=&listID= \   -d "name=&username="
$response = InEvent\List.person::bind($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "name" => "",
  "username" => ""
]);

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

tokenIDQUERY : token identifier

listIDQUERY : list identifier

nameBODY : person name

usernameBODY : person username or email

( listID, *name, email )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.person.bind&listID= \   -d "email="
$response = InEvent\List.person::bind($client, [
  "listID" => ""
], [
  "email" => ""
]);

Adds person email in list listID.

listIDQUERY : list identifier

*nameBODY : person name

emailBODY : person username or email

( tokenID, listID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.person.bind&tokenID=&listID= \   -d "path="
$response = InEvent\List.person::bind($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "path" => ""
]);

Adds people as excel sheet path in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

pathBODY : people excel sheet url

list.person.dismiss

( tokenID, listID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.person.dismiss&tokenID=&listID=&personID=
$response = InEvent\List.person::dismiss($client, [
  "tokenID" => "",
  "listID" => "",
  "personID" => ""
]);

Removes person personID from list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

personIDQUERY : person identifier

( tokenID, listID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=list.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.person.dismiss&tokenID=&listID= \   -d "content="
$response = InEvent\List.person::dismiss($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "content" => ""
]);

Removes people content from list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

contentBODY : people identifiers

list.person.find

( tokenID, listID, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=list.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.person.find&tokenID=&listID=
$response = InEvent\List.person::find($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers all people in list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

*queryQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=list.sms.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.sms.create&tokenID= \   -d "text="
$response = InEvent\List.sms::create($client, [
  "tokenID" => ""
], [
  "text" => ""
]);

Creates a new sms in list listID.

tokenIDQUERY : token identifier

*listIDQUERY : list identifier

*selectionQUERY : specific selection

textBODY : sms contents

list.sms.edit

( tokenID, listSmsID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=list.sms.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=list.sms.edit&tokenID=&listSmsID=&key= \   -d "value="
$response = InEvent\List.sms::edit($client, [
  "tokenID" => "",
  "listSmsID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

listSmsIDQUERY : sms at list identifier

keyQUERY : field name

{
    "text": "sms contents"
}

valueBODY : field value

{
    "text": "string"
}

list.sms.remove

( tokenID, listSmsID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.sms.remove&tokenID=&listSmsID=
$response = InEvent\List.sms::remove($client, [
  "tokenID" => "",
  "listSmsID" => ""
]);

Removes sms at list listSmsID.

tokenIDQUERY : token identifier

listSmsIDQUERY : sms at list identifier

list.sms.find

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.sms.find&tokenID=&listID=
$response = InEvent\List.sms::find($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers all sms at list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.sms.find&tokenID=&eventID=&selection=
$response = InEvent\List.sms::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all sms at event eventID without a list linked.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : specific selection

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

list.sms.preview

( tokenID, listSmsID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.previewHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.sms.preview&tokenID=&listSmsID=
$response = InEvent\List.sms::preview($client, [
  "tokenID" => "",
  "listSmsID" => ""
]);

Sends a preview for sms at listlistSmsID.

tokenIDQUERY : token identifier

listSmsIDQUERY : sms at list identifier

list.sms.send

( tokenID, listSmsID )

  • Info
  • Curl
  • PHP
GET /api/?action=list.sms.sendHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=list.sms.send&tokenID=&listSmsID=
$response = InEvent\List.sms::send($client, [
  "tokenID" => "",
  "listSmsID" => ""
]);

Sends sms at list listSmsID.

tokenIDQUERY : token identifier

listSmsIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=literature.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=literature.create&tokenID= \   -d "url=&category="
$response = InEvent\Literature::create($client, [
  "tokenID" => ""
], [
  "url" => "",
  "category" => ""
]);

Creates a literature with external url url.

tokenIDQUERY : token identifier

urlBODY : external url

categoryBODY : literature category

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

literature.remove

( tokenID, literatureID )

  • Info
  • Curl
  • PHP
GET /api/?action=literature.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=literature.remove&tokenID=&literatureID=
$response = InEvent\Literature::remove($client, [
  "tokenID" => "",
  "literatureID" => ""
]);

Removes literature literatureID.

tokenIDQUERY : token identifier

literatureIDQUERY : literature identifier

literature.find

( )

  • Info
  • Curl
  • PHP
GET /api/?action=literature.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=literature.find
$response = InEvent\Literature::find($client, [

]);

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 )

  • Info
  • Curl
  • PHP
POST /api/?action=lodging.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=lodging.create&tokenID=&eventID= \   -d "name=&capacity=&price="
$response = InEvent\Lodging::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "capacity" => "",
  "price" => ""
]);

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

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : room name

capacityBODY : max number of people allowed inside the room

priceBODY : room price

*descriptionBODY : room description

*addressBODY : hotel address

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=lodging.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=lodging.create&tokenID=&eventID= \   -d "path="
$response = InEvent\Lodging::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple rooms at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : excel sheet url

lodging.edit

( tokenID, lodgingID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=lodging.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=lodging.edit&tokenID=&lodgingID=&key= \   -d "value="
$response = InEvent\Lodging::edit($client, [
  "tokenID" => "",
  "lodgingID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of room lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

keyQUERY : field name

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

valueBODY : field value

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

lodging.remove

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.remove&tokenID=&lodgingID=
$response = InEvent\Lodging::remove($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Removes lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

lodging.find

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.find&tokenID=&eventID=&selection=
$response = InEvent\Lodging::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all rooms at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : specific selection

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

lodging.get

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.get&tokenID=&lodgingID=
$response = InEvent\Lodging::get($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Gathers room lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

lodging.stats

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.statsHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.stats&tokenID=&eventID=
$response = InEvent\Lodging::stats($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all lodging statistics at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.bind&tokenID=&lodgingID=
$response = InEvent\Lodging.person::bind($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Adds person tokenID to lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

( tokenID, lodgingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.bind&tokenID=&lodgingID=&personID=
$response = InEvent\Lodging.person::bind($client, [
  "tokenID" => "",
  "lodgingID" => "",
  "personID" => ""
]);

Adds person personID to lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

personIDQUERY : person identifier

lodging.person.dismiss

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.dismiss&tokenID=&lodgingID=
$response = InEvent\Lodging.person::dismiss($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Removes person tokenID at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

( tokenID, lodgingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.dismiss&tokenID=&lodgingID=&personID=
$response = InEvent\Lodging.person::dismiss($client, [
  "tokenID" => "",
  "lodgingID" => "",
  "personID" => ""
]);

Removes personID at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

personIDQUERY : person identifier

lodging.person.find

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.find&tokenID=&lodgingID=
$response = InEvent\Lodging.person::find($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Gathers all people at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

( tokenID, eventID, selection, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.find&tokenID=&eventID=&selection=
$response = InEvent\Lodging.person::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all people at event eventID filtered by lodging.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : search

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

*queryQUERY : query text

lodging.person.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.get&tokenID=&eventID=
$response = InEvent\Lodging.person::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers lodging for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.get&tokenID=&eventID=&personID=
$response = InEvent\Lodging.person::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers lodging for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

lodging.person.invite

( tokenID, lodgingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.inviteHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.invite&tokenID=&lodgingID=&personID=
$response = InEvent\Lodging.person::invite($client, [
  "tokenID" => "",
  "lodgingID" => "",
  "personID" => ""
]);

Invites personID for lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

personIDQUERY : person identifier

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.inviteHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.invite&tokenID=&eventID=&personID=
$response = InEvent\Lodging.person::invite($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Invites person personID for lodging at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

lodging.person.inviteConfirm

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.inviteConfirmHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.inviteConfirm&tokenID=&lodgingID=
$response = InEvent\Lodging.person::inviteConfirm($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Confirms invitation at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

lodging.person.inviteReject

( tokenID, lodgingID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.inviteRejectHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.inviteReject&tokenID=&lodgingID=
$response = InEvent\Lodging.person::inviteReject($client, [
  "tokenID" => "",
  "lodgingID" => ""
]);

Rejects invitation at lodging lodgingID.

tokenIDQUERY : token identifier

lodgingIDQUERY : lodging identifier

lodging.person.invites

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=lodging.person.invitesHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=lodging.person.invites&tokenID=&eventID=
$response = InEvent\Lodging.person::invites($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all invitations for lodgings at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=marketo.edit&tokenID=&companyID=&key= \   -d "value="
$response = InEvent\Marketo::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

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

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

keyQUERY : field name

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

valueBODY : field value

{
    "autoLinkEvents": "boolean",
    "autoLinkMode": "r|w|rw",
    "autoLinkFolderId": "integer"
}

marketo.get

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.get&tokenID=&companyID=
$response = InEvent\Marketo::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Gathers Marketo integration details from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.get&tokenID=&eventID=
$response = InEvent\Marketo::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers Marketo integration details for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

marketo.linkAccount

( tokenID, companyID, clientId, clientSecret, munchkinId )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.linkAccountHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=marketo.linkAccount&tokenID=&companyID= \   -d "clientId=&clientSecret=&munchkinId="
$response = InEvent\Marketo::linkAccount($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "clientId" => "",
  "clientSecret" => "",
  "munchkinId" => ""
]);

Links a Marketo account with company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

clientIdBODY : Marketo client identifier

clientSecretBODY : Marketo client secret

munchkinIdBODY : Marketo munchkin identifier

marketo.unlinkAccount

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.unlinkAccountHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.unlinkAccount&tokenID=&companyID=
$response = InEvent\Marketo::unlinkAccount($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Unlinks a Marketo account from company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

marketo.getFolders

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getFoldersHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.getFolders&tokenID=&companyID=
$response = InEvent\Marketo::getFolders($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Get a list of folders available for linkage from Marketo at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

marketo.getChannels

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getChannelsHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.getChannels&tokenID=&companyID=
$response = InEvent\Marketo::getChannels($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Get a list of channels available for linkage from Marketo at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

marketo.getTags

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getTagsHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.getTags&tokenID=&companyID=
$response = InEvent\Marketo::getTags($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Get a list of tags available for linkage from Marketo at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

marketo.getTypes

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getTypesHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.getTypes&tokenID=
$response = InEvent\Marketo::getTypes($client, [
  "tokenID" => ""
]);

Get a list of types available for linkage from Marketo.

tokenIDQUERY : token identifier

marketo.getProgram

( tokenID, companyID, name )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.getProgramHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.getProgram&tokenID=&companyID=&name=
$response = InEvent\Marketo::getProgram($client, [
  "tokenID" => "",
  "companyID" => "",
  "name" => ""
]);

Get a program by its name from Marketo.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameQUERY : program name

marketo.import

( tokenID, eventID, mktListID, target, *targetID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.importHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.import&tokenID=&eventID=&mktListID=&target=
$response = InEvent\Marketo::import($client, [
  "tokenID" => "",
  "eventID" => "",
  "mktListID" => "",
  "target" => ""
]);

Import list leads from Marketo mktListID to a target and targetID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

mktListIDQUERY : marketo list identifier

targetQUERY : target list

{
    "event.person": "attendees list",
    "event.invite": "invitees list",
    "list": "custom list (requires targetID)"
}

*targetIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.field.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=marketo.field.bind&tokenID=&eventID= \   -d "feedbackID=&mkFieldId="
$response = InEvent\Marketo.field::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "feedbackID" => "",
  "mkFieldId" => ""
]);

Links a Marketo field to event eventID and a field feedbackID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

feedbackIDBODY : InEvent field identifier

mkFieldIdBODY : Marketo field identifier

marketo.field.dismiss

( tokenID, marketoFieldID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.field.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.field.dismiss&tokenID=&marketoFieldID=
$response = InEvent\Marketo.field::dismiss($client, [
  "tokenID" => "",
  "marketoFieldID" => ""
]);

Unlinks a Marketo field marketoFieldID from event.

tokenIDQUERY : token identifier

marketoFieldIDQUERY : linkage identifier

( tokenID, feedbackID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.field.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.field.dismiss&tokenID=&feedbackID=
$response = InEvent\Marketo.field::dismiss($client, [
  "tokenID" => "",
  "feedbackID" => ""
]);

Unlinks a Marketo field linked with feedbackID from event.

tokenIDQUERY : token identifier

feedbackIDQUERY : feedback identifier

marketo.field.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.field.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.field.find&tokenID=&eventID=
$response = InEvent\Marketo.field::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all linked fields between Marketo and InEvent at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

marketo.field.get

( tokenID, marketoFieldID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.field.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.field.get&tokenID=&marketoFieldID=
$response = InEvent\Marketo.field::get($client, [
  "tokenID" => "",
  "marketoFieldID" => ""
]);

Get a specific linkage field marketoFieldID between Marketo and InEvent.

tokenIDQUERY : token identifier

marketoFieldIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.link.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=marketo.link.bind&tokenID=&eventID= \   -d "listID=&linkId=&mode="
$response = InEvent\Marketo.link::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "listID" => "",
  "linkId" => "",
  "mode" => ""
]);

Links a Marketo list to event eventID and a list listID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

listIDBODY : InEvent list identifier

linkIdBODY : Marketo list identifier

modeBODY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.link.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=marketo.link.bind&tokenID=&eventID= \   -d "linkId=&mode="
$response = InEvent\Marketo.link::bind($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "linkId" => "",
  "mode" => ""
]);

Links a Marketo program to event eventID attendees list.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

linkIdBODY : Marketo program identifier

modeBODY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=marketo.link.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=marketo.link.operate&tokenID=&marketoLinkID=&key= \   -d "value="
$response = InEvent\Marketo.link::operate($client, [
  "tokenID" => "",
  "marketoLinkID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key for a linkage marketoLinkID.

tokenIDQUERY : token identifier

marketoLinkIDQUERY : activity identifier

keyQUERY : element name

{
    "mode": "approval status"
}

valueBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.link.dismiss&tokenID=&marketoLinkID=
$response = InEvent\Marketo.link::dismiss($client, [
  "tokenID" => "",
  "marketoLinkID" => ""
]);

Unlinks a Marketo list marketoLinkID from event.

tokenIDQUERY : token identifier

marketoLinkIDQUERY : linkage identifier

marketo.link.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.link.find&tokenID=&eventID=
$response = InEvent\Marketo.link::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Finds all linked lists between Marketo and InEvent at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

marketo.link.get

( tokenID, marketoLinkID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.link.get&tokenID=&marketoLinkID=
$response = InEvent\Marketo.link::get($client, [
  "tokenID" => "",
  "marketoLinkID" => ""
]);

Get a specific linkage list marketoLinkID between Marketo and InEvent.

tokenIDQUERY : token identifier

marketoLinkIDQUERY : linkage identifier

marketo.link.sync

( tokenID, marketoLinkID )

  • Info
  • Curl
  • PHP
GET /api/?action=marketo.link.syncHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=marketo.link.sync&tokenID=&marketoLinkID=
$response = InEvent\Marketo.link::sync($client, [
  "tokenID" => "",
  "marketoLinkID" => ""
]);

Forces a synchronization between Marketo and InEvent for linkage list marketoLinkID.

tokenIDQUERY : token identifier

marketoLinkIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=material.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=material.create&tokenID=&activityID= \   -d "name=&extension=&url="
$response = InEvent\Material::create($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "name" => "",
  "extension" => "",
  "url" => ""
]);

Creates a material with name name and hosted at url at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

nameBODY : file name

extensionBODY : file extension

urlBODY : file url

( tokenID, eventID, name, extension, url )

  • Info
  • Curl
  • PHP
POST /api/?action=material.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=material.create&tokenID=&eventID= \   -d "name=&extension=&url="
$response = InEvent\Material::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "extension" => "",
  "url" => ""
]);

Creates a material with name name and hosted at url at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : file name

extensionBODY : file extension

urlBODY : file url

material.remove

( tokenID, materialID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=material.remove&tokenID=&materialID=
$response = InEvent\Material::remove($client, [
  "tokenID" => "",
  "materialID" => ""
]);

Removes material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : material identifier

material.find

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=material.find&tokenID=&activityID=
$response = InEvent\Material::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Gathers all materials from activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=material.find&tokenID=&eventID=
$response = InEvent\Material::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all materials from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

material.get

( tokenID, materialID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=material.get&tokenID=&materialID=
$response = InEvent\Material::get($client, [
  "tokenID" => "",
  "materialID" => ""
]);

Gathers material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=material.tag.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=material.tag.bind&tokenID=&materialID=&tagID=
$response = InEvent\Material.tag::bind($client, [
  "tokenID" => "",
  "materialID" => "",
  "tagID" => ""
]);

Creates tag tagID at material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : material identifier

tagIDQUERY : tag identifier

material.tag.dismiss

( tokenID, materialID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.tag.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=material.tag.dismiss&tokenID=&materialID=&tagID=
$response = InEvent\Material.tag::dismiss($client, [
  "tokenID" => "",
  "materialID" => "",
  "tagID" => ""
]);

Removes tag tagID from material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : material identifier

tagIDQUERY : tag identifier

material.tag.find

( tokenID, materialID )

  • Info
  • Curl
  • PHP
GET /api/?action=material.tag.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=material.tag.find&tokenID=&materialID=
$response = InEvent\Material.tag::find($client, [
  "tokenID" => "",
  "materialID" => ""
]);

Gathers all tags for material materialID.

tokenIDQUERY : token identifier

materialIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=meeting.create&tokenID=&eventID= \   -d "dateBegin=&dateEnd=&spot=&capacity="
$response = InEvent\Meeting::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "dateBegin" => "",
  "dateEnd" => "",
  "spot" => "",
  "capacity" => ""
]);

Creates a time slot that starts at dateBegin and ends at dateEnd for meetings located at spot for host tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

dateBeginBODY : time that the meeting starts

dateEndBODY : time that the meeting ends

spotBODY : meeting place

capacityBODY : amount of people allowed to participate at the meeting

( tokenID, eventID, dateBegin, dateEnd, spot, capacity, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=meeting.create&tokenID=&eventID=&personID= \   -d "dateBegin=&dateEnd=&spot=&capacity="
$response = InEvent\Meeting::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "dateBegin" => "",
  "dateEnd" => "",
  "spot" => "",
  "capacity" => ""
]);

Creates a time slot that starts at dateBegin and ends at dateEnd for meetings located at spot for host personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

dateBeginBODY : time that the meeting starts

dateEndBODY : time that the meeting ends

spotBODY : meeting place

capacityBODY : amount of people allowed to participate at the meeting

personIDQUERY : host identifier

( tokenID, eventID, path )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=meeting.create&tokenID=&eventID= \   -d "path="
$response = InEvent\Meeting::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "path" => ""
]);

Creates multiple meetings at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

pathBODY : meetings excel sheet url

meeting.edit

( tokenID, meetingID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=meeting.edit&tokenID=&meetingID=&key= \   -d "value="
$response = InEvent\Meeting::edit($client, [
  "tokenID" => "",
  "meetingID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

keyQUERY : field name

{
    "dateBegin": "date and time",
    "dateEnd": "date and time",
    "spot": "place"
}

valueBODY : field value

{
    "dateBegin": "integer(11)",
    "dateEnd": "integer(11)",
    "spot": "string"
}

meeting.remove

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.remove&tokenID=&meetingID=
$response = InEvent\Meeting::remove($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Removes meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

meeting.find

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

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.find&tokenID=&eventID=&personID=
$response = InEvent\Meeting::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers all meetings at event eventID hosted by personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

*dateBeginQUERY : date and time of start

*dateEndQUERY : date and time of end

( tokenID, eventID, *dateBegin, *dateEnd )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.find&tokenID=&eventID=
$response = InEvent\Meeting::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all meetings at event eventID related to tokenID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*dateBeginQUERY : date and time of start

*dateEndQUERY : date and time of end

meeting.get

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.get&tokenID=&meetingID=
$response = InEvent\Meeting::get($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Gathers meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

meeting.fill

( tokenID, eventID, minutes )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.fillHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=meeting.fill&tokenID=&eventID= \   -d "minutes="
$response = InEvent\Meeting::fill($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "minutes" => ""
]);

Fill all meetings at event eventID with intervals of minutes.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

minutesBODY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.feedback.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=meeting.feedback.create&tokenID=&meetingID= \   -d "text="
$response = InEvent\Meeting.feedback::create($client, [
  "tokenID" => "",
  "meetingID" => ""
], [
  "text" => ""
]);

Creates a feedback with text text for the meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

textBODY : feedback text

meeting.feedback.find

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.feedback.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.feedback.find&tokenID=&meetingID=
$response = InEvent\Meeting.feedback::find($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Gathers all feedbacks for meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.person.bind&tokenID=&meetingID=
$response = InEvent\Meeting.person::bind($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Adds guest tokenID to meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.person.bind&tokenID=&meetingID=&personID=
$response = InEvent\Meeting.person::bind($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Adds guest personID to meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : person identifier

meeting.person.confirm

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.confirmHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.person.confirm&tokenID=&meetingID=&personID=
$response = InEvent\Meeting.person::confirm($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Confirms meeting meetingID with guest personID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : host identifier

meeting.person.revoke

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.revokeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.person.revoke&tokenID=&meetingID=&personID=
$response = InEvent\Meeting.person::revoke($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Rejects meeting meetingID with guest personID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : host identifier

meeting.person.dismiss

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.person.dismiss&tokenID=&meetingID=
$response = InEvent\Meeting.person::dismiss($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Cancels their presence at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.person.dismiss&tokenID=&meetingID=&personID=
$response = InEvent\Meeting.person::dismiss($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Cancels their presence at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : person identifier

meeting.person.checkIn

( tokenID, meetingID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.checkInHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.person.checkIn&tokenID=&meetingID=
$response = InEvent\Meeting.person::checkIn($client, [
  "tokenID" => "",
  "meetingID" => ""
]);

Confirms their presence at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

( tokenID, meetingID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.person.checkInHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.person.checkIn&tokenID=&meetingID=&personID=
$response = InEvent\Meeting.person::checkIn($client, [
  "tokenID" => "",
  "meetingID" => "",
  "personID" => ""
]);

Confirms their presence at meeting meetingID.

tokenIDQUERY : token identifier

meetingIDQUERY : meeting identifier

personIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.quota.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=meeting.quota.create&tokenID=&eventID= \   -d "name=&amount="
$response = InEvent\Meeting.quota::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => "",
  "amount" => ""
]);

Creates a quota with name name and amount of meetings amount at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : quota name

amountBODY : amount of meetings for quota

meeting.quota.get

( tokenID, meetingQuotaID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.quota.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.quota.get&tokenID=&meetingQuotaID=
$response = InEvent\Meeting.quota::get($client, [
  "tokenID" => "",
  "meetingQuotaID" => ""
]);

Gathers quota meetingQuotaID.

tokenIDQUERY : token identifier

meetingQuotaIDQUERY : quota identifier

meeting.quota.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.quota.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.quota.find&tokenID=&eventID=
$response = InEvent\Meeting.quota::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all quotas at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

meeting.quota.edit

( tokenID, meetingQuotaID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=meeting.quota.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=meeting.quota.edit&tokenID=&meetingQuotaID=&key= \   -d "value="
$response = InEvent\Meeting.quota::edit($client, [
  "tokenID" => "",
  "meetingQuotaID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of quota meetingQuotaID.

tokenIDQUERY : token identifier

meetingQuotaIDQUERY : quota identifier

keyQUERY : field name

{
    "name": "quota name",
    "amount": "amount of meetings"
}

valueBODY : field value

{
    "name": "string",
    "amount": "integer(11)"
}

meeting.quota.remove

( tokenID, eventID, meetingQuotaID )

  • Info
  • Curl
  • PHP
GET /api/?action=meeting.quota.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=meeting.quota.remove&tokenID=&eventID=&meetingQuotaID=
$response = InEvent\Meeting.quota::remove($client, [
  "tokenID" => "",
  "eventID" => "",
  "meetingQuotaID" => ""
]);

Removes quota meetingQuotaID from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

meetingQuotaIDQUERY : quota identifier

Moip

Module destinated for integrations between InEvent and Moip.

Methods

moip.get

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=moip.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=moip.get&tokenID=&eventID=
$response = InEvent\Moip::get($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers data from Moip integration at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

moip.edit

( tokenID, eventID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=moip.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=moip.edit&tokenID=&eventID=&key= \   -d "value="
$response = InEvent\Moip::edit($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits data from Moip integration at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : field name

{
    "installments": "number of maximum installments"
}

valueBODY : field value

{
    "installments": "integer (from 1 to 12)"
}

moip.linkAccount

( tokenID, eventID, apiKey, apiToken, sandbox )

  • Info
  • Curl
  • PHP
POST /api/?action=moip.linkAccountHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=moip.linkAccount&tokenID=&eventID= \   -d "apiKey=&apiToken=&sandbox="
$response = InEvent\Moip::linkAccount($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "apiKey" => "",
  "apiToken" => "",
  "sandbox" => ""
]);

Links a Moip account with event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

apiKeyBODY : Moip api key

apiTokenBODY : Moip api token

sandboxBODY : sandbox environment or production (1 or 0)

moip.unlinkAccount

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=moip.unlinkAccountHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=moip.unlinkAccount&tokenID=&eventID=
$response = InEvent\Moip::unlinkAccount($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Unlinks a Moip account from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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, *channel, *scheduled, *date )

  • Info
  • Curl
  • PHP
POST /api/?action=news.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=news.create&tokenID=&eventID=&personID= \   -d "message="
$response = InEvent\News::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "message" => ""
]);

Sends a message message for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : recipient identifier

messageBODY : message (140)

*channelBODY : communication media to send message

*scheduledBODY : if message should be schedule or not (default: 0)

[
    0,
    1
]

*dateBODY : date for message to be sent (ignored in case schedule == 0)

( tokenID, eventID, message, *channel, *scheduled, *date )

  • Info
  • Curl
  • PHP
POST /api/?action=news.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=news.create&tokenID=&eventID= \   -d "message="
$response = InEvent\News::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "message" => ""
]);

Sends message message for all people at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

messageBODY : message (140)

*channelBODY : communication media to send message

*scheduledBODY : if message should be schedule or not (default: 0)

[
    0,
    1
]

*dateBODY : date for message to be sent (ignored in case schedule == 0)

( tokenID, activityID, message, *channel, *scheduled, *date )

  • Info
  • Curl
  • PHP
POST /api/?action=news.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=news.create&tokenID=&activityID= \   -d "message="
$response = InEvent\News::create($client, [
  "tokenID" => "",
  "activityID" => ""
], [
  "message" => ""
]);

Sends message message for all people at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

messageBODY : message (140)

*channelBODY : communication media to send message

*scheduledBODY : if message should be schedule or not (default: 0)

[
    0,
    1
]

*dateBODY : date for message to be sent (ignored in case schedule == 0)

( tokenID, listID, message, *channel, *scheduled, *date )

  • Info
  • Curl
  • PHP
POST /api/?action=news.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=news.create&tokenID=&listID= \   -d "message="
$response = InEvent\News::create($client, [
  "tokenID" => "",
  "listID" => ""
], [
  "message" => ""
]);

Sends message message for all people at list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

messageBODY : message (140)

*channelBODY : communication media to send message

*scheduledBODY : if message should be schedule or not (default: 0)

[
    0,
    1
]

*dateBODY : date for message to be sent (ignored in case schedule == 0)

news.edit

( newsID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=news.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=news.edit&newsID=&key= \   -d "value="
$response = InEvent\News::edit($client, [
  "newsID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of news newsID.

newsIDQUERY : news identifier

keyQUERY : field name

valueBODY : field value

news.remove

( tokenID, newsID )

  • Info
  • Curl
  • PHP
GET /api/?action=news.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=news.remove&tokenID=&newsID=
$response = InEvent\News::remove($client, [
  "tokenID" => "",
  "newsID" => ""
]);

Removes news newsID.

tokenIDQUERY : token identifier

newsIDQUERY : news identifier

news.find

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=news.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=news.find&tokenID=&eventID=&personID=
$response = InEvent\News::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers all news sent between person with tokenID and person personID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, selection )

  • Info
  • Curl
  • PHP
GET /api/?action=news.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=news.find&tokenID=&eventID=&selection=
$response = InEvent\News::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "selection" => ""
]);

Gathers all news at event eventID, filtered by selection selection.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

selectionQUERY : message receiver

{
    "all": "all messages",
    "self": "messages sent specifically for person with tokenID"
}

( tokenID, activityID )

  • Info
  • Curl
  • PHP
GET /api/?action=news.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=news.find&tokenID=&activityID=
$response = InEvent\News::find($client, [
  "tokenID" => "",
  "activityID" => ""
]);

Gathers all news at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

( tokenID, listID )

  • Info
  • Curl
  • PHP
GET /api/?action=news.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=news.find&tokenID=&listID=
$response = InEvent\News::find($client, [
  "tokenID" => "",
  "listID" => ""
]);

Gathers all news at list listID.

tokenIDQUERY : token identifier

listIDQUERY : list identifier

news.get

( newsID )

  • Info
  • Curl
  • PHP
GET /api/?action=news.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=news.get&newsID=
$response = InEvent\News::get($client, [
  "newsID" => ""
]);

Gathers news newsID.

newsIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=note.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=note.create&tokenID=&eventID=&personID= \   -d "text="
$response = InEvent\Note::create($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
], [
  "text" => ""
]);

Creates a note for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

textBODY : note text

note.find

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=note.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=note.find&tokenID=&eventID=&personID=
$response = InEvent\Note::find($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Gathers all notes of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=note.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=note.find&tokenID=&eventID=
$response = InEvent\Note::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Payment

Every product from the event generates a log of purchase.

Methods

payment.create

( tokenID, eventID, username, tickets, *name, *email, *password )

  • Info
  • Curl
  • PHP
POST /api/?action=payment.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=payment.create&tokenID=&eventID= \   -d "username=&tickets="
$response = InEvent\Payment::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "username" => "",
  "tickets" => ""
]);

Create a static payment for a new person at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

usernameBODY : person username

ticketsBODY : json content with tickets

*nameBODY : person name

*emailBODY : person email

*passwordBODY : person password

payment.find

( tokenID, eventID, *query )

  • Info
  • Curl
  • PHP
GET /api/?action=payment.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=payment.find&tokenID=&eventID=
$response = InEvent\Payment::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Gathers all payments made at event eventID with a search query.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

*queryQUERY : query text

Paypal

Module destinated to integrations with Paypal

Methods

paypal.get

( tokenID, companyID, *eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=paypal.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=paypal.get&tokenID=&companyID=
$response = InEvent\Paypal::get($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns authentication tokens linked to company companyID.

tokenIDQUERY : admin token

companyIDQUERY : company identifier

*eventIDQUERY : event identifier

paypal.edit

( tokenID, companyID, key, value, *eventID )

  • Info
  • Curl
  • PHP
POST /api/?action=paypal.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=paypal.edit&tokenID=&companyID=&key= \   -d "value="
$response = InEvent\Paypal::edit($client, [
  "tokenID" => "",
  "companyID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edit paypal config.

tokenIDQUERY : admin token

companyIDQUERY : company identifier

keyQUERY : Key for updated

valueBODY : Value updated

*eventIDQUERY : event identifier

paypal.clear

( tokenID, companyID, *eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=paypal.clearHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=paypal.clear&tokenID=&companyID=
$response = InEvent\Paypal::clear($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Edit paypal config.

tokenIDQUERY : admin token

companyIDQUERY : company identifier

*eventIDQUERY : event identifier

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 )

  • Info
  • Curl
  • PHP
POST /api/?action=person.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.create \   -d "name=&username=&password="
$response = InEvent\Person::create($client, [

], [
  "name" => "",
  "username" => "",
  "password" => ""
]);

Creates an account for a person named name, user username and password password.

nameBODY : person name

usernameBODY : person user

passwordBODY : person password

*languageBODY : (en|es|pt)

person.edit

( tokenID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=person.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.edit&tokenID=&key= \   -d "value="
$response = InEvent\Person::edit($client, [
  "tokenID" => "",
  "key" => ""
], [
  "value" => ""
]);

Updates value value at field key for person tokenID.

tokenIDQUERY : token identifier

keyQUERY : field name

valueBODY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=person.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.edit&tokenID=&key=&personID= \   -d "value="
$response = InEvent\Person::edit($client, [
  "tokenID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Updates value value at field key of person personID.

tokenIDQUERY : token identifier

keyQUERY : field name

valueBODY : field value

{
    "name": "string",
    "email": "string",
    "password": "string",
    "role": "string",
    "company": "string",
    "language": "(en|es|pt)"
}

personIDQUERY : person identifier

( tokenID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=person.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.edit&tokenID= \   -d "content="
$response = InEvent\Person::edit($client, [
  "tokenID" => ""
], [
  "content" => ""
]);

Updates content of person personID.

tokenIDQUERY : token identifier

contentBODY : json content

person.get

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.get&tokenID=
$response = InEvent\Person::get($client, [
  "tokenID" => ""
]);

Returns person tokenID.

tokenIDQUERY : token identifier

( tokenID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.get&tokenID=&personID=
$response = InEvent\Person::get($client, [
  "tokenID" => "",
  "personID" => ""
]);

Returns person personID.

tokenIDQUERY : token identifier

personIDQUERY : person identifier

person.signIn

( username, password )

  • Info
  • Curl
  • PHP
POST /api/?action=person.signInHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.signIn&username= \   -d "password="
$response = InEvent\Person::signIn($client, [
  "username" => ""
], [
  "password" => ""
]);

Begins a session for person username and password password.

usernameQUERY : person username

passwordBODY : person password

( username, secretCode )

  • Info
  • Curl
  • PHP
POST /api/?action=person.signInHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.signIn&username= \   -d "secretCode="
$response = InEvent\Person::signIn($client, [
  "username" => ""
], [
  "secretCode" => ""
]);

Begins a limited session for person username and code secretCode.

usernameQUERY : person username

secretCodeBODY : person temporary code

( username, password, companyID )

  • Info
  • Curl
  • PHP
POST /api/?action=person.signInHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.signIn&username=&companyID= \   -d "password="
$response = InEvent\Person::signIn($client, [
  "username" => "",
  "companyID" => ""
], [
  "password" => ""
]);

Begins a limited session for person username and password password at company companyID.

usernameQUERY : person username

passwordBODY : person password

companyIDQUERY : company identifier

( username, password, *companyID, *verifyBy )

  • Info
  • Curl
  • PHP
POST /api/?action=person.signInHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.signIn&username= \   -d "password="
$response = InEvent\Person::signIn($client, [
  "username" => ""
], [
  "password" => ""
]);

Requests a secure code at session for person username and password password.

usernameQUERY : person username

passwordBODY : person password

*companyIDQUERY : company identifier

*verifyByQUERY : verification scope

{
    "email": "will send an email with code",
    "telephone": "will send a sms with code"
}

( username, password, *companyID, *verifyBy, *code )

  • Info
  • Curl
  • PHP
POST /api/?action=person.signInHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.signIn&username= \   -d "password="
$response = InEvent\Person::signIn($client, [
  "username" => ""
], [
  "password" => ""
]);

Informs a secure code at session for person username and password password.

usernameQUERY : person username

passwordBODY : person password

*companyIDQUERY : company identifier

*verifyByQUERY : verification scope

{
    "email": "will send an email with code",
    "telephone": "will send a sms with code"
}

*codeQUERY : code verification

person.externalSignIn

( username, password, company )

  • Info
  • Curl
  • PHP
POST /api/?action=person.externalSignInHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.externalSignIn&username=&company= \   -d "password="
$response = InEvent\Person::externalSignIn($client, [
  "username" => "",
  "company" => ""
], [
  "password" => ""
]);

Begins an external session for person username, password password and company company.

usernameQUERY : person username

passwordBODY : person password

companyQUERY : company key

person.enableTwoFactor

( tokenID, verifyBy )

  • Info
  • Curl
  • PHP
GET /api/?action=person.enableTwoFactorHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.enableTwoFactor&tokenID=&verifyBy=
$response = InEvent\Person::enableTwoFactor($client, [
  "tokenID" => "",
  "verifyBy" => ""
]);

Enables two-factor authentication for user.

tokenIDQUERY : token identifier

verifyByQUERY : verification scope

{
    "email": "will send an email with code",
    "telephone": "will send a sms with code"
}

( tokenID, verifyBy, *code )

  • Info
  • Curl
  • PHP
GET /api/?action=person.enableTwoFactorHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.enableTwoFactor&tokenID=&verifyBy=
$response = InEvent\Person::enableTwoFactor($client, [
  "tokenID" => "",
  "verifyBy" => ""
]);

Confirms two-factor authentication for user.

tokenIDQUERY : token identifier

verifyByQUERY : verification scope

{
    "email": "will send an email with code",
    "telephone": "will send a sms with code"
}

*codeQUERY : code verification

person.disableTwoFactor

( tokenID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.disableTwoFactorHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.disableTwoFactor&tokenID=
$response = InEvent\Person::disableTwoFactor($client, [
  "tokenID" => ""
]);

Disables two-factor authentication for user.

tokenIDQUERY : token identifier

person.sendRecovery

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.sendRecoveryHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.sendRecovery&tokenID=&companyID=
$response = InEvent\Person::sendRecovery($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Sends a recovery email password for authenticated person.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.sendRecoveryHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.sendRecovery&tokenID=&eventID=
$response = InEvent\Person::sendRecovery($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Sends a recovery email password for authenticated person.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

( username, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.sendRecoveryHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.sendRecovery&username=&companyID=
$response = InEvent\Person::sendRecovery($client, [
  "username" => "",
  "companyID" => ""
]);

Sends a recovery email password for person username.

usernameQUERY : person username

companyIDQUERY : company identifier

( username, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.sendRecoveryHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.sendRecovery&username=&eventID=
$response = InEvent\Person::sendRecovery($client, [
  "username" => "",
  "eventID" => ""
]);

Sends a recovery email password for person username.

usernameQUERY : person username

eventIDQUERY : event identifier

person.changePassword

( tokenID, oldPassword, newPassword )

  • Info
  • Curl
  • PHP
POST /api/?action=person.changePasswordHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.changePassword&tokenID= \   -d "oldPassword=&newPassword="
$response = InEvent\Person::changePassword($client, [
  "tokenID" => ""
], [
  "oldPassword" => "",
  "newPassword" => ""
]);

Changes an old password oldPassword for new password newPassword.

tokenIDQUERY : token identifier

oldPasswordBODY : old password

newPasswordBODY : new password

( tokenID, newPassword )

  • Info
  • Curl
  • PHP
POST /api/?action=person.changePasswordHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.changePassword&tokenID= \   -d "newPassword="
$response = InEvent\Person::changePassword($client, [
  "tokenID" => ""
], [
  "newPassword" => ""
]);

Changes password for person tokenID.

tokenIDQUERY : id de autenticação especial

newPasswordBODY : new password

person.changeLevel

( tokenID, personID, newLevel )

  • Info
  • Curl
  • PHP
POST /api/?action=person.changeLevelHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.changeLevel&tokenID=&personID= \   -d "newLevel="
$response = InEvent\Person::changeLevel($client, [
  "tokenID" => "",
  "personID" => ""
], [
  "newLevel" => ""
]);

Changes person personID level.

tokenIDQUERY : token identifier

personIDQUERY : person identifier

newLevelBODY : person level

( tokenID, username, newLevel )

  • Info
  • Curl
  • PHP
POST /api/?action=person.changeLevelHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.changeLevel&tokenID=&username= \   -d "newLevel="
$response = InEvent\Person::changeLevel($client, [
  "tokenID" => "",
  "username" => ""
], [
  "newLevel" => ""
]);

Changes person username level.

tokenIDQUERY : token identifier

usernameQUERY : person username

newLevelBODY : person level

person.exportData

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.exportDataHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.exportData&tokenID=&companyID=
$response = InEvent\Person::exportData($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Exports person tokenID data at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

person.terminateAccount

( tokenID, password )

  • Info
  • Curl
  • PHP
POST /api/?action=person.terminateAccountHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.terminateAccount&tokenID= \   -d "password="
$response = InEvent\Person::terminateAccount($client, [
  "tokenID" => ""
], [
  "password" => ""
]);

Wipes person tokenID data validated by password.

tokenIDQUERY : token identifier

passwordBODY : person password

person.sendFeedback

( tokenID, companyID, message )

  • Info
  • Curl
  • PHP
POST /api/?action=person.sendFeedbackHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.sendFeedback&tokenID=&companyID= \   -d "message="
$response = InEvent\Person::sendFeedback($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "message" => ""
]);

Sends a feedback message at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

messageBODY : person feedback

person.sendBug

( tokenID, companyID, *eventID, platform, pagelink, bug, steps, extra )

  • Info
  • Curl
  • PHP
POST /api/?action=person.sendBugHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.sendBug&tokenID=&companyID= \   -d "platform=&pagelink=&bug=&steps=&extra="
$response = InEvent\Person::sendBug($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "platform" => "",
  "pagelink" => "",
  "bug" => "",
  "steps" => "",
  "extra" => ""
]);

Sends a bug report.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

*eventIDQUERY : event identifier

platformBODY : person feedback

pagelinkBODY : person feedback

bugBODY : person feedback

stepsBODY : person feedback

extraBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=person.badge.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.badge.find&tokenID=&eventID=
$response = InEvent\Person.badge::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Verifies counter badges for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

person.badge.get

( tokenID, eventID, target )

  • Info
  • Curl
  • PHP
GET /api/?action=person.badge.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.badge.get&tokenID=&eventID=&target=
$response = InEvent\Person.badge::get($client, [
  "tokenID" => "",
  "eventID" => "",
  "target" => ""
]);

Verifies counter badge from target target for person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

targetQUERY : target module

person.badge.clear

( tokenID, eventID, target )

  • Info
  • Curl
  • PHP
GET /api/?action=person.badge.clearHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.badge.clear&tokenID=&eventID=&target=
$response = InEvent\Person.badge::clear($client, [
  "tokenID" => "",
  "eventID" => "",
  "target" => ""
]);

Cleans counter badge from target target of person personID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

targetQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=person.device.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.device.bind&tokenID=&companyID= \   -d "model=&deviceKey="
$response = InEvent\Person.device::bind($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "model" => "",
  "deviceKey" => ""
]);

Creates a device deviceKey for person tokenID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

modelBODY : phone model (0: Android, 1: iOS)

deviceKeyBODY : GCM/APNS authentication key

person.device.dismiss

( tokenID, companyID, model, deviceKey )

  • Info
  • Curl
  • PHP
POST /api/?action=person.device.dismissHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.device.dismiss&tokenID=&companyID= \   -d "model=&deviceKey="
$response = InEvent\Person.device::dismiss($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "model" => "",
  "deviceKey" => ""
]);

Removes device deviceKey.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

modelBODY : phone model (0: Android, 1: iOS)

deviceKeyBODY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=person.favorite.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.favorite.bind&tokenID=&eventID=&personID=
$response = InEvent\Person.favorite::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Creates favorite personID for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

( tokenID, eventID, code, source )

  • Info
  • Curl
  • PHP
GET /api/?action=person.favorite.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.favorite.bind&tokenID=&eventID=&code=&source=
$response = InEvent\Person.favorite::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "code" => "",
  "source" => ""
]);

Creates favorite code for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

codeQUERY : code identifier

sourceQUERY : list type

{
    "networking": "manual (default)",
    "scanner": "QR scanner"
}

( tokenID, eventID, code, source, *grade, *note )

  • Info
  • Curl
  • PHP
POST /api/?action=person.favorite.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.favorite.bind&tokenID=&eventID=&code=&source= \   -d ""
$response = InEvent\Person.favorite::bind($client, [
  "tokenID" => "",
  "eventID" => "",
  "code" => "",
  "source" => ""
], [

]);

Creates favorite code for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

codeQUERY : code identifier

sourceQUERY : list type

{
    "networking": "manual (default)",
    "scanner": "QR scanner"
}

*gradeBODY : rating

*noteBODY : text comment

person.favorite.operate

( tokenID, eventID, key, value, personID )

  • Info
  • Curl
  • PHP
POST /api/?action=person.favorite.operateHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.favorite.operate&tokenID=&eventID=&key=&personID= \   -d "value="
$response = InEvent\Person.favorite::operate($client, [
  "tokenID" => "",
  "eventID" => "",
  "key" => "",
  "personID" => ""
], [
  "value" => ""
]);

Updates value value at field key of favorite tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

keyQUERY : element name

{
    "grade": "rating"
}

valueBODY : element value

{
    "grade": "integer"
}

personIDQUERY : person identifier

person.favorite.dismiss

( tokenID, eventID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.favorite.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.favorite.dismiss&tokenID=&eventID=&personID=
$response = InEvent\Person.favorite::dismiss($client, [
  "tokenID" => "",
  "eventID" => "",
  "personID" => ""
]);

Removes favorite personID from person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

personIDQUERY : person identifier

person.favorite.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.favorite.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.favorite.find&tokenID=&eventID=
$response = InEvent\Person.favorite::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all favorites for person tokenID at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=person.stream.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.stream.edit&tokenID=&activityID=&key= \   -d "value="
$response = InEvent\Person.stream::edit($client, [
  "tokenID" => "",
  "activityID" => "",
  "key" => ""
], [
  "value" => ""
]);

Updates value value at field key at activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

keyQUERY : field name

{
    "dateBegin": "stream start",
    "dateEnd": "stream end"
}

valueBODY : field value

{
    "dateBegin": "timestamp",
    "dateEnd": "timestamp"
}

person.stream.get

( tokenID, activityID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.stream.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.stream.get&tokenID=&activityID=&personID=
$response = InEvent\Person.stream::get($client, [
  "tokenID" => "",
  "activityID" => "",
  "personID" => ""
]);

Returns person personID at stream activity activityID.

tokenIDQUERY : token identifier

activityIDQUERY : activity identifier

personIDQUERY : 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 )

  • Info
  • Curl
  • PHP
GET /api/?action=person.tag.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.tag.bind&tokenID=&tagID=&personID=
$response = InEvent\Person.tag::bind($client, [
  "tokenID" => "",
  "tagID" => "",
  "personID" => ""
]);

Creates tag tagID for person personID.

tokenIDQUERY : token identifier

tagIDQUERY : tag identifier

personIDQUERY : person identifier

( tokenID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.tag.bindHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.tag.bind&tokenID=&tagID=
$response = InEvent\Person.tag::bind($client, [
  "tokenID" => "",
  "tagID" => ""
]);

Creates tag tagID for person tokenID.

tokenIDQUERY : token identifier

tagIDQUERY : tag identifier

( tokenID, content )

  • Info
  • Curl
  • PHP
POST /api/?action=person.tag.bindHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=person.tag.bind&tokenID= \   -d "content="
$response = InEvent\Person.tag::bind($client, [
  "tokenID" => ""
], [
  "content" => ""
]);

Creates tags content for person tokenID.

tokenIDQUERY : token identifier

contentBODY : json content

person.tag.dismiss

( tokenID, tagID, personID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.tag.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.tag.dismiss&tokenID=&tagID=&personID=
$response = InEvent\Person.tag::dismiss($client, [
  "tokenID" => "",
  "tagID" => "",
  "personID" => ""
]);

Removes tag tagID from person personID.

tokenIDQUERY : token identifier

tagIDQUERY : tag identifier

personIDQUERY : person identifier

( tokenID, tagID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.tag.dismissHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.tag.dismiss&tokenID=&tagID=
$response = InEvent\Person.tag::dismiss($client, [
  "tokenID" => "",
  "tagID" => ""
]);

Removes tag tagID from person tokenID.

tokenIDQUERY : token identifier

tagIDQUERY : tag identifier

person.tag.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=person.tag.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=person.tag.find&tokenID=&eventID=
$response = InEvent\Person.tag::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all person tags at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : 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 )

  • Info
  • Curl
  • PHP
POST /api/?action=photo.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=photo.create&tokenID=&eventID= \   -d "url="
$response = InEvent\Photo::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "url" => ""
]);

Creates photo at url url at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

urlBODY : photo url

photo.remove

( tokenID, photoID )

  • Info
  • Curl
  • PHP
GET /api/?action=photo.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=photo.remove&tokenID=&photoID=
$response = InEvent\Photo::remove($client, [
  "tokenID" => "",
  "photoID" => ""
]);

Removes photo photoID.

tokenIDQUERY : token identifier

photoIDQUERY : photo identifier

photo.find

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=photo.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=photo.find&tokenID=&eventID=
$response = InEvent\Photo::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all photos at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

photo.get

( tokenID, photoID )

  • Info
  • Curl
  • PHP
GET /api/?action=photo.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=photo.get&tokenID=&photoID=
$response = InEvent\Photo::get($client, [
  "tokenID" => "",
  "photoID" => ""
]);

Returns photo photoID.

tokenIDQUERY : token identifier

photoIDQUERY : 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, companyID, name, *category )

  • Info
  • Curl
  • PHP
POST /api/?action=place.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=place.create&tokenID=&companyID= \   -d "name="
$response = InEvent\Place::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => ""
]);

Creates place named name at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : event identifier

nameBODY : place name

*categoryBODY : place category

( tokenID, eventID, name )

  • Info
  • Curl
  • PHP
POST /api/?action=place.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=place.create&tokenID=&eventID= \   -d "name="
$response = InEvent\Place::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => ""
]);

Creates place named name at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : place name

place.remove

( tokenID, placeID )

  • Info
  • Curl
  • PHP
GET /api/?action=place.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=place.remove&tokenID=&placeID=
$response = InEvent\Place::remove($client, [
  "tokenID" => "",
  "placeID" => ""
]);

Removes place placeID.

tokenIDQUERY : token identifier

placeIDQUERY : place identifier

place.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=place.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=place.find&tokenID=&companyID=
$response = InEvent\Place::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all places at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=place.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=place.find&tokenID=&eventID=
$response = InEvent\Place::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all places at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

place.findCategories

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=place.findCategoriesHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=place.findCategories&tokenID=&companyID=
$response = InEvent\Place::findCategories($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all place categories at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=place.findCategoriesHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=place.findCategories&tokenID=&eventID=
$response = InEvent\Place::findCategories($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all place categories at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

place.get

( tokenID, placeID )

  • Info
  • Curl
  • PHP
GET /api/?action=place.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=place.get&tokenID=&placeID=
$response = InEvent\Place::get($client, [
  "tokenID" => "",
  "placeID" => ""
]);

Returns place placeID.

tokenIDQUERY : token identifier

placeIDQUERY : 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, *mask )

  • Info
  • Curl
  • PHP
POST /api/?action=placeholder.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=placeholder.create&tokenID=&eventID= \   -d "type="
$response = InEvent\Placeholder::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "type" => ""
]);

Creates a placeholder at event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

typeBODY : placeholder type

*valueBODY : placeholder value

*maskBODY : mask to placeholder

( tokenID, companyID, type, *value )

  • Info
  • Curl
  • PHP
POST /api/?action=placeholder.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=placeholder.create&tokenID=&companyID= \   -d "type="
$response = InEvent\Placeholder::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "type" => ""
]);

Creates a placeholder at company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

typeBODY : placeholder type

*valueBODY : placeholder value

placeholder.remove

( tokenID, placeholderID )

  • Info
  • Curl
  • PHP
GET /api/?action=placeholder.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=placeholder.remove&tokenID=&placeholderID=
$response = InEvent\Placeholder::remove($client, [
  "tokenID" => "",
  "placeholderID" => ""
]);

Removes placeholder placeholderID.

tokenIDQUERY : token identifier

placeholderIDQUERY : placeholder identifier

placeholder.find

( companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=placeholder.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=placeholder.find&companyID=
$response = InEvent\Placeholder::find($client, [
  "companyID" => ""
]);

Returns all placeholders from company companyID.

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=placeholder.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=placeholder.find&tokenID=&eventID=
$response = InEvent\Placeholder::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all placeholders from event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

placeholder.get

( tokenID, placeholderID )

  • Info
  • Curl
  • PHP
GET /api/?action=placeholder.getHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=placeholder.get&tokenID=&placeholderID=
$response = InEvent\Placeholder::get($client, [
  "tokenID" => "",
  "placeholderID" => ""
]);

Returns placeholder placeholderID.

tokenIDQUERY : token identifier

placeholderIDQUERY : placeholder identifier

Profile

Set usage profile for event or business administrators.

Models

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

Methods

profile.create

( tokenID, companyID, name )

  • Info
  • Curl
  • PHP
POST /api/?action=profile.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=profile.create&tokenID=&companyID= \   -d "name="
$response = InEvent\Profile::create($client, [
  "tokenID" => "",
  "companyID" => ""
], [
  "name" => ""
]);

Creates a profile for admins of company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

nameBODY : profile name

( tokenID, eventID, name )

  • Info
  • Curl
  • PHP
POST /api/?action=profile.createHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=profile.create&tokenID=&eventID= \   -d "name="
$response = InEvent\Profile::create($client, [
  "tokenID" => "",
  "eventID" => ""
], [
  "name" => ""
]);

Creates a profile for admins of event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

nameBODY : profile name

profile.edit

( tokenID, profileID, key, value )

  • Info
  • Curl
  • PHP
POST /api/?action=profile.editHTTP/1.1 Host: inevent.us
$ curl -X POST http://inevent.us/api/?action=profile.edit&tokenID=&profileID=&key= \   -d "value="
$response = InEvent\Profile::edit($client, [
  "tokenID" => "",
  "profileID" => "",
  "key" => ""
], [
  "value" => ""
]);

Edits value value from field key of profile profileID.

tokenIDQUERY : token identifier

profileIDQUERY : profile identifier

keyQUERY : field name

{
    "name": "profile name",
    "description": "profile description"
}

valueBODY : field value

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

profile.remove

( tokenID, profileID )

  • Info
  • Curl
  • PHP
GET /api/?action=profile.removeHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=profile.remove&tokenID=&profileID=
$response = InEvent\Profile::remove($client, [
  "tokenID" => "",
  "profileID" => ""
]);

Removes profile profileID.

tokenIDQUERY : token identifier

profileIDQUERY : profile identifier

profile.find

( tokenID, companyID )

  • Info
  • Curl
  • PHP
GET /api/?action=profile.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=profile.find&tokenID=&companyID=
$response = InEvent\Profile::find($client, [
  "tokenID" => "",
  "companyID" => ""
]);

Returns all profiles for company companyID.

tokenIDQUERY : token identifier

companyIDQUERY : company identifier

( tokenID, eventID )

  • Info
  • Curl
  • PHP
GET /api/?action=profile.findHTTP/1.1 Host: inevent.us
$ curl -X GET http://inevent.us/api/?action=profile.find&tokenID=&eventID=
$response = InEvent\Profile::find($client, [
  "tokenID" => "",
  "eventID" => ""
]);

Returns all profiles for event eventID.

tokenIDQUERY : token identifier

eventIDQUERY : event identifier

Profile permissions

Set permissions for the usage profile.

Models

{
    "count": 1,
    "data": [
        {
            "profilePermissionID": "",
            "profileID": "",
            "key": ""
        }
    ]
}

Methods

profile.permission.bind

( tokenID, profileID, key )

  • Info
  • Curl
  • PHP