POST apioauth/poialerts/get

Get POI Alert Details

Request Information

URI Parameters

None.

Body Parameters

OAuthGetPOIAlertRequestModel

OAuthGetPOIAlertRequestModel
NameDescriptionTypeAdditional information
POIAlertIDList

A list of poi alert ids being requested

Collection of unsigned integer

None.

Request Formats

application/json, text/json

Sample:
{
  "POIAlertIDList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<OAuthGetPOIAlertRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <POIAlertIDList>
    <unsignedLong>1</unsignedLong>
    <unsignedLong>2</unsignedLong>
  </POIAlertIDList>
</OAuthGetPOIAlertRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A GetPOIAlertResponseModel

GetPOIAlertResponseModel
NameDescriptionTypeAdditional information
POIAlertList

The list of POI alerts requested

Collection of POIAlert

None.

Response Formats

application/json, text/json

Sample:
{
  "POIAlertList": [
    {
      "POIAlertID": 1,
      "Title": "sample string 2",
      "Message": "sample string 3",
      "StartTime": "sample string 4",
      "EndTime": "sample string 5",
      "AlertDays": 1,
      "AlertRecipientEmailAddressList": [
        "sample string 1",
        "sample string 2"
      ],
      "POIEntryAlertIDList": [
        1,
        2
      ],
      "POIEntryGroupID": 6,
      "POIExitAlertIDList": [
        1,
        2
      ],
      "POIExitGroupID": 7,
      "ServiceIDList": [
        1,
        2
      ],
      "ServiceGroupID": 8
    },
    {
      "POIAlertID": 1,
      "Title": "sample string 2",
      "Message": "sample string 3",
      "StartTime": "sample string 4",
      "EndTime": "sample string 5",
      "AlertDays": 1,
      "AlertRecipientEmailAddressList": [
        "sample string 1",
        "sample string 2"
      ],
      "POIEntryAlertIDList": [
        1,
        2
      ],
      "POIEntryGroupID": 6,
      "POIExitAlertIDList": [
        1,
        2
      ],
      "POIExitGroupID": 7,
      "ServiceIDList": [
        1,
        2
      ],
      "ServiceGroupID": 8
    }
  ]
}

application/xml, text/xml

Sample:
<GetPOIAlertResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <POIAlertList>
    <POIAlert>
      <POIAlertID>1</POIAlertID>
      <Title>sample string 2</Title>
      <Message>sample string 3</Message>
      <StartTime>sample string 4</StartTime>
      <EndTime>sample string 5</EndTime>
      <AlertDays>Saturday</AlertDays>
      <AlertRecipientEmailAddressList>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </AlertRecipientEmailAddressList>
      <POIEntryAlertIDList>
        <unsignedLong>1</unsignedLong>
        <unsignedLong>2</unsignedLong>
      </POIEntryAlertIDList>
      <POIEntryGroupID>6</POIEntryGroupID>
      <POIExitAlertIDList>
        <unsignedLong>1</unsignedLong>
        <unsignedLong>2</unsignedLong>
      </POIExitAlertIDList>
      <POIExitGroupID>7</POIExitGroupID>
      <ServiceIDList>
        <unsignedLong>1</unsignedLong>
        <unsignedLong>2</unsignedLong>
      </ServiceIDList>
      <ServiceGroupID>8</ServiceGroupID>
    </POIAlert>
    <POIAlert>
      <POIAlertID>1</POIAlertID>
      <Title>sample string 2</Title>
      <Message>sample string 3</Message>
      <StartTime>sample string 4</StartTime>
      <EndTime>sample string 5</EndTime>
      <AlertDays>Saturday</AlertDays>
      <AlertRecipientEmailAddressList>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </AlertRecipientEmailAddressList>
      <POIEntryAlertIDList>
        <unsignedLong>1</unsignedLong>
        <unsignedLong>2</unsignedLong>
      </POIEntryAlertIDList>
      <POIEntryGroupID>6</POIEntryGroupID>
      <POIExitAlertIDList>
        <unsignedLong>1</unsignedLong>
        <unsignedLong>2</unsignedLong>
      </POIExitAlertIDList>
      <POIExitGroupID>7</POIExitGroupID>
      <ServiceIDList>
        <unsignedLong>1</unsignedLong>
        <unsignedLong>2</unsignedLong>
      </ServiceIDList>
      <ServiceGroupID>8</ServiceGroupID>
    </POIAlert>
  </POIAlertList>
</GetPOIAlertResponseModel>