The complete event solution (1.0.0)

Download OpenAPI specification:

API Support: admin@ashkerevents.com License: Apache 2.0 Terms of Service

REST APIs from Ashker Events.

Auth

Auth APIs

Sign up a user

Request Body schema: application/json
required

Register user details(𝑺𝒆𝒆 𝑺𝒄𝒉𝒆𝒎𝒂𝒔 ⬇️)

One of

email	string
firstName	string
lastName	string
companyName	string
typeOfBusiness	string Enum: "CORPORATE" "INDIVIDUAL"
authStrategy	string Enum: "EMAIL_PASSWORD" "GOOGLE"

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"typeOfBusiness": "CORPORATE",
"authStrategy": "EMAIL_PASSWORD"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"user": {"_id": "string",
"fullName": "string",
"email": "string",
"authStrategy": "EMAIL_PASSWORD",
"realm": "VENUE",
"role": "string",
"isActive": true
}
}
}

Sign in a user

Request Body schema: application/json
required

Login venue/client detuserails(𝑺𝒆𝒆 𝑺𝒄𝒉𝒆𝒎𝒂𝒔 ⬇️)

One of

email	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"userProfile": {"_id": "string",
"email": "string",
"realm": "VENUE",
"role": "string",
"tenantId": "string",
"permissions": ["string"
]
}
},
"includes": {"authToken": "string"
}
}

Gets a signed url

query Parameters

fileName

required

string

File name to be uploaded

Responses

Response samples

200
400
404
500

Content type

application/json

"string"

Sign in a guest user

Request Body schema: application/json
required

Login guest user details(𝑺𝒆𝒆 𝑺𝒄𝒉𝒆𝒎𝒂𝒔 ⬇️)

email	string
password	string
eventId	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string",
"eventId": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"guestProfile": {"_id": "string",
"email": "string",
"fullName": "string"
}
},
"includes": {"guestToken": "string"
}
}

Event

Event APIs

Creates an event.

Request Body schema: application/json
required

Create event request

_id	string
eventName	string
eventType	string Enum: "CONFERENCE" "SEMINAR" "WORKSHOP" "TRADESHOW" "NETWORKING" "WEDDING"
noOfGuests	number
dressCode	string Enum: "CASUAL" "BUSINESS" "FORMAL" "BLACK_TIE"
coverPhoto	string
setupTime	string
eventStartDate	string
eventEndDate	string
eventStartTime	string
eventEndTime	string
eventLocation	string
eventDescription	string
eventCurrency	string Enum: "ETB" "USD"
eventStatus	string Enum: "DRAFT" "PROFORMA_SENT" "NEGOTIATING" "CONTRACT_PENDING" "BOOKED"
isPublished	boolean
registrationFormId	string
allowTicketing	boolean
allowRegistration	boolean
allowPublicRegistration	boolean
logo	string
coverText	string

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"eventName": "string",
"eventType": "CONFERENCE",
"noOfGuests": 0,
"dressCode": "CASUAL",
"coverPhoto": "string",
"setupTime": "string",
"eventStartDate": "string",
"eventEndDate": "string",
"eventStartTime": "string",
"eventEndTime": "string",
"eventLocation": "string",
"eventDescription": "string",
"eventCurrency": "ETB",
"eventStatus": "DRAFT",
"isPublished": true,
"registrationFormId": "string",
"allowTicketing": true,
"allowRegistration": true,
"allowPublicRegistration": true,
"logo": "string",
"coverText": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"_id": "string",
"eventName": "string",
"eventType": "CONFERENCE",
"noOfGuests": 0,
"dressCode": "CASUAL",
"coverPhoto": "string",
"setupTime": "string",
"eventStartDate": "string",
"eventEndDate": "string",
"eventStartTime": "string",
"eventEndTime": "string",
"eventLocation": "string",
"eventDescription": "string",
"eventCurrency": "ETB",
"eventStatus": "DRAFT",
"isPublished": true,
"registrationFormId": "string",
"allowTicketing": true,
"allowRegistration": true,
"allowPublicRegistration": true,
"logo": "string",
"coverText": "string"
}

