IBMS Cloud Help Page

Introduction

Learn how to integrate your custom applications with IBMS Cloud.

Global Rules

Searches can handle wildcards. The wildcard character is *
Limits will default to 100 if not provided.
To remove the limit from a search, supply 0 as the value in the paramater.
An AccessToken and ClientID header is required on all requests

AccessToken

API	Description
POST api/Mobile/AccessToken	Register mobile device

Actions

API	Description
GET api/Portal/Actions	Return a list of actions

Assets

API	Description
GET api/Portal/AssetsTable	Load Assets table records.

Auth

API	Description
POST api/Mobile/Auth	Auth via mobile

CompanyLogo

API	Description
GET api/CompanyLogo/{CompanyCode}	Get company logo

concertoWebhooks

API	Description
POST api/concerto/webhooks	Concerto intergration - api/concerto/webhooks.

Coordinates

API	Description
GET api/Portal/Coordinates?Postcode={Postcode}	Load Coordinates records.

DeviceLocation

API	Description
POST api/mobile/DeviceLocation	Post Device Location Details

Diary

API	Description
GET api/Mobile/Diary?FromDate={FromDate}&ToDate={ToDate}	Gather active Diary appointments.
POST api/Mobile/Diary	Update Diary appointments.
POST api/Mobile/Diary/Assets	Update Diary assets.
GET api/Diary?WorkOrderID={WorkOrderID}	No documentation available.

DMSDocumentList

API	Description
GET api/Mobile/dms?LastModifiedDate={LastModifiedDate}&SiteID={SiteID}	Gather Site contacts.
GET api/Mobile/dms/{DMSID}	Gather Site contacts.

Documents

API	Description
GET api/Mobile/Documents	Gather documents.
GET api/Portal/Documents/Download/{DMSID}	Download DMS Documents.
GET api/Portal/Documents/{DMSID}/DocDownload	Download DMS Documents as base64
GET api/Portal/DocumentTable?type={type}	Load Employee documents data.
GET api/Portal/DocumentApprovalsTable?type={type}	No documentation available.

Employee

API	Description
POST api/Mobile/EmployeeStatus	Send engineer update.
GET api/Mobile/Employee?LastModifiedDate={LastModifiedDate}	Get employee details registered to device
PUT api/Mobile/Employee	Update employee external code

Errors

API	Description
POST api/errors	No documentation available.

Expenses

API	Description
GET api/Portal/Expenses?EmployeeID={EmployeeID}	Gather expense records.
GET api/Portal/ExpenseTable?EmployeeID={EmployeeID}	Generate expense table.
PUT api/Portal/Expense/{ExpenseID}	Update expenses
POST api/Portal/Expense	Create expense.
DELETE api/Portal/Expense/{ExpenseID}	Delete expense record
GET api/Portal/Expense/{ExpenseID}	Delete expense record
PUT api/Portal/Expense/{ExpenseID}/{ExpenseDetailsID}	Update expense record
POST api/Portal/Expense/{ExpenseID}	Create expense record
DELETE api/Portal/Expense/{ExpenseID}/{ExpenseDetailsID}	Delete expense record
PUT api/Portal/Expense/Approve?ExpenseID={ExpenseID}&Notes={Notes}	Approve Expense
PUT api/Portal/Expense/Query?ExpenseID={ExpenseID}&Notes={Notes}	Query Expense
PUT api/Portal/Expense/Submit?ExpenseID={ExpenseID}	Submit Expense

External

API	Description
GET api/External/PortalAccess/{EmployeeID}	Get Employee Portal Permissions
POST api/External/Auth	Get Employee Auth
POST api/external?Username={Username}&FullName={FullName}&EmployeeID={EmployeeID}&DatabaseConnectionID={DatabaseConnectionID}	No documentation available.

HandsetLog

API	Description
POST api/Mobile/HandsetLog	Create entry in the HandsetLogTable

HCCoils

