POST api/POI/Retrievepoi
Retrieves the Point of Interest for population in drop down list.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| poiRequest |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"CreatedDateFrom": "2025-11-02T09:15:43.7094238+01:00",
"CreatedDateTo": "2025-11-02T09:15:43.7094238+01:00",
"POIStatus": 1,
"SortOrder": 2,
"Type": 3,
"POIFilter": 4,
"POIIds": [
1,
2,
3
],
"Token": "sample string 5",
"FreeText": "sample string 6",
"GroupIds": [
1,
2,
3
],
"FromIndex": 7,
"ToIndex": 8,
"IsWebCalling": true,
"RequestMode": "sample string 10",
"Client": "sample string 11",
"AppVersion": "sample string 12",
"AppOperatingSystem": "sample string 13",
"AppName": "sample string 14",
"MasterUserID": 15,
"IsRecurringRequest": true
}
text/html
Sample:
{"CreatedDateFrom":"2025-11-02T09:15:43.7094238+01:00","CreatedDateTo":"2025-11-02T09:15:43.7094238+01:00","POIStatus":1,"SortOrder":2,"Type":3,"POIFilter":4,"POIIds":[1,2,3],"Token":"sample string 5","FreeText":"sample string 6","GroupIds":[1,2,3],"FromIndex":7,"ToIndex":8,"IsWebCalling":true,"RequestMode":"sample string 10","Client":"sample string 11","AppVersion":"sample string 12","AppOperatingSystem":"sample string 13","AppName":"sample string 14","MasterUserID":15,"IsRecurringRequest":true}
application/xml, text/xml
Sample:
<APIPointOfInterestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<AppName>sample string 14</AppName>
<AppOperatingSystem>sample string 13</AppOperatingSystem>
<AppVersion>sample string 12</AppVersion>
<Client>sample string 11</Client>
<FreeText>sample string 6</FreeText>
<FromIndex>7</FromIndex>
<GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
<d2p1:int>3</d2p1:int>
</GroupIds>
<IsRecurringRequest>true</IsRecurringRequest>
<IsWebCalling>true</IsWebCalling>
<MasterUserID>15</MasterUserID>
<RequestMode>sample string 10</RequestMode>
<ToIndex>8</ToIndex>
<Token>sample string 5</Token>
<CreatedDateFrom>2025-11-02T09:15:43.7094238+01:00</CreatedDateFrom>
<CreatedDateTo>2025-11-02T09:15:43.7094238+01:00</CreatedDateTo>
<POIFilter>4</POIFilter>
<POIIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
<d2p1:int>3</d2p1:int>
</POIIds>
<POIStatus>1</POIStatus>
<SortOrder>2</SortOrder>
<Type>3</Type>
</APIPointOfInterestRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{
"APIDdlBindDataWithGroupsModel": [
{
"ID": 1,
"Name": "sample string 2",
"GroupIdCsv": "sample string 3",
"VehicleID": "sample string 4",
"SecurableId": "6e12937c-8b8d-4d8b-a509-6cf4ab57b357",
"DeviceVendor": "sample string 5"
},
{
"ID": 1,
"Name": "sample string 2",
"GroupIdCsv": "sample string 3",
"VehicleID": "sample string 4",
"SecurableId": "6e12937c-8b8d-4d8b-a509-6cf4ab57b357",
"DeviceVendor": "sample string 5"
},
{
"ID": 1,
"Name": "sample string 2",
"GroupIdCsv": "sample string 3",
"VehicleID": "sample string 4",
"SecurableId": "6e12937c-8b8d-4d8b-a509-6cf4ab57b357",
"DeviceVendor": "sample string 5"
}
],
"Success": true,
"ErrorMessage": "sample string 2",
"MenuAccessData": {
"HasAccessToMap": true,
"HasAccessToVehicle": true,
"HasAccessToVehicleAdministration": true,
"HasAccessToDriver": true,
"HasAccessToPOI": true,
"HasAccessToReports": true,
"HasAccessToSettings": true,
"HasAccessToTrips": true,
"HasAccessToTranslations": true,
"HasAccessToDashboard": true,
"HasAccessToLogBook": true,
"HasAccessToGroup": true,
"HasAccessToTemplate": true,
"HasAccessToUnit": true,
"HasAccessToUser": true,
"HasAccessToTicket": true,
"HasAccessToContract": true,
"HasAccessToSIM": true,
"HasAccessToCommand": true,
"HasAccessToUnitProfile": true,
"HasAccessToProfileTrigger": true,
"HasAccessToScript": true,
"HasAccessToTriggerSchedule": true,
"HasAccessToMetaBaseReport": true,
"HasAccessToMetaBaseUserDashboard": true,
"HasAccessToRecoveryMode": true
},
"StatusCode": 3,
"ComponentFilterIds": [
1,
2,
3
]
}
text/html
Sample:
{"APIDdlBindDataWithGroupsModel":[{"ID":1,"Name":"sample string 2","GroupIdCsv":"sample string 3","VehicleID":"sample string 4","SecurableId":"6e12937c-8b8d-4d8b-a509-6cf4ab57b357","DeviceVendor":"sample string 5"},{"ID":1,"Name":"sample string 2","GroupIdCsv":"sample string 3","VehicleID":"sample string 4","SecurableId":"6e12937c-8b8d-4d8b-a509-6cf4ab57b357","DeviceVendor":"sample string 5"},{"ID":1,"Name":"sample string 2","GroupIdCsv":"sample string 3","VehicleID":"sample string 4","SecurableId":"6e12937c-8b8d-4d8b-a509-6cf4ab57b357","DeviceVendor":"sample string 5"}],"Success":true,"ErrorMessage":"sample string 2","MenuAccessData":{"HasAccessToMap":true,"HasAccessToVehicle":true,"HasAccessToVehicleAdministration":true,"HasAccessToDriver":true,"HasAccessToPOI":true,"HasAccessToReports":true,"HasAccessToSettings":true,"HasAccessToTrips":true,"HasAccessToTranslations":true,"HasAccessToDashboard":true,"HasAccessToLogBook":true,"HasAccessToGroup":true,"HasAccessToTemplate":true,"HasAccessToUnit":true,"HasAccessToUser":true,"HasAccessToTicket":true,"HasAccessToContract":true,"HasAccessToSIM":true,"HasAccessToCommand":true,"HasAccessToUnitProfile":true,"HasAccessToProfileTrigger":true,"HasAccessToScript":true,"HasAccessToTriggerSchedule":true,"HasAccessToMetaBaseReport":true,"HasAccessToMetaBaseUserDashboard":true,"HasAccessToRecoveryMode":true},"StatusCode":3,"ComponentFilterIds":[1,2,3]}
application/xml, text/xml
Sample:
<APIDdlBindWithGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
<ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.Transport">Success</ResponseCode>
<ComponentFilterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
<d2p1:int>3</d2p1:int>
</ComponentFilterIds>
<ErrorMessage>sample string 2</ErrorMessage>
<MenuAccessData>
<HasAccessToCommand>true</HasAccessToCommand>
<HasAccessToContract>true</HasAccessToContract>
<HasAccessToDashboard>true</HasAccessToDashboard>
<HasAccessToDriver>true</HasAccessToDriver>
<HasAccessToGroup>true</HasAccessToGroup>
<HasAccessToLogBook>true</HasAccessToLogBook>
<HasAccessToMap>true</HasAccessToMap>
<HasAccessToMetaBaseReport>true</HasAccessToMetaBaseReport>
<HasAccessToMetaBaseUserDashboard>true</HasAccessToMetaBaseUserDashboard>
<HasAccessToPOI>true</HasAccessToPOI>
<HasAccessToProfileTrigger>true</HasAccessToProfileTrigger>
<HasAccessToRecoveryMode>true</HasAccessToRecoveryMode>
<HasAccessToReports>true</HasAccessToReports>
<HasAccessToSIM>true</HasAccessToSIM>
<HasAccessToScript>true</HasAccessToScript>
<HasAccessToSettings>true</HasAccessToSettings>
<HasAccessToTemplate>true</HasAccessToTemplate>
<HasAccessToTicket>true</HasAccessToTicket>
<HasAccessToTranslations>true</HasAccessToTranslations>
<HasAccessToTriggerSchedule>true</HasAccessToTriggerSchedule>
<HasAccessToTrips>true</HasAccessToTrips>
<HasAccessToUnit>true</HasAccessToUnit>
<HasAccessToUnitProfile>true</HasAccessToUnitProfile>
<HasAccessToUser>true</HasAccessToUser>
<HasAccessToVehicle>true</HasAccessToVehicle>
<HasAccessToVehicleAdministration>true</HasAccessToVehicleAdministration>
</MenuAccessData>
<StatusCode>3</StatusCode>
<Success>true</Success>
<APIDdlBindDataWithGroupsModel>
<APIDdlBindDataWithGroups>
<DeviceVendor>sample string 5</DeviceVendor>
<GroupIdCsv>sample string 3</GroupIdCsv>
<ID>1</ID>
<Name>sample string 2</Name>
<SecurableId>6e12937c-8b8d-4d8b-a509-6cf4ab57b357</SecurableId>
<VehicleID>sample string 4</VehicleID>
</APIDdlBindDataWithGroups>
<APIDdlBindDataWithGroups>
<DeviceVendor>sample string 5</DeviceVendor>
<GroupIdCsv>sample string 3</GroupIdCsv>
<ID>1</ID>
<Name>sample string 2</Name>
<SecurableId>6e12937c-8b8d-4d8b-a509-6cf4ab57b357</SecurableId>
<VehicleID>sample string 4</VehicleID>
</APIDdlBindDataWithGroups>
<APIDdlBindDataWithGroups>
<DeviceVendor>sample string 5</DeviceVendor>
<GroupIdCsv>sample string 3</GroupIdCsv>
<ID>1</ID>
<Name>sample string 2</Name>
<SecurableId>6e12937c-8b8d-4d8b-a509-6cf4ab57b357</SecurableId>
<VehicleID>sample string 4</VehicleID>
</APIDdlBindDataWithGroups>
</APIDdlBindDataWithGroupsModel>
</APIDdlBindWithGroupsResponse>