Akkroo (v2)

CORS

Cross-Origin Resource Sharing (CORS) is enabled for the API allowing XHR request to be processed. This can be acheieved by sending an OPTIONS preflight request in which the server will respond with the following headers.

  • Access-Control-Allow-Origin
  • Access-Control-Allow-Headers
  • Access-Control-Allow-Methods
For more information / further explaination of the concept of CORS, check out the following link

Filtering

To filter the results returned by a collection endpoint the request should contain the query string parameter filters[]. This must be an array as it is possible to supply multiple filter conditions.

The format of the filters parameter is as follows:
{logic}-{field}-{operator}-{value}

Filter strings should be url encoded

Logic

The valid values for logic are and / or. The logic is used to split the filters[] array into groups of filters based on the position on the position of the logic value or. This allows more complex queries to be constructed specifying multiple groups of conditions.

Example:
?filters[]=and-event.name-like-%Data%20Capture%20Event%
&filters[]=and-event.type-eq-1
&filters[]=or-event.name-like-%Guest%20List%20Event%
&filters[]=and-event.type-eq-2

This could be represented as the following SQL query:

SELECT ..
WHERE
(`event.name` LIKE '%Data Capture Event%' AND `event.type`=1)
OR
(`event.name` LIKE '%Guest List Event%' AND `event.type`=2)

Field

The field name to be queried in the condition. You can check what fields can be queried on each endpoint schema.

Operator

The operator used in the condition. The list of valid operators which can be supplied with a filter are:

  • eq: Equals to
  • neq: Not equals to
  • lt: Less than
  • lte: Less than or equals to
  • gt: Greater than
  • gte: Greater than or equals to
  • like: Like

Value

The value that the condition is checking for. This will be smartly parsed while the filter string is being transformed to convert the type to int, float and null.

Sorting

To sort the the results returned by a collection endpoint the request should contain the query string parameter sorts[]. This must be an array as it is possible to supply multiple sort conditions.

The format of the sort parameter is as follows:
{field}-{direction}

Below is an example of sorting events in ascending order by the endDate and then by name
/v2/events/{eventID}?sorts[]=event.endDate-asc&sorts[]=event.name-asc

Field

The field name the collection will be sorted by. You can check what fields you can use to sort a collection on each endpoint schema.

Direction

The direction to order the results. Below is a list of valid directions.

  • asc: Ascending
  • desc: Descending

Pagination

The results returned from a collection endpoint will be paginated by default. The maximum number of results returned is set to 50 by default. This value can be changed by specifing the query parameter per_page or limit. The maximum value that can be specified is 200.

The header Link will be returned with the response following the format specified in RFC5988.

Example:
</v2/events?per_page=50&page=1>; rel="self",
</v2/events?per_page=50&page=2>; rel="next",
</v2/events?per_page=50&page=3>; rel="last"

Below is a list of the available pagination query params

  • per_page - The number of results to return per page
  • page - The page number of the results to be returned

Includes

The concept of includes is to allow related data to be included in the response from the server. For example when querying Records, the Resources are not included in the response by default. To include the resources you just supply the query param include which can be comma separated to allow multiple includes.

Example of retrieving an event including the template and records:
/v2/events/{eventID}?include=template,records

Authentication

The API endpoints require an access token in the Authorization header of every request. This is a simple process - you use the Client Credentials found in your account dashboard, then you perform a POST to the authorization endpoint, which will return your access token on success.

You can find your Client Credentials in Settings > API from the Akkroo dashboard.

Once you have received your access token, store it in your application until it expires. You will use it in every subsequent API request.

Authenticate

Request an access token.

header Parameters
X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Request Body schema: application/json
One of
  • object
  • object
scope
required
string
Value:"public"
grant_type
required
string
Value:"client_credentials"
client_id
required
string non-empty
client_secret
required
string non-empty

Responses

200

Success

401

Unauthorized

post /auth
https://api.akkroo.com/v2/auth

Request samples

