POST api/SocialDriver/GetBusinessPrivateJourneySummary

View a collection of business private journey summaries

Request Information

URI Parameters

None.

Body Parameters

ViewBusinessPrivateJourneySummaryRequest

Name	Description	Type	Additional information
StartDate	The start date queried	date	None.
EndDate	The end date queried	date	None.
SummaryPeriod	The summary period queried	BusinessPrivateJourneySummaryType	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2025-04-27T16:27:28.2412097+00:00",
  "EndDate": "2025-04-27T16:27:28.2412097+00:00",
  "SummaryPeriod": 0
}

application/xml, text/xml

Sample:

<ViewBusinessPrivateJourneySummaryRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StartDate>2025-04-27T16:27:28.2412097+00:00</StartDate>
  <EndDate>2025-04-27T16:27:28.2412097+00:00</EndDate>
  <SummaryPeriod>Daily</SummaryPeriod>
</ViewBusinessPrivateJourneySummaryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ViewBusinessPrivateJourneySummaryResponse

Name	Description	Type	Additional information
BusinessPrivateJourneySummaries	The business private journey summaries	Collection of BusinessPrivateJourneySummary	None.
SummaryCount	The number of summaries	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "BusinessPrivateJourneySummaries": [
    {
      "ServiceIdPeriod": "sample string 1",
      "ServiceId": 2,
      "BusinessPrivateJourneySummaryType": 0,
      "StartDate": "2025-04-27T16:27:28.2412097+00:00",
      "EndDate": "2025-04-27T16:27:28.2412097+00:00",
      "TotalDistance": 5,
      "PrivateDistance": 6,
      "BusinessDistance": 7,
      "TotalDuration": 8,
      "PrivateDuration": 9,
      "BusinessDuration": 10,
      "PrivateJourneyCount": 11,
      "BusinessJourneyCount": 12
    },
    {
      "ServiceIdPeriod": "sample string 1",
      "ServiceId": 2,
      "BusinessPrivateJourneySummaryType": 0,
      "StartDate": "2025-04-27T16:27:28.2412097+00:00",
      "EndDate": "2025-04-27T16:27:28.2412097+00:00",
      "TotalDistance": 5,
      "PrivateDistance": 6,
      "BusinessDistance": 7,
      "TotalDuration": 8,
      "PrivateDuration": 9,
      "BusinessDuration": 10,
      "PrivateJourneyCount": 11,
      "BusinessJourneyCount": 12
    }
  ],
  "SummaryCount": 1
}

application/xml, text/xml

Sample:

<ViewBusinessPrivateJourneySummaryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BusinessPrivateJourneySummaries>
    <BusinessPrivateJourneySummary>
      <ServiceIdPeriod>sample string 1</ServiceIdPeriod>
      <ServiceId>2</ServiceId>
      <BusinessPrivateJourneySummaryType>Daily</BusinessPrivateJourneySummaryType>
      <StartDate>2025-04-27T16:27:28.2412097+00:00</StartDate>
      <EndDate>2025-04-27T16:27:28.2412097+00:00</EndDate>
      <TotalDistance>5</TotalDistance>
      <PrivateDistance>6</PrivateDistance>
      <BusinessDistance>7</BusinessDistance>
      <TotalDuration>8</TotalDuration>
      <PrivateDuration>9</PrivateDuration>
      <BusinessDuration>10</BusinessDuration>
      <PrivateJourneyCount>11</PrivateJourneyCount>
      <BusinessJourneyCount>12</BusinessJourneyCount>
    </BusinessPrivateJourneySummary>
    <BusinessPrivateJourneySummary>
      <ServiceIdPeriod>sample string 1</ServiceIdPeriod>
      <ServiceId>2</ServiceId>
      <BusinessPrivateJourneySummaryType>Daily</BusinessPrivateJourneySummaryType>
      <StartDate>2025-04-27T16:27:28.2412097+00:00</StartDate>
      <EndDate>2025-04-27T16:27:28.2412097+00:00</EndDate>
      <TotalDistance>5</TotalDistance>
      <PrivateDistance>6</PrivateDistance>
      <BusinessDistance>7</BusinessDistance>
      <TotalDuration>8</TotalDuration>
      <PrivateDuration>9</PrivateDuration>
      <BusinessDuration>10</BusinessDuration>
      <PrivateJourneyCount>11</PrivateJourneyCount>
      <BusinessJourneyCount>12</BusinessJourneyCount>
    </BusinessPrivateJourneySummary>
  </BusinessPrivateJourneySummaries>
  <SummaryCount>1</SummaryCount>
</ViewBusinessPrivateJourneySummaryResponse>