Web API Help Page

UCO API (ver. 2.16)

Introduction

This Neutral Fuels API provides functionality to be used by the UCO Collection App.

Notes

All dates and times are recorded in UTC time in the database. However, when you pass a datetime into the API or receive a JSON response, the datetime fields will be in your local time. The system will use the Time Zone Name (recorded against your user account) to convert datetime parameters and responses accordingly.

ROCCollection

API for managing ROC Collections to and from McDonald's stores.

API	Description
GET api/v1/ROCCollection/AllCollections?dtFrom={dtFrom}&dtTo={dtTo}	Query ROC collections by logged in user for a specific date range.
GET api/v1/ROCCollection/Collection?collectionid={collectionid}	Query ROC collection information using the collection id.
GET api/v1/ROCCollection/LastCollectionForStore?storeid={storeid}	Query ROC collection information for the most recent collection from a store.
POST api/v1/ROCCollection/newCollection	Record a new collection record.
GET api/v1/ROCCollection/EmptyRocsAtStore?storeid={storeid}	Get a list of empty ROCs at a store.
GET api/v1/ROCCollection/CollectionsPendingByTruckRego?truckrego={truckrego}&isallclientcollections={isallclientcollections}	Query ROC collections which are pending delivery for a specific truck.

Delivery

API for managing Deliveries

API	Description
GET api/v1/Delivery/DEL_GET_PendingROCDeliveriesByTruck?truckRego={truckRego}	Returns a prepared delivery post record for all collections made by the truck
GET api/v1/Delivery/DEL_GET_PendingROCDeliveriesBySite?siteId={siteId}	Returns a list of pending ROC deliveries by Site
GET api/v1/Delivery/DEL_GET_PendingROCDeliveriesByCustomer?CustomerId={CustomerId}	Returns a list of all pending collections made by the customer
GET api/v1/Delivery/DEL_GET_PendingROCDeliveriesBySupplier?SupplierId={SupplierId}	Returns a list of all pending collections made from the supplier
GET api/v1/Delivery/DEL_GET_PendingPurchaseDeliveriesBySite?siteId={siteId}	Returns a list of pending non-ROC deliveries by Site
GET api/v1/Delivery/DEL_GET_PendingPurchaseDeliveriesByTruck?truckRego={truckRego}	Returns a prepared delivery post record for all non-ROC collections made by the truck
GET api/v1/Delivery/DEL_GET_PendingPurchaseDeliveriesBySupplier?SupplierId={SupplierId}	Returns a list of all pending (non-ROC) collections made from the supplier
GET api/v1/Delivery/DEL_GET_PendingPUMPINDeliveriesByTruck?truckRego={truckRego}	Returns a prepared delivery post record for all Direct Pump-in collections made by the truck
POST api/v1/Delivery/DEL_POST_BulkPumpInDeliveriesByTruck	Create a new Bulk Delivery record from Bulk Pump-in collections for Neutral Fuels Truck. Use this method when a Neutral Fuels truck has pumped in uco from multiple collection locations.
POST api/v1/Delivery/DEL_POST_BulkROCDelivery	Post all ROC collections at once using this method.
POST api/v1/Delivery/DEL_POST_PurchaseDelivery	Create a new Purchase delivery record.
POST api/v1/Delivery/DEL_POST_ReceiptDelivery	Create a new Receipt delivery record.
POST api/v1/Delivery/DEL_POST_BulkPumpInDeliveryBySupplier	Create a new Bulk Delivery record for a bulk pump-in delivery by supplier. Use this method when a supplier delivers UCO in bulk (no corresponding collection record).
POST api/v1/Delivery/DEL_CR_POST_ROCDelivery	Post a receipt or purchase delivery from a Collection Request containing ROCs where the supplier / customer arrives with a delivery.
POST api/v1/Delivery/DEL_POST_AdhocDelivery	Post an adhoc receipt or purchase delivery
GET api/v1/Delivery/DEL_CR_GET_ApprovedByCustomer?customerId={customerId}	All Collection requests pending for the customer
GET api/v1/Delivery/DEL_CR_GET_ApprovedBySupplier?supplierId={supplierId}	All Collection requests pending for the supplier