application/json
Copy
Expand all Collapse all
{
  • "scope": "public",
  • "grant_type": "client_credentials",
  • "client_id": "wexler",
  • "client_secret": "secret_here"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "access_token": "N2NWMGlrZ2M1WEZLYmk0S3lDK2ExZjVZNXBib2IwUUhJZytsa0Y5Mjg0YURHU1E1eC9kbXJUNG0yTmRFZTRMMWZSUHpkaVhwWkhYT0k0Rk1ManpRbkFzOEFBWWNRR1RSVlAzeGFMcFRCNFdFRllpMExodmdteXk5Sk1MSzdIbGxFMmNhcFgvbEZ1ajJnZEloQ2duSC93PT06OqXYBxdWqNn1byue2UnTmWk=",
  • "expires_in": 86400,
  • "refresh_token": "bGxRWHhVM0ZmQndMZGI0dFB4amRCYWpaZkJKblFlZVVhQzgweEVPQ2REWGRaQnhDa2VmVmlGMUEvUzBTMGlBdmt1cWlSTTByUUR4QjIxc1VNZ2l2YkJnTGxtcmhhUzVIeXJVUUFKd254aUl4SlZVQVZFOE9lRFEvS001TndSOHo6OjfqRs4sXbRUlCQRg+uggUM="
}

Users

Retrieve authenticated user

Retrieves the currently logged in user

header Parameters
Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Authorization
required
string

The bearer token obtained through authentication

Responses

200

Success

401

Unauthorized

get /users/me
https://api.akkroo.com/v2/users/me

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 1,
  • "username": "wexler",
  • "name": "Welxer Inc",
  • "email": "admin@wexler.com"
}

Events

Events define what questions are asked of the end user and the data required from them, and contain a collection of registrations.


Event Type

The type of an event is indicated by an integer value for the property type.
There are 2 concepts for types of events which are explained below.

1. Data Capture

The standard event type which is used for purely for capturing records based on the template defined for the event.

2. Check-in

This event type may be pre-populated with records on creation (e.g Guestlist). These records can then queried and updated to indicate that an attendee has arrived. (This could really do with a better explaination from product, including the "Register" part of a check-in event).

List of Event Types

Type ID Event Type
1Data Capture
5Check-in or Register then Data Capture
2(Deprecated) Check-in (no Registration)
3(Deprecated) Check-in or Register
4(Deprecated) Check-in then Data Capture (no Registration)


Event Status

The status of an event is indicated by the property status.

Status Description
1Active
2Archived
3Deleted
4Closed


Available Includes

The availble includes are as follows:

  • records - The records captured for the event
  • resources - The resources associated to the event
  • template - The event template containing the form questions
  • recordsLastModified - Datetime representing the last time a record was modified for an event

For more information see the includes explaination



Event Template

Each Event can contain an array of fields, each defined in an object, this is defined in the template attribute of the event. Every question must contain an id and type. Other parameters are specific to the type of question. Common parameters are defined below.

Common structure of a field

{
  id: "string",
  type: "string",
  label: "string",
  required: "boolean",
  initialVal: "string",
  hidden: false,
  displayed: {/*see logic section*/},
  tooltip: {
    message: "string",
    alwaysVisible: false
  },
  warningMessage: "string",
  errorMessages: {
    required: "string"
  },
  successMessage: "string"
}
Attribute Description
id The id identifies the question and associates the question with collected data. It is an alpha-numerical Camel Case string with no spaces. When created in Akkroo, it is auto-generated based on the label entered for the question, but can also be set manually.
type The type parameter identifies the type of question. See the Fields definition for all the allowed types.
label The label defines the text label for the question — the question you want to ask the user.
required The required parameter defines if the question requires a response. It is valid on all question types, except label, note and divider. If not defined, the default is false i.e. not required.
displayed The displayed parameter defines if the question should be displayed. It is valid on all question types. If not defined, the default value is true i.e. the question is displayed.

