POST api/SIM/RetrieveSIMsWithSummary

Retrieves SIMs as per user right and filters.

Request Information

Parameters

Name	Description	Additional information
req		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "SIMIDs": [
    1,
    2,
    3
  ],
  "SortOrder": 1,
  "IsSIMDataIncluded": true,
  "IsSummaryDataIncluded": true,
  "Token": "sample string 4",
  "FreeText": "sample string 5",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 6,
  "ToIndex": 7,
  "IsWebCalling": true,
  "RequestMode": "sample string 9",
  "Client": "sample string 10",
  "AppVersion": "sample string 11",
  "AppOperatingSystem": "sample string 12",
  "AppName": "sample string 13",
  "MasterUserID": 14,
  "IsRecurringRequest": true
}

text/html

Sample:

{"SIMIDs":[1,2,3],"SortOrder":1,"IsSIMDataIncluded":true,"IsSummaryDataIncluded":true,"Token":"sample string 4","FreeText":"sample string 5","GroupIds":[1,2,3],"FromIndex":6,"ToIndex":7,"IsWebCalling":true,"RequestMode":"sample string 9","Client":"sample string 10","AppVersion":"sample string 11","AppOperatingSystem":"sample string 12","AppName":"sample string 13","MasterUserID":14,"IsRecurringRequest":true}

application/xml, text/xml

Sample:

<APISIMWithSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.APIModels">
  <AppName xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 13</AppName>
  <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 12</AppOperatingSystem>
  <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 11</AppVersion>
  <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 10</Client>
  <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 5</FreeText>
  <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">6</FromIndex>
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </GroupIds>
  <IsRecurringRequest xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsRecurringRequest>
  <IsWebCalling xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsWebCalling>
  <MasterUserID xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">14</MasterUserID>
  <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 9</RequestMode>
  <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">7</ToIndex>
  <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 4</Token>
  <IsSIMDataIncluded>true</IsSIMDataIncluded>
  <IsSummaryDataIncluded>true</IsSummaryDataIncluded>
  <SIMIDs 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>
  </SIMIDs>
  <SortOrder>1</SortOrder>
</APISIMWithSummaryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "SIMData": [
    {
      "ID": 1,
      "ICCNo": "sample string 2",
      "MobileNo": "sample string 3",
      "IMSINo": "sample string 4",
      "IsActive": true,
      "CreatedDate": "2024-10-16T23:01:41.8902602+02:00",
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      },
      "Groups": [
        {
          "ID": 1,
          "Name": "sample string 2"
        },
        {
          "ID": 1,
          "Name": "sample string 2"
        },
        {
          "ID": 1,
          "Name": "sample string 2"
        }
      ]
    },
    {
      "ID": 1,
      "ICCNo": "sample string 2",
      "MobileNo": "sample string 3",
      "IMSINo": "sample string 4",
      "IsActive": true,
      "CreatedDate": "2024-10-16T23:01:41.8902602+02:00",
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      },
      "Groups": [
        {
          "ID": 1,
          "Name": "sample string 2"
        },
        {
          "ID": 1,
          "Name": "sample string 2"
        },
        {
          "ID": 1,
          "Name": "sample string 2"
        }
      ]
    },
    {
      "ID": 1,
      "ICCNo": "sample string 2",
      "MobileNo": "sample string 3",
      "IMSINo": "sample string 4",
      "IsActive": true,
      "CreatedDate": "2024-10-16T23:01:41.8902602+02:00",
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      },
      "Groups": [
        {
          "ID": 1,
          "Name": "sample string 2"
        },
        {
          "ID": 1,
          "Name": "sample string 2"
        },
        {
          "ID": 1,
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "SummaryData": {
    "TotalSIMs": 1
  },
  "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
  },
  "StatusCode": 3,
  "ComponentFilterIds": [
    1,
    2,
    3
  ]
}

text/html

Sample:

{"SIMData":[{"ID":1,"ICCNo":"sample string 2","MobileNo":"sample string 3","IMSINo":"sample string 4","IsActive":true,"CreatedDate":"2024-10-16T23:01:41.8902602+02:00","AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"Groups":[{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"}]},{"ID":1,"ICCNo":"sample string 2","MobileNo":"sample string 3","IMSINo":"sample string 4","IsActive":true,"CreatedDate":"2024-10-16T23:01:41.8902602+02:00","AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"Groups":[{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"}]},{"ID":1,"ICCNo":"sample string 2","MobileNo":"sample string 3","IMSINo":"sample string 4","IsActive":true,"CreatedDate":"2024-10-16T23:01:41.8902602+02:00","AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"Groups":[{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"}]}],"SummaryData":{"TotalSIMs":1},"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},"StatusCode":3,"ComponentFilterIds":[1,2,3]}

application/xml, text/xml

Sample:

<APISIMWithSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.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" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ComponentFilterIds>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 2</ErrorMessage>
  <MenuAccessData xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <HasAccessToCommand>true</HasAccessToCommand>
    <HasAccessToContract>true</HasAccessToContract>
    <HasAccessToDashboard>true</HasAccessToDashboard>
    <HasAccessToDriver>true</HasAccessToDriver>
    <HasAccessToGroup>true</HasAccessToGroup>
    <HasAccessToLogBook>true</HasAccessToLogBook>
    <HasAccessToMap>true</HasAccessToMap>
    <HasAccessToPOI>true</HasAccessToPOI>
    <HasAccessToProfileTrigger>true</HasAccessToProfileTrigger>
    <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 xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">3</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</Success>
  <SIMData>
    <APISIMWithSummaryData>
      <AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
        <d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
        <d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
        <d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
      </AccessRights>
      <CreatedDate>2024-10-16T23:01:41.8902602+02:00</CreatedDate>
      <Groups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
      </Groups>
      <ICCNo>sample string 2</ICCNo>
      <ID>1</ID>
      <IMSINo>sample string 4</IMSINo>
      <IsActive>true</IsActive>
      <MobileNo>sample string 3</MobileNo>
    </APISIMWithSummaryData>
    <APISIMWithSummaryData>
      <AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
        <d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
        <d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
        <d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
      </AccessRights>
      <CreatedDate>2024-10-16T23:01:41.8902602+02:00</CreatedDate>
      <Groups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
      </Groups>
      <ICCNo>sample string 2</ICCNo>
      <ID>1</ID>
      <IMSINo>sample string 4</IMSINo>
      <IsActive>true</IsActive>
      <MobileNo>sample string 3</MobileNo>
    </APISIMWithSummaryData>
    <APISIMWithSummaryData>
      <AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
        <d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
        <d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
        <d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
      </AccessRights>
      <CreatedDate>2024-10-16T23:01:41.8902602+02:00</CreatedDate>
      <Groups xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
        <d4p1:APIDdlBindData>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:APIDdlBindData>
      </Groups>
      <ICCNo>sample string 2</ICCNo>
      <ID>1</ID>
      <IMSINo>sample string 4</IMSINo>
      <IsActive>true</IsActive>
      <MobileNo>sample string 3</MobileNo>
    </APISIMWithSummaryData>
  </SIMData>
  <SummaryData>
    <TotalSIMs>1</TotalSIMs>
  </SummaryData>
</APISIMWithSummaryResponse>