Collection

API for managing Collections

API	Description
GET api/v1/Collection/COL_CR_GET_DespatchedToNFTruck?truckRego={truckRego}	Returns collection requests already despatched to NF Truck.
GET api/v1/Collection/COL_GET_EmptyROCsAtStore?storeid={storeid}	Get a list of empty ROCs at a store.
GET api/v1/Collection/COL_GET_EmptyROCsAtSupplier?supplierid={supplierid}&locationid={locationid}	Get a list of empty ROCs at a supplier.
POST api/v1/Collection/COL_POST_NewPurchasesCollection	Record a new non-ROC collection.
POST api/v1/Collection/COL_POST_NewReceiptsCollection	New ROC Collection Record when collecting from Store or Customer
GET api/v1/Collection/COL_GET_LastCollectionFromStore?storeid={storeid}	Query ROC collection information for the most recent collection from a store.
GET api/v1/Collection/COL_GET_LastCollectionFromSupplier?supplierid={supplierid}&locationid={locationid}	Query ROC collection information for the most recent collection from a supplier.
GET api/v1/Collection/COL_GET_EntityCollections?entityid={entityid}&locationid={locationid}&fromdate={fromdate}&todate={todate}	Query collection information for the enity and location over a specific time period.

Users

API for user management.

API	Description
GET api/v1/Users/UserInfo	Query information for the current user.
POST api/v1/Users/Logout	Log out / end the session for the current user.
POST api/v1/Users/UpdateUserInfo	Update User details

Suppliers

API for querying Neutral Fuels supplier information.

API	Description
GET api/v1/Suppliers/AllSuppliers?countryid={countryid}	Query supplier information for all suppliers.
GET api/v1/Suppliers/SuppliersBySite?siteid={siteid}	Query supplier information for all suppliers of a Neutral Fuels site.
GET api/v1/Suppliers/Supplier?supplierid={supplierid}	Query supplier information for a specific supplier.
GET api/v1/Suppliers/SupplierCollectionLocations?supplierid={supplierid}	Query supplier collection location information
GET api/v1/Suppliers/VerificationMethods?supplierid={supplierid}	Verification Methods available to this Supplier
GET api/v1/Suppliers/VerificationRequest?supplierid={supplierid}&verifytypecode={verifytypecode}&mobileappcode={mobileappcode}&identifier={identifier}	Obtain a Verification Code. A Supplier may have multiple forms of verification assigned. By supplying the verification type and mobile app code, the system knows which method of verification to use.

Store

API for querying Neutral Fuels customer stores.

API	Description
GET api/v1/Store/Stores?SiteId={SiteId}	Query store information for a specific site
POST api/v1/Store/New	Create a new Store record.
POST api/v1/Store/Update	Update an existing store record.
GET api/v1/Store/VerificationMethods?storeid={storeid}	Verification Methods available to this Store (via Customer Record)
GET api/v1/Store/VerificationRequest?storeid={storeid}&verifytypecode={verifytypecode}&mobileappcode={mobileappcode}&identifier={identifier}	Obtain a Verification Code. A Customer may have multiple forms of verification assigned. By supplying the verification type and mobile app code, the system knows which method of verification to use.

Despatch

API for managing empty ROCs from Neutral Fuels despatch.

