2021-12-03 Fred Gleason <fredg@paravelsystems.com>

* Added a 'ListCartSchedCodes()' method to the 'rivwebpyapi' API.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason 2021-12-03 16:55:36 -05:00
parent ee8d34d094
commit 5136c3efc8
5 changed files with 116 additions and 1 deletions

View File

@ -22643,3 +22643,5 @@
* Fixed a SQL escaping bug in 'lib/export_resultsrecon.cpp'.
* Fixed a SQL escaping bug in 'lib/rdlibrarymodel.cpp'.
* Fixed a SQL escaping bug in 'rdlibrary/rdlibrary.cpp'.
2021-12-03 Fred Gleason <fredg@paravelsystems.com>
* Added a 'ListCartSchedCodes()' method to the 'rivwebpyapi' API.

View File

@ -213,7 +213,7 @@ class rivwebpyapi(object):
Takes the following arguments:
cart_number - The number of the desired cart, in the range
0 - 999999 (integer)
1 - 999999 (integer)
include_cuts - Include cut information in the return. Default is
False. (boolean)
@ -365,6 +365,49 @@ class rivwebpyapi(object):
return handler.output()
def ListCartSchedCodes(self,cart_number):
"""
Returns a list of Rivendell schedule codes (dictionary)
Takes the following arguments:
cart_number - The number of the cart for the desired schedule codes,
in the range
1 - 999999 (integer)
"""
if((cart_number<1)or(cart_number>999999)):
raise ValueError('invalid cart number')
#
# Build the WebAPI arguments
#
postdata={
'COMMAND': '27',
'LOGIN_NAME': self.__connection_username,
'PASSWORD': self.__connection_password,
'CART_NUMBER': str(cart_number)
}
#
# Fetch the XML
#
r=requests.post(self.__connection_url,data=postdata)
if(r.status_code!=requests.codes.ok):
r.raise_for_status()
#
# Generate the output dictionary
#
fields={
'code': 'string',
'description': 'string'
}
handler=RivWebPyApi_ListHandler(base_tag='schedCode',fields=fields)
xml.sax.parseString(r.text,handler)
return handler.output()
def ListGroup(self,group_name):
"""
Returns a list of Rivendell groups (dictionary).

View File

@ -21,6 +21,7 @@
## Use automake to process this into a Makefile.in
EXTRA_DIST = list_cart.py\
list_cart_sched_codes.py\
list_carts.py\
list_group.py\
list_groups.py\

0
apis/rivwebpyapi/tests/list_cart.py Normal file → Executable file
View File

View File

@ -0,0 +1,69 @@
#!%PYTHON_BANGPATH%
# list_cart_sched_codes.py
#
# RivWebPyApi test script for Rivendell
#
# Test the ListCartSchedCodes Web API call
#
# (C) Copyright 2021 Fred Gleason <fredg@paravelsystems.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
import getpass
import rivwebpyapi
import sys
url='';
username=''
password=''
cart_number=0
include_cuts=False
#
# Get login parameters
#
usage='list_cart_sched_codes --url=<rd-url> --username=<rd-username> --cart-number=<num> [--password=<passwd>]'
for arg in sys.argv:
f0=arg.split('=')
if(len(f0)==2):
if(f0[0]=='--url'):
url=f0[1]
if(f0[0]=='--username'):
username=f0[1]
if(f0[0]=='--password'):
password=f0[1]
if(f0[0]=='--cart-number'):
cart_number=int(f0[1])
if(not password):
password=getpass.getpass()
if((not url)or(not username)):
print(usage)
sys.exit(1)
#
# Get the code list
#
webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password)
codes=webapi.ListCartSchedCodes(cart_number=cart_number)
#
# Display the code list
#
for code in codes:
print('code: '+str(code['code']))
print('description: '+str(code['description']))
print('')