API	Description
GET api/Integrations/HCCoils/ProductionTotals	Get Production Totals

Holidays

API	Description
GET api/Portal/Holidays/{HolidayYear}?EmployeeID={EmployeeID}&FromActionsEmployeeAbsenceID={FromActionsEmployeeAbsenceID}	Get Holidays by year
GET api/Portal/HolidayTable?EmployeeID={EmployeeID}	Get Holiday Table
POST api/Portal/Holidays	Request holiday
GET api/Portal/Holidays/NextHoliday	Get next holiday
PUT api/Portal/Holidays/RequestCancelation?EmployeeAbsenceID={EmployeeAbsenceID}&Notes={Notes}	Request Cancelation
PUT api/Portal/Holidays/Approve?EmployeeAbsenceID={EmployeeAbsenceID}&Notes={Notes}	Approve Holiday
PUT api/Portal/Holidays/Reject?EmployeeAbsenceID={EmployeeAbsenceID}&Notes={Notes}	Reject Holiday

Inventory

API	Description
GET api/Portal/InventoryTable?type={type}	Load Inventory data.

Invida

API	Description
POST api/Invida/webhooks	Invida intergration - api/Invida/webhooks.
POST api/Invida/WorkOrder/{WorkOrderID}/Status	No documentation available.

Layout

API	Description
POST api/Portal/Layout	Update layout of portal

LogCallout

API	Description
POST api/Mobile/Logcallout	Raise a callout and return the Job IDs & Reference.

Loneworker

API	Description
GET api/Loneworker?Ref={Ref}	Retrieve lone worker status.
POST api/Loneworker	Record an employee as a lone worker
PUT api/Loneworker	Extend an employee’s Lone Worker status or check them out as a lone worker

MobileAssets

API	Description
PUT api/Mobile/Assets/Barcode	Attach barcode to asset
GET api/Mobile/AssetAdditional?clientHash={clientHash}	Get Asset Addition Details
GET api/Mobile/AssetAdditionalTypes?TypeID={TypeID}	Get Asset Addition Types
GET api/Mobile/AssetLastUpdated	Planner and asset deatils based on a Site ID.
POST api/MobileAssets	No documentation available.

MobileBackup

API	Description
POST api/Mobile/Backup?HelpdeskID={HelpdeskID}	Post backup file

MobileClients

API	Description
GET api/Mobile/Clients?Search={Search}&Limit={Limit}	Load client records.
GET api/Mobile/Clients/{ClientID}	Load client record by ClientID

MobileHelpdesk

API	Description
GET api/Mobile/HelpdeskUpdate/{HelpdeskID}?LastDate={LastDate}	Load Helpdesk record by HelpdeskID
GET api/Mobile/HelpdeskIncidents/{HelpdeskID}	Load Helpdesk record by HelpdeskID
POST api/mobile/Helpdesk	Create Helpdesk record.
POST api/mobile/HelpdeskUpdate	Create Helpdesk update record.

MobileHolidays

API	Description
GET api/Mobile/Holidays?Limit={Limit}&Months={Months}	Load Site records.
POST api/Mobile/Holidays	Craete new holiday record
PUT api/Mobile/Holidays	Update holiday status

MobileRefrigerants

API	Description
GET api/Mobile/Fgas/Refrigerants	Load Refrigerants.
GET api/Mobile/Fgas/Transactions?DaysInPast={DaysInPast}	Load Cylinder transactions.
GET api/Mobile/Fgas/cylinders?DaysInPast={DaysInPast}	Load Cylinder transactions.
POST api/Mobile/fgas/cylinders	new cylinders.
POST api/Mobile/fgas/cylindertransactions	new cylinder transactions.
PUT api/Mobile/fgas/cylinders	update cylinders.

MobileSites

API	Description
GET api/Mobile/Sites?Search={Search}&Limit={Limit}	Load Site records.
GET api/Mobile/Sites/{SiteID}	Load Site record by SiteID
POST api/mobile/Sites	Create Site record.
PUT api/mobile/Sites	Update Site record.