API	Description
GET api/v1/Despatch/AllDespatchedEmpties?dtFrom={dtFrom}&dtTo={dtTo}	Query despatched containers by logged in user for a specific date range.
GET api/v1/Despatch/DespatchedEmpty?despatchid={despatchid}	Query empty ROCs supplied during a depatch operation.
POST api/v1/Despatch/newDepatchedEmpty	Record a new despatch record for empty ROCs supplied from despatch.
POST api/v1/Despatch/DES_CR_POST_Despatch	Despatch empty ROCs to Neutral Fuels, Customer or Supplier Trucks.
POST api/v1/Despatch/DES_POST_AdhocDespatch	Despatch empty ROCs to customer or supplier truck
GET api/v1/Despatch/DES_CR_GET_ApprovedBySite?siteId={siteId}	All Collection requests for the site which have been approved, but not yet despatched.
GET api/v1/Despatch/DES_CR_GET_ApprovedByCustomer?customerId={customerId}	All Collection requests for the customer which have been approved, but not yet despatched.
GET api/v1/Despatch/DES_CR_GET_ApprovedBySupplier?supplierId={supplierId}	All Collection requests for the supplier which have been approved, but not yet despatched.
GET api/v1/Despatch/DES_CR_GET_ApprovedByNFTruck?truckRego={truckRego}	Collection Requests Approved and Scheduled for specific NF Truck. Use during despatching
GET api/v1/Despatch/DES_CR_GET_DespatchedToCustomer?CustomerId={CustomerId}&StartDate={StartDate}&EndDate={EndDate}	Obtain a list of despatch records for a customer and time period

Countries

API for querying country information.

API	Description
GET api/v1/Countries/AllCountries	Query country information for all countries.
GET api/v1/Countries/Country?countryid={countryid}	Query country information for a specific country.

CollectionRequest

API for managing Collection Requests

API	Description
GET api/v1/CollectionRequest/COL_CR_GET_MerchantCollectionRequests	Returns current collection requests in REQUESTED, DESPATCHED and PENDING state
POST api/v1/CollectionRequest/COL_CR_POST_NewCollectionRequest	Request a new Collection Request.
POST api/v1/CollectionRequest/COL_CR_Post_CollectionRequestDelete?CollectionRequestId={CollectionRequestId}	Delete a new Collection Request (if in 'Requested' state).
POST api/v1/CollectionRequest/COL_CR_POST_CollectionRequestUpdate	Update an existing Collection Request (if in REQUESTED state).
POST api/v1/CollectionRequest/COL_CR_POST_RequestRecurringCR	Request a recurring Collection Request

NFStaff

API for querying Neutral Fuels staff information.

API	Description
GET api/v1/NFStaff/AllStaff	Query staff information for all Neutral Fuels staff.
GET api/v1/NFStaff/StaffBySite?siteId={siteId}	Query Neutral Fuels staff information for a specific Neutral Fuels site.
GET api/v1/NFStaff/Staff?staffid={staffid}	Query staff information for a specific Neutral Fuels staff member.

Customer

API for querying Neutral Fuels customers.

API	Description
GET api/v1/Customer/AllCustomers	Query customer information for all Neutral Fuels customers.
GET api/v1/Customer/Customer?customerid={customerid}	Query customer information for a specific Neutral Fuels customer.
GET api/v1/Customer/Stores?customerid={customerid}	Query McDonald's store information associated with a specific customer.
GET api/v1/Customer/Trucks?customerid={customerid}	Query customer truck information for a specific customer.
GET api/v1/Customer/ThirdPartyTrucks?customerid={customerid}	Query customer truck information for a specific customer.
GET api/v1/Customer/VerificationMethods?customerid={customerid}	Verification Methods available to this Customer
GET api/v1/Customer/VerificationRequest?customerid={customerid}&verifytypecode={verifytypecode}&mobileappcode={mobileappcode}&identifier={identifier}	Obtain a Verification Code. A Customer may have multiple forms of verification assigned. By supplying the verification type and mobile app code, the system knows which method of verification to use.

OtherDelivery

API for managing non-ROC deliveries.

API	Description
GET api/v1/OtherDelivery/AllDeliveries?dtFrom={dtFrom}&dtTo={dtTo}	Query delivery information for a non-ROC delivery for the current user and date range.
GET api/v1/OtherDelivery/Delivery?deliveryid={deliveryid}	Query non-ROC delivery information for a specific delivery.
POST api/v1/OtherDelivery/newDelivery	Create a new Delivery record.
POST api/v1/OtherDelivery/newBulkPumpInDelivery	Create a new Bulk Delivery record from Bulk Pump-in collections for this truck. Use this method when a large container truck has pumped in uco from multiple collection locations.

NFTrucks

API for querying Neutral Fuel truck information.

