GET api/Ride/GetList?status={status}&isHistory={isHistory}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
status

byte

Required

isHistory

boolean

Required

Body Parameters

None.

Response Information

Resource Description

LiteRide
NameDescriptionTypeAdditional information
Id

integer

None.

GroupId

integer

None.

GroupName

string

None.

GroupMemberCount

integer

None.

GroupDescription

string

None.

RideType

byte

None.

PickUpDate

date

None.

PickUpLocationId

integer

None.

PickUpLocationName

string

None.

PickUpAddressLine1

string

None.

PickUpAddressLine2

string

None.

PickUpAddressCity

string

None.

PickUpAddressPostCode

string

None.

PickUpAddressLat

decimal number

None.

PickUpAddressLng

decimal number

None.

DropOffLocationId

integer

None.

DropOffLocationName

string

None.

DropOffAddressLine1

string

None.

DropOffAddressLine2

string

None.

DropOffAddressCity

string

None.

DropOffAddressPostCode

string

None.

DropOffAddressLat

decimal number

None.

DropOffAddressLng

decimal number

None.

ReturnTrip

boolean

None.

MaxSeats

byte

None.

Notes

string

None.

Cancelled

boolean

None.

TransactionId

integer

None.

CreatedBy

string

None.

CreatedByUserFullName

string

None.

CreatedByUserAddress

string

None.

CreatedByUserPhoneNumber

string

None.

CreatedByUserProfileImageThumbnail

Collection of byte

None.

CreatedOn

date

None.

IsMy

boolean

None.

IsAccepted

boolean

None.

IsPending

boolean

None.

RideChildren

Collection of LiteRideChildren

None.

RideRequestAcceptedResponses

Collection of LiteRideRequestResponse

None.

RideOfferAcceptedResponses

Collection of LiteRideOfferResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "GroupId": 2,
  "GroupName": "sample string 3",
  "GroupMemberCount": 4,
  "GroupDescription": "sample string 5",
  "RideType": 64,
  "PickUpDate": "2019-11-24T01:45:38.7689454+00:00",
  "PickUpLocationId": 1,
  "PickUpLocationName": "sample string 8",
  "PickUpAddressLine1": "sample string 9",
  "PickUpAddressLine2": "sample string 10",
  "PickUpAddressCity": "sample string 11",
  "PickUpAddressPostCode": "sample string 12",
  "PickUpAddressLat": 1.0,
  "PickUpAddressLng": 1.0,
  "DropOffLocationId": 1,
  "DropOffLocationName": "sample string 13",
  "DropOffAddressLine1": "sample string 14",
  "DropOffAddressLine2": "sample string 15",
  "DropOffAddressCity": "sample string 16",
  "DropOffAddressPostCode": "sample string 17",
  "DropOffAddressLat": 1.0,
  "DropOffAddressLng": 1.0,
  "ReturnTrip": true,
  "MaxSeats": 64,
  "Notes": "sample string 19",
  "Cancelled": true,
  "TransactionId": 1,
  "CreatedBy": "sample string 21",
  "CreatedByUserFullName": "sample string 22",
  "CreatedByUserAddress": "sample string 23",
  "CreatedByUserPhoneNumber": "sample string 24",
  "CreatedByUserProfileImageThumbnail": "QEA=",
  "CreatedOn": "2019-11-24T01:45:38.7845414+00:00",
  "IsMy": true,
  "IsAccepted": true,
  "IsPending": true,
  "RideChildren": [
    {
      "Id": 1,
      "RideId": 2,
      "UserChildrenId": 3,
      "UserChildren": {
        "Id": 1,
        "ParentUserId": "sample string 2",
        "Name": "sample string 3",
        "AgeText": "sample string 4",
        "Gender": 64,
        "GenderName": "sample string 6"
      }
    },
    {
      "Id": 1,
      "RideId": 2,
      "UserChildrenId": 3,
      "UserChildren": {
        "Id": 1,
        "ParentUserId": "sample string 2",
        "Name": "sample string 3",
        "AgeText": "sample string 4",
        "Gender": 64,
        "GenderName": "sample string 6"
      }
    }
  ],
  "RideRequestAcceptedResponses": [
    {
      "Id": 1,
      "RideId": 2,
      "UserId": "sample string 3",
      "UserFullName": "sample string 4",
      "UserAddress": "sample string 5",
      "UserPhoneNumber": "sample string 6",
      "UserProfileImageThumbnail": "QEA=",
      "Status": 64
    },
    {
      "Id": 1,
      "RideId": 2,
      "UserId": "sample string 3",
      "UserFullName": "sample string 4",
      "UserAddress": "sample string 5",
      "UserPhoneNumber": "sample string 6",
      "UserProfileImageThumbnail": "QEA=",
      "Status": 64
    }
  ],
  "RideOfferAcceptedResponses": [
    {
      "Id": 1,
      "RideId": 2,
      "UserId": "sample string 3",
      "UserFullName": "sample string 4",
      "UserFirstName": "sample string 5",
      "UserLastName": "sample string 6",
      "UserAddress": "sample string 7",
      "UserAddressLat": 1.0,
      "UserAddressLng": 1.0,
      "UserPhoneNumber": "sample string 8",
      "UserProfileImageThumbnail": "QEA=",
      "Seats": 64,
      "Notes": "sample string 10",
      "Status": 64,
      "AlternativeAddressLine1": "sample string 12",
      "AlternativeAddressLine2": "sample string 13",
      "AlternativeAddressCity": "sample string 14",
      "AlternativeAddressPostCode": "sample string 15",
      "AlternativeAddressLat": 1.0,
      "AlternativeAddressLng": 1.0
    },
    {
      "Id": 1,
      "RideId": 2,
      "UserId": "sample string 3",
      "UserFullName": "sample string 4",
      "UserFirstName": "sample string 5",
      "UserLastName": "sample string 6",
      "UserAddress": "sample string 7",
      "UserAddressLat": 1.0,
      "UserAddressLng": 1.0,
      "UserPhoneNumber": "sample string 8",
      "UserProfileImageThumbnail": "QEA=",
      "Seats": 64,
      "Notes": "sample string 10",
      "Status": 64,
      "AlternativeAddressLine1": "sample string 12",
      "AlternativeAddressLine2": "sample string 13",
      "AlternativeAddressCity": "sample string 14",
      "AlternativeAddressPostCode": "sample string 15",
      "AlternativeAddressLat": 1.0,
      "AlternativeAddressLng": 1.0
    }
  ]
}

