POST api/poialerts/createedit
Create of edit POI Alerts
Request Information
URI Parameters
None.
Body Parameters
The CreateEditPOIRequestModel made
CreateEditPOIAlertRequestModelName | Description | Type | Additional information |
---|---|---|---|
Token |
The token returned after login used for authentication |
string |
None. |
UserID |
The user id returned after login used for authentication |
unsigned integer |
None. |
POIAlertList |
The list of POI alerts being set up |
Collection of POIAlert |
None. |
Request Formats
application/json, text/json
Sample:
{ "Token": "sample string 1", "UserID": 2, "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:
<CreateEditPOIAlertRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Token>sample string 1</Token> <UserID>2</UserID> <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> </CreateEditPOIAlertRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A CreateEditPOIResponseModel on success
CreateEditPOIAlertResponseModelName | Description | Type | Additional information |
---|---|---|---|
POIAlertDetailList |
A list of the poi alert details |
Collection of POIAlertDetail |
None. |
POIAlertCount |
A count of the poi alert made / edited |
unsigned integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "POIAlertDetailList": [ { "POIAlertTitle": "sample string 1", "POIAlertID": 2 }, { "POIAlertTitle": "sample string 1", "POIAlertID": 2 } ], "POIAlertCount": 1 }
application/xml, text/xml
Sample:
<CreateEditPOIAlertResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <POIAlertDetailList> <POIAlertDetail> <POIAlertTitle>sample string 1</POIAlertTitle> <POIAlertID>2</POIAlertID> </POIAlertDetail> <POIAlertDetail> <POIAlertTitle>sample string 1</POIAlertTitle> <POIAlertID>2</POIAlertID> </POIAlertDetail> </POIAlertDetailList> <POIAlertCount>1</POIAlertCount> </CreateEditPOIAlertResponseModel>