Gets all tenant events.

query Parameters

page required	number Page
limit required	number Limit
filter required	string Filter

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": [{"_id": "string",
"eventName": "string",
"eventType": "CONFERENCE",
"noOfGuests": 0,
"dressCode": "CASUAL",
"coverPhoto": "string",
"setupTime": "string",
"eventStartDate": "string",
"eventEndDate": "string",
"eventStartTime": "string",
"eventEndTime": "string",
"eventLocation": "string",
"eventDescription": "string",
"eventCurrency": "ETB",
"eventStatus": "DRAFT",
"isPublished": true,
"registrationFormId": "string",
"allowTicketing": true,
"allowRegistration": true,
"allowPublicRegistration": true,
"logo": "string",
"coverText": "string"
}
],
"meta": {"lastPage": 0,
"nextPage": 0,
"currentPage": 0,
"limit": 0,
"count": 0
}
}

Event CheckinList

Event Rules APIs

Create new event CheckinList.

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

Event rule create request

eventId	string
name	string
allowMultipleEntries	boolean
allowReEntryAfterExitScan	boolean
antiPassbackEnabled	boolean
entryLimitDuration	number

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"name": "string",
"allowMultipleEntries": true,
"allowReEntryAfterExitScan": true,
"antiPassbackEnabled": true,
"entryLimitDuration": 0
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"checkinList": {"_id": "string",
"eventId": "string",
"name": "string",
"allowMultipleEntries": true,
"allowReEntryAfterExitScan": true,
"antiPassbackEnabled": true,
"entryLimitDuration": 0,
"gates": [{"gate": "string",
"userId": "string"
}
]
}
}
}

Update event CheckinList.

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

Event rule update request

_id	string
name	string
allowMultipleEntries	boolean
allowReEntryAfterExitScan	boolean
antiPassbackEnabled	boolean
entryLimitDuration	number

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"name": "string",
"allowMultipleEntries": true,
"allowReEntryAfterExitScan": true,
"antiPassbackEnabled": true,
"entryLimitDuration": 0
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"checkinList": {"_id": "string",
"eventId": "string",
"name": "string",
"allowMultipleEntries": true,
"allowReEntryAfterExitScan": true,
"antiPassbackEnabled": true,
"entryLimitDuration": 0,
"gates": [{"gate": "string",
"userId": "string"
}
]
}
}
}

Event Rules

Get event rules.

path Parameters

id

required

string

Event ID

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"checkinList": {"_id": "string",
"eventId": "string",
"name": "string",
"allowMultipleEntries": true,
"allowReEntryAfterExitScan": true,
"antiPassbackEnabled": true,
"entryLimitDuration": 0,
"gates": [{"gate": "string",
"userId": "string"
}
]
}
}
}

Event Registration

Event Registration APIs

Create new event registration config.

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

Event registration config create request

eventId	string
allowRsvp	boolean

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"allowRsvp": true
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"eventRegistrationConfig": {"_id": "string",
"eventId": "string",
"allowRsvp": true
}
}
}

Update event registration config.

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

Event registration config update request

_id	string
allowRsvp	boolean

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"allowRsvp": true
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"eventRegistrationConfig": {"_id": "string",
"eventId": "string",
"allowRsvp": true
}
}
}

Get event registration config.

path Parameters

id

required

string

Event ID

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"eventRegistrationConfig": {"_id": "string",
"eventId": "string",
"allowRsvp": true
}
}
}

Speakers

Event Registration APIs

Create new event speakers.

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

Event speakers create request

eventId	string
speakerName	string
speakerBio	string
speakerPhoto	string

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"speakerName": "string",
"speakerBio": "string",
"speakerPhoto": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"eventSpeaker": {"_id": "string",
"eventId": "string",
"speakerName": "string",
"speakerBio": "string",
"speakerPhoto": "string"
}
}
}

Update event speakers.

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

Event speakers update request

