Sw0rdDoom
/
AnemoiBackend


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621
							<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

          "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>backend.API : API documentation</title>

    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
    <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
    <link rel="stylesheet" type="text/css" href="apidocs.css" />
  </head>
  <body>

    <nav class="navbar navbar-default">
      <div class="container">
        <div class="navbar-header">
          <a class="navbar-brand" href="index.html">
            backend API Documentation
          </a>
        </div>
      </div>
    </nav>

    <div id="showPrivate">
      <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
    </div>

    <div class="container">

      <div class="page-header">
        <h1 class="class"><code>backend.API</code> <small>class documentation</small></h1>

        <span id="partOf">
          Part of <code><a href="backend.html" class="code" data-type="Module">backend</a></code>
          
          <a href="classIndex.html#backend.API">(View In Hierarchy)</a>
        </span>
      </div>

      <div class="extrasDocstring">
        
      </div>

      <div class="moduleDocstring">
        <div><p>This interacts with the external odoo 13 API with XMLrpc</p><p>The API Class is intended to be used a black box implentation which is imported by another Class or Python Scipt</p></div>
      </div>

      <div id="splitTables">
        <table class="children sortable" id="id6">
  
  <tr class="classvariable">
    
    <td>Class Variable</td>
    <td><a href="backend.API.html#url" class="code" data-type="Class Variable">url</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="classvariable">
    
    <td>Class Variable</td>
    <td><a href="backend.API.html#db" class="code" data-type="Class Variable">db</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="classvariable">
    
    <td>Class Variable</td>
    <td><a href="backend.API.html#username" class="code" data-type="Class Variable">username</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="classvariable">
    
    <td>Class Variable</td>
    <td><a href="backend.API.html#password" class="code" data-type="Class Variable">password</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="classvariable">
    
    <td>Class Variable</td>
    <td><a href="backend.API.html#common" class="code" data-type="Class Variable">common</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="classvariable">
    
    <td>Class Variable</td>
    <td><a href="backend.API.html#models" class="code" data-type="Class Variable">models</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="classvariable">
    
    <td>Class Variable</td>
    <td><a href="backend.API.html#uid" class="code" data-type="Class Variable">uid</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="backend.API.html#__init__" class="code" data-type="Method">__init__</a></td>
    <td><span>Reads the values from its parameters and uses them to build the API</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#printed" class="code" data-type="Instance Variable">printed</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#id" class="code" data-type="Instance Variable">id</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#name" class="code" data-type="Instance Variable">name</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#number" class="code" data-type="Instance Variable">number</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#addres" class="code" data-type="Instance Variable">addres</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#description" class="code" data-type="Instance Variable">description</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#menge" class="code" data-type="Instance Variable">menge</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#preis" class="code" data-type="Instance Variable">preis</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#sum_order" class="code" data-type="Instance Variable">sum_order</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="instancevariable">
    
    <td>Instance Variable</td>
    <td><a href="backend.API.html#comment" class="code" data-type="Instance Variable">comment</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="backend.API.html#login" class="code" data-type="Method">login</a></td>
    <td><span>Login into the Server return the reading rights of stock.picking</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="backend.API.html#get_fields" class="code" data-type="Method">get_fields</a></td>
    <td><span>What Fields does the our Odoo Model have of of this data Field</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="backend.API.html#get_partner_address" class="code" data-type="Method">get_partner_address</a></td>
    <td><span>Returns the adress and geolocation of all ids as a AdressSchema</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="backend.API.html#get_not_printed_pickings" class="code" data-type="Method">get_not_printed_pickings</a></td>
    <td><span>Returns all Pickings which have not been not been printed or processed The xml Response of the Server is parsed to a python Data Picking Class</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="backend.API.html#get_product" class="code" data-type="Method">get_product</a></td>
    <td><span>Returns all orders Lines of a Product</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="backend.API.html#post_printed_picking" class="code" data-type="Method">post_printed_picking</a></td>
    <td><span>Post the new value of printed for picking_id</span></td>
  </tr><tr class="method private">
    
    <td>Method</td>
    <td><a href="backend.API.html#__load_picking" class="code" data-type="Method">__load_picking</a></td>
    <td><span>Loads the Picking Schema from a String. Usefull for testing</span></td>
  </tr>
</table>
        

          
      </div>

      <div id="childList">

        <div class="baseclassvariable">
  
  <a name="backend.API.url">
    
  </a>
  <a name="url">
    
  </a>
  <div class="functionHeader">
    url =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div> (type: <code>str</code>)
  </div>
</div><div class="baseclassvariable">
  
  <a name="backend.API.db">
    
  </a>
  <a name="db">
    
  </a>
  <div class="functionHeader">
    db =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div> (type: <code>str</code>)
  </div>
</div><div class="baseclassvariable">
  
  <a name="backend.API.username">
    
  </a>
  <a name="username">
    
  </a>
  <div class="functionHeader">
    username =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div> (type: <code>str</code>)
  </div>