See the display logic section for information on more complex logic
successMessage A message shown once the value of the field is corrected.
warningMessage A warning message shown before the field is interacted with.
errorMessages Error messages shown on specific errors:
  • required - An error that occurs when no value is entered on a required field

Fields

Field Attributes Example
Text autoCapitalize
  • characters - capitalize all letters
  • sentences - capitalize just the first letter
  • words - capitalize all the first letters of words
subtype
if subtype is multiline than the text field should accept multiple lines instead of the default single line.
{
  id: "string",
  type: "text",
  label: "string",
  required: true,
  autoCapitalize: "string",
  placeholder: "string",
  autoCorrect: <'on'|'off'>,
  subtype: 'multiline',
  ...
}
Email autoCapitalize
  • characters - capitalize all letters
  • sentences - capitalize just the first letter
  • words - capitalize all the first letters of words
{
  type: "email",
  label: "string",
  required: true,
  id: "string",
  placeholder: "string",
  autoCorrect: <'on'|'off'>,
  autoCapitalize: "string",
  ...
}
Number

minVal
The minimum number

maxVal
The maximum number

{
  type: "number",
  id: "string",
  label: "string",
  minVal: 0,
  maxVal: 0,
  ...
}
Phone Number
{
  type: "tel",
  id: "string",
  label: "string",
  ...
}
Website
{
  type: "url",
  id: "string",
  label: "string",
  placeholder: "string",
  ...
}
Auto Complete

limit
Maximum number of items to display

selectedQuantity
Maximum number of items that can be selected

options
Auto complete options, this can be an array of strings or objects

{
  type: "autocomplete",
  id: "string",
  label: "string",
  placeholder: "string",
  limit: 0,
  selectedQuantity: 0,
  allowNewEntries: true,
  options: [],
  ...
}
Date

subtype
This option can be date,month,datetime-local,time and week

startRange
Timestamp that defines the minimum date

endRange
Timestamp that defines the maximum date

startTimeRange
Minimum time range

endTimeRange
Maximum time range

{
  type: "date",
  id: "string",
  label: "string",
  placeholder: "string",
  subtype: "string",
  startRange: 0,
  endRange: 0,
  startTimeRange: "10:10",
  endTimeRange: "10:10",
  ...
}
Label
{
  type: "url",
  id: "string",
  label: "string",
  ...
}
Header
{
  type: "url",
  id: "string",
  label: "string",
  subtype: "header",
  ...
}
Checkbox
{
  type: "checkbox",
  id: "string",
  label: "string",
  initialVal: true,
  ...
}
Checkbox group

options
Auto complete options, this can be an array of strings or objects

{
  type: "checkboxGroup",
  id: "string",
  label: "string",
  options: [],
  ...
}
Select

addEmpty
Whether to have a first option that is empty or not

multiSelect
Allow multi selection of options

{
  type: "select",
  id: "string",
  label: "string",
  addEmpty: true,
  multiSelect: true,
  options: [],
  ...
}
Radio group
{
  type: "radio",
  id: "string",
  label: "string",
  options: [],
  ...
}
Rating

maxRating
The number of stars to display, either 5 or 10

{
  type: "rating",
  id: "string",
  label: "string",
  maxRating: 5,
  ...
}
Link builder

links
Array of urls and labels

{
  type: "linkbuilder",
  id: "string",
  label: "string",
  links: [
    {
      label: 'string',
      url: 'string'
    }
  ],
  ...
}
Camera
{
  type: "cameraPhoto",
  id: "string",
  label: "string",
  ...
}
Business card
{
  type: "businessCard",
  id: "string",
  label: "string",
  ...
}
Barcode scanner
{
  type: "barcodeScanner",
  id: "string",
  label: "string",
  ...
}

Display logic

Logic works by defining logic expressions for the displayed fields. Logic expressions work like MongoDB queries on the values already entered into the form.

Questions that are not displayed are not required

