FireMate API Reference
API Root: https://api.firemate.com.au/
Any Endpoint that returns multiple records will normally also return a NextPageInformation object which details the name of the filter and the value to use to return the next set of results. The Page Information also details how many results were returned and how many there are in total.
NOTES:
- Total can change from query to query as the system is live.
- MaximumCurrentResults may be less than RecordsInCurrentResults because of objects within the same filter value needing to be included in the current page.
- FilterValue can be a Date and Time value with an accuracy of up to seven decimal places.
"NextPageInformation": {
"FilterName": "DateCreatedAfter",
"RecordsInCurrentResults": 5,
"TotalApplicableRecords": 8,
"MaximumCurrentResults": 5,
"FilterValue": "2017-12-04T02:56:58.933"
}
You can check the status of the FireMate API and your own Database with the below calls via HEAD method.
https://api.firemate.com.au/api/online
This requires no Authentication and will respond with 200 OK if online.
https://api.firemate.com.au/api/online/databaseavailable
Requires Authentication and will respond with 200 OK if online.
All API endpoints that require Authentication will return a 503 Service Unavailable when the database being accessed is under maintenance.
Get the current version of the FireMate API by calling https://api.firemate.com.au/api/version
|
Date
Released |
01/09/2023 |
|
Update
Description |
-
Adds Timesheet
endpoint |
|
Date
Released |
19/01/2022 |
|
Update
Description |
-
Adds PurchaseOrder-V2
Line Items |
|
Date
Released |
18/01/2022 |
|
Update
Description |
-
Adds PurchaseOrder-V2
Endpoints |
|
Date
Released |
25/10/2021 |
|
Update
Description |
-
Adds SRSEType to SR LineItem to api/invoice |
|
Date
Released |
23/09/2021 |
|
Update
Description |
-
Adds Addresses to api/Customer |
|
Date
Released |
24/08/2020 |
|
Update
Description |
-
Adds ProductID to api/ProductInspectionPeriod |
|
Date
Released |
02/07/2020 |
|
Update
Description |
-
Adds InternalNotes to api/task |
|
Date
Released |
19/05/2020 |
|
Update
Description |
-
Adds QuotedCostOverride to api/task |
|
Date
Released |
15/02/2020 |
|
Update
Description |
-
UtcDateCreated and UtcDateModified data types have been updated from SQL
Server DATETIME to DATETIME2. This has an increased accuracy to seven decimal
places. |
|
Date
Released |
06/12/2019 |
|
Update
Description |
-
Contract ServiceSuspended updated to Boolean -
Add UTCDateModified to Attachment Endpoint |
|
Date
Released |
27/09/2019 |
|
Update
Description |
-
Add Inventory
Endpoint |
|
Date
Released |
27/09/2019 |
|
Update
Description |
-
Add
Consolidated to Invoice Endpoints -
Add ConsolidatedParentInvoiceID to Invoice Endpoints |
|
Date
Released |
20/09/2019 |
|
Update
Description |
-
Add ExtraTechnicians to RA Endpoints |
|
Date
Released |
30/08/2019 |
|
Update
Description |
-
Add OriginalDefectDescription to Defect Endpoint |
|
Date
Released |
29/08/2019 |
|
Update
Description |
-
PUT Invoice
Exported Endpoint -
PUT Invoice
Payment Status Endpoint |
|
Date
Released |
28/08/2019 |
|
Update
Description |
-
Enable External
URL Link in POST Attachment Endpoint |
|
Date
Released |
13/08/2019 |
|
Update
Description |
-
Add ContractBranchID to Invoice Endpoint |
|
Date
Released |
21/05/2019 |
|
Update
Description |
-
Add CommonResponse Endpoint |
|
Date
Released |
01/03/2019 |
|
Update
Description |
-
Add ContactMapping Endpoint -
Add ContactMappings to Contact Endpoint |
|
Date
Released |
25/02/2019 |
|
Update
Description |
-
Add Photo URL
to SafetyChecklistResults Endpoint |
|
Date
Released |
13/02/2019 |
|
Update
Description |
-
PromptID in SafetyChecklist Endpoint -
SignatureClientName in
RA/SR Endpoints -
SIgnatureURL in
RA/SR/Employee Endpoints |
|
Date
Released |
29/01/2019 |
|
Update
Description |
-
New Endpoint api/note -
Attachment
Endpoint o
Now handles
file attachments o
Get Results by
ID -
Attachment and/or
Photo endpoints on o
Customer o
Contract o
Property o
RA o
Asset o
Defect o
Job o
SR o
Task o
Quote |
|
Date
Released |
17/01/2019 |
|
Update
Description |
-
New Endpoint api/version |
|
Date
Released |
14/01/2019 |
|
Update
Description |
-
CompanyName in Employee -
StatusChangeReason in
Defect -
DateClosed in Defect |
|
Date
Released |
10/12/2018 |
|
Update
Description |
-
New Endpoint api/safetychecklist |
|
Date
Released |
22/11/2018 |
|
Update
Description |
-
Add NextPageInformation to Employee -
Add NextPageInformation to Product -
Add NextPageInformation to Branch -
Clean up
results from ItemModified Endpoint |
|
Date
Released |
21/11/2018 |
|
Update
Description |
-
AssetTestedBy in
Employee |
|
Date
Released |
20/11/2018 |
|
Update
Description |
-
Get results by
ID (intended for seeding external datastore) o
Asset o
Contact o
Contract o
Customer o
Defect o
EquipmentType o
Installation o
Invoice o
Job o
ProductInspectionPeriod o
Property o
PurchaseOrder o
Quote o
RA o
SR o
SREquipment o
Task o
TechTime |
Table of Contents
api/customer/{id:nonzero}/contract
api/customer/{id:nonzero}/property
api/customer/{id:nonzero}/contact
api/customer/{id:nonzero}/invoice
api/customer/{id:nonzero}/note
api/customer/{id:nonzero}/attachment
api/customer/{id:nonzero}
(PUT)
api/customer/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/contract/{id:nonzero}/property
api/contract/{id:nonzero}/invoice
api/contract/{id:nonzero}/note
api/contract/{id:nonzero}/attachment
api/contract/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/property/{id:nonzero}/product
api/property/{id:nonzero}/ProductInspectionPeriod
api/property/{id:nonzero}/note
api/property/{id:nonzero}/attachment
api/property/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/installation/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/ra/{id:nonzero}/attachment
api/ra/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/asset/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/defect/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/job/{id:nonzero}/srequipment
api/job/{id:nonzero}/attachment
api/job/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/sr/{id:nonzero}/srequipment
api/sr/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/task/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/equipmenttype/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/srequipment/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/employee/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/techtime/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/contact/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/quote/{id:nonzero}/attachment
api/quote/{id:nonzero}/recordlink/{recordlink}
(PUT)
api/invoice/{id:nonzero}/exported/{exported}
(PUT)
api/invoice/{id:nonzero}/paymentstatus/{status}
(PUT)
api/invoice/{id:nonzero}/recordlink/{recordlink}
(PUT)
|
Method: |
GET |
|
Endpoint: |
api/version |
|
Description: |
Gets
current version of the API |
|
Example
Request: |
{
"VersionNumber":
"1.8.0.174",
"VersionReleased":
"2019-01-17T15:20:00"
}
|
Method: |
GET |
|
Endpoint: |
api/itemLastModified |
|
Description: |
Gets
list of items that have been modified |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) Required |
|
Example
Request: |
https://api.firemate.com.au/api/itemlastmodified?datemodifiedafter=2017-11-23T13:55:00.00 |
{
"Keyword": "Invoice",
"UtcDateModified": "2017-11-24T00:00:00"
}
|
Method: |
GET |
|
Endpoint: |
api/branch |
|
Description: |
Will
return list of Branches |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
{
"BranchID": 1,
"BranchName": "Wagga",
"Description": "Woo",
"RecordLink": "",
"UtcDateCreated": "2017-12-06T23:51:05.04",
"UtcDateModified": "2017-12-06T23:51:05.04",
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/customer/{id:nonzero} |
|
Description: |
Given
a valid Customer ID, will return details of that Customer |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/customer/{id:nonzero}/contract |
|
Description: |
Given
a valid Customer ID, will return a list of Contracts |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/customer/{id:nonzero}/property |
|
Description: |
Given
a valid Customer ID, will return a list of Properties |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/customer/{id:nonzero}/contact |
|
Description: |
Given
a valid Customer ID, will return a list of Contacts |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/customer/{id:nonzero}/invoice |
|
Description: |
Given
a valid Customer ID, will return a list of Invoices |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/customer/{id:nonzero}/note |
|
Description: |
Given
a valid Customer ID, will return a list of Notes |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/customer/{id:nonzero}/attachment |
|
Description: |
Given
a valid Customer ID, will return a list of Attachments |
|
Example
Request: |
|
Method: |
PUT |
|
Endpoint: |
api/customer/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/customer (GET) |
|
Description: |
Returns
a list of Customers |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/customer?DateCreatedAfter=2016-08-22T13:55:00.00 |
{
"CustomerID": 405,
"RecordLink": "",
"CustomerName": "test",
"GUID": "326bb0f5-0b81-40a1-b07b-cff2907ce307",
"Type": "Gold",
"Status": "Normal",
"Phone": "123456789",
"Fax": "1",
"Email": "",
"Website": "",
"ABN": "",
"AccountsReference": "",
"UtcDateModified": "2017-11-24T01:00:03.52",
"UtcDateCreated": "2017-11-24T00:42:10.587",
"ElectronicBilling": true,
"GSTExclusive": false,
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/contract/{id:nonzero} |
|
Description: |
Given
a valid Contract ID, will return details of that Contract |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/contract/{id:nonzero}/property |
|
Description: |
Given
a valid Contract ID, will return a list of Properties |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/contract/{id:nonzero}/invoice |
|
Description: |
Given
a valid Contract ID, will return a list of Invoices |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/contract/{id:nonzero}/note |
|
Description: |
Given
a valid Contract ID, will return a list of Notes |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/contract/{id:nonzero}/attachment |
|
Description: |
Given
a valid Contract ID, will return a list of Attachments |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/contract |
|
Description: |
Returns
a list of Contracts |
|
DateModifiedAfter DATETIME2
(UTC) DateCreatedAfter DATETIME2
(UTC) |
|
|
Example
Request: |
https://api.firemate.com.au/api/contract?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/contract/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"ContractID": 388,
"CustomerID": 405,
"DurationMonths": 12,
"TotalAnnualAmount": 0,
"RecordLink": "",
"ContractName": "test contract",
"GUID": "5589aca5-e277-47b6-90c7-b33014c4104c",
"CustomerPO": "1",
"ContractType": "Standard",
"BillingType": "Advance",
"BillingFrequency": "Monthly",
"AccountRef": "",
"ContractRenewal": "Automatic",
"ServiceSuspended": false,
"StartDate": "2017-12-01T00:00:00",
"EndDate": "2018-11-30T00:00:00",
"InvoicedUpTo": "0001-01-01T00:00:00",
"UtcDateModified": "2017-11-24T00:59:58.58",
"UtcDateCreated": "2017-11-24T00:42:22.63",
"ActiveRecord": true,
"BodyCorporate": false
}
|
Method: |
GET |
|
Endpoint: |
api/property |
|
Description: |
Will
return list of Properties |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/property?datemodifiedafter=2016-11-23T13:55:00.00 |
|
Method: |
GET |
|
Endpoint: |
api/property/{id:nonzero} |
|
Description: |
Given
a valid Property ID, will return details of that Property |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/property/{id:nonzero}/product |
|
Description: |
Given
a valid Property ID, will return a list of Products |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/property/{id:nonzero}/ProductInspectionPeriod |
|
Description: |
Given
a valid Property ID, will return a list of Product Inspection Period Details |
|
Example
Request: |
https://api.firemate.com.au/api/property/805/productinspectionperiod |
|
Method: |
GET |
|
Endpoint: |
api/property/{id:nonzero}/note |
|
Description: |
Given
a valid Property ID, will return a list of Notes |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/property/{id:nonzero}/attachment |
|
Description: |
Given
a valid Property ID, will return a list of Attachments |
|
Example
Request: |
|
Method: |
PUT |
|
Endpoint: |
api/property/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"PropertyID": 233,
"CustomerID": 248,
"ContractID": 244,
"PropertyName": "Strata",
"ZoneName": "Gold Coast Central",
"KeyNumber1": "Main switch board located in the front stairwell on the ground floor, NMB key required",
"KeyNumber2": "Test switch installed",
"KeyNumber3": "",
"KeyNumber4": "",
"KeyNumber5": "",
"GPSCoordinates": "-33.09072,151.6284597",
"BuildingClassification": "",
"PropertyAddress": "",
"State": "NSW",
"Postcode": "2088",
"City": "Balmoral",
"Country": "",
"PropertyRef": "",
"CommisionDate": "0001-01-01T00:00:00",
"AnnualStatementsDue": "2017-08-08T00:00:00",
"AutomaticReporting": true,
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/installation |
|
Description: |
Will
return list of Installations |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/installation?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/installation/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
https://api.firemate.com.au/api/installation/1/recordlink/123 |
{
"InstallationID":
1401,
"PropertyID":
44,
"SETypeID":
1017,
"PricePerInspection":
0,
"PropertyName":
"Mandalong Rd Mosman",
"PropertyRecordLink":
"",
"SETypeName":
"",
"RecordLink":
"",
"PropertyRef":
"",
"UtcDateCreated":
"2017-12-06T23:27:43.18",
"UtcDateModified":
"2017-12-06T23:27:43.18",
"ActiveRecord":
true
}
|
Method: |
GET |
|
Endpoint: |
api/productinspectionperiod |
|
Description: |
Will
return list of Product Inspection Periods |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/productinspectionperiod?DateModifiedAfter=2018-01-01T00:00:00.000 |
{
"ProductInspectionPeriodID":
8639,
"PropertyID":
590,
"EstimatedDuration":
-1,
"ProductName": "Fire
Detection Systems",
"MaintenanceStandard":
"AS1851-2012 Section 6 - Fire Detection and Alarm Systems",
"InspectionPeriod":
"Six-Monthly",
"Frequency":
"Six-Monthly",
"DefaultAssignedTech":
"",
"InstallationStandard":
"AS-1670 - Fire Detection Warning, Control & Intercom Systems",
"PropertyName":
"CofC - 120 Queen St",
"RecordLink":
"",
"NextInspectionDate":
"0001-01-01T00:00:00",
"UtcDateModified":
"2018-01-05T00:14:52.713",
"UtcDateCreated":
"2018-01-05T00:14:52.713",
"DoAndBill":
false,
"NotifyCustomer":
false,
"Contracted": false,
"PORequired":
false,
"ActiveRecord":
true,
"PricePerInspectionLevel":
-1
},
|
Method: |
GET |
|
Endpoint: |
api/ra |
|
Description: |
Returns
a list of RAs |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) DateScheduledAfter DATETIME (Local) showAssets
Boolean Not Required -
Will add the
RAs list of Assets to the returned results |
|
Example
Request: |
https://api.firemate.com.au/api/ra?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
GET |
|
Endpoint: |
api/ra/{id:nonzero} |
|
Description: |
Given
a valid Routine Activity ID (RA ID), will return details of that Routine
Activity |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/ra/{id:nonzero}/asset |
|
Description: |
Given
a valid RA ID, will return a list of Assets |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/ra/{id:nonzero}/techtime |
|
Description: |
Given
a valid RA ID, will return a list of Technician Times |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/ra/{id:nonzero}/defect |
|
Description: |
Given
a valid RA ID, will return a list of Defects |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/ra/{id:nonzero}/photo |
|
Description: |
Given
a valid RA ID, will return a list of Photos |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/ra/{id:nonzero}/attachment |
|
Description: |
Given
a valid RA ID, will return a list of Attachments |
|
Example
Request: |
|
Method: |
PUT |
|
Endpoint: |
api/ra/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"RAID": 2908,
"NumberOfAssets": 6,
"EmployeeID": 10,
"RecordLink": "",
"GUID": "bf141e24-77a1-4bf9-b3bb-a0dde1297ef4",
"AssignedEmployee": "Chrystal Huerta",
"RAStatus": "Assigned To Tech",
"RANotes": "December 2017 - Six-Monthly Routine Inspection of Fire Blankets (AS1851-2012 Section 16)",
"InternalNotes": "1",
"LogBookId": "",
"PropertyName": "10 Pretend Way",
"PropertyRef": "",
"GPSCoordinates": "-43.5539502,172.5191662",
"HasImage": "No",
"SETypeName": "Portable Fire Extinguishers, Fire Hose Reels & Fire Blankets",
"DateScheduled": "2017-12-01T14:44:15.773",
"DateDue": "2017-12-01T00:00:00",
"DateCompleted": "0001-01-01T00:00:00",
"DeadlineDate": "2018-01-01T00:00:00",
"UtcDateModified": "2017-12-01T03:44:31.517",
"UtcDateCreated": "2017-12-01T03:44:15.773",
"ActiveRecord": true
},
|
Method: |
GET |
|
Endpoint: |
api/asset |
|
Description: |
Returns
a list of Assets |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/asset?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
GET |
|
Endpoint: |
api/asset/{id:nonzero}/photo |
|
Description: |
Given
a valid Asset ID, will return a list of Photos |
|
Example
Request: |
|
Method: |
PUT |
|
Endpoint: |
api/asset/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"AssetID": 18159,
"RAID": -1,
"PropertyID": 44,
"SETypeID": 1006,
"ProductID": 1112,
"EquipmentTypeID": 2177,
"WorkSequence": 0,
"PropertyName": "Mandalong Rd Mosman",
"PropertyRecordLink": "",
"SETypeName": "Fire, Smoke & Exit Doors",
"ProductName": "Solid Core Doors",
"EquipmentTypeName": "Solid Core Doors",
"AssetNumber": "-0",
"Barcode": "123456",
"GUID": "f4e88343-b77f-48db-ab29-061b00cae47a",
"GPSCoordinates": "",
"Comments": "new for api",
"Location": "",
"PropertyLevel": "",
"RecordLink": "",
"LastInspectionDate": "0001-01-01T00:00:00",
"DeactivationDate": "0001-01-01T00:00:00",
"UtcDateModified": "2017-12-06T22:06:45.447",
"UtcDateCreated": "2017-12-06T22:06:45.383",
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/defect |
|
Description: |
Will
return list of Defects |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) DateDetectedAfter DATETIME (Local) |
|
Example
Request: |
https://api.firemate.com.au/api/defect?datemodifiedafter=2017-11-23T13:55:00.00 |
|
Method: |
GET |
|
Endpoint: |
api/defect/{id:nonzero} |
|
Description: |
Given
a valid Defect ID, will return details of that Defect |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/defect/{id:nonzero}/photo |
|
Description: |
Given
a valid Defect ID, will return a list of Photos |
|
Example
Request: |
|
Method: |
PUT |
|
Endpoint: |
api/defect/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"DefectID": 6253,
"SRID": -1,
"TaskID": -1,
"PropertyID": 246,
"SETypeID": 1003,
"ProductID": 1009,
"EquipmentTypeID": 2032,
"QuotedCost": 0,
"QuoteID": -1,
"GUID": "69059D24-E2B6-4BF4-85B8-1C30C4390716",
"PropertyName": "Strata",
"PropertyRecordLink": "",
"SEType": "Fire Hydrant Systems",
"ProductName": "Fire Hydrant Systems",
"EquipmentTypeName": "Hydrant Valves",
"DefectType": "Defect",
"Status": "Open",
"Severity": "Non-Critical",
"RaisedBy": "FireMate Support",
"Description": "fail",
"RecordLink": "",
"VerbalCommunicationDate": "0001-01-01T00:00:00",
"WrittenCommunicationDate": "0001-01-01T00:00:00",
"DetectionDate": "2017-12-04T09:38:07",
"UtcDateCreated": "2017-12-04T22:38:12.013",
"UtcDateModified": "2017-12-04T22:50:30.037",
"Approved": false,
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/job/{id:nonzero}/sr |
|
Description: |
Given
a valid Job ID, will return a list of SRs |
|
Parameters: |
ShowTasks
True/False Not required (Default = False) |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/job/{id:nonzero}/techtime |
|
Description: |
Given
a valid Job ID, will return a list of Technician Times |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/job/{id:nonzero}/srequipment |
|
Description: |
Given
a valid Job ID, will return a list of Equipment used |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/job/{id:nonzero}/note |
|
Description: |
Given
a valid Job ID, will return a list of Notes |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/job/{id:nonzero}/attachment |
|
Description: |
Given
a valid Job ID, will return a list of Attachments |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/job |
|
Description: |
Will
return list of Jobs |
|
Parameters: |
DateCreatedAfter DATETIME2 (UTC) ShowSRs
True/False Not required (Default = False) ShowTasks
True/False Not required (Default = False) DateModifiedAfter DATETIME2 (UTC) ShowSRs
True/False Not required (Default = False) ShowTasks
True/False Not required (Default = False) |
|
Example
Request: |
https://api.firemate.com.au/api/job?DateCreatedAfter=2016-08-22T13:55:00.00&showsrs=true |
|
PUT |
|
|
Endpoint: |
api/job/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will update the
RecordLink value for the given ID |
|
Example
Request: |
{
"JobID": 233,
"PropertyID": 177,
"CustomerID": 184,
"GUID": "617af3d6-3adf-4878-a490-9e17903c556f",
"PropertyName": "Strata Plan",
"PropertyBranch": "",
"JobStatus": "Closed",
"Description": "Smoke alarm going off ground floor need replacing",
"Priority": "Medium",
"AuthorisedEmployee": "Dev Mukherjee",
"Comments": "",
"OrderRef": "",
"PropertyRef": "",
"AccountsReference": "FOB61610",
"NumberofSRs": 1,
"QuoteID": -1,
"RAID": -1,
"AlternateBillingCustomerID": -1,
"UtcDateCreated": "0001-01-01T00:00:00",
"UtcDateModified": "0001-01-01T00:00:00",
"ActiveRecord": true,
"ServiceRequests": null
}
|
Method: |
GET |
|
Endpoint: |
api/sr/{id:nonzero}/techtime |
|
Description: |
Given
a valid SR ID, will return a list of Technician Times |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/sr/{id:nonzero}/srequipment |
|
Description: |
Given
a valid SR ID, will return a list of Equipment used |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/sr/{id:nonzero}/defect |
|
Description: |
Given
a valid SR ID, will return a list of Defects |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/sr/{id:nonzero}/photo |
|
Description: |
Given
a valid SR ID, will return a list of Photos |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/sr |
|
Description: |
Will
return list of SRs |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) ShowTasks
True/False Not required (Default = False) DateCreatedAfter DATETIME2 (UTC) ShowTasks
True/False Not required (Default = False) |
|
Example
Request: |
https://api.firemate.com.au/api/sr?DateModifiedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/sr/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"SRID": 2251,
"JobID": 1033,
"RAID": -1,
"NumberOfTasks": 5,
"GUID": "D539D7D0-64B7-4824-A7F7-3AF0511BB38D",
"AssignedEmployee": "Keith Graves",
"Description": "Faults found during recent inspection \r\nNo access was gained upon scheduled inspection",
"ActionTaken": "Carried out works as requested - DW",
"SRStatus": "Closed",
"PropertyName": "Strata Plan",
"EquipmentTypeName": "PSA 240v photelectric smoke alarm",
"AssetName": "2 - PSA 9v smoke alarm",
"AssetLocation": "Unit 2",
"AssetPropertyLevel": "",
"ProductName": "Smoke and Heat Alarms",
"OrderRef": "work order no 043897",
"GPSCoordinates": "-33.845603,151.149327",
"HasImage": "False",
"UtcDateModified": "0001-01-01T00:00:00",
"UtcDateCreated": "0001-01-01T00:00:00",
"DateCompleted": "2016-09-14T08:04:35",
"DateRequired": "2016-09-14T07:00:00",
"ActiveRecord": true,
"Tasks": null
}
|
Method: |
GET |
|
Endpoint: |
api/task/{id:nonzero}/defect |
|
Description: |
Given
a valid Task ID, will return a list of Defects |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/task/{id:nonzero} |
|
Description: |
Given
a valid Task ID, will return details of that Task |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/task/{id:nonzero}/photo |
|
Description: |
Given
a valid Task ID, will return a list of Photos |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/task |
|
Description: |
Will
return list of Tasks |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/task?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/task/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"TaskID": 1556,
"SRID": 2251,
"GUID": "5D13ADED-C58B-4252-B7B6-FA7FE67AE3A2",
"AssignedEmployee": "Keith Graves",
"Description": "No access upon inspection ",
"ActionTaken": "Tested smoke alarms and replaced batteries - DW\r\n2 x 9v batteries used $10",
"TaskStatus": "Completed",
"AssetName": "2 - PSA 9v smoke alarm",
"AssetLocation": "Unit 2",
"AssetPropertyLevel": "",
"HasImage": "False",
"UtcDateModified": "0001-01-01T00:00:00",
"UtcDateCreated": "0001-01-01T00:00:00",
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/product |
|
Description: |
Will
return list of Products |
|
Example
Request: |
{
"ProductID": 1001,
"ProductName": "General Sprinkler System",
"Description": "General Sprinkler System",
"SETypeName": "Automatic Fire Sprinkler Systems",
"ActiveRecord": true
}
{
"PropertyID": 233,
"ProductID": 1011,
"PropertyName": "Strata Plan No 1606 5 The Esplande Balmoral",
"PropertyRecordLink": "",
"SETypeName": "Exit & Emergency Lighting",
"ProductName": "Exit & Emergency Lighting Single Point System",
"SETypeGUID": "91B76AC2-9A1F-43FC-8F58-F1168737B932",
"PeriodName": "Six-Monthly",
"RecordLink": "",
"NextActivityDueDate": "2016-12-01T00:00:00",
"UtcDateCreated": "0001-01-01T00:00:00",
"UtcDateModified": "0001-01-01T00:00:00",
"ActiveRecord": true
},
|
Method: |
GET |
|
Endpoint: |
api/equipmentType |
|
Description: |
Will
return list of Equipment Types |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/equipmenttype?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/equipmenttype/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
https://api.firemate.com.au/api/equipmenttype/1/recordlink/123 |
{
"EquipmentTypeID": 2233,
"CostPrice": 0,
"SellPrice": 0,
"WarrantyPeriod": 1,
"MarginPercentage": 0,
"SEType": "Custom Product Inspections",
"ProductName": "Custom Product Inspections",
"EquipmentTypeName": "Test",
"GUID": "596921F1-A4EC-4537-919E-FEC3C6115286",
"Description": "ttt",
"SupplierPartNumber": "",
"RecordLink": "",
"StartDate": "0001-01-01T00:00:00",
"EndDate": "0001-01-01T00:00:00",
"UtcDateModified": "2017-12-04T04:11:16.32",
"UtcDateCreated": "2017-12-04T04:10:55.243",
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/inventory |
|
Description: |
Will
return list of Equipment Types |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/inventory?DateCreatedAfter=2016-08-22T13:55:00.00 |
{
"InventoryID": 32,
"Quantity": 0,
"CostPrice": 0,
"SellPrice": 0,
"InventoryName": "3.5KG CO2 Extinguisher",
"ItemCode": "1033",
"AccountReference": "",
"AccountReferenceBuy": "",
"AccountReferenceSell": "",
"PartNumber": "",
"Description": "3.5KG CO2 Extinguisher",
"RecordLink": "",
"UtcDateCreated": "2019-02-13T20:15:23.7",
"UtcDateModified": "2019-02-13T20:15:23.75",
"ActiveRecord": true,
"SETypes": [
{
"SETypeID": 1009,
"SETypeName": "Portable Fire Extinguishers, Fire Hose Reels & Fire Blankets"
}
],
"Products": [
{
"ProductID": 1017,
"ProductName": "Fire Extinguishers"
}
]
},
|
Method: |
GET |
|
Endpoint: |
api/srEquipment |
|
Description: |
Will
return list of Service Request Equipment |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/srequipment?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/srequipment/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
https://api.firemate.com.au/api/srequipment/1/recordlink/123 |
{
"SREquipmentID": 427,
"JobID": 1222,
"SRID": 2674,
"Quantity": 2,
"Price": 15,
"EquipmentTypeName": "Deluge Water Spray System",
"Comments": "",
"UtcDateCreated": "2017-11-23T23:01:27.417",
"UtcDateModified": "0001-01-01T00:00:00",
"IsLoaned": false,
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/employee/{id:nonzero} |
|
Description: |
Returns
an Employee given a valid ID |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/employee (GET) |
|
Description: |
Returns
a list of Employees |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/employee?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/employee/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"EmployeeID": 28,
"GUID": "0d3e58b7-40f6-4d1c-9d13-939fe9f39021",
"FirstName": "Boby",
"LastName": "Bobinson",
"EmploymentType": "Casual",
"DOB": "",
"Email": "",
"Phone": "1111111",
"Mobile": "",
"LastGPSPosition": "",
"LicenseNo": "",
"ABN": "",
"RecordLink": "",
"UtcLastGPSUpdate": "0001-01-01T00:00:00",
"StartDate": "2017-12-04T00:00:00",
"EndDate": "0001-01-01T00:00:00",
"UtcDateModified": "2017-12-04T00:28:08.437",
"UtcDateCreated": "2017-12-04T00:28:08.437",
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/attachment |
|
Description: |
Will
return list of Attchments for given ItemID and ItemType |
|
Parameters: |
AttachmentType String Required -
Photo
Photos taken through FM App only -
File Files
Only ItemID
INT Required ItemType
String Required -
RA Photo
and File -
Asset Photo -
Defect -
Photo -
SR Photo -
Task Photo -
Customer
File -
Contract -
File -
Property
File -
Job File -
Quote - File |
|
Example
Request: |
https://api.firemate.com.au/api/attachment?ItemID=17570&ItemType=RA&attachmenttype=photo |
{
"AttachmentID":
1,
"ItemID":
1,
"ItemType":
"Defect",
"FileName":
"",
"ItemRecordLink":
"",
"URLPath":
"https://xxx/CF2CB42B-1AB4-477D-9AC5-9EA296E18884.jpg",
"AttachmentType":
"Photo",
Description:
,
"UtcDateCreated":
"2018-08-06T00:07:42.217",
"UtcDateCreated":
"2018-08-06T00:07:42.217",
ActiveRecord: true
},
|
Method: |
GET |
|
Endpoint: |
api/techTime
|
|
Description: |
Will
return list of Technician Times |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) TimeStartedAfter DATETIME (Local) |
|
Example
Request: |
https://api.firemate.com.au/api/techtime?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/techtime/{id:nonzero}/recordlink/{recordlink} (PUT)
|
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"TechTimeID": 4218,
"JobID": 1222,
"SRID": 2674,
"RAID": -1,
"EmployeeID": 7,
"RecordLink": "",
"Employee": "Brooke Callahan",
"HourType": "Work Hours",
"StartTime": "2017-11-24T09:55:00",
"EndTime": "2017-11-24T22:10:00",
"UtcDateCreated": "2017-11-23T22:58:56.56",
"UtcDateModified": "2017-11-23T23:00:45.893",
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/timesheet
|
|
Description: |
Will
return list of Technician Times |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) TimeStartedAfter DATETIME (Local) |
|
Example
Request: |
https://api.firemate.com.au/api/timesheet?DateCreatedAfter=2016-08-22T13:55:00.00 |
{
"TechTimeID": 559,
"EmployeeID": 17,
"Employee": "Kim Kardashian",
"ActiveRecord": true,
"HourType": "Work Hours",
"TimesheetStartTime": "2021-08-08T06:28:00",
"TimesheetEndTime": "2021-08-08T10:28:00",
"TimesheetSubmitted": false,
"TimesheetApproved": false,
"RAID": 1754,
"JobID": -1,
"SRID": -1,
"PropertyID": 10,
"PropertyName": "Hagrids Hut",
"RecordLink": "",
"GroupGUID": "",
"PayRate1Minutes": -1,
"PayRate2Minutes": -1,
"Notes": "",
"EventID": 1,
"EventName": "RA Hours",
"PayableEvent": 1,
"ExpenseAccountCode": "",
"IsAllowance": false,
"AllowanceAmount": 0.0,
"RAExpenseAccountCode": "4-3500",
"SRExpenseAccountCode": "",
"UtcDateCreated": "2021-09-28T04:22:33.0143714",
"UtcDateModified": "2021-09-28T04:22:33.0143714"
}
|
Method: |
GET |
|
Endpoint: |
api/contact |
|
Description: |
Will
return list of Contacts |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/contact?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/contact/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"ContactID": 58,
"RecordLink": "",
"FirstName": "Billy",
"MiddleName": "",
"LastName": "Joe",
"ContactType": "Primary",
"CompanyName": "",
"Position": "",
"Phone": "",
"Mobile": "",
"Fax": "",
"Email": "",
"DOB": "0001-01-01T00:00:00",
"UtcDateModified": "0001-01-01T00:00:00",
"UtcDateCreated": "0001-01-01T00:00:00",
"ActiveRecord": true
"ContactMappings": [
{
"ContactMappingID": 3869,
"ContactID": 0,
"ItemID": 395,
"ItemType": "Property"
}
}
|
Method: |
GET |
|
Endpoint: |
api/contactmapping |
|
Description: |
Will
return list of Contact Mappings |
|
Parameters: |
LastID
INT Not Required |
|
Example
Request: |
{
"ContactMappingID": 8034,
"ContactID": 1306,
"ItemID": 449,
"ItemType": "Property",
}
|
Method: |
GET |
|
Endpoint: |
api/quote/{id:nonzero} |
|
Description: |
Will
return a Quote given a valid ID |
|
Parameters: |
ShowLineItems showlineitems=true - Optional |
|
Example
Request: |
https://api.firemate.com.au/api/quote/223?showlineitems=true |
|
Method: |
GET |
|
Endpoint: |
api/quote/{id:nonzero}/attachment |
|
Description: |
Given
a valid Quote ID, will return a list of Attachments |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/quote |
|
Description: |
ShowLineItems showlineitems=true Optional |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) ShowLineItems Optional - ?showlineitems=true |
|
Example
Request: |
https://api.firemate.com.au/api/quote?datemodifiedafter=2017-11-23T13:55:00.00&showlineitems=true |
|
Method: |
PUT |
|
Endpoint: |
api/quote/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"QuoteID": 588,
"PropertyID": 387,
"JobID": -1,
"EmployeeID": 6,
"TotalAmount": 0,
"PropertyName": "10 Pretend Way",
"PropertyRecordLink": "",
"Status": "Created",
"GUID": "5BBD0669-C4BC-4FA7-87D9-F5D7EA44D606",
"Description": "qqq",
"InternalNotes": "wwwe",
"EmployeeName": "FireMate Support",
"RecordLink": "",
"PropertyRef": "",
"SentDate": "0001-01-01T00:00:00",
"DateQuoted": "2017-12-04T16:17:11.307",
"DateWonLost": "0001-01-01T00:00:00",
"ExpiryDate": "2018-01-03T16:17:11.487",
"UtcDateCreated": "2017-12-04T05:17:20.583",
"UtcDateModified": "2017-12-04T21:50:29.843",
"ActiveRecord": true
}
|
Method: |
GET |
|
Endpoint: |
api/invoice/{id:nonzero} |
|
Description: |
Given
a valid Invoice ID, will return details of that Invoice |
|
Parameters |
ShowLineItems showlineitems=true - Optional |
|
Example
Request: |
|
Method: |
GET |
|
Endpoint: |
api/invoice |
|
Description: |
Will
return list of Invoices |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) ShowLineItems showlineitems=true - Optional |
|
Example
Request: |
https://api.firemate.com.au/api/invoice?DateCreatedAfter=2016-08-22T13:55:00.00&showlineitems=true |
|
Method: |
GET |
|
Endpoint: |
api/invoice/credited |
|
Description: |
Will
return list of Invoices that have been Credited |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) ShowLineItems showlineitems=true - Optional |
|
Example
Request: |
https://api.firemate.com.au/api/invoice/credited/?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
PUT |
|
Endpoint: |
api/invoice/{id:nonzero}/recordlink/{recordlink} (PUT) |
|
Description: |
Will
update the RecordLink value for the given ID |
|
Example
Request: |
{
"InvoiceID":
462883,
"CustomerID":
9175,
"ContractID":
-1,
"JobID": -1,
"RAID": -1,
"NumberOfLineItems":
0,
"NumberOfLineItemSRs":
0,
"NumberOfLineItemFees":
0,
"NumberOfLineItemRASEs":
0,
"ContractBranchID":
-1,
"ConsolidatedParentInvoiceID":
462883,
"GUID":
"46A22A0A-CAC9-4FC8-8C91-654A5AA8A7F5",
"InvoiceType":
"Job",
"CreditNote":
"",
"CreditComments":
"",
"OrderRef":
"",
"PaymentStatus":
"",
"RecordLink":
"",
"AccountsRef":
"109",
"ProjectNumber":
"",
"PeriodStart":
"0001-01-01T00:00:00",
"PeriodEnd":
"0001-01-01T00:00:00",
"InvoiceDate":
"2019-11-06T09:22:02.09",
"SentDate":
"2019-11-06T09:26:55.353",
"InvoiceDue":
"2019-12-06T08:22:03.3",
"ExportDate":
"2019-11-06T23:00:18.24",
"UtcCreditDate":
"0001-01-01T00:00:00",
"UtcDateCreated":
"2019-11-05T22:22:02.1",
"UtcDateModified":
"2019-11-06T12:00:18.233",
"ActiveRecord":
true,
"Exported": true,
"ReadyToSend":
true,
"ExcludeGST":
false,
"Consolidated": false,
"InvoiceAmount":
220,
"CreditAmount":
0,
"LineItems":
null,
"LineItemsSRs":
null,
"LineItemsContractFees":
null,
"LineItemsContractSE":
null
}
|
Method: |
GET |
|
Endpoint: |
api/purchaseOrder |
|
Description: |
Will
return list of Purchase Orders - old non-integrated PO System (Supplier
Purchase Orders) |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/purchaseOrder?DateCreatedAfter=2016-08-22T13:55:00.00 |
|
Method: |
GET |
|
Endpoint: |
api/purchaseOrder-V2 |
|
Description: |
Will
return list of Purchase Orders - new integrated PO System (API Purchase
Orders) |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) DateCreatedAfter DATETIME2 (UTC) |
|
Example
Request: |
https://api.firemate.com.au/api/purchaseOrder-V2?DateCreatedAfter=2021-08-12T01:05:02.3134197 |
{
"POID": 14,
"JobID": 1971,
"RAID": -1,
"LoggedByID": 15,
"ReceivedByID": -1,
"Price": 550,
"PriceIncTax": 605,
"Description": "Annual Fire & Evacuation Training including Fire Handling (up to 20 people per session) - BH 16 Martin St",
"PONumber": "WO8862",
"Comments": "DB Quoted - $715 Sue - Strategic WO 8862 - $550",
"SupplierName": "Strategic Fire Solutions",
"ReceivedByEmployee": "",
"LoggedByEmployee": "Dena Cummings",
"TimeStamp": "2017-08-03T10:02:54.86",
"UtcDateModified": "2018-06-26T00:36:15.367",
"UtcDateCreated": "2018-06-26T00:36:15.407",
"ActiveRecord": true,
"GoodsReceived": false
},
{
"POID": 3,
"LoggedByID": 16,
"DeliveryAcceptedByID": -1,
"PONumber": "FM0004",
"Notes": "",
"Reference": "",
"DeliveryNotes": "Deliver to: ",
"SupplierName": "",
"ReceivedBy": "",
"LoggedByEmployee": "Angus&Julia Stone",
"DeliveryAcceptedByEmployee": "",
"UtcDateCreated": "2021-08-18T23:13:18.4064682",
"UtcDateModified": "2021-08-18T23:13:18.4064682",
"DateSent": "0001-01-01T00:00:00",
"DateDelivered": "0001-01-01T00:00:00",
"ActiveRecord": true,
"ItemsReceived": false,
"Approved": false,
"Deleted": false
},
|
Method: |
GET |
|
Endpoint: |
api/supplier |
|
Description: |
Will
return list of Suppliers |
|
Parameters: |
|
|
Example
Request: |
{
"SupplierID": 1,
"SupplierName": "FDM Australia",
"SupplierPhone": "(07) 32563033 ",
"SupplierFax": " (07) 32563933",
"SupplierEmail": "fdm@fdmaustralia.com.au",
"SupplierAccountsRef": "",
"ActiveRecord": true
},
{
"SafetyChecklistResultID":
1,
"EmployeeID":
74,
"CustomerID":
131,
"RAID": 1822,
"SRID": -1,
"Comments": "Working
around high voltage equipment, maintain clearances ",
"EmployeeName": "John
Trevolta",
"CustomerName":
"Icon CO. PTY LTD",
"DateRecorded":
"2018-07-04T09:49:46.147",
"SafetyChecklistResultItems":
[
{
"Result":
"No",
"ExpectedResult":
"No",
"Prompt":
"Does your task(s) involve Electrical Works?"
},
]
}
|
Method: |
GET |
|
Endpoint: |
api/note |
|
Description: |
Will
return list of Notes |
|
Parameters: |
DateModifiedAfter DATETIME2 (UTC) Not Required DateCreatedAfter DATETIME2 (UTC) Not Required |
|
Example
Request: |
{
"NoteID":
1,
"CustomerID":
-1,
"ContractID":
-1,
"PropertyID":
1,
"JobID": -1,
"CreatedByEmployeeID":
15,
"NoteText":
"Tenant not authorised to initiate callouts.",
"NoteType":
"Technician Note",
"CreatedByEmployeeName":
"Billy Corgan",
"StartDate":
"2017-02-01T00:00:00",
"EndDate":
"0001-01-01T00:00:00",
"UtcDateCreated":
"0001-01-01T00:00:00",
"UtcDateModified":
"0001-01-01T00:00:00",
"ActiveRecord":
true
},
{
"CommonResponseID": 21,
"ProductID":
1011,
"SETypeName":
"Exit & Emergency Lighting",
"ProductName": "Exit
& Emergency Lighting Single Point System",
"MaintenanceStandard":
"AS 2293.2 - 1995 Emergency Evacuation Lighting And
Exit Signs For Buildings - Inspection & Maintenance - Single Point
Systems",
"PromptItemNo":
"3.2.2.1e",
"PromptDescription":
"Operate luminaires and exit signs from battery supply",
"ReasonResponse":
"Failed 90 minute discharge test. Replace light
with new LED fitting.",
"ActionResponse":
"",
"UtcDateCreated":
"2018-12-18T05:18:55.913",
"UtcDateModified":
"2019-03-27T05:45:23.52",
"ActiveRecord":
true
},