GET Booking/GetPlannedPaymentMethodList

Returns a list of the Booking Pay Methods

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Returns a list of the Booking Pay Methods

AgvBookingPayMethod
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

string
ErrorList

List of errors from the API

Collection of string
WarningList

List of warnings from the API

Collection of string
BookPayMethodList

Collection of ClsBookPayMethod

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "BookPayMethodList": [
    {
      "UniqueId": 5,
      "BookPayMethodGuid": "4559bd00-b412-41c7-8c91-b4036800e8c4",
      "BookPayMethodId": "sample string 6",
      "BookPayMethodDescription": "sample string 7",
      "Inactive": true,
      "InactiveDateTimeUtc": "2024-04-26T08:23:04.0958322+00:00"
    },
    {
      "UniqueId": 5,
      "BookPayMethodGuid": "4559bd00-b412-41c7-8c91-b4036800e8c4",
      "BookPayMethodId": "sample string 6",
      "BookPayMethodDescription": "sample string 7",
      "Inactive": true,
      "InactiveDateTimeUtc": "2024-04-26T08:23:04.0958322+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<AgvBookingPayMethod xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Booking">
  <BookPayMethodList xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.AR">
    <d2p1:ClsBookPayMethod>
      <d2p1:BookPayMethodDescription>sample string 7</d2p1:BookPayMethodDescription>
      <d2p1:BookPayMethodGuid>4559bd00-b412-41c7-8c91-b4036800e8c4</d2p1:BookPayMethodGuid>
      <d2p1:BookPayMethodId>sample string 6</d2p1:BookPayMethodId>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:InactiveDateTimeUtc>2024-04-26T08:23:04.0958322+00:00</d2p1:InactiveDateTimeUtc>
      <d2p1:UniqueId>5</d2p1:UniqueId>
    </d2p1:ClsBookPayMethod>
    <d2p1:ClsBookPayMethod>
      <d2p1:BookPayMethodDescription>sample string 7</d2p1:BookPayMethodDescription>
      <d2p1:BookPayMethodGuid>4559bd00-b412-41c7-8c91-b4036800e8c4</d2p1:BookPayMethodGuid>
      <d2p1:BookPayMethodId>sample string 6</d2p1:BookPayMethodId>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:InactiveDateTimeUtc>2024-04-26T08:23:04.0958322+00:00</d2p1:InactiveDateTimeUtc>
      <d2p1:UniqueId>5</d2p1:UniqueId>
    </d2p1:ClsBookPayMethod>
  </BookPayMethodList>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvBookingPayMethod>