GetBansInfo

GetBansInfo

Request for getting information on bans.

Request

Format Description

• SubAgenciesIDs — list of external subagents, on which you want to get bans information (optional field). Data type — array.
• SubAgencyID — ID of external subagent (mandatory field). Data type — 32-bit integer.

Examples

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:avia="http://ws-ibe.com/Avia" xmlns:stl="http://ws-ibe.com/STL">
   <soapenv:Header/>
   <soapenv:Body>
      <avia:GetBansInfo>
         <avia:Request>
            <stl:Requisites>
               <stl:AuthToken>token</stl:AuthToken>
            </stl:Requisites>
            <stl:UserID>11111</stl:UserID>
            <stl:RequestType>P</stl:RequestType>
            <stl:RequestBody>
               <avia:SubAgenciesIDs>
                  <avia:ID>11333</avia:ID>
               </avia:SubAgenciesIDs>
            </stl:RequestBody>
         </avia:Request>
      </avia:GetBansInfo>
   </soapenv:Body>
</soapenv:Envelope>

Response

Format Description

• Bans — Attribute of successful cancellation. Data type — boolean.
• Ban — Information on ban. Data type — complex.
• Ban.SubAgencyID — ID of external subagent. Data type — 32-bit integer.
• Ban.BanType — Ban type. Data type — enumeration. Possible values are:
  • SearchesLimit — The limit on amount of searches is exceeded.
  • SearchesPerTicketsLimit — The limit on amount of searches per ticket is exceeded.
• Ban.AdditionalBanInfo — Additional information on ban. Data type — complex.
• Ban.AdditionalBanInfo.Searches — Amount of searches. Data type — 32-bit integer.
• Ban.AdditionalBanInfo.SearchesPerTicket — Amount of searches per ticket. Data type — 32-bit integer.

Examples

<?xml version="1.0"?>
<ResponseWithGetBansInfoRSBody xmlns="http://ws-ibe.com/STL" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <RequestID>100000000</RequestID>
  <ResponseBody xmlns:a="http://ws-ibe.com/Avia">
    <a:Bans>
      <a:Ban>
        <a:SubAgencyID>11333</a:SubAgencyID>
        <a:BanType>SearchesLimit</a:BanType>
        <a:AdditionalBanInfo>
          <a:Searches>8</a:Searches>
        </a:AdditionalBanInfo>
      </a:Ban>
    </a:Bans>
  </ResponseBody>
</ResponseWithGetBansInfoRSBody>