MobileStatus

API	Description
POST api/mobile/Status	Update employee status
GET api/mobile/Status?LastTrackingID={LastTrackingID}	View 7 days worth of statuses

MobileSuppliers

API	Description
GET api/Mobile/Suppliers?Limit={Limit}	Load Supplier records.
GET api/Mobile/Suppliers/{SupplierID}	Load supplier record by SupplierID

MobileSync

API	Description
POST api/Mobile/MobileSync	Create entry in the MobileSyncTable

MobileTeamTalk

API	Description
GET api/Mobile/TeamTalk?Limit={Limit}&LastSyncDate={LastSyncDate}	Load TeamTalk Messages
POST api/Mobile/TeamTalk	Create New TeamTalk Messages
PUT api/Mobile/TeamTalk	Update employees status of message

MobileTimesheets

API	Description
GET api/mobile/TimesheetStatus?TimesheetID={TimesheetID}	Return the status of a timesheet record.
POST api/mobile/Timesheets	Create Timesheet record.
POST api/mobile/TimesheetDetails	Create Timesheet record.
POST api/Mobile/Timesheets?InputHours={InputHours}	No documentation available.
POST api/Mobile/Timesheets?TSDID={TSDID}&TSID={TSID}&Description={Description}&Details={Details}&EmployeeID={EmployeeID}	No documentation available.
GET api/Mobile/Timesheets?EmployeeID={EmployeeID}&LineDate={LineDate}	No documentation available.

MyDetails

API	Description
GET api/Portal/MyDetails	Pull back employee profile.

MyTeam

API	Description
GET api/Portal/MyTeam	Pull back employees team.

Notifications

API	Description
GET api/Mobile/Notifications?Exclude={Exclude}	Load notification records.

PortalAuth

API	Description
POST api/Portal/Auth	Internal
POST api/Portal/AuthCheck	Internal
GET api/Portal/CompanyCheck	Internal
POST api/PortalAuth?AccessToken={AccessToken}&Username={Username}&FullName={FullName}&EmployeeID={EmployeeID}	No documentation available.

PortalCards

API	Description
GET api/Portal/Template/Card?Name={Name}&ID={ID}&EmployeeID={EmployeeID}	Load card

PortalClients

API	Description
GET api/Portal/Clients	Load Client records.
GET api/Portal/ClientTable	Load Client table records.

PortalContracts

API	Description
GET api/Portal/ContractsTable	Load Contracts table records.
GET api/Portal/AssetsSmall?SiteID={SiteID}&WorkOrderID={WorkOrderID}&PeriodicalID={PeriodicalID}	Load Contracts table records (small).
GET api/Portal/Asset?PeriodicAssetID={PeriodicAssetID}	Load assets by
PUT api/Portal/Asset/Edit	Create / Update an asset.
PUT api/Portal/Asset/ImageEdit	Update images of an asset.
DELETE api/Portal/Asset/Delete	Delete Asset
GET api/Portal/Maintenance/{SiteID}	Get planner by SiteID

PortalCRM

API	Description
GET api/Portal/CRMTable	Load vehicle table records.

PortalDiary

API	Description
GET api/Portal/Diary	Gather active Diary appointments.
GET api/Portal/DiaryTableData	Gather active Diary appointments.

PortalEmployees

API	Description
GET api/Portal/Employees	Load Employee records.
GET api/portal/Employees/{EmployeeID}	Load an Employee record by EmployeeID
GET api/Portal/EmployeeTable	Load Employee table data.
PUT api/portal/Employees	Update an Employee rcord.
POST api/portal/Employees	Create an Employee rcord.
DELETE api/portal/Employees	Delete an Employee rcord.

PortalFGas

API	Description
GET api/Portal/FGasTable	Load FGas table records.

PortalHelpdesk

API	Description
GET api/Portal/HelpdeskTable	Load Sales Invoices table records.

