POST api/Contract/RetrieveContractsWithSummary

Fetches Contracts along with summary based on the parameters passed and user's access rights.

Request Information

Parameters

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

Request body formats

application/json, text/json

Sample:

{
  "AccountIds": [
    1,
    2,
    3
  ],
  "ContractIds": [
    1,
    2,
    3
  ],
  "StartDate": "2024-10-16T22:59:52.2930444+02:00",
  "EndDate": "2024-10-16T22:59:52.2940476+02:00",
  "ContractTerm": "sample string 1",
  "NoOfUnits": 1,
  "MonthlyFee": 1.1,
  "IsActive": true,
  "SortOrder": 2,
  "IsContractDataIncluded": true,
  "IsSummaryDataIncluded": true,
  "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:

{"AccountIds":[1,2,3],"ContractIds":[1,2,3],"StartDate":"2024-10-16T22:59:52.2930444+02:00","EndDate":"2024-10-16T22:59:52.2940476+02:00","ContractTerm":"sample string 1","NoOfUnits":1,"MonthlyFee":1.1,"IsActive":true,"SortOrder":2,"IsContractDataIncluded":true,"IsSummaryDataIncluded":true,"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:

<APIContractWithSummaryRequest 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 14</AppName>
  <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 13</AppOperatingSystem>
  <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 12</AppVersion>
  <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 11</Client>
  <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 6</FreeText>
  <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">7</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">15</MasterUserID>
  <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 10</RequestMode>
  <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">8</ToIndex>
  <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 5</Token>
  <AccountIds 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>
  </AccountIds>
  <ContractIds 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>
  </ContractIds>
  <ContractTerm>sample string 1</ContractTerm>
  <EndDate>2024-10-16T22:59:52.2940476+02:00</EndDate>
  <IsActive>true</IsActive>
  <IsContractDataIncluded>true</IsContractDataIncluded>
  <IsSummaryDataIncluded>true</IsSummaryDataIncluded>
  <MonthlyFee>1.1</MonthlyFee>
  <NoOfUnits>1</NoOfUnits>
  <SortOrder>2</SortOrder>
  <StartDate>2024-10-16T22:59:52.2930444+02:00</StartDate>
</APIContractWithSummaryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "ContractData": [
    {
      "ID": 1,
      "AccountID": 1,
      "ContractNo": "sample string 2",
      "AccountNo": "sample string 3",
      "StartDate": "2024-10-16T22:59:52.3311252+02:00",
      "EndDate": "2024-10-16T22:59:52.3311252+02:00",
      "NoOfUsers": 1,
      "NoOfUnits": 1,
      "MonthlyFee": 1.1,
      "IsActive": true,
      "Note": "sample string 4",
      "CreatedDate": "2024-10-16T22:59:52.3311252+02:00",
      "ContractTerm": "sample string 5",
      "RecurringRevenue": 1.1,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      }
    },
    {
      "ID": 1,
      "AccountID": 1,
      "ContractNo": "sample string 2",
      "AccountNo": "sample string 3",
      "StartDate": "2024-10-16T22:59:52.3311252+02:00",
      "EndDate": "2024-10-16T22:59:52.3311252+02:00",
      "NoOfUsers": 1,
      "NoOfUnits": 1,
      "MonthlyFee": 1.1,
      "IsActive": true,
      "Note": "sample string 4",
      "CreatedDate": "2024-10-16T22:59:52.3311252+02:00",
      "ContractTerm": "sample string 5",
      "RecurringRevenue": 1.1,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      }
    },
    {
      "ID": 1,
      "AccountID": 1,
      "ContractNo": "sample string 2",
      "AccountNo": "sample string 3",
      "StartDate": "2024-10-16T22:59:52.3311252+02:00",
      "EndDate": "2024-10-16T22:59:52.3311252+02:00",
      "NoOfUsers": 1,
      "NoOfUnits": 1,
      "MonthlyFee": 1.1,
      "IsActive": true,
      "Note": "sample string 4",
      "CreatedDate": "2024-10-16T22:59:52.3311252+02:00",
      "ContractTerm": "sample string 5",
      "RecurringRevenue": 1.1,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      }
    }
  ],
  "SummaryData": {
    "TotalContracts": 1,
    "TotalUnits": 2,
    "RecurringRevenue": 3.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:

{"ContractData":[{"ID":1,"AccountID":1,"ContractNo":"sample string 2","AccountNo":"sample string 3","StartDate":"2024-10-16T22:59:52.3311252+02:00","EndDate":"2024-10-16T22:59:52.3311252+02:00","NoOfUsers":1,"NoOfUnits":1,"MonthlyFee":1.1,"IsActive":true,"Note":"sample string 4","CreatedDate":"2024-10-16T22:59:52.3311252+02:00","ContractTerm":"sample string 5","RecurringRevenue":1.1,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true}},{"ID":1,"AccountID":1,"ContractNo":"sample string 2","AccountNo":"sample string 3","StartDate":"2024-10-16T22:59:52.3311252+02:00","EndDate":"2024-10-16T22:59:52.3311252+02:00","NoOfUsers":1,"NoOfUnits":1,"MonthlyFee":1.1,"IsActive":true,"Note":"sample string 4","CreatedDate":"2024-10-16T22:59:52.3311252+02:00","ContractTerm":"sample string 5","RecurringRevenue":1.1,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true}},{"ID":1,"AccountID":1,"ContractNo":"sample string 2","AccountNo":"sample string 3","StartDate":"2024-10-16T22:59:52.3311252+02:00","EndDate":"2024-10-16T22:59:52.3311252+02:00","NoOfUsers":1,"NoOfUnits":1,"MonthlyFee":1.1,"IsActive":true,"Note":"sample string 4","CreatedDate":"2024-10-16T22:59:52.3311252+02:00","ContractTerm":"sample string 5","RecurringRevenue":1.1,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true}}],"SummaryData":{"TotalContracts":1,"TotalUnits":2,"RecurringRevenue":3.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:

<APIContractWithSummaryResponse 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>
  <ContractData>
    <APIContractWithSummaryData>
      <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>
      <AccountID>1</AccountID>
      <AccountNo>sample string 3</AccountNo>
      <ContractNo>sample string 2</ContractNo>
      <ContractTerm>sample string 5</ContractTerm>
      <CreatedDate>2024-10-16T22:59:52.3311252+02:00</CreatedDate>
      <EndDate>2024-10-16T22:59:52.3311252+02:00</EndDate>
      <ID>1</ID>
      <IsActive>true</IsActive>
      <MonthlyFee>1.1</MonthlyFee>
      <NoOfUnits>1</NoOfUnits>
      <NoOfUsers>1</NoOfUsers>
      <Note>sample string 4</Note>
      <RecurringRevenue>1.1</RecurringRevenue>
      <StartDate>2024-10-16T22:59:52.3311252+02:00</StartDate>
    </APIContractWithSummaryData>
    <APIContractWithSummaryData>
      <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>
      <AccountID>1</AccountID>
      <AccountNo>sample string 3</AccountNo>
      <ContractNo>sample string 2</ContractNo>
      <ContractTerm>sample string 5</ContractTerm>
      <CreatedDate>2024-10-16T22:59:52.3311252+02:00</CreatedDate>
      <EndDate>2024-10-16T22:59:52.3311252+02:00</EndDate>
      <ID>1</ID>
      <IsActive>true</IsActive>
      <MonthlyFee>1.1</MonthlyFee>
      <NoOfUnits>1</NoOfUnits>
      <NoOfUsers>1</NoOfUsers>
      <Note>sample string 4</Note>
      <RecurringRevenue>1.1</RecurringRevenue>
      <StartDate>2024-10-16T22:59:52.3311252+02:00</StartDate>
    </APIContractWithSummaryData>
    <APIContractWithSummaryData>
      <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>
      <AccountID>1</AccountID>
      <AccountNo>sample string 3</AccountNo>
      <ContractNo>sample string 2</ContractNo>
      <ContractTerm>sample string 5</ContractTerm>
      <CreatedDate>2024-10-16T22:59:52.3311252+02:00</CreatedDate>
      <EndDate>2024-10-16T22:59:52.3311252+02:00</EndDate>
      <ID>1</ID>
      <IsActive>true</IsActive>
      <MonthlyFee>1.1</MonthlyFee>
      <NoOfUnits>1</NoOfUnits>
      <NoOfUsers>1</NoOfUsers>
      <Note>sample string 4</Note>
      <RecurringRevenue>1.1</RecurringRevenue>
      <StartDate>2024-10-16T22:59:52.3311252+02:00</StartDate>
    </APIContractWithSummaryData>
  </ContractData>
  <SummaryData>
    <RecurringRevenue>3.1</RecurringRevenue>
    <TotalContracts>1</TotalContracts>
    <TotalUnits>2</TotalUnits>
  </SummaryData>
</APIContractWithSummaryResponse>