API	Description
GET api/v1/NFTrucks/TrucksBySite?siteid={siteid}	Query Neutral Fuels truck information for a specific Neutral Fuels site.

OtherCollection

API for managing non-ROC collections from suppliers.

API	Description
GET api/v1/OtherCollection/AllCollections?dtFrom={dtFrom}&dtTo={dtTo}	Query non-ROC collection information for the current user and date range.
POST api/v1/OtherCollection/AllPendingCollections?dtFrom={dtFrom}&dtTo={dtTo}	Query Pending iCollect Collections for the current user and date range.
GET api/v1/OtherCollection/Collection?collectionid={collectionid}	Query non-ROC collection information for a specific collection.
GET api/v1/OtherCollection/CollectionsPendingByTruckRego?truckrego={truckrego}	Query non-ROC delivery information for all pending deliveries by specific truck.
POST api/v1/OtherCollection/newCollection	Record a new non-ROC collection.

TestResult

API for managing Test Results

API	Description
GET api/v1/TestResult/TEST_GET_TestResult?vialnumber={vialnumber}&siteid={siteid}	Returns all test results for tests conducted on sample, given the vial number
POST api/v1/TestResult/TEST_POST_NewTestResult	Create a new Test Result.
POST api/v1/TestResult/TEST_POST_DeleteTestResultDetail?TestResultDetailId={TestResultDetailId}	Remove a test result
GET api/v1/TestResult/TEST_GET_TestResultsForEntity?dtFrom={dtFrom}&dtTo={dtTo}	Returns latest test results for the customer (or supplier) associated with the driver

Sites

API for querying Neutral Fuels site information.

API	Description
GET api/v1/Sites/AllSites	Query Neutral Fuels site information for all sites.
GET api/v1/Sites/Site?siteid={siteid}	Query Neutral Fuels site information for a specific site.
GET api/v1/Sites/VerificationMethods?siteid={siteid}	Verification Methods available to this Site

DeliveryStatus

API for querying delivery status.

API	Description
GET api/v1/DeliveryStatus/AllDeliveryStatus	Query delivery status indicators.

CustomerTruck

API for querying Neutral Fuels customers.

API	Description
GET api/v1/CustomerTruck/Trucks?customerid={customerid}	Query customer truck information for a specific customer.
POST api/v1/CustomerTruck/New	Create a new Customer Truck record.
POST api/v1/CustomerTruck/Update	Update an existing Customer Truck record.

ContainerType

API for querying container types.

API	Description
GET api/v1/ContainerType/AllContainerTypes	Query container type information.

System

API for querying Neutral Fuels system.

API	Description
GET api/v1/System/MobileApps	Mobile Apps and Production Versions
POST api/v1/System/GenerateARBFiles?AppCode={AppCode}	Generate ARB files from Language Dictionaries

Error

API for Reporting Errors.

API	Description
POST api/v1/Error/LogNonCriticalError?errorMessage={errorMessage}&sendEmail={sendEmail}	Log a non-critical error to the database and send optional email
POST api/v1/Error/LogCriticalError?errorMessage={errorMessage}&exceptionErrorMessage={exceptionErrorMessage}	Log a Critical error to the database and send optional email

McdStaff

API for querying McDonald's staff information.

API	Description
GET api/v1/McdStaff/StaffMemberByEmployeeId?employeeid={employeeid}	Query McDonald's staff member based on Employee Id
GET api/v1/McdStaff/StaffByStore?storeId={storeId}	Query McDonald's staff information at a specific store.
GET api/v1/McdStaff/StaffByCountry?countryid={countryid}	Query McDonald's staff information for a specific country.

ROCDelivery

API for managing ROC deliveries.

API	Description
GET api/v1/ROCDelivery/AllDeliveries?dtFrom={dtFrom}&dtTo={dtTo}	Query ROC deliveries by logged in user for a specific date range.
GET api/v1/ROCDelivery/Delivery?deliveryid={deliveryid}	Query ROC delivery information for a specific delivery.
POST api/v1/ROCDelivery/newDelivery	Create a new Delivery record.