PortalPopup

API	Description
GET api/Portal/Template/Popup?Name={Name}&ID={ID}&Extra={Extra}	Load card

PortalProductivity

API	Description
GET api/Portal/Productivity/BarChart?FromDate={FromDate}&ToDate={ToDate}&ViewType={ViewType}	Gather bar chart data for productivity.
GET api/Portal/Productivity/SiteBarChart?FromDate={FromDate}&ToDate={ToDate}&ViewType={ViewType}	Gather side bar chart data for productivity.
GET api/Portal/Productivity/LineChart?FromDate={FromDate}&ToDate={ToDate}&DayIntervals={DayIntervals}&ViewType={ViewType}	Gather line chart data for productivity.
GET api/Portal/Productivity/SiteLineChart?FromDate={FromDate}&ToDate={ToDate}&DayIntervals={DayIntervals}&ViewType={ViewType}	Gather site line chart data for productivity.
GET api/Portal/Productivity/ProductivityDetails?EmployeeID={EmployeeID}&FromDate={FromDate}&ToDate={ToDate}	Gather productivity details.
GET api/Portal/Productivity/ProductivitySiteDetails?SiteID={SiteID}&FromDate={FromDate}&ToDate={ToDate}	Gather productivity site details.
GET api/Portal/Productivity/InvoiceDetails?WorkOrderID={WorkOrderID}	Gather productivity invoice details.

PortalPurchaseInvoices

API	Description
GET api/Portal/PurchaseInvoiceTable	Load Purchase Invoices table records.

PortalPurchaseOrders

API	Description
GET api/Portal/PurchaseOrdersTable	Load Employee table data.

PortalSalesInvoices

API	Description
GET api/Portal/SalesInvoicesTable	Load Sales Invoices table records.

PortalSites

API	Description
GET api/Portal/Sites	Load Site records.
GET api/portal/Sites/{SiteID}	Load Site record by SiteID
PUT api/portal/Sites	Update Site records.
POST api/portal/Sites	Create Site records.
DELETE api/portal/Sites	Delete Site records.
GET api/Portal/Sites/SurveyDoc?StartDate={StartDate}&EndDate={EndDate}&SiteID={SiteID}	No documentation available.

PortalTeamTalk

API	Description
GET api/Portal/TeamTalk/{EmployeeID}	Load Recent Messages.
POST api/Portal/TeamTalk?EmployeeID={EmployeeID}&EmployeeName={EmployeeName}	Load Recent Messages.

PortalTemplates

API	Description
GET api/Portal/Templates/Vault	Load Site records.
GET api/Portal/Templates	Load Templates.
GET api/Portal/Templates/Items?TemplateID={TemplateID}	Load Site records.
GET api/Portal/Templates/{SurveyDocTemplateID}	Load Template.
GET api/Portal/Templates/Reporting	Load Site records.
GET api/Portal/Templates/History?TemplateID={TemplateID}	Load Site records.
GET api/Portal/TemplatesTable	Load templates on Atom.
GET api/Portal/WorkflowsTable	Load templates on Atom.

PortalVehicle

API	Description
GET api/Portal/VehiclesTable	Load vehicle table records.

PortalWorkFlows

API	Description
GET api/Portal/WorkFlows	Gather work flow data.
GET api/Portal/WorkFlows/WorkFlowsDashboard?StartDate={StartDate}&EndDate={EndDate}&SurveyID={SurveyID}	Gather work flow dashboard.
GET api/Portal/WorkFlows/Questions?TemplateID={TemplateID}	Load work flow questions

PortaSurvey

API	Description
GET api/Portal/Survey/SurveyDoc?StartDate={StartDate}&EndDate={EndDate}&SurveyID={SurveyID}	Load SurveyDoc records.
GET api/Portal/Survey/CompleteSurveyDoc?StartDate={StartDate}&EndDate={EndDate}&SurveyID={SurveyID}	Load SurveyDoc records.
GET api/Portal/Survey/Completed	Load SurveyDoc records.
GET api/Portal/Survey/SurveyDocDetails?SurveyID={SurveyID}&SurveyDocID={SurveyDocID}	Load SurveyDocDetails records.
GET api/Portal/Survey/FlagDetails?SurveyID={SurveyID}&SurveyDocItemID={SurveyDocItemID}	Load SurveyDocDetails records.