_id	string
eventId	string
speakerName	string
speakerBio	string
speakerPhoto	string

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"eventId": "string",
"speakerName": "string",
"speakerBio": "string",
"speakerPhoto": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"eventSpeaker": {"_id": "string",
"eventId": "string",
"speakerName": "string",
"speakerBio": "string",
"speakerPhoto": "string"
}
}
}

Get event speakers.

path Parameters

id

required

string

Event ID

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": [{"_id": "string",
"eventId": "string",
"speakerName": "string",
"speakerBio": "string",
"speakerPhoto": "string"
}
]
}

Form

Form APIs

Get form by id.

path Parameters

formId

required

string

Form ID

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"form": {"_id": "string"
}
}
}

Update form by id.

path Parameters

formId

required

string

Form ID

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

successful operation

object

_id

string

Responses

Request samples

Payload

Content type

application/json

{"form": {"_id": "string"
}
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"form": {"_id": "string"
}
}
}

Get forms.

query Parameters

page required	number Page
limit required	number Limit

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": [{"_id": "string"
}
],
"meta": {"lastPage": 0,
"nextPage": 0,
"currentPage": 0,
"limit": 0,
"count": 0
}
}

Guest

Guest APIs

Creates a guest

path Parameters

eventId

required

string

Event ID

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

successful operation

email	string
fullName	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"fullName": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"guest": {"_id": "string",
"email": "string",
"fullName": "string",
"emailSent": true,
"emailSentDate": "string",
"emailSeen": true,
"emailSeenDate": "string"
}
}
}

Uploads guests from csv

path Parameters

eventId

required

string

Event ID

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: multipart/form-data

csvFile

string <binary>

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": [{"_id": "string",
"email": "string",
"fullName": "string",
"emailSent": true,
"emailSentDate": "string",
"emailSeen": true,
"emailSeenDate": "string"
}
],
"message": "string"
}

Permission

Permission APIs

Create role permission

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

successful operation

roleId	string
permissionId	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"roleId": "string",
"permissionId": ["string"
]
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"rolePermission": {"_id": "string",
"roleId": "string",
"permissionId": ["string"
]
}
}
}

Get all permissions.

query Parameters

page required	number Page
limit required	number Limit
userId required	string User Id

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": [{"_id": "string",
"name": "string"
}
],
"meta": {"lastPage": 0,
"nextPage": 0,
"currentPage": 0,
"limit": 0,
"count": 0
}
}

Get permission by roleId.

path Parameters

roleId

required

string

Role ID

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"rolePermission": {"_id": "string",
"roleId": "string",
"permissionId": ["string"
]
}
}
}

Role

Role APIs

Create new role.

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

Role create request

role	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"role": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"role": {"_id": "string",
"role": "string",
"description": "string",
"isDefault": true
}
}
}

Get all roles.

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": [{"_id": "string",
"role": "string",
"description": "string",
"isDefault": true
}
],
"meta": {"lastPage": 0,
"nextPage": 0,
"currentPage": 0,
"limit": 0,
"count": 0
}
}

Update role by Id

Authorizations:

ApiKeyAuth

header Parameters

x-tenant-id

required

string

Tenant ID

Request Body schema: application/json

Role update request

_id	string
role	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"role": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"role": {"_id": "string",
"role": "string",
"description": "string",
"isDefault": true
}
}
}

Get role by Id

Authorizations:

ApiKeyAuth

path Parameters

roleId

required

string

ID of the role to update

header Parameters

x-tenant-id

required

string

Tenant ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"role": {"_id": "string",
"role": "string",
"description": "string",
"isDefault": true
}
}
}

The complete event solution (1.0.0)

Auth

Sign up a user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign in a user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Gets a signed url

query Parameters

Responses

Response samples

Sign in a guest user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Event

Creates an event.

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Gets all tenant events.

query Parameters

Responses

Response samples

Event CheckinList

Create new event CheckinList.

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Update event CheckinList.

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Event Rules

Get event rules.

path Parameters

header Parameters

Responses

Response samples

Event Registration

Create new event registration config.

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Update event registration config.

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get event registration config.

path Parameters

header Parameters

Responses

Response samples

Speakers

Create new event speakers.

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Update event speakers.

header Parameters

Request Body schema: application/json

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required