Core Module

The Core module is the main repository for master data about users and sharing rules.

It handles authentication and authorization, and receives most of the interactions from administrative and end-user apps.

Admin Interface

The Admin interface handles web service calls from the Admin web gui. The base url for this is at:

/api/admin/

A JSON file with OpenAPI data about all core-related admin APIs can be downloaded here.

Select a topic from the list below.

Core - Current User
- Login
- Logout
- Get current user data
- Get current user communities
- Set language
- Edit password
- Edit mobile number
- Edit email
- Renew Token
Core - End User
- Get end user (Id)
- Get end user (Guid)
- Get filtered user list
- Search end user
- Add new or edit existing user
- Upload Agreement Attachment
- Delete User
- Get active session count
- Force logoff for a specified user
- Force user to change password during the next login
- Get User additional data
- Update end user additional data
- Override system disable status
- Get the Communities Tree
- Get Roles
- Get users by group
- Get group IDs by user
- Get groups by user
- Save Groups
Core - Additional User Data Fields
- Get one additional user data field
- Get the list of all additional user data fields
- Get the list of additional user fields
- Get the list required additional user data fields
- Add or edit an additional user field
- Delete one additional user field
Core - Operators
- Get operator
- Get operator by Guid
- Get list of operators
- Search operator
- Add new or edit existing operator record
- Delete operator
- Get communities
- Get roles
- Get active session count
- Force logoff for a specified operators
- Force operator to change password during the next login
Core - Roles
- Get roles
Core - Authenticated Sessions
- Get users active sessions
- Get specified user active sessions
- Revoke specified session
Core - Communities
- Get Tree of communities
- Get communities subtree
- Get a community
- Get a community by Guid
- Get list of communities
- Add new or edit existing community
- Delete community
- Get list of community default groups
- Get list of community ancestors default groups
- Get list of community group IDs
- Set enabled groups
- Edit community branding
- Get community details
- Add new or edit community details
- Delete community detail
- Get list of community hierarchy levels
- Add or edit existing community level
- Delete community level
- Get a Bulletin Board document
- Get FAQs
- Get Terms and Conditions
- Get all documents of a community
- Edit an existing document or create a new document
- Delete document
Core - Group
- Get user group details
- Get all user groups
- Get user groups
- Add new or edit existing user group
- Delete user group
Core - Addresses
- Get address list
- Add or edit an address
- Delete an address
- Get list of country codes
Core - License Documents
- Get a license document of end user
- Get latest document of end user
- Get license documents of end user
- Add new or edit existing license document for end user
- Delete license document of end user
Core - License Documents To Validate
- Get license documents to be validated
- Validate License document
Core - Issuing Authorities
- Get country codes
- Get issuing authorities
- Add new or edit existing issuing authority
- Delete issuing authority
Core - Places
- Get User’s Places
Core - Transportation Request
- Get trasportation request
- Add transportation request
- Get filters
Core - Service Rules
- Get service rules list
- Get service rules by module and user group
- Get service rules description by module and user group
- Get modules
- Edit existing service rule
- Get service rules by user group
- Add new service rule by user group and module
Core - Ext Resource Group
- Gets external resource groups list
- Get external resource groups list by module
- Get external resource groups by user
Core - Movement Authorities
- Get movement authority
- Get reservations
- Get movement authorities by transportation request
- Get reservations opened by the user
- Get active reservation count
- Confirm movement authority
- Revoke movement authority
- Delete movement authority
- Get trips by movement authority
- Get movement details by movement authority
- Gets approaching reservations without vehicle
- Get list of news
Core - Trips
- Get trip
- Get trips
- Get user trips
- Get trip user
- Open trip
- Close trip
- Download user trips
- Get trip events
- Get trip details
- Get trips exceeding expected duration
- Get attention required trips news
Core - Attachments
- Get attachment file
- Update attachment file
- Delete attachment
Core - Messages
- Get message template
- Get HTML message templates list
- Get simple text message templates list
- Get SMS message templates list
- Get push notification message templates list
- Get message template list
- Add new or edit existing message template
- Delete Message Template
- Test message
- Get message log
- Get system message preferences
- Add new or edit existing system message preference
- Get notification preferences
- Add new or edit existing notification preference
Core - Configuration
- Get map setting data
- Get frontend configurations
- Get modules
- Download modules
- Get environment variables
Core - Import Controller
- Add new user
- Delete all users
- Remove attachments
Core - System
- Reindex
- Retrieve Action Logs

Statistics Interface

This interface allows for access to statistics data. The base url for this interface is at:

/api/statistics/

A JSON file with OpenAPI data about all vehicle-related statistics APIs can be downloaded here.

A valid JWT is required for all statistics access.

Select a topic from the list below.

Core Statistics
- Status Data
- Historical Data