</div><div class="baseclassvariable">
  
  <a name="backend.API.password">
    
  </a>
  <a name="password">
    
  </a>
  <div class="functionHeader">
    password =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div> (type: <code>str</code>)
  </div>
</div><div class="baseclassvariable">
  
  <a name="backend.API.common">
    
  </a>
  <a name="common">
    
  </a>
  <div class="functionHeader">
    common =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseclassvariable">
  
  <a name="backend.API.models">
    
  </a>
  <a name="models">
    
  </a>
  <div class="functionHeader">
    models =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseclassvariable">
  
  <a name="backend.API.uid">
    
  </a>
  <a name="uid">
    
  </a>
  <div class="functionHeader">
    uid =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="basemethod">
  
  <a name="backend.API.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self, id, name, number, addres, description, menge, preis, sum_order, comment):
    
  </div>
  <div class="docstring functionBody">
    
    
    <div><p>Reads the values from its parameters and uses them to build the API</p></div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.printed">
    
  </a>
  <a name="printed">
    
  </a>
  <div class="functionHeader">
    printed =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div> (type: <code>bool</code>)
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.id">
    
  </a>
  <a name="id">
    
  </a>
  <div class="functionHeader">
    id =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.name">
    
  </a>
  <a name="name">
    
  </a>
  <div class="functionHeader">
    name =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.number">
    
  </a>
  <a name="number">
    
  </a>
  <div class="functionHeader">
    number =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.addres">
    
  </a>
  <a name="addres">
    
  </a>
  <div class="functionHeader">
    addres =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.description">
    
  </a>
  <a name="description">
    
  </a>
  <div class="functionHeader">
    description =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.menge">
    
  </a>
  <a name="menge">
    
  </a>
  <div class="functionHeader">
    menge =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.preis">
    
  </a>
  <a name="preis">
    
  </a>
  <div class="functionHeader">
    preis =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.sum_order">
    
  </a>
  <a name="sum_order">
    
  </a>
  <div class="functionHeader">
    sum_order =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="baseinstancevariable">
  
  <a name="backend.API.comment">
    
  </a>
  <a name="comment">
    
  </a>
  <div class="functionHeader">
    comment =
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="basemethod">
  
  <a name="backend.API.login">
    
  </a>
  <a name="login">
    
  </a>
  <div class="functionHeader">
    
    def
    login():
    
  </div>
  <div class="docstring functionBody">
    
    
    <div><p>Login into the Server return the reading rights of stock.picking</p></div>
  </div>
</div><div class="basemethod">
  
  <a name="backend.API.get_fields">
    
  </a>
  <a name="get_fields">
    
  </a>
  <div class="functionHeader">
    
    def
    get_fields(field_name):
    
  </div>
  <div class="docstring functionBody">
    
    
    <div><p>What Fields does the our Odoo Model have of of this data Field</p></div>
  </div>
</div><div class="basemethod">
  
  <a name="backend.API.get_partner_address">
    
  </a>
  <a name="get_partner_address">
    
  </a>
  <div class="functionHeader">
    
    def
    get_partner_address(ids):
    
  </div>
  <div class="docstring functionBody">
    
    
    <div><p>Returns the adress and geolocation of all ids as a AdressSchema</p></div>
  </div>
</div><div class="basemethod">
  
  <a name="backend.API.get_not_printed_pickings">
    
  </a>
  <a name="get_not_printed_pickings">
    
  </a>
  <div class="functionHeader">
    
    def
    get_not_printed_pickings():
    
  </div>
  <div class="docstring functionBody">
    
    
    <div><p>Returns all Pickings which have not been not been printed or processed The xml Response of the Server is parsed to a python Data Picking Class</p></div>
  </div>
</div><div class="basemethod private">
  
  <a name="backend.API.__load_picking">
    
  </a>
  <a name="__load_picking">
    
  </a>
  <div class="functionHeader">
    
    def
    __load_picking(p_picking):
    
  </div>
  <div class="docstring functionBody">
    
    
    <div><p>Loads the Picking Schema from a String. Usefull for testing</p></div>
  </div>
</div><div class="basemethod">
  
  <a name="backend.API.get_product">
    
  </a>
  <a name="get_product">
    
  </a>
  <div class="functionHeader">
    
    def
    get_product(ids):
    
  </div>
  <div class="docstring functionBody">
    
    
    <div><p>Returns all orders Lines of a Product</p></div>
  </div>
</div><div class="basemethod">
  
  <a name="backend.API.post_printed_picking">
    
  </a>
  <a name="post_printed_picking">
    
  </a>
  <div class="functionHeader">
    
    def
    post_printed_picking(printed, picking_id):
    
  </div>
  <div class="docstring functionBody">
    
    
    <div><p>Post the new value of printed for picking_id</p></div>
  </div>
</div>

      </div>
      <address>
        <a href="index.html">API Documentation</a> for backend, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> at 2020-09-10 02:53:19.
      </address>

    </div>

    <script src="pydoctor.js" type="text/javascript"></script>

  </body>
</html>