URL-Parameters.html

<!DOCTYPE HTML>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width" />
<title>URL parameters</title>
<style>
    table {
       border-collapse:collapse;
    }
    td,th
    {
        border: 1px solid black; 
        vertical-align:top;
        padding: 2px;
    }
    th{
        background-color:lightblue;
    }
    .param
    {
        font-style: italic;
    }
</style>
</head>

<body>
<table>
    <tr>
        <th>Parameter</th>
        <th>Description</th>
        <th>Examples</th>
    </tr>
    <tr>
        <td class="param">board</td>
        <td>Board number, max. 15 characters</td>
        <td>board=14</td>
    </tr>
    <tr>
        <td class="param">dealer</td>
        <td>Dealer, one character out of N, S, E or W</td>
        <td>dealer=E</td>
    </tr>
    <tr>
        <td class="param">vul</td>
        <td>Vulnerability, one of NS, EW, All or None</td>
        <td>vul=All</td>
    </tr>
    <tr>
        <td class="param">north, south, east, west</td>
        <td>Hand for each of the positions. Order of suits: Spade-Hearts-Diamonds-Clubs. <br>Cards for each suit are separated by a dot (.)</td>
        <td>west=KQJ..A9764.JT432</td>
    </tr>
    <tr>
        <td class="param">contract</td>
        <td>The played contract</td>
        <td>contract=4SxN</td>
    </tr>
    <tr>
        <td class="param">declarer</td>
        <td>Declarer, one of N, S, E or W</td>
        <td>declarer=W</td>
    </tr>
    <tr>
        <td class="param">title</td>
        <td>Title for display above the diagram, may contain HTML tags</td>
        <td>title=&lt;b&gt;Championship on July, 4th&lt;b&gt;</td>
    </tr>
    <tr>
        <td class="param">analyse</td>
        <td>Defines whether analysis should be done automatically</td>
        <td>analyse=true</td>
    </tr>
    <tr>
        <td class="param">dd</td>
        <td>Double Dummy analysis. A string of 20 characters</td>
        <td>dd=334234444422222323a3</td>
    </tr>
    <tr>
        <td class="param">optimumscore</td>
        <td>Optimum score for a single board</td>
        <td>optimimumscore=4SN+2</td>
    </tr>
    <tr>
        <td class="param">leadcard</td>
        <td>Played card, 2 characters, first is card, second is suit</td>
        <td>leadcard=QS</td>
    </tr>
    <tr>
        <td class="param">event, eventid</td>
        <td>Name of the event</td>
        <td>event=Championship</td>
    </tr>
    <tr>
        <td class="param">lin</td>
        <td>A string of characters that represents a played board as available from BBO</td>
        <td>lin=pn|Bodensee20,Anjaaa,rollhase,AnT07|st||md|3S8KH258D248TQC...c|DT|pc|H7|pc|D7|pc|DQ|pc|SQ|</td>
    </tr>
    <tr>
        <td class="param">club</td>
        <td>Name of the club</td>
        <td>club=Bridgeclub XXX</td>
    </tr>
    <tr>
        <td class="param">pair_number</td>
        <td>Pair number for a single board</td>
        <td>pair_number=402</td>
    </tr>
    <tr>
        <td class="param">direction</td>
        <td></td>
        <td></td>
    </tr>
    <tr>
        <td class="param">compare</td>
        <td></td>
        <td></td>
    </tr>
    <tr>
        <td class="param">file</td>
        <td>Names a URL for a file to be loaded for analysis. Can be any of format .pbn, .lin, .dlm<br>
            For a .pbn URL without an explicit xml parameter, BSOL looks for a traveller with the same basename
            in the same directory: first .xml, then .json if the XML file is not found.
            If neither exists, only the PBN is loaded. Other retrieval errors are reported.<br>
            With the local file chooser, select one PBN/LIN/DLM file, or select a PBN file together
            with one XML/JSON traveller file. The browser cannot search a local folder automatically.<br>
            <b>Note:</b> <br>If the pbn file for retrieval is on a different domain then that domain must have a CORS header in place
            by setting "Access-Control-Allow-Origin" to either to * (all domains can retrieve pbn files) or to a specific domain
        </td>
        <td>file=https://www.example.com/20250916.pbn</td>
    </tr>
    <tr>
        <td class="param">xml</td>
        <td>Names a URL for an XML or JSON traveller file. It must be used together with a "file" parameter that loads the corresponding pbn data.
            An explicit xml parameter takes priority and disables automatic traveller discovery.
            <br><b>Note:</b><br>The xml file can be generated by converting a downloaded csv file from BBOs result page using the BBO Extractor extension. 
            See documentation here: <a href="https://mirgo2.co.uk/bboextractor/">https://mirgo2.co.uk/bboextractor/</a>
        </td>
        <td>xml=https://www.example.com/test.xml&file=https://www.example.com/test.pbn</td>
    </tr>
    <tr>
        <td class="param">sessid</td>
        <td></td>
        <td></td>
    </tr>
    <tr>
        <td class="param">msec</td>
        <td>Section number for multiple section events</td>
        <td>msec=2</td>
    </tr>
    <tr>
        <td class="param">display</td>
        <td>One of allpairs, personal or board</td>
        <td>display=allpairs</td>
    </tr>
    <tr>
        <td class="param">analysis</td>
        <td>Request is from BridgeWebs. This means that "Results Analysis" button will be displayed. <br>If any 3rd party site sets this parameter the button will be displayed but won't display any data.</td>
        <td></td>
    </tr>
    <tr>
        <td class="param">debug</td>
        <td>Debugging the application</td>
        <td>debug=true</td>
    </tr>
    <tr>
        <td class="param">jsonline</td>
        <td></td>
        <td></td>
    </tr>
    <tr>
        <td class="param">lang</td>
        <td>Language code for displayed text.</td>
        <td>lang=de</td>
    </tr>
    <tr>
        <td class="param">nav</td>
        <td>Hide or show top navigation area</td>
        <td>nav=0</td>
    </tr>
</table>
</body>