POST api/User/MoveBulkUsers
Moves users in bulk from or out of groups.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| req |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"Data": [
{
"UserID": 1,
"GroupID": 2,
"IsAdded": true
},
{
"UserID": 1,
"GroupID": 2,
"IsAdded": true
},
{
"UserID": 1,
"GroupID": 2,
"IsAdded": true
}
],
"Token": "sample string 1",
"FreeText": "sample string 2",
"GroupIds": [
1,
2,
3
],
"FromIndex": 3,
"ToIndex": 4,
"IsWebCalling": true,
"RequestMode": "sample string 6",
"Client": "sample string 7",
"AppVersion": "sample string 8",
"AppOperatingSystem": "sample string 9",
"AppName": "sample string 10",
"MasterUserID": 11,
"IsRecurringRequest": true
}
text/html
Sample:
{"Data":[{"UserID":1,"GroupID":2,"IsAdded":true},{"UserID":1,"GroupID":2,"IsAdded":true},{"UserID":1,"GroupID":2,"IsAdded":true}],"Token":"sample string 1","FreeText":"sample string 2","GroupIds":[1,2,3],"FromIndex":3,"ToIndex":4,"IsWebCalling":true,"RequestMode":"sample string 6","Client":"sample string 7","AppVersion":"sample string 8","AppOperatingSystem":"sample string 9","AppName":"sample string 10","MasterUserID":11,"IsRecurringRequest":true}
application/xml, text/xml
Sample:
<APIBulkMoveUsersRequest 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 10</AppName>
<AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 9</AppOperatingSystem>
<AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 8</AppVersion>
<Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 7</Client>
<FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 2</FreeText>
<FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">3</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">11</MasterUserID>
<RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 6</RequestMode>
<ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">4</ToIndex>
<Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 1</Token>
<Data>
<APIBulkMoveUserData>
<GroupID>2</GroupID>
<IsAdded>true</IsAdded>
<UserID>1</UserID>
</APIBulkMoveUserData>
<APIBulkMoveUserData>
<GroupID>2</GroupID>
<IsAdded>true</IsAdded>
<UserID>1</UserID>
</APIBulkMoveUserData>
<APIBulkMoveUserData>
<GroupID>2</GroupID>
<IsAdded>true</IsAdded>
<UserID>1</UserID>
</APIBulkMoveUserData>
</Data>
</APIBulkMoveUsersRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{
"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:
{"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:
<APIBaseResponse 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>
</APIBaseResponse>