PPMPlanner

API	Description
GET api/Mobile/Planner/{SiteID}	Planner and asset deatils based on a Site ID.

QuestionnaireItems

API	Description
GET api/Mobile/QuestionnaireItems/{QuestionnaireID}	Gather active QuestionnaireItems.

Questionnaires

API	Description
GET api/Mobile/Questionnaires	Gather active Questionaires.

Quotes

API	Description
GET api/Portal/Quotes?FromDate={FromDate}	Gather quotes.
GET api/Portal/Quotes/{QuoteID}	Gather quote details.
GET api/Portal/Quotes/{QuoteID}/notes	Gather quote notes.
GET api/Portal/Quotes/{QuoteID}/items	Gather quote items.
GET api/Portal/Quotes/DisciplineRate/{DisciplineID}/{Type}	Get rate from discipline.
POST api/Portal/Quotes/{QuoteID}/items	Create quote items.
PUT api/Portal/Quotes/{QuoteID}/items/{JobsheetID}	Update quote item.
DELETE api/Portal/Quotes/{QuoteID}/items/{JobsheetID}	DELETE quote item.
GET api/Portal/Quotes/{QuoteID}/documents	Gather quote documents.
GET api/Portal/Quotes/stats	Gather quote stats.
GET api/Portal/Quotes/{QuoteID}/history	Gather quote history.
GET api/Portal/QuotesTable?type={type}	Load Employee documents data.
POST api/Portal/Quotes/New	Create a new quote.
PUT api/Portal/Quotes/{QuoteID}	Update quote details.
PUT api/Portal/Quotes/{QuoteID}/update	Update quote info.
GET api/Portal/Quotes/{QuoteID}/NextStep	Get next stage info.
POST api/Portal/Quotes/{QuoteID}/NextStep/action	POST next stage info.
PATCH api/Portal/Quotes/{QuoteID}/reject	Reject a quote.
GET api/Portal/Quotes/DocumentTable?QuoteID={QuoteID}	Load quote documents.
POST api/Portal/Quotes/{QuoteID}/AttachDocument	Upload document to quote.
POST api/Portal/Quotes/{QuoteID}/NextStep/ClientRequest	POST next stage info.
POST api/Portal/Quotes/{QuoteID}/NextStep/ClientApprove	POST next stage info.
POST api/Portal/Quotes/{QuoteID}/NextStep/Schedule	POST next stage info.
DELETE api/Portal/Quotes/{QuoteID}/DeleteDoc/{DMSID}	POST next stage info.
POST api/Portal/Quotes/{QuoteID}/CloneQuote	POST next stage info.

Register

API	Description
POST api/Mobile/Register	Register via mobile
POST api/Mobile/RegisterCrossApp	Register app via another app

Sage

API	Description
POST api/Integrations/Sage/Auth	Get Production Totals
GET api/Integrations/Sage/SalesInvoices	No documentation available.

Scheduler

API	Description
GET api/Portal/Scheduler/{Name}	Getscheduler data

Schedules

API	Description
GET api/Mobile/Schedules	Planner and asset deatils based on a Site ID.

SchedulesByWorkOrder

API	Description
GET api/Mobile/SchedulesByWorkOrder/{WorkOrderID}	Schedules By Work Order.

SetCover

API	Description
POST api/Portal/SetCover	Update Covered By.
POST api/Portal/RemoveCover	Remove Cover.

SiteContacts

API	Description
GET api/Mobile/SiteContacts/{SiteID}	Gather Site contacts.

SiteLocations