{
  ...,
  displayed: {
    OTHER_FIELD_ID: {
      "$OPERATOR": "VALUE"
    },
    ...
  },
  ...
}
Operator Description Example
$displayed Display field if other field is displayed or not
{
  OTHER_FIELD_ID: {
      "$displayed": "boolean"
    }
}
$eq Display field if other field is equal to value. This operator also accepts a Regular Expression.
{
  OTHER_FIELD_ID: {
      "$eq": "any"
    }
}
or
{
  OTHER_FIELD_ID: "any"
}
$ne Display field if other field is not equal to value. This operator also accepts a Regular Expression.
{
  OTHER_FIELD_ID: {
      "$ne": "any"
    }
}
$in Display field if other field value is one of the values defined in the condition,
{
  OTHER_FIELD_ID: {
      "$in": ["any"]
    }
}
$nin Display field if other field value is not in the array of values defined in the condition
{
  OTHER_FIELD_ID: {
      "$nin": ["any"]
    }
}
$and Display field if all conditions are true
{
  OTHER_FIELD_ID: {
      "$and": [
        {
          OTHER_FIELD_ID: {
            "$OPERATOR": "value"
          }
        },
        {
          OTHER_FIELD_ID: {
            "$OPERATOR": "value"
          }
        },
        ...
      ]
    }
}
$or Display field if at least one of the conditions is true
{
  OTHER_FIELD_ID: {
      "$or": [
        {
          OTHER_FIELD_ID: {
            "$OPERATOR": "value"
          }
        },
        {
          OTHER_FIELD_ID: {
            "$OPERATOR": "value"
          }
        },
        ...
      ]
    }
}

Retrieve list of events

Filters & Sorts

Below is the list of available filters and sorts when listing events.
For more information see the filters and sorts explaination.

Filters Sorts
  • event.id
  • event.name
  • event.type
  • event.tags
  • event.status
  • event.date
  • event.endDate
  • event.templateID
  • event.lastModified
  • event.created
  • event.webFormAccess
  • record.lastModified
  • event.id
  • event.name
  • event.type
  • event.date
  • event.endDate
  • event.lastModified
  • event.created
query Parameters
filters
Array of strings
Example: "?filters[]={LOGIC}-{FIELD}-{OPERATOR}-{VALUE}"

An array of filter strings.

See the filtering explaination for more information

sorts
Array of strings
Example: "?sorts[]={FIELD}-{DIRECTION}"

An array of sort strings.

See the sorting explaination for more information

page
number
Example: "?page={PAGE_NUMBER}"

The page number to retrieve.

See the pagination explaination for more information.

per_page
number
Example: "?per_page={QUANTITY}"

The number of items per page to retrieve.

See the pagination explaination for more information.

withTrashed
number
Enum:0 1
Example: "?withTrashed=1"

Include soft deleted resources

include
string
Example: "?include=resources"

Comma separated string of related data to include in the response.

See the includes explaination for more information.

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Responses

200

Success

401

Unauthorized

get /events
https://api.akkroo.com/v2/events

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Retrieve event

path Parameters
eventID
required
string

id of the event you want to retrieve

query Parameters
include
string
Example: "?include=resources"

Comma separated string of related data to include in the response.

See the includes explaination for more information.

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Responses

200

Success

401

Unauthorized

404

Resource not found

get /events/{eventID}
https://api.akkroo.com/v2/events/{eventID}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": 1,
  • "lastModified": "2019-01-01T00:00:00+00:00",
  • "created": "2019-01-01T00:00:00+00:00",
  • "name": "My Event",
  • "type": 1,
  • "status": 1,
  • "date": "2019-01-01T00:00:00+00:00",
  • "endDate": "2019-01-31T00:00:00+00:00",
  • "styleJSON":
    {
    },
  • "collection": "Test Events",
  • "tags": { },
  • "appSchema":
    {
    },
  • "template":
    {
    },
  • "resources":
    [],
  • "recordsLastModified": "2019-01-31T00:00:00+00:00"
}

Retrieve event resources

path Parameters
eventID
required
string

