AlertSense Map Service

<back to all web services

RecipientRequest

The following routes are available for this service:
POST/api/data/Geometry
POST/api/recipients
RecipientRequest Parameters:
NameParameterData TypeRequiredDescription
CountsOnlybodyboolNo
GeoJsonbodyGeoJsonNo
GeoJson Parameters:
NameParameterData TypeRequiredDescription
TypebodystringNo
ShapesbodyList<Shape>No
Shape Parameters:
NameParameterData TypeRequiredDescription
TypebodystringNo
GeometrybodyHickoryGeometryNo
PropertiesbodyObjectNo
HickoryGeometry Parameters:
NameParameterData TypeRequiredDescription
TypebodystringNo
CoordinatesbodyList<List>No
RecipientResponse Parameters:
NameParameterData TypeRequiredDescription
SourceRecordsbodyList<SourceRecord>No
SourceRecord Parameters:
NameParameterData TypeRequiredDescription
SourceIdbodyintNo
LabelbodystringNo
CountbodyintNo
StatusbodystringNo
RecipientsbodyList<Recipient>No
Recipient Parameters:
NameParameterData TypeRequiredDescription
NumberbodystringNo
LatLngbodyLatLngDetailsNo
LatLngDetails Parameters:
NameParameterData TypeRequiredDescription
LatbodydoubleNo
LngbodydoubleNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/RecipientRequest HTTP/1.1 
Host: elm.alertsense.com 
Content-Type: application/json
Content-Length: length

{"countsOnly":false,"geoJSON":{"type":"String","features":[{"type":"String","geometry":{"type":"String","coordinates":[[[0]]]},"properties":{}}]}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"SourceRecords":[{"SourceId":0,"Label":"String","Count":0,"Status":"String","Recipients":[{"Number":"String","LatLng":{"Lat":0,"Lng":0}}]}]}