This documentation is for the v4 (stable) version of the API.
Invocation URL: /v4/electronicatl

Description

deliver customers the ability to register for a permanent electronic ATL via the public website. A management portal in MFM will allow for Regional Franchisees to approve and administer new and existing requests. The existing ILOC barcodes will be despatched to customers by the RF to affix somewhere on their property for a courier to scan on delivery

Actions

Action Name Description Invocation URL
AddLocationByAtlId Add a new location to the Electronic ATL /v4/electronicatl/addlocationbyatlid
CancelRenewalATL Cancel an existing ATL /v4/electronicatl/cancelrenewalatl
CreateNewATL Create a new ATL application /v4/electronicatl/createnewatl
CreateNewLocationTemp Create temporary safe location which is used in the sign up page. Note that the ATL is not yet created, therefore the safelocation added by the user needs to be held temporarily /v4/electronicatl/createnewlocationtemp
CreateTempNewSafeLocations Create a new temporary safe location /v4/electronicatl/createtempnewsafelocations
DeleteAllSafeLocationsBySessionId Delete all temporary safe locations /v4/electronicatl/deleteallsafelocationsbysessionid
DeleteBySafeLocationId Delete Safe location /v4/electronicatl/deletebysafelocationid
DeleteBySafeLocationSessionId Delete temporary safe location /v4/electronicatl/deletebysafelocationsessionid
GetATLById Get ATL details /v4/electronicatl/getatlbyid
GetATLSafeLocationsById Get Safe location details /v4/electronicatl/getatlsafelocationsbyid
GetATLSafeLocationsBySessionId Get temporary safe locations /v4/electronicatl/getatlsafelocationsbysessionid
RenewATL Renew an existing ATL /v4/electronicatl/renewatl
ValidateAddressAsNonRural Check if the address entered is rural or not /v4/electronicatl/validateaddressasnonrural

Back to Index