id of the event you want to retrieve resources from

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

X-DeviceInformation
string

A JSON-encoded string, providing an "id" key that matches a device ID associated with the current company. This header triggers updates the collections in the device model that the route is touching. This is a stringified JSON to accept future modifications.

Responses

200

Success

400

Bad request

401

Unauthorized

404

Resource not found

get /events/{eventID}/resources
https://api.akkroo.com/v2/events/{eventID}/resources

Response samples

application/json
Copy
Expand all Collapse all
[]

Records

A record is a document of data collected from an individual. It describes the time they entered the data, the answers to questions, any additional comments or starring, who collected the data, and more.


Values

The answers to questions defined for an event are stored in the values object for a record. This object must be structured in the following format.

  • Each top level key should be the ID of the question / form field and contain an object
  • The object associated with the top level key must contain the property value

Example:

{
  "values" : {
    "firstName" : {
      "value": "John"
    },
    "lastName" : {
      "value": "Doe"
    },
    "optIn": {
      "value": true
    }
  }
}
  



Includes

The availble includes are as follows:

  • event - The event the record belongs to
  • resources - The resources related to the record
  • parent - The parent record if the record is a duplicate but not a main duplicate
  • children - The child records if the record is a main duplicate

For more information see the includes explaination

Retrieve list of records

Filters & Sorts

The properties available for the filtering and sorting of records are not limited and any property may be used. You can also use the dot notation to indicate querying of nested properties.

Example: and-values.firstName.value-eq-John

For more information see the filters and sorts explaination.

path Parameters
eventID
required
string

id of the event you want to retrieve records from

query Parameters
filters
Array of strings
Example: "?filters[]={LOGIC}-{FIELD}-{OPERATOR}-{VALUE}"

An array of filter strings.

See the filtering explaination for more information

sorts
Array of strings
Example: "?sorts[]={FIELD}-{DIRECTION}"

An array of sort strings.

See the sorting explaination for more information

page
number
Example: "?page={PAGE_NUMBER}"

The page number to retrieve.

See the pagination explaination for more information.

per_page
number
Example: "?per_page={QUANTITY}"

The number of items per page to retrieve.

See the pagination explaination for more information.

withTrashed
number
Enum:0 1
Example: "?withTrashed=1"

Include soft deleted resources

include
string
Example: "?include=resources"

Comma separated string of related data to include in the response.

See the includes explaination for more information.

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Responses

200

Success

401

Unauthorized

get /events/{eventID}/records
https://api.akkroo.com/v2/events/{eventID}/records

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create a record

Creates a record

path Parameters
eventID
required
string

id of the event you want to create record on

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Request Body schema: application/json
isCheckIn
boolean

Indicates if the record was uploaded as part of a check-in list

values
required
object

The answers to questions defined for the event . See the values section for more information.

timeArrived
required
RFC3339 UTC Date (string) or null

The datetime of when the record was created on the client

starred
boolean

Flag indicating if the record is important

Responses

201

Created

202

Created and flagged as duplicate

400

Bad request

401

Unauthorized

post /events/{eventID}/records
https://api.akkroo.com/v2/events/{eventID}/records

Request samples

application/json
Copy
Expand all Collapse all
{
  • "isCheckIn": true,
  • "isAttending": true,
  • "publicUserID": 0,
  • "values": { },
  • "lastModified": "2019-07-04T13:00:42Z",
  • "created": "2019-07-04T13:00:42Z",
  • "timeArrived": "2019-07-04T13:00:42Z",
  • "deleted":
    {
    },
  • "updated":
    {
    },
  • "parent": null,
  • "children": null,
  • "starred": true,
  • "deviceID": "string",
  • "badgeIntegrationSuccess": true,
  • "duplicateOf": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "57178e112798716007123456",
  • "isCheckIn": true,
  • "appUserID": null,
  • "source": "upload",
  • "eventID": 1,
  • "values":
    {
    },
  • "companyID": 1,
  • "created": "2018-04-20T15:11:29+01:00",
  • "lastModified": "2018-04-20T15:11:29+01:00"
}

