POST Ship/BookingList

Request Information

URI Parameters

None.

Body Parameters

ShipBookingListRequest
NameDescriptionTypeAdditional information
filterBy

string

None.

startDate

date

None.

endDate

date

None.

userID

user API

string

None.

accessToken

access code getting from login

string

None.

Request Formats

application/json, text/json

Sample:
{
  "filterBy": "sample string 1",
  "startDate": "2021-11-27T13:06:06.3893182+07:00",
  "endDate": "2021-11-27T13:06:06.3893182+07:00",
  "userID": "sample string 2",
  "accessToken": "sample string 3"
}

application/xml, text/xml

Sample:
<ShipBookingListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 3</accessToken>
  <userID>sample string 2</userID>
  <endDate>2021-11-27T13:06:06.3893182+07:00</endDate>
  <filterBy>sample string 1</filterBy>
  <startDate>2021-11-27T13:06:06.3893182+07:00</startDate>
</ShipBookingListRequest>

Response Information

Resource Description

ShipBookingListResponse
NameDescriptionTypeAdditional information
startDate

date

None.

endDate

date

None.

list

Collection of ShipBookingModel

None.

respTime

describe time in sending response

date

None.

userID

user ID to access API

string

None.

accessToken

access token that needed to access API

string

None.

status

SUCCESS or FAILED

string

None.

respMessage

detail message of response status

string

None.

Response Formats

application/json, text/json

Sample:
{
  "startDate": "2021-11-27T13:06:06.3893182+07:00",
  "endDate": "2021-11-27T13:06:06.3893182+07:00",
  "list": [
    {
      "numCode": "sample string 1",
      "route": "sample string 2",
      "bookingDateTime": "2021-11-27T13:06:06.3893182+07:00",
      "issuedDateTime": "2021-11-27T13:06:06.3893182+07:00",
      "issuedDateTimeLimit": "2021-11-27T13:06:06.3893182+07:00",
      "ticketStatus": "sample string 5",
      "totalPassenger": "sample string 6",
      "ticketPrice": 7.0
    },
    {
      "numCode": "sample string 1",
      "route": "sample string 2",
      "bookingDateTime": "2021-11-27T13:06:06.3893182+07:00",
      "issuedDateTime": "2021-11-27T13:06:06.3893182+07:00",
      "issuedDateTimeLimit": "2021-11-27T13:06:06.3893182+07:00",
      "ticketStatus": "sample string 5",
      "totalPassenger": "sample string 6",
      "ticketPrice": 7.0
    }
  ],
  "respTime": "2021-11-27T13:06:06.3893182+07:00",
  "userID": "sample string 2",
  "accessToken": "sample string 3",
  "status": "sample string 4",
  "respMessage": "sample string 5"
}

application/xml, text/xml

Sample:
<ShipBookingListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 3</accessToken>
  <respMessage>sample string 5</respMessage>
  <respTime>2021-11-27T13:06:06.3893182+07:00</respTime>
  <status>sample string 4</status>
  <userID>sample string 2</userID>
  <endDate>2021-11-27T13:06:06.3893182+07:00</endDate>
  <list>
    <ShipBookingModel>
      <bookingDateTime>2021-11-27T13:06:06.3893182+07:00</bookingDateTime>
      <issuedDateTime>2021-11-27T13:06:06.3893182+07:00</issuedDateTime>
      <issuedDateTimeLimit>2021-11-27T13:06:06.3893182+07:00</issuedDateTimeLimit>
      <numCode>sample string 1</numCode>
      <route>sample string 2</route>
      <ticketPrice>7</ticketPrice>
      <ticketStatus>sample string 5</ticketStatus>
      <totalPassenger>sample string 6</totalPassenger>
    </ShipBookingModel>
    <ShipBookingModel>
      <bookingDateTime>2021-11-27T13:06:06.3893182+07:00</bookingDateTime>
      <issuedDateTime>2021-11-27T13:06:06.3893182+07:00</issuedDateTime>
      <issuedDateTimeLimit>2021-11-27T13:06:06.3893182+07:00</issuedDateTimeLimit>
      <numCode>sample string 1</numCode>
      <route>sample string 2</route>
      <ticketPrice>7</ticketPrice>
      <ticketStatus>sample string 5</ticketStatus>
      <totalPassenger>sample string 6</totalPassenger>
    </ShipBookingModel>
  </list>
  <startDate>2021-11-27T13:06:06.3893182+07:00</startDate>
</ShipBookingListResponse>