Create/Update/Delete Postcode/Location SOAP API
- Matthew Wren (Unlicensed)
The sp:UpdateLocationRequest API method can be used to create, update and delete postcodes/locations.
Description
Postcodes (or locations, depending on the use case) may be added into the system and mapped onto the regions structure. Locations created through this interface are referred to elsewhere as ‘named places’.
Additionally, existing postcode/locations may be updated with new latitude/longitude information (the old entry is removed and the new entry replaces it). Entries may also be deleted via this interface.
Definition
The definition of this API is:
Web Service | Type | Description | Req? | Val? | |
|
|
| |||
|
|
| The textual postcode/zipcode or location code for the place |
|
|
|
|
| Latitude (see 2.5) of the named postcode/location |
| |
|
|
| Longitude (see 2.5) of the named postcode/location |
| |
|
|
| Optional Bit field indicating whether this is an addition, update (replacement) or deletion:
Not supplying the parameter is the same as supplying it with a value of 0. |
| |
|
|
| This is an optional parameter. Set true (1) if the named place to be created should be visible in the ServicePlanner map. Set false (0) if the named place to be created should not be visible in the ServicePlanner map. Not supplying the parameter is the same as supplying a value of false(0). |
| |
|
|
| |||
Return Structure
The API returns the standard return structure.
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are:
SP_OK (0)SP_UDLOC_INVALID_ACTION (690)SP_UDLOC_INVALID_NAME (691)SP_UDLOC_FAILED_REGION_MAPPING (692)SP_UDLOC_NAME_ALREADY_EXISTS (693)