POST api/User/UpdateMultipleUsers

Updates multiple users.

Request Information

Parameters

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

Request body formats

application/json, text/json

Sample:

{
  "UserIds": [
    1,
    2,
    3
  ],
  "GroupIds": [
    1,
    2,
    3
  ],
  "RoleID": 1,
  "DefaultGroupIds": [
    1,
    2,
    3
  ],
  "ComponentId": 1,
  "SubComponentId": 1,
  "EntityId": 1,
  "DefualtLanguageCode": "sample string 2",
  "CountryCodeId": 1,
  "TimeZoneValue": 1,
  "IsAccountLocked": true,
  "Token": "sample string 4",
  "FreeText": "sample string 5",
  "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:

{"UserIds":[1,2,3],"GroupIds":[1,2,3],"RoleID":1,"DefaultGroupIds":[1,2,3],"ComponentId":1,"SubComponentId":1,"EntityId":1,"DefualtLanguageCode":"sample string 2","CountryCodeId":1,"TimeZoneValue":1,"IsAccountLocked":true,"Token":"sample string 4","FreeText":"sample string 5","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:

<APIMultipleUsersUpdateRequest 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" />
  <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>
  <ComponentId>1</ComponentId>
  <CountryCodeId>1</CountryCodeId>
  <DefaultGroupIds 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>
  </DefaultGroupIds>
  <DefualtLanguageCode>sample string 2</DefualtLanguageCode>
  <EntityId>1</EntityId>
  <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>
  <IsAccountLocked>true</IsAccountLocked>
  <RoleID>1</RoleID>
  <SubComponentId>1</SubComponentId>
  <TimeZoneValue>1</TimeZoneValue>
  <UserIds 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>
  </UserIds>
</APIMultipleUsersUpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "UserData": [
    {
      "ID": 1,
      "Username": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "EmploymentNo": "sample string 5",
      "RoleID": 1,
      "RoleName": "sample string 6",
      "Email": "sample string 7",
      "MobileNo": "sample string 8",
      "ApiCallCountLimit": 1,
      "ComponentId": 1,
      "SubComponentId": 1,
      "DefualtLanguageCode": "sample string 9",
      "EntityId": 1,
      "TimeZoneValue": 1,
      "DefaultGroupIds": [
        1,
        2,
        3
      ],
      "CountryCodeId": 1,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      },
      "GroupIds": [
        1,
        2,
        3
      ],
      "IsGDPRAgree": true,
      "IsAccountLocked": true,
      "UserSettingID": 12,
      "DefaultLanguageCode": "sample string 13",
      "DefaultGroupIdsCSV": "sample string 14"
    },
    {
      "ID": 1,
      "Username": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "EmploymentNo": "sample string 5",
      "RoleID": 1,
      "RoleName": "sample string 6",
      "Email": "sample string 7",
      "MobileNo": "sample string 8",
      "ApiCallCountLimit": 1,
      "ComponentId": 1,
      "SubComponentId": 1,
      "DefualtLanguageCode": "sample string 9",
      "EntityId": 1,
      "TimeZoneValue": 1,
      "DefaultGroupIds": [
        1,
        2,
        3
      ],
      "CountryCodeId": 1,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      },
      "GroupIds": [
        1,
        2,
        3
      ],
      "IsGDPRAgree": true,
      "IsAccountLocked": true,
      "UserSettingID": 12,
      "DefaultLanguageCode": "sample string 13",
      "DefaultGroupIdsCSV": "sample string 14"
    },
    {
      "ID": 1,
      "Username": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "EmploymentNo": "sample string 5",
      "RoleID": 1,
      "RoleName": "sample string 6",
      "Email": "sample string 7",
      "MobileNo": "sample string 8",
      "ApiCallCountLimit": 1,
      "ComponentId": 1,
      "SubComponentId": 1,
      "DefualtLanguageCode": "sample string 9",
      "EntityId": 1,
      "TimeZoneValue": 1,
      "DefaultGroupIds": [
        1,
        2,
        3
      ],
      "CountryCodeId": 1,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      },
      "GroupIds": [
        1,
        2,
        3
      ],
      "IsGDPRAgree": true,
      "IsAccountLocked": true,
      "UserSettingID": 12,
      "DefaultLanguageCode": "sample string 13",
      "DefaultGroupIdsCSV": "sample string 14"
    }
  ],
  "UpdateMessages": [
    {
      "ID": 1,
      "Message": "sample string 2",
      "MessageType": 3
    },
    {
      "ID": 1,
      "Message": "sample string 2",
      "MessageType": 3
    },
    {
      "ID": 1,
      "Message": "sample string 2",
      "MessageType": 3
    }
  ],
  "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:

{"UserData":[{"ID":1,"Username":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","EmploymentNo":"sample string 5","RoleID":1,"RoleName":"sample string 6","Email":"sample string 7","MobileNo":"sample string 8","ApiCallCountLimit":1,"ComponentId":1,"SubComponentId":1,"DefualtLanguageCode":"sample string 9","EntityId":1,"TimeZoneValue":1,"DefaultGroupIds":[1,2,3],"CountryCodeId":1,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"GroupIds":[1,2,3],"IsGDPRAgree":true,"IsAccountLocked":true,"UserSettingID":12,"DefaultLanguageCode":"sample string 13","DefaultGroupIdsCSV":"sample string 14"},{"ID":1,"Username":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","EmploymentNo":"sample string 5","RoleID":1,"RoleName":"sample string 6","Email":"sample string 7","MobileNo":"sample string 8","ApiCallCountLimit":1,"ComponentId":1,"SubComponentId":1,"DefualtLanguageCode":"sample string 9","EntityId":1,"TimeZoneValue":1,"DefaultGroupIds":[1,2,3],"CountryCodeId":1,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"GroupIds":[1,2,3],"IsGDPRAgree":true,"IsAccountLocked":true,"UserSettingID":12,"DefaultLanguageCode":"sample string 13","DefaultGroupIdsCSV":"sample string 14"},{"ID":1,"Username":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","EmploymentNo":"sample string 5","RoleID":1,"RoleName":"sample string 6","Email":"sample string 7","MobileNo":"sample string 8","ApiCallCountLimit":1,"ComponentId":1,"SubComponentId":1,"DefualtLanguageCode":"sample string 9","EntityId":1,"TimeZoneValue":1,"DefaultGroupIds":[1,2,3],"CountryCodeId":1,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true},"GroupIds":[1,2,3],"IsGDPRAgree":true,"IsAccountLocked":true,"UserSettingID":12,"DefaultLanguageCode":"sample string 13","DefaultGroupIdsCSV":"sample string 14"}],"UpdateMessages":[{"ID":1,"Message":"sample string 2","MessageType":3},{"ID":1,"Message":"sample string 2","MessageType":3},{"ID":1,"Message":"sample string 2","MessageType":3}],"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:

<APIMultipleUsersUpdateResponse 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>
  <UpdateMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Model">
    <d2p1:UserUpdateMessage>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Message>sample string 2</d2p1:Message>
      <d2p1:MessageType>3</d2p1:MessageType>
    </d2p1:UserUpdateMessage>
    <d2p1:UserUpdateMessage>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Message>sample string 2</d2p1:Message>
      <d2p1:MessageType>3</d2p1:MessageType>
    </d2p1:UserUpdateMessage>
    <d2p1:UserUpdateMessage>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Message>sample string 2</d2p1:Message>
      <d2p1:MessageType>3</d2p1:MessageType>
    </d2p1:UserUpdateMessage>
  </UpdateMessages>
  <UserData>
    <APIUserWithSummaryData>
      <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>
      <ApiCallCountLimit>1</ApiCallCountLimit>
      <ComponentId>1</ComponentId>
      <CountryCodeId>1</CountryCodeId>
      <DefaultGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
        <d4p1:int>3</d4p1:int>
      </DefaultGroupIds>
      <DefaultGroupIdsCSV>sample string 14</DefaultGroupIdsCSV>
      <DefaultLanguageCode>sample string 13</DefaultLanguageCode>
      <DefualtLanguageCode>sample string 9</DefualtLanguageCode>
      <Email>sample string 7</Email>
      <EmploymentNo>sample string 5</EmploymentNo>
      <EntityId>1</EntityId>
      <FirstName>sample string 3</FirstName>
      <GroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
        <d4p1:int>3</d4p1:int>
      </GroupIds>
      <GroupNameCSV>sample string 10</GroupNameCSV>
      <ID>1</ID>
      <IsAccountLocked>true</IsAccountLocked>
      <IsGDPRAgree>true</IsGDPRAgree>
      <LastName>sample string 4</LastName>
      <MobileNo>sample string 8</MobileNo>
      <RoleID>1</RoleID>
      <RoleName>sample string 6</RoleName>
      <SubComponentId>1</SubComponentId>
      <TimeZoneValue>1</TimeZoneValue>
      <UserSettingID>12</UserSettingID>
      <Username>sample string 2</Username>
    </APIUserWithSummaryData>
    <APIUserWithSummaryData>
      <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>
      <ApiCallCountLimit>1</ApiCallCountLimit>
      <ComponentId>1</ComponentId>
      <CountryCodeId>1</CountryCodeId>
      <DefaultGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
        <d4p1:int>3</d4p1:int>
      </DefaultGroupIds>
      <DefaultGroupIdsCSV>sample string 14</DefaultGroupIdsCSV>
      <DefaultLanguageCode>sample string 13</DefaultLanguageCode>
      <DefualtLanguageCode>sample string 9</DefualtLanguageCode>
      <Email>sample string 7</Email>
      <EmploymentNo>sample string 5</EmploymentNo>
      <EntityId>1</EntityId>
      <FirstName>sample string 3</FirstName>
      <GroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
        <d4p1:int>3</d4p1:int>
      </GroupIds>
      <GroupNameCSV>sample string 10</GroupNameCSV>
      <ID>1</ID>
      <IsAccountLocked>true</IsAccountLocked>
      <IsGDPRAgree>true</IsGDPRAgree>
      <LastName>sample string 4</LastName>
      <MobileNo>sample string 8</MobileNo>
      <RoleID>1</RoleID>
      <RoleName>sample string 6</RoleName>
      <SubComponentId>1</SubComponentId>
      <TimeZoneValue>1</TimeZoneValue>
      <UserSettingID>12</UserSettingID>
      <Username>sample string 2</Username>
    </APIUserWithSummaryData>
    <APIUserWithSummaryData>
      <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>
      <ApiCallCountLimit>1</ApiCallCountLimit>
      <ComponentId>1</ComponentId>
      <CountryCodeId>1</CountryCodeId>
      <DefaultGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
        <d4p1:int>3</d4p1:int>
      </DefaultGroupIds>
      <DefaultGroupIdsCSV>sample string 14</DefaultGroupIdsCSV>
      <DefaultLanguageCode>sample string 13</DefaultLanguageCode>
      <DefualtLanguageCode>sample string 9</DefualtLanguageCode>
      <Email>sample string 7</Email>
      <EmploymentNo>sample string 5</EmploymentNo>
      <EntityId>1</EntityId>
      <FirstName>sample string 3</FirstName>
      <GroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
        <d4p1:int>3</d4p1:int>
      </GroupIds>
      <GroupNameCSV>sample string 10</GroupNameCSV>
      <ID>1</ID>
      <IsAccountLocked>true</IsAccountLocked>
      <IsGDPRAgree>true</IsGDPRAgree>
      <LastName>sample string 4</LastName>
      <MobileNo>sample string 8</MobileNo>
      <RoleID>1</RoleID>
      <RoleName>sample string 6</RoleName>
      <SubComponentId>1</SubComponentId>
      <TimeZoneValue>1</TimeZoneValue>
      <UserSettingID>12</UserSettingID>
      <Username>sample string 2</Username>
    </APIUserWithSummaryData>
  </UserData>
</APIMultipleUsersUpdateResponse>