My Alerts Web Services
Web services for communicating with the My Alerts database.
Before you can use the My Alerts Web Services you must make sure that you have Configured My Alerts in Studio.
There are two types of My Alerts users:
Clients – these are a person or company allowed to use the My Alerts web service.
Users – these are people who have signed up to My Alerts.
Here we cover the Clients scenario with the assumption that the client has obtained their Login credentials, a UserName, Password and UniqueKey, from Astun Technology Ltd.
You may also wish to view the topic Setting up your Email Template.
Overview
The My Alerts Users Web Service [Users.asmx] is used to communicate with the My Alerts database. There are two ways to validate a user’s credentials:
from the Council Portal
from iShareMaps Portal
Provided that the user has already logged on to one of the above then you can use one of the following My Alerts Web Services:
My Alerts UserManager Web Service [UserManager.asmx] can be used for managing My Alerts users or this can be done via Studio using the My Alerts Administrator Module.
My Alerts Transaction Web Service [Transaction.asmx] is used to retrieve alerts for a user.
API Reference
- My Alerts Users Web Service
- My Alerts UserManager Web Service
- Add a Location for a User
- Delete a User Location
- Delete User from My Alerts database
- Un-subscribe a User from a Layer Group
- Return User Interval
- Return Layer Groups subscribed to by a User
- Return the Locations set for a User
- Get User Session Key
- Return a User's default Location
- Get User's Panels
- Send Forgotten Password email
- Send Welcome email to newly Registered User
- Define Location information for a User
- Update a User's details
- Update a User's interval for checking for alerts
- Subscribe a User to a Layer Group
- Change a User's Password
- Update a User's default Location
- Update the panels for a User
- Reset Password for a User
- Check the existence of a User Location
- Add a User to MyAlerts database
- My Alerts Transaction Web Service