Retrieve record

path Parameters
eventID
required
string

id of the event you want to retrieve record from

recordID
required
string

id of the record you want to retrieve

query Parameters
includeParent
string
Example: "?include=parent"

Includes parent record if duplicate

includeChildren
string
Example: "?include=children"

Includes child records if duplicate

include
string
Example: "?include=resources"

Comma separated string of related data to include in the response.

See the includes explaination for more information.

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

X-DeviceInformation
string

A JSON-encoded string, providing an "id" key that matches a device ID associated with the current company. This header triggers updates the collections in the device model that the route is touching. This is a stringified JSON to accept future modifications.

Responses

200

Success

400

Bad request

401

Unauthorized

404

Resource not found

get /events/{eventID}/records/{recordID}
https://api.akkroo.com/v2/events/{eventID}/records/{recordID}

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Update record

Update a record

path Parameters
eventID
required
string

id of the event you want to update record from

recordID
required
string

id of the record you want to update

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Request Body schema: application/json
isCheckIn
boolean

Indicates if the record was uploaded as part of a check-in list

values
object

The answers to questions defined for the event . See the values section for more information.

timeArrived
RFC3339 UTC Date (string) or null

The datetime of when the record was created on the client

starred
boolean

Flag indicating if the record is important

Responses

200

Success

400

Bad request

401

Unauthorized

404

Resource not found

412

A more recent resource already existed

patch /events/{eventID}/records/{recordID}
https://api.akkroo.com/v2/events/{eventID}/records/{recordID}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "isCheckIn": true,
  • "isAttending": true,
  • "publicUserID": 0,
  • "values": { },
  • "lastModified": "2019-07-04T13:00:42Z",
  • "created": "2019-07-04T13:00:42Z",
  • "timeArrived": "2019-07-04T13:00:42Z",
  • "deleted":
    {
    },
  • "updated":
    {
    },
  • "parent": null,
  • "children": null,
  • "starred": true,
  • "deviceID": "string",
  • "badgeIntegrationSuccess": true,
  • "duplicateOf": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "isCheckIn": true,
  • "isAttending": true,
  • "publicUserID": 0,
  • "source": "upload",
  • "eventID": 0,
  • "values": { },
  • "companyID": 0,
  • "lastModified": "2019-07-04T13:00:42Z",
  • "created": "2019-07-04T13:00:42Z",
  • "timeArrived": "2019-07-04T13:00:42Z",
  • "versions": [ ],
  • "valueValidationErrors": [ ],
  • "deleted":
    {
    },
  • "updated":
    {
    },
  • "resources":
    [],
  • "parent": null,
  • "children": null,
  • "starred": true,
  • "deviceID": "string",
  • "badgeIntegrationSuccess": true,
  • "isDuplicate": true,
  • "isMainDuplicate": true,
  • "duplicateOf": "string"
}

Delete record

path Parameters
eventID
required
string

id of the event you want to delete record from

recordID
required
string

id of the record you want to delete

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Responses

200

Success

401

Unauthorized

404

Resource not found

delete /events/{eventID}/records/{recordID}
https://api.akkroo.com/v2/events/{eventID}/records/{recordID}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "error":
    {
    }
}

Retrieve record resources

path Parameters
eventID
required
string

id of the event you want to retrieve resources from

recordID
required
string

id of the record you want to retrieve resources from

header Parameters
Authorization
required
string

The bearer token obtained through authentication

X-Request-ID
string <uuid>

The Request ID to be used for replaying requests in case of a spotty internet connection.

X-DeviceInformation
string

A JSON-encoded string, providing an "id" key that matches a device ID associated with the current company. This header triggers updates the collections in the device model that the route is touching. This is a stringified JSON to accept future modifications.

Content-Type
string <uuid>

Type of the content used on response, it should always be application/json

Responses

200

Success

400

Bad request

401

Unauthorized