application/xml, text/xml

Sample:
<LiteRide xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HubApi.Models.Hub.Api">
  <Cancelled>true</Cancelled>
  <CreatedBy>sample string 21</CreatedBy>
  <CreatedByUserAddress>sample string 23</CreatedByUserAddress>
  <CreatedByUserFullName>sample string 22</CreatedByUserFullName>
  <CreatedByUserPhoneNumber>sample string 24</CreatedByUserPhoneNumber>
  <CreatedByUserProfileImageThumbnail>QEA=</CreatedByUserProfileImageThumbnail>
  <CreatedOn>2019-11-24T01:45:38.7845414+00:00</CreatedOn>
  <DropOffAddressCity>sample string 16</DropOffAddressCity>
  <DropOffAddressLat>1</DropOffAddressLat>
  <DropOffAddressLine1>sample string 14</DropOffAddressLine1>
  <DropOffAddressLine2>sample string 15</DropOffAddressLine2>
  <DropOffAddressLng>1</DropOffAddressLng>
  <DropOffAddressPostCode>sample string 17</DropOffAddressPostCode>
  <DropOffLocationId>1</DropOffLocationId>
  <DropOffLocationName>sample string 13</DropOffLocationName>
  <GroupDescription>sample string 5</GroupDescription>
  <GroupId>2</GroupId>
  <GroupMemberCount>4</GroupMemberCount>
  <GroupName>sample string 3</GroupName>
  <Id>1</Id>
  <IsAccepted>true</IsAccepted>
  <IsMy>true</IsMy>
  <IsPending>true</IsPending>
  <MaxSeats>64</MaxSeats>
  <Notes>sample string 19</Notes>
  <PickUpAddressCity>sample string 11</PickUpAddressCity>
  <PickUpAddressLat>1</PickUpAddressLat>
  <PickUpAddressLine1>sample string 9</PickUpAddressLine1>
  <PickUpAddressLine2>sample string 10</PickUpAddressLine2>
  <PickUpAddressLng>1</PickUpAddressLng>
  <PickUpAddressPostCode>sample string 12</PickUpAddressPostCode>
  <PickUpDate>2019-11-24T01:45:38.7689454+00:00</PickUpDate>
  <PickUpLocationId>1</PickUpLocationId>
  <PickUpLocationName>sample string 8</PickUpLocationName>
  <ReturnTrip>true</ReturnTrip>
  <RideChildren>
    <LiteRideChildren>
      <Id>1</Id>
      <RideId>2</RideId>
      <UserChildren>
        <AgeText>sample string 4</AgeText>
        <Gender>64</Gender>
        <GenderName>sample string 6</GenderName>
        <Id>1</Id>
        <Name>sample string 3</Name>
        <ParentUserId>sample string 2</ParentUserId>
      </UserChildren>
      <UserChildrenId>3</UserChildrenId>
    </LiteRideChildren>
    <LiteRideChildren>
      <Id>1</Id>
      <RideId>2</RideId>
      <UserChildren>
        <AgeText>sample string 4</AgeText>
        <Gender>64</Gender>
        <GenderName>sample string 6</GenderName>
        <Id>1</Id>
        <Name>sample string 3</Name>
        <ParentUserId>sample string 2</ParentUserId>
      </UserChildren>
      <UserChildrenId>3</UserChildrenId>
    </LiteRideChildren>
  </RideChildren>
  <RideOfferAcceptedResponses>
    <LiteRideOfferResponse>
      <AlternativeAddressCity>sample string 14</AlternativeAddressCity>
      <AlternativeAddressLat>1</AlternativeAddressLat>
      <AlternativeAddressLine1>sample string 12</AlternativeAddressLine1>
      <AlternativeAddressLine2>sample string 13</AlternativeAddressLine2>
      <AlternativeAddressLng>1</AlternativeAddressLng>
      <AlternativeAddressPostCode>sample string 15</AlternativeAddressPostCode>
      <Id>1</Id>
      <Notes>sample string 10</Notes>
      <RideId>2</RideId>
      <Seats>64</Seats>
      <Status>64</Status>
      <UserAddress>sample string 7</UserAddress>
      <UserAddressLat>1</UserAddressLat>
      <UserAddressLng>1</UserAddressLng>
      <UserFirstName>sample string 5</UserFirstName>
      <UserFullName>sample string 4</UserFullName>
      <UserId>sample string 3</UserId>
      <UserLastName>sample string 6</UserLastName>
      <UserPhoneNumber>sample string 8</UserPhoneNumber>
      <UserProfileImageThumbnail>QEA=</UserProfileImageThumbnail>
    </LiteRideOfferResponse>
    <LiteRideOfferResponse>
      <AlternativeAddressCity>sample string 14</AlternativeAddressCity>
      <AlternativeAddressLat>1</AlternativeAddressLat>
      <AlternativeAddressLine1>sample string 12</AlternativeAddressLine1>
      <AlternativeAddressLine2>sample string 13</AlternativeAddressLine2>
      <AlternativeAddressLng>1</AlternativeAddressLng>
      <AlternativeAddressPostCode>sample string 15</AlternativeAddressPostCode>
      <Id>1</Id>
      <Notes>sample string 10</Notes>
      <RideId>2</RideId>
      <Seats>64</Seats>
      <Status>64</Status>
      <UserAddress>sample string 7</UserAddress>
      <UserAddressLat>1</UserAddressLat>
      <UserAddressLng>1</UserAddressLng>
      <UserFirstName>sample string 5</UserFirstName>
      <UserFullName>sample string 4</UserFullName>
      <UserId>sample string 3</UserId>
      <UserLastName>sample string 6</UserLastName>
      <UserPhoneNumber>sample string 8</UserPhoneNumber>
      <UserProfileImageThumbnail>QEA=</UserProfileImageThumbnail>
    </LiteRideOfferResponse>
  </RideOfferAcceptedResponses>
  <RideRequestAcceptedResponses>
    <LiteRideRequestResponse>
      <Id>1</Id>
      <RideId>2</RideId>
      <Status>64</Status>
      <UserAddress>sample string 5</UserAddress>
      <UserFullName>sample string 4</UserFullName>
      <UserId>sample string 3</UserId>
      <UserPhoneNumber>sample string 6</UserPhoneNumber>
      <UserProfileImageThumbnail>QEA=</UserProfileImageThumbnail>
    </LiteRideRequestResponse>
    <LiteRideRequestResponse>
      <Id>1</Id>
      <RideId>2</RideId>
      <Status>64</Status>
      <UserAddress>sample string 5</UserAddress>
      <UserFullName>sample string 4</UserFullName>
      <UserId>sample string 3</UserId>
      <UserPhoneNumber>sample string 6</UserPhoneNumber>
      <UserProfileImageThumbnail>QEA=</UserProfileImageThumbnail>
    </LiteRideRequestResponse>
  </RideRequestAcceptedResponses>
  <RideType>64</RideType>
  <TransactionId>1</TransactionId>
</LiteRide>