POST api/Account/AddGroupInAccount

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
req
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "GroupID": 1,
  "DataValidationDayRange": 1,
  "Description": "sample string 2",
  "DestinationURL": "sample string 3",
  "GroupAccessCode": "sample string 4",
  "HeatMapFileName": "sample string 5",
  "IsActiveForMatching": true,
  "Name": "sample string 6",
  "ParentGroupID": 1,
  "SystemUsingCompanyID": 1,
  "Token": "sample string 7",
  "FreeText": "sample string 8",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 9,
  "ToIndex": 10,
  "IsWebCalling": true,
  "RequestMode": "sample string 12",
  "Client": "sample string 13",
  "AppVersion": "sample string 14",
  "AppOperatingSystem": "sample string 15",
  "AppName": "sample string 16",
  "MasterUserID": 17,
  "IsRecurringRequest": true
}

text/html

Sample:
{"GroupID":1,"DataValidationDayRange":1,"Description":"sample string 2","DestinationURL":"sample string 3","GroupAccessCode":"sample string 4","HeatMapFileName":"sample string 5","IsActiveForMatching":true,"Name":"sample string 6","ParentGroupID":1,"SystemUsingCompanyID":1,"Token":"sample string 7","FreeText":"sample string 8","GroupIds":[1,2,3],"FromIndex":9,"ToIndex":10,"IsWebCalling":true,"RequestMode":"sample string 12","Client":"sample string 13","AppVersion":"sample string 14","AppOperatingSystem":"sample string 15","AppName":"sample string 16","MasterUserID":17,"IsRecurringRequest":true}

application/xml, text/xml

Sample:
<APIAddAccountRequest 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 16</AppName>
  <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 15</AppOperatingSystem>
  <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 14</AppVersion>
  <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 13</Client>
  <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 8</FreeText>
  <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">9</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">17</MasterUserID>
  <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 12</RequestMode>
  <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">10</ToIndex>
  <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 7</Token>
  <DataValidationDayRange>1</DataValidationDayRange>
  <Description>sample string 2</Description>
  <DestinationURL>sample string 3</DestinationURL>
  <GroupAccessCode>sample string 4</GroupAccessCode>
  <GroupID>1</GroupID>
  <HeatMapFileName>sample string 5</HeatMapFileName>
  <IsActiveForMatching>true</IsActiveForMatching>
  <Name>sample string 6</Name>
  <ParentGroupID>1</ParentGroupID>
  <SystemUsingCompanyID>1</SystemUsingCompanyID>
</APIAddAccountRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "NewAccount": {
    "GroupID": 1,
    "AccountID": 2,
    "ParentGroupID": 3,
    "Name": "sample string 4",
    "AccountNo": "sample string 5",
    "Description": "sample string 6",
    "DataValidationDayRange": 7,
    "TemplateID": 1,
    "CountryID": 1,
    "TemplatesCSV": "sample string 8",
    "LanguageCodeID": "sample string 9",
    "TimeZoneValue": 1,
    "StartPageComponentID": 1,
    "Comments": "sample string 10",
    "DestinationURL": "sample string 11",
    "IsActiveForMatching": true,
    "AccessRights": {
      "HasRetrieveAccess": true,
      "HasUpdateAccess": true,
      "HasDeleteAccess": true,
      "HasCreateAccess": true
    }
  },
  "ErrorCode": 1,
  "Success": true,
  "ErrorMessage": "sample string 3",
  "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": 4,
  "ComponentFilterIds": [
    1,
    2,
    3
  ]
}

text/html

Sample:
{"NewAccount":{"GroupID":1,"AccountID":2,"ParentGroupID":3,"Name":"sample string 4","AccountNo":"sample string 5","Description":"sample string 6","DataValidationDayRange":7,"TemplateID":1,"CountryID":1,"TemplatesCSV":"sample string 8","LanguageCodeID":"sample string 9","TimeZoneValue":1,"StartPageComponentID":1,"Comments":"sample string 10","DestinationURL":"sample string 11","IsActiveForMatching":true,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true}},"ErrorCode":1,"Success":true,"ErrorMessage":"sample string 3","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":4,"ComponentFilterIds":[1,2,3]}

application/xml, text/xml

Sample:
<APIAddAccountResponse 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 3</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">4</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</Success>
  <ErrorCode>1</ErrorCode>
  <NewAccount>
    <AccessRights xmlns:d3p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
      <d3p1:HasCreateAccess>true</d3p1:HasCreateAccess>
      <d3p1:HasDeleteAccess>true</d3p1:HasDeleteAccess>
      <d3p1:HasRetrieveAccess>true</d3p1:HasRetrieveAccess>
      <d3p1:HasUpdateAccess>true</d3p1:HasUpdateAccess>
    </AccessRights>
    <AccountID>2</AccountID>
    <AccountNo>sample string 5</AccountNo>
    <Comments>sample string 10</Comments>
    <CountryID>1</CountryID>
    <DataValidationDayRange>7</DataValidationDayRange>
    <Description>sample string 6</Description>
    <DestinationURL>sample string 11</DestinationURL>
    <GroupID>1</GroupID>
    <IsActiveForMatching>true</IsActiveForMatching>
    <LanguageCodeID>sample string 9</LanguageCodeID>
    <Name>sample string 4</Name>
    <ParentGroupID>3</ParentGroupID>
    <StartPageComponentID>1</StartPageComponentID>
    <TemplateID>1</TemplateID>
    <TemplatesCSV>sample string 8</TemplatesCSV>
    <TimeZoneValue>1</TimeZoneValue>
  </NewAccount>
</APIAddAccountResponse>