Cancel
Input XML Tags
|
XML Tag |
Column Name |
Definition |
Rules |
|
comcorp |
corp |
Five digits |
five digit system number assigned to each corp. Numeric values only. |
|
house |
6 character field |
numeric, 6 digits |
|
|
cust |
2 character field |
numeric, 2 digits |
|
|
opr |
oprid |
3 character field |
Operator Id passed in to check if the task is executable by the Operator. |
|
custlevelpin |
4 character field |
Customer Pin number. Numeric values only. |
|
|
lockacct_pid |
5 character field |
5 character field |
5 digit unique locking pid (1,001 - 65, 535) (05-23-2001) |
|
jobtype |
N/A |
3 character field |
Identify which of the pending jobs the user wants to Cancel. Valid Values: WIP, T/C and SRO |
|
cancel_reason |
cancel_reason |
1 character field |
Code36 table (133 - Cancel Reason) valid values: 0-9, A-Z |
|
ord_comment |
cmmt |
350 character field |
Alpha-numeric, maximum charters = 350; amount of data stored dependent on cp_ordcommaxln field in GetControlParams transaction. |
|
cdwf_dflash |
350 characters maximum |
350 character field |
Alpha-numeric, maximum charters = 350; amount of data stored dependent on cp_wipcommaxln field in GetControlParams transaction. |
Output XML Tags
|
XML Tag |
Definition |
|
errorcode |
short |
|
errormessage |
char |
Change Log
|
5/23/01 |
Added lockacct_pid data field for locking functionality |
|
6/15/01 |
Updated Usage section for "non-pay disconnect" logic when performing a Cancel transaction |
|
8/24/01 |
Updated Rules section of document for clarity on ord_comment and cdwf_dflash tags |
Usage
The way to check to see if a P/DISC is a non-pay is to look at the "wdwo" flag in the WIP, if = 1 it is a non-pay.
Once this has been determined then the following logic should be used to determine if the Cancel API should be submitted:
IF orderparams.cxlnonpay flag = 1 (meaning the Corp allows a non-pay disc to be manually cancelled),
THEN IF opr.chgcoll = 1, continue with Cancel transaction
IF opr.chgcoll = 0, operator not allowed to cancel non-pay (because operator is not allowed to change collections information…canceling of non-pay will take account out of collections)
Associated XML Documents