pazion/bumbal-client-api-php

Bumbal API documentation

This PHP package is automatically generated by the Swagger Codegen project:

API version: 2.0
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/bumbal/bumbal-client-api-php.git"
    }
  ],
  "require": {
    "bumbal/bumbal-client-api-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to//autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
BumbalClient\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// BumbalClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$api_instance = new BumbalClient\Api\ActivityApi();
$activity_id = 789; // int | ID of the activity to delete

try {
    $result = $api_instance->deleteActivity($activity_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivityApi->deleteActivity: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v2

Class	Method	HTTP request	Description
ActivityApi	deleteActivity	DELETE /activity/{activityId}	Delete an activity
ActivityApi	lockActivity	POST /activity/lock	Lock activities which satisfy set filters
ActivityApi	retrieveActivity	GET /activity/{activityId}	Find activity by ID
ActivityApi	retrieveListActivity	PUT /activity	Retrieve List of Activities
ActivityApi	setActivity	POST /activity/set	Set (create or update) an Activity
ActivityApi	unlockActivity	POST /activity/unlock	Unlock activities which satisfy set filters
ActivityApi	unsuccessful	POST /activity/unsuccessful	Report an unsuccessful activity
ActivityApi	updateActivity	PUT /activity/{activityId}	Update a activity
ActivitytypeApi	retrieveActivityType	GET /activity-type/{activityTypeId}	Find ActivityType by ID
ActivitytypeApi	retrieveListActivityType	PUT /activity-type	Retrieve List of ActivityTypes
AddressApi	deleteAddress	DELETE /address/{addressId}	Delete an address
AddressApi	retrieveAddress	GET /address/{addressId}	Retrieve a Address
AddressApi	retrieveListAddress	PUT /address	Retrieve List of Addresses
AddressApi	reverseGeoCodeAddress	POST /address/reverse-geo-code	Reverse Geo Code a address
AddressApi	setAddress	POST /address/set	Add a new Address
AddressApi	updateAddress	PUT /address/{addressId}	Update a address
AddressappliedApi	retrieveAddressApplied	GET /address-applied/{addressId}	Retrieve an Applied Address
AddressappliedApi	updateAddressApplied	PUT /address-applied/{addressId}	Update a AddressApplied
AssignmentApi	deleteAssignment	DELETE /assignment/{assignmentId}	Delete an assignment
AssignmentApi	retrieveAssignment	GET /assignment/{assignmentId}	Find assignment by ID
AssignmentApi	retrieveListAssignment	PUT /assignment	Retrieve List of Assignments
AssignmentApi	setAssignment	POST /assignment/set	Set (create or update) an Assignment
AssignmentApi	updateAssignment	PUT /assignment/{assignmentId}	Update a assignment
AuthenticateApi	authenticateCheckToken	GET /authenticate/check-token	Check a token for validity
AuthenticateApi	authenticateSignIn	POST /authenticate/sign-in	Sign In with your user credentials
AuthenticateApi	authenticateSignOut	GET /authenticate/sign-out	Sign out
BrandApi	createBrand	POST /brand	Add a new Brand
BrandApi	deleteBrand	DELETE /brand/{brandId}	Delete a Brand
BrandApi	retrieveBrand	GET /brand/{brandId}	Retrieve a Brand
BrandApi	retrieveListBrand	PUT /brand	Retrieve List of Brands
BrandApi	setBrand	POST /brand/set	Set (create or update) a Brand
BrandApi	updateBrand	PUT /brand/{brandId}	Update a Brand
CapacitytypeApi	deleteCapacityType	DELETE /capacity-type/{capacityTypeId}	Delete a capacity-type
CapacitytypeApi	retrieveCapacityType	GET /capacity-type/{capacityTypeId}	Find capacity-type by ID
CapacitytypeApi	retrieveListCapacityType	PUT /capacity-type	Retrieve List of CapacityTypes
CapacitytypeApi	setCapacityType	POST /capacity-type/set	Set (create or update) an CapacityType
CommunicationApi	retrieveActivityCommunication	POST /communication/retrieve-activity	Retrieve Activity
CommunicationApi	triggerMessageCommunication	POST /communication/trigger-message	Trigger Message to Communication
DriverApi	createDriver	POST /driver	Add a driver
DriverApi	deleteDriver	DELETE /driver/{driverId}	Delete an driver
DriverApi	retrieveDriver	GET /driver/{driverId}	Find driver by ID
DriverApi	retrieveListDriver	PUT /driver	Retrieve List of Drivers
DriverApi	setDriver	POST /driver/set	Set (create or update) a driver
DriverApi	updateDriver	PUT /driver/{driverId}	Update a driver
DriverunavailabilityApi	createDriverUnavailability	POST /driver-unavailability	Add a new DriverUnavailability
DriverunavailabilityApi	deleteDriverUnavailability	DELETE /driver-unavailability/{driverunavailabilityId}	Delete a DriverUnavailability entry
DriverunavailabilityApi	retrieveDriverUnavailability	GET /driver-unavailability/{driverunavailabilityId}	Retrieve a DriverUnavailability
DriverunavailabilityApi	retrieveListDriverUnavailability	PUT /driver-unavailability	Retrieve List of DriverUnavailability
DriverunavailabilityApi	setDriverUnavailability	POST /driver-unavailability/set	Set (create or update) a driver unavailability
DriverunavailabilityApi	updateDriverUnavailability	PUT /driver-unavailability/{driverunavailabilityId}	Update a specific DriverUnavailability object
EquipmentApi	createEquipment	POST /equipment	Add a new Equipment
EquipmentApi	deleteEquipment	DELETE /equipment/{equipmentId}	Delete an Equipment entry
EquipmentApi	retrieveEquipment	GET /equipment/{equipmentId}	Retrieve a Equipment
EquipmentApi	retrieveListEquipment	PUT /equipment	Retrieve List of Equipment
EquipmentApi	setEquipment	POST /equipment/set	Set (create or update) a Equipment
EquipmentApi	updateEquipment	PUT /equipment/{equipmentId}	Update a specific Equipment object
FileApi	deleteFile	DELETE /file/{fileId}	Delete an File
FileApi	fileCopy	POST /file/copy	Copy File
FileApi	retrieveFile	GET /file/{fileId}	Retrieve a File
FileApi	retrieveListFile	PUT /file	Retrieve List of Files
FileApi	setFile	POST /file/set	Create or Update a File Object
InstantmessagingApi	instantMessagingList	POST /instant-messaging/list	List conversations
InstantmessagingApi	instantMessagingPost	POST /instant-messaging/post	Post a message to some one
InstantmessagingApi	instantMessagingRetrieveConversation	POST /instant-messaging/retrieve-conversation	Retrieve Conversation
LanguageApi	retrieveListLanguage	PUT /language	Retrieve List of Language
LinkApi	deleteLink	DELETE /link/{linkId}	Delete a link
LinkApi	updateLink	PUT /link/{linkId}	Update a specific link object
LogApi	retrieveListLog	PUT /log	Retrieve List of Log messages
LogApi	setLog	POST /log/set	Post a Log message
MetadataApi	createMetaData	POST /metadata	Add a new MetaData
MetadataApi	deleteMetaData	DELETE /metadata/{metadataId}	Delete a MetaData entry
MetadataApi	retrieveListMetaData	PUT /metadata	Retrieve List of MetaData
MetadataApi	retrieveMetaData	GET /metadata/{metadataId}	Retrieve a MetaData
MetadataApi	setMetaData	POST /metadata/set	Set (create or update) a MetaData record
MetadataApi	updateMetaData	PUT /metadata/{metadataId}	Update a specific MetaData object
NoteApi	deleteNote	DELETE /note/{noteId}	Delete an note
NoteApi	retrieveListNote	PUT /note	Retrieve List of Notes
NoteApi	retrieveNote	GET /note/{noteId}	Find note by ID
NoteApi	setNote	POST /note/set	Set (create or update) a note
NotecategoryApi	deleteNoteCategory	DELETE /note-category/{noteCategoryId}	Delete a note-category
NotecategoryApi	retrieveListNoteCategory	PUT /note-category	Retrieve List of NoteCategories
NotecategoryApi	retrieveNoteCategory	GET /note-category/{noteCategoryId}	Find note-category by ID
NotecategoryApi	setNoteCategory	POST /note-category/set	Set (create or update) an NoteCategory
NotificationApi	createNotification	POST /notification	Add a new Notification
NotificationApi	deleteNotification	DELETE /notification/{notificationId}	Delete an Notification entry
NotificationApi	retrieveListNotification	PUT /notification	Retrieve List of Notification
NotificationApi	retrieveNotification	GET /notification/{notificationId}	Retrieve a Notification
NotificationApi	setNotification	POST /notification/set	Set (create or update) a notification
NotificationApi	updateNotification	PUT /notification/{notificationId}	Update a specific Notification object
NotificationcategoryApi	createNotificationCategory	POST /notification-category	Add a new NotificationCategory
NotificationcategoryApi	deleteNotificationCategory	DELETE /notification-category/{notification-categoryId}	Delete an NotificationCategory entry
NotificationcategoryApi	retrieveListNotificationCategory	PUT /notification-category	Retrieve List of NotificationCategory
NotificationcategoryApi	retrieveNotificationCategory	GET /notification-category/{notification-categoryId}	Retrieve a NotificationCategory
NotificationcategoryApi	setNotificationCategory	POST /notification-category/set	Create a new NotificationCategory or update an existing one
NotificationcategoryApi	updateNotificationCategory	PUT /notification-category/{notification-categoryId}	Update a specific NotificationCategory object
PackagelineApi	createPackageLine	POST /package-line	Create or update an Package Line
PackagelineApi	deletePackageLine	DELETE /package-line/{packageLineId}	Delete an package-line
PackagelineApi	retrieveListPackageLine	PUT /package-line	Retrieve List of PackageLines
PackagelineApi	retrievePackageLine	GET /package-line/{packageLineId}	Find package-line by ID
PackagelineApi	setPackageLine	POST /package-line/set	Set (create or update) an PackageLine
PackagelineApi	updatePackageLine	PUT /package-line/update	Update package-lines in bulk
PackagetypeApi	createPackageType	POST /package-type	Create or update a Package Line
PackagetypeApi	deletePackageType	DELETE /package-type/{packageTypeId}	Delete an package-type
PackagetypeApi	retrieveListPackageType	PUT /package-type	Retrieve List of PackageTypes
PackagetypeApi	retrievePackageType	GET /package-type/{packageTypeId}	Find package-type by ID
PackagetypeApi	setPackageType	POST /package-type/set	Set (create or update) an PackageType
PackagetypeApi	updatePackageType	PUT /package-type/{packageTypeId}	Update a package-type
PartyApi	createParty	POST /party	Create or update an Party
PartyApi	deleteParty	DELETE /party/{partyId}	Delete an party
PartyApi	retrieveListParty	PUT /party	Retrieve List of Parties
PartyApi	retrieveParty	GET /party/{partyId}	Find party by ID
PartyApi	setParty	POST /party/set	Set (create or update) an Party
PartyApi	updateParty	PUT /party/{partyId}	Update a party
PauseApi	createPause	POST /pause	Add a new Pause
PauseApi	deletePause	DELETE /pause/{pauseId}	Delete a Pause
PauseApi	retrieveListPause	PUT /pause	Retrieve List of Pauses
PauseApi	retrievePause	GET /pause/{pauseId}	Retrieve a Pause
PauseApi	setPause	POST /pause/set	Set (create or update) a Pause
PauseApi	updatePause	PUT /pause/{pauseId}	Update a Pause
PaymentApi	createPayment	POST /payment	Add a new Payment
PaymentApi	deletePayment	DELETE /payment/{paymentId}	Delete an Payment entry
PaymentApi	retrieveListPayment	PUT /payment	Retrieve List of Payment
PaymentApi	retrievePayment	GET /payment/{paymentId}	Retrieve a Payment
PaymentApi	setPayment	POST /payment/set	Set (create or update) a Payment
PaymentApi	updatePayment	PUT /payment/{paymentId}	Update a specific Payment object
PlannerApi	applyPlanning	POST /planner/apply-planning	Apply a planning schema
PlannerApi	autoPlan	POST /planner/auto-plan	Plan a certain activity in any fitting route
PlannerApi	autoPlanResult	POST /planner/auto-plan-result	Fetch current result for a auto plan Request. This could be done, in progress or cancelled.
PlannerApi	changeActivitySequence	POST /planner/change-activity-sequence	Change Activity Sequence
PlannerApi	checkAvailability	POST /planner/check-availability	check availability in planning for a certain set of activity properties
PlannerApi	checkAvailabilityResult	POST /planner/check-availability-result	Fetch current result for a checkAvailability Request. This could be done, in progress or cancelled.
PlannerApi	plannerAddActivitiesToRoute	POST /planner/add-activities-to-route	Add Activities to Route
PlannerApi	removeActivitiesFromRoute	POST /planner/remove-activities-from-route	Remove Activities From Route
PortalApi	createPortal	POST /portal	Add a new Portal
PortalApi	deletePortal	DELETE /portal/{portalId}	Delete a Portal
PortalApi	retrieveListPortal	PUT /portal	Retrieve List of Portals
PortalApi	retrievePortal	GET /portal/{portalId}	Retrieve a Portal
PortalApi	setPortal	POST /portal/set	Set (create or update) a Portal
PortalApi	updatePortal	PUT /portal/{portalId}	Update a Portal
PortalsettingApi	createPortalSetting	POST /portal-setting	Add a new PortalSetting
PortalsettingApi	deletePortalSetting	DELETE /portal-setting/{portal-settingId}	Delete a PortalSetting
PortalsettingApi	retrieveListPortalSetting	PUT /portal-setting	Retrieve List of Portal Settings
PortalsettingApi	retrievePortalSetting	GET /portal-setting/{portal-settingId}	Retrieve a PortalSetting
PortalsettingApi	setPortalSetting	POST /portal-setting/set	Set (create or update) a PortalSetting
PortalsettingApi	updatePortalSetting	PUT /portal-setting/{portal-settingId}	Update a PortalSetting
ProviderApi	createProvider	POST /provider	Add a new Provider
ProviderApi	retrieveListProvider	PUT /provider	Retrieve List of Providers
ProviderApi	retrieveProvider	GET /provider/{providerId}	Retrieve a Provider
ProviderApi	updateProvider	PUT /provider/{providerId}	Update a specific provider object
QuestionnaireApi	changeLanguage	POST /questionnaire/change-language	change language of a Questionnaire
QuestionnaireApi	deleteQuestionnaire	DELETE /questionnaire/{questionnaireId}	Delete an Questionnaire entry
QuestionnaireApi	getNextQuestion	POST /questionnaire/get-next-question	getNextQuestion of an Questionnaire
QuestionnaireApi	getPreviousQuestion	POST /questionnaire/get-previous-question	getPreviousQuestion of an Questionnaire
QuestionnaireApi	retrieveListQuestionnaire	PUT /questionnaire	Retrieve List of Questionnaire
QuestionnaireApi	retrieveQuestionnaire	GET /questionnaire/{questionnaireId}	Retrieve a Questionnaire
QuestionnaireanswerApi	createQuestionnaireAnswer	POST /questionnaire-answer	Add a new QuestionnaireAnswer
QuestionnaireanswerApi	deleteQuestionnaireAnswer	DELETE /questionnaire-answer/{questionnaire-answerId}	Delete an QuestionnaireAnswer entry
QuestionnaireanswerApi	retrieveListQuestionnaireAnswer	PUT /questionnaire-answer	Retrieve List of QuestionnaireAnswer
QuestionnaireanswerApi	retrieveQuestionnaireAnswer	GET /questionnaire-answer/{questionnaire-answerId}	Retrieve a QuestionnaireAnswer
QuestionnaireanswerApi	setQuestionnaireAnswer	POST /questionnaire-answer/set	Set (create or update) a QuestionnaireAnswer
QuestionnaireanswerApi	updateQuestionnaireAnswer	PUT /questionnaire-answer/{questionnaire-answerId}	Update a specific QuestionnaireAnswer object
QuestionnairequestiontypeApi	retrieveListQuestionnaireQuestionType	PUT /questionnaire-question-type	Retrieve List of QuestionnaireQuestionType
QuestionnairequestiontypeApi	retrieveQuestionnaireQuestionType	GET /questionnaire-question-type/{questionnaire-question-typeId}	Retrieve a QuestionnaireQuestionType
QuestionnairetemplateApi	createQuestionnaireTemplate	POST /questionnaire-template	Add a new QuestionnaireTemplate
QuestionnairetemplateApi	deleteQuestionnaireTemplate	DELETE /questionnaire-template/{questionnaire-templateId}	Delete an QuestionnaireTemplate entry
QuestionnairetemplateApi	retrieveListQuestionnaireTemplate	PUT /questionnaire-template	Retrieve List of QuestionnaireTemplate
QuestionnairetemplateApi	retrieveQuestionnaireTemplate	GET /questionnaire-template/{questionnaire-templateId}	Retrieve a QuestionnaireTemplate
QuestionnairetemplateApi	setQuestionnaireTemplate	POST /questionnaire-template/set	Set (create or update) a QuestionnaireTemplate
QuestionnairetemplateApi	updateQuestionnaireTemplate	PUT /questionnaire-template/{questionnaire-templateId}	Update a specific QuestionnaireTemplate object
QuestionnairetemplategetlanguagesApi	getQuestionnaireTemplateLanguages	GET /questionnaire-template/get-languages/{questionnaire-templateId}	Retrieves all set languages for an QuestionnaireTemplate entry
QuestionnairetemplatequestionApi	createQuestionnaireTemplateQuestion	POST /questionnaire-template-question	Add a new QuestionnaireTemplateQuestion
QuestionnairetemplatequestionApi	deleteQuestionnaireTemplateQuestion	DELETE /questionnaire-template-question/{questionnaire-template-questionId}	Delete an QuestionnaireTemplateQuestion entry
QuestionnairetemplatequestionApi	retrieveListQuestionnaireTemplateQuestion	PUT /questionnaire-template-question	Retrieve List of QuestionnaireTemplateQuestion
QuestionnairetemplatequestionApi	retrieveQuestionnaireTemplateQuestion	GET /questionnaire-template-question/{questionnaire-template-questionId}	Retrieve a QuestionnaireTemplateQuestion
QuestionnairetemplatequestionApi	setQuestionnaireTemplateQuestion	POST /questionnaire-template-question/set	Set (create or update) a QuestionnaireTemplateQuestion
QuestionnairetemplatequestionApi	updateQuestionnaireTemplateQuestion	PUT /questionnaire-template-question/{questionnaire-template-questionId}	Update a specific QuestionnaireTemplateQuestion object
QuestionnairetemplatequestionoptionApi	createQuestionnaireTemplateQuestionOption	POST /questionnaire-template-question-option	Add a new QuestionnaireTemplateQuestionOption
QuestionnairetemplatequestionoptionApi	deleteQuestionnaireTemplateQuestionOption	DELETE /questionnaire-template-question-option/{questionnaire-template-question-optionId}	Delete an QuestionnaireTemplateQuestionOption entry
QuestionnairetemplatequestionoptionApi	getPossibleFollowUpQuestions	POST /questionnaire-template-question-option/get-possible-followup-questions	get possible follow up questions
QuestionnairetemplatequestionoptionApi	retrieveListQuestionnaireTemplateQuestionOption	PUT /questionnaire-template-question-option	Retrieve List of QuestionnaireTemplateQuestionOption
QuestionnairetemplatequestionoptionApi	retrieveQuestionnaireTemplateQuestionOption	GET /questionnaire-template-question-option/{questionnaire-template-question-optionId}	Retrieve a QuestionnaireTemplateQuestionOption
QuestionnairetemplatequestionoptionApi	setQuestionnaireTemplateQuestionOption	POST /questionnaire-template-question-option/set	Set (create or update) a QuestionnaireTemplateQuestionOption
QuestionnairetemplatequestionoptionApi	updateQuestionnaireTemplateQuestionOption	PUT /questionnaire-template-question-option/{questionnaire-template-question-optionId}	Update a specific QuestionnaireTemplateQuestionOption object
QuestionnairetemplatequestionoptiontextApi	createQuestionnaireTemplateQuestionOptionText	POST /questionnaire-template-question-option-text	Add a new QuestionnaireTemplateQuestionOptionText
QuestionnairetemplatequestionoptiontextApi	deleteQuestionnaireTemplateQuestionOptionText	DELETE /questionnaire-template-question-option-text/{questionnaire-template-question-option-textId}	Delete an QuestionnaireTemplateQuestionOptionText entry
QuestionnairetemplatequestionoptiontextApi	retrieveListQuestionnaireTemplateQuestionOptionText	PUT /questionnaire-template-question-option-text	Retrieve List of QuestionnaireTemplateQuestionOptionText
QuestionnairetemplatequestionoptiontextApi	retrieveQuestionnaireTemplateQuestionOptionText	GET /questionnaire-template-question-option-text/{questionnaire-template-question-option-textId}	Retrieve a QuestionnaireTemplateQuestionOptionText
QuestionnairetemplatequestionoptiontextApi	setQuestionnaireTemplateQuestionOptionText	POST /questionnaire-template-question-option-text/set	Set (create or update) a QuestionnaireTemplateQuestionOptionText
QuestionnairetemplatequestionoptiontextApi	updateQuestionnaireTemplateQuestionOptionText	PUT /questionnaire-template-question-option-text/{questionnaire-template-question-option-textId}	Update a specific QuestionnaireTemplateQuestionOptionText object
QuestionnairetemplatequestiontextApi	createQuestionnaireTemplateQuestionText	POST /questionnaire-template-question-text	Add a new QuestionnaireTemplateQuestionText
QuestionnairetemplatequestiontextApi	deleteQuestionnaireTemplateQuestionText	DELETE /questionnaire-template-question-text/{questionnaire-template-question-textId}	Delete an QuestionnaireTemplateQuestionText entry
QuestionnairetemplatequestiontextApi	retrieveListQuestionnaireTemplateQuestionText	PUT /questionnaire-template-question-text	Retrieve List of QuestionnaireTemplateQuestionText
QuestionnairetemplatequestiontextApi	retrieveQuestionnaireTemplateQuestionText	GET /questionnaire-template-question-text/{questionnaire-template-question-textId}	Retrieve a QuestionnaireTemplateQuestionText
QuestionnairetemplatequestiontextApi	setQuestionnaireTemplateQuestionText	POST /questionnaire-template-question-text/set	Set (create or update) a QuestionnaireTemplateQuestionText
QuestionnairetemplatequestiontextApi	updateQuestionnaireTemplateQuestionText	PUT /questionnaire-template-question-text/{questionnaire-template-question-textId}	Update a specific QuestionnaireTemplateQuestionText object
QuestionnairetypeApi	retrieveListQuestionnaireType	PUT /questionnaire-type	Retrieve List of QuestionnaireType
QuestionnairetypeApi	retrieveQuestionnaireType	GET /questionnaire-type/{questionnaire-typeId}	Retrieve a QuestionnaireType
RecurrenceApi	deleteRecurrence	DELETE /recurrence/{recurrenceId}	Delete an Recurrence
RecurrenceApi	finish	POST /recurrence/finish	Cleans up after the process run
RecurrenceApi	getRuns	POST /recurrence/get-runs	Returns the given runs for the next recurrences!
RecurrenceApi	processRuns	POST /recurrence/process-runs	Executes the the processes for the ids retrieved with get-runs
RecurrenceApi	retrieveListRecurrence	PUT /recurrence	Retrieve List of Recurrences
RecurrenceApi	retrieveRecurrence	GET /recurrence/{recurrenceId}	Retrieve a Recurrence
RecurrenceApi	updateRecurrence	PUT /recurrence/{recurrenceId}	Update a Recurrence
RouteApi	createRoute	POST /route	Add a new Route
RouteApi	deleteRoute	DELETE /route/{routeId}	Delete an Route
RouteApi	getExecutableActivities	POST /route/get-executable-activities	Returns all activities in this route which hav enot been executed yet.
RouteApi	retrieveListRoute	PUT /route	Retrieve List of Routes
RouteApi	retrieveRoute	GET /route/{routeId}	Retrieve a Route
RouteApi	routeStoreGeoLocations	POST /route/store-geo-locations	Store tracked Geo Locations in bulk
RouteApi	setRoute	POST /route/set	Set (create or update) an Route
RouteApi	updateRoute	PUT /route/{routeId}	Update a Route
SaywhenApi	saywhenRetrievePortalURL	GET /saywhen/retrieve-portal-url/{activityId}	Retrieve SayWhen Portal URL
SaywhenApi	saywhenRetrievePortalURLs	PUT /saywhen/retrieve-portal-urls	Retrieve SayWhen Portal URLs
SaywhenApi	saywhenRetrieveStatus	GET /saywhen/retrieve-status/{activityId}	Retrieve SayWhen Status
SettingsApi	getConstants	GET /settings/get-constants	getConstants, returns in structure 'string':'string', can contain rounding errors for floating points
SettingsApi	getConstantsReversed	GET /settings/get-constants-reversed	getConstantsReversed, returns in structure 'string':int/float
SettingsApi	retrieveListSettings	PUT /settings	Retrieve List of Settings
SettingsApi	retrieveSettings	GET /settings/{settingsId}	Retrieve a Settings
SettingsApi	setSetting	POST /settings/set	Set (update) Setting value
SettingsApi	updateSettings	PUT /settings/{settingsId}	Update a Settings
SystemApi	systemGetConfig	GET /system/get-config	Retrieve System Configuration
SystemApi	systemGetSayWhenConfig	GET /system/get-say-when-config	Retrieve SayWhen System Configuration
SystemApi	systemGetVariables	GET /system/get-variables	Retrieve System Variables
SystemproviderApi	retrieveListSystemProvider	PUT /system-provider	Retrieve List of System Providers
SystemproviderApi	retrieveSystemProvider	GET /system-provider/{providerId}	Retrieve a System Provider
TagsApi	addTagToObject	POST /tags/add-tag-to-object	adds a tag to an object
TagsApi	createTag	POST /tags	Add a new Tag
TagsApi	deleteTag	DELETE /tags/{tagId}	Delete a Tag
TagsApi	retrieveListTags	PUT /tags	Retrieve List of Tags
TagsApi	retrieveTag	GET /tags/{tagId}	Retrieve a Tag
TagsApi	updateTag	PUT /tags/{tagId}	Update a Tag
TagtypeApi	createTagType	POST /tag-type	Add a new Tag type
TagtypeApi	deleteTagType	DELETE /tag-type/{tagTypeId}	Delete a Tag type
TagtypeApi	retrieveListTagType	PUT /tag-type	Retrieve List of Tag types
TagtypeApi	retrieveTagType	GET /tag-type/{tagTypeId}	Retrieve a Tag type
TagtypeApi	setTagType	POST /tag-type/set	Set (create or update) Tag type
TagtypeApi	updateTagType	PUT /tag-type/{tagTypeId}	Update a Tag type
TracktraceApi	trackTraceCalculateETA	GET /track-and-trace/calculate-eta/{activityId}	Calculate ETA for Activity
TracktraceApi	trackTraceCalculateRoutesETA	PUT /track-and-trace/calculate-routes-eta	Calculate ETA for Activities on Routes
TrailerApi	createTrailer	POST /trailer	Add a trailer
TrailerApi	deleteTrailer	DELETE /trailer/{trailerId}	Delete an trailer
TrailerApi	retrieveListTrailer	PUT /trailer	Retrieve List of Trailers
TrailerApi	retrieveTrailer	GET /trailer/{trailerId}	Find trailer by ID
TrailerApi	setTrailer	POST /trailer/set	Set (create or update) a trailer
TrailerApi	updateTrailer	PUT /trailer/{trailerId}	Update a trailer
TransactionApi	createTransaction	POST /transaction	Add a new Transaction
TransactionApi	deleteTransaction	DELETE /transaction/{transactionId}	Delete an Transaction entry
TransactionApi	retrieveListTransaction	PUT /transaction	Retrieve List of Transaction
TransactionApi	retrieveTransaction	GET /transaction/{transactionId}	Retrieve a Transaction
TransactionApi	setTransaction	POST /transaction/set	Set (create or update) a Transaction
TransactionApi	token	POST /transaction/token	get a transaction token
TransactionApi	token_0	POST /transaction/token-is-paid	set a transaction to paid with token
TransactionApi	token_1	POST /transaction/token-is-cancelled	set a transaction to cancelled with token
TransactionApi	token_2	POST /transaction/token-has-failed	set a transaction to failed with token
TransactionApi	updateTransaction	PUT /transaction/{transactionId}	Update a specific Transaction object
UnsuccessfulreasonApi	createUnsuccessfulReason	POST /unsuccessful-reason	Add a new UnsuccessfulReason
UnsuccessfulreasonApi	deleteUnsuccessfulReason	DELETE /unsuccessful-reason/{unsuccessful-reasonId}	Delete a UnsuccessfulReason entry
UnsuccessfulreasonApi	retrieveListUnsuccessfulReason	PUT /unsuccessful-reason	Retrieve List of UnsuccessfulReason
UnsuccessfulreasonApi	retrieveUnsuccessfulReason	GET /unsuccessful-reason/{unsuccessful-reasonId}	Retrieve a UnsuccessfulReason
UnsuccessfulreasonApi	updateUnsuccessfulReason	PUT /unsuccessful-reason/{unsuccessful-reasonId}	Update a specific UnsuccessfulReason object
UomApi	retrieveListUom	PUT /uom	Retrieve List of Uom's
UsersApi	checkCredentialsUser	GET /users/check-credentials	Checks the credentials of a User
UsersApi	retrieveListUserNotification	PUT /users/notification	Retrieve List of UserNotification
UsersApi	retrieveListUsers	PUT /users	Retrieve List of Users
UsersApi	retrieveUsers	GET /users/{usersId}	Retrieve a Users
UsersApi	setUser	POST /users/set	Set (create or update) a User
UsersApi	setUserNotification	POST /users/notification	Create a new UserNotification or update an existing one
UsersApi	updateUsers	PUT /users/{usersId}	Update a Users
VehicleApi	createVehicle	POST /vehicle	Add a new vehicle
VehicleApi	deleteVehicle	DELETE /vehicle/{vehicleId}	Delete a vehicle entry
VehicleApi	retrieveListVehicle	PUT /vehicle	Retrieve List of Vehicles
VehicleApi	retrieveVehicle	GET /vehicle/{vehicleId}	Find vehicle by ID
VehicleApi	setVehicle	POST /vehicle/set	Set (create or update) a vehicle
VehicleApi	updateVehicle	PUT /vehicle/{vehicleId}	Update a vehicle
VehicletypeApi	createVehicleType	POST /vehicle-type	Add a new VehicleType
VehicletypeApi	deleteVehicleType	DELETE /vehicle-type/{vehicleTypeId}	Delete a VehicleType entry
VehicletypeApi	retrieveListVehicleType	PUT /vehicle-type	Retrieve List of VehicleTypes
VehicletypeApi	retrieveVehicleType	GET /vehicle-type/{vehicleTypeId}	Retrieve a VehicleType
VehicletypeApi	updateVehicleType	PUT /vehicle-type/{vehicleTypeId}	Update a specific VehicleType object
WebhookApi	triggerWebHook	POST /web-hook/trigger	Trigger a webhook
WorkerApi	addActionToWorkerStack	POST /worker/add-action-to-stack	Add Action To Worker Stack
ZoneApi	createZone	POST /zone	Add a new Zone
ZoneApi	deleteZone	DELETE /zone/{zoneId}	Delete a Zone
ZoneApi	retrieveListZone	PUT /zone	Retrieve List of Zone
ZoneApi	retrieveZone	GET /zone/{zoneId}	Retrieve a Zone
ZoneApi	setZone	POST /zone/set	Set (create or update) a Zone
ZoneApi	updateZone	PUT /zone/{zoneId}	Update a Zone

Documentation For Models

Documentation For Authorization

api_key

Type: API key
API key parameter name: ApiKey
Location: HTTP header

Author

gerb@bumbal.eu

pazion / bumbal-client-api-php