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 .xml suffix or ?format=xml

HTTP + XML

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

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

<RootObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlertSense.Elm.ServiceModel.Mapping_DTOs">
  <countsOnly>false</countsOnly>
  <geoJSON>
    <features>
      <Feature>
        <geometry>
          <coordinates xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:ArrayOfArrayOfdouble>
              <d6p1:ArrayOfdouble>
                <d6p1:double>0</d6p1:double>
              </d6p1:ArrayOfdouble>
            </d6p1:ArrayOfArrayOfdouble>
          </coordinates>
          <type>String</type>
        </geometry>
        <properties />
        <type>String</type>
      </Feature>
    </features>
    <type>String</type>
  </geoJSON>
</RootObject>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecipientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlertSense.Elm.ServiceModel.Mapping_DTOs">
  <SourceRecords>
    <SourceRecord>
      <Count>0</Count>
      <Label>String</Label>
      <Recipients>
        <Recipient>
          <LatLng>
            <Lat>0</Lat>
            <Lng>0</Lng>
          </LatLng>
          <Number>String</Number>
        </Recipient>
      </Recipients>
      <SourceId>0</SourceId>
      <Status>String</Status>
    </SourceRecord>
  </SourceRecords>
</RecipientResponse>