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

* Added an 'UnassignSchedCode()' method to the 'rivwebpyapi' API.

Signed-off-by: Fred Gleason <fredg@paravelsystems.com>
This commit is contained in:
Fred Gleason
2021-12-06 16:30:33 -05:00
parent 0615903a32
commit 7df741b8a1
4 changed files with 103 additions and 2 deletions

View File

@@ -418,7 +418,7 @@ class rivwebpyapi(object):
def AssignSchedCode(self,cart_number,sched_code):
"""
Assigned a schedule code to a cart.
Assign a schedule code to a cart.
Takes the following arguments:
@@ -1344,3 +1344,38 @@ class rivwebpyapi(object):
'ErrorString': 'string'
}
handler=RivWebPyApi_ListHandler(base_tag='RDWebResult',fields=fields)
def UnassignSchedCode(self,cart_number,sched_code):
"""
Unassign a schedule code from a cart.
Takes the following arguments:
cart_number - The number of the desired cart, in the range
1 - 999999 (integer)
sched_code - An existing schedule code (integer).
"""
if((cart_number<1)or(cart_number>999999)):
raise ValueError('invalid cart number')
if(not sched_code):
raise ValueError('invalid schedule code')
#
# Build the WebAPI arguments
#
postdata={
'COMMAND': '26',
'LOGIN_NAME': self.__connection_username,
'PASSWORD': self.__connection_password,
'CART_NUMBER': str(cart_number),
'CODE': sched_code
}
#
# Fetch the XML
#
r=requests.post(self.__connection_url,data=postdata)
if(r.status_code!=requests.codes.ok):
r.raise_for_status()