API	Description
GET api/Mobile/SiteLocations/{SiteID}	Gather Site Locations.

stats

API	Description
GET api/eLogbooks/stats/activity	eLogbooks statistics - api/eLogbooks/stats/activity.
GET api/eLogbooks/stats/dailyactivity	eLogbooks statistics - api/eLogbooks/stats/dailyactivity.
GET api/eLogbooks/stats/data?Search={Search}	eLogbooks statistics - api/eLogbooks/stats/data.
GET api/stats?StartDate={StartDate}	No documentation available.

SupplierGroups

API	Description
GET api/Mobile/SupplierGroups	Gather a list of supplier groups.

Suppliers

API	Description
GET api/portal/suppliers?TypeID={TypeID}	Load supplier records
GET api/portal/SupplierTable?TypeID={TypeID}	Load supplier records
GET api/Portal/Suppliers/{SupplierID}	Load supplier record by SupplierID

SurveyDocs

API	Description
POST api/Mobile/SurveyDocs	Post new Survey Doc.

Surveys

API	Description
POST api/Mobile/Surveys	Post new survey.
PUT api/Mobile/Surveys	Update survey.

SurveyTemplates

API	Description
GET api/Mobile/SurveyTemplates?LastModifiedDate={LastModifiedDate}	Pull back a list of templates.

Timesheets

API	Description
GET api/Portal/Timesheets?EmployeeID={EmployeeID}	Gather Timesheet records.
GET api/Portal/TimesheetTable?EmployeeID={EmployeeID}	Gather Timesheet records.
GET api/Portal/Timesheets/{TSID}	Gather Timesheet details records.
GET api/Portal/Timesheets/Current	Gather Timesheet records.
GET api/Portal/Timesheets/{TSID}/Stats	Gather Timesheet records.
POST api/Portal/Timesheets?EmployeeID={EmployeeID}&TimesheetWeek={TimesheetWeek}&Autofill={Autofill}	Create new Timesheet
POST api/Portal/Timesheets/{TSID}	Insert ts details records.
POST api/Portal/Timesheets/{TSID}/submit	Request approval for timesheet
POST api/Portal/Timesheets/{TSID}/delete	Delete timesheet
POST api/Portal/Timesheets/{TSID}/autofill	Auto Fill timesheet
DELETE api/Portal/Timesheets/{TSID}/{TSDID}/delete	Delete timesheet
PUT api/Portal/Timesheets/Approve?TSID={TSID}&Notes={Notes}	Approve Timesheets
PUT api/Portal/Timesheets/Query?TSID={TSID}&Notes={Notes}	Query Timesheets
PUT api/Portal/Timesheets/{TSID}/{TSDID}	Query Timesheets
GET api/Portal/Timesheets/Types	Get timesheet types

webhooks

API	Description
POST api/eLogbooks/webhooks	eLogbooks intergration - api/eLogbooks/webhooks.

workbooksWebhooks

API	Description
POST api/workbooks/webhooks	Workbooks intergration - api/workbooks/webhooks.

WorkbookWorkOrder

API	Description
POST api/Workbooks/WorkOrder	Create a new work order from Workbooks.

WorkLocations

API	Description
GET api/Portal/WorkLocations	Gather Work Locations.

WorkOrder

Various work order endpoints

API	Description
GET api/v1/WorkOrders?Search={Search}&Limit={Limit}&StatusID={StatusID}	Gather a list of work orders.
GET api/v1/WorkOrders/{WorkOrderID}/Diary	Gather a list of appointments associated to the work order.

WorkOrders

API	Description
GET api/Portal/WorkOrders	Gather Work Locations.
GET api/Portal/WorkOrderTable	Load Work Orders table data.
GET api/Portal/AppointmentsTable	Load Work Orders table data.
GET api/Portal/HCWorkOrderTable	Load Work Orders table data.
GET api/Portal/WorkOrderTable/GetLastXDays/{Days}?TimesheetID={TimesheetID}	Load Work Orders table data.