992 lines
28 KiB
HTML
992 lines
28 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Request Order Assistance (QMARQSOA) API</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<!-- QMARQSOA SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
|
<!-- at RCHVMW2 on 7 Oct 1998 at 19:56:26 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- Edited by Kersten Jan 02 -->
|
|
<!--End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!-- Java sync-link -->
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>Request Order Assistance (QMARQSOA) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Output order ID</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="20%">Char(31)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Input order ID</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(31)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Send or receive option</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Contact information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Configuration file</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Network address</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Request information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">System information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Request Order Assistance (QMARQSOA) API sends a request for order
|
|
assistance to a service provider using an ECS connection. This API also creates
|
|
a corresponding entry in the user's order log. Optionally, a system
|
|
configuration file can be sent along with the order assistance request. This
|
|
file will help the service provider to find the best solution to the customer's
|
|
needs.</p>
|
|
|
|
<br>
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Output order ID</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(31)
|
|
|
|
<p>The order identifier of the order log entry that was created or appended
|
|
to.</p>
|
|
|
|
<p><strong>Note:</strong> If only a configuration file was sent without any
|
|
request information, this variable is set to blanks.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Input order ID</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(31)
|
|
|
|
<p>When appending to a previous order assistance request, this is the order ID
|
|
of the request to append to. If the order ID does not exist in the order
|
|
database, a new request will be created with this order ID.</p>
|
|
|
|
<p><strong>Note:</strong> If the input order ID is set to blanks, a new order
|
|
assistance request will be created with a system-generated order ID.</p>
|
|
|
|
<p>The input order ID must be in the following format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top">Displayable order ID</td>
|
|
<td align="left" valign="top">CHAR(10)
|
|
|
|
<p>The order ID as it is shown on the Work with Order Requests (WRKORDRQS) main
|
|
display. <strong>Note:</strong> It is recommended that all characters in the
|
|
displayable order ID be from the invariant character set.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Origin network address</td>
|
|
<td align="left" valign="top">CHAR(21)<br>
|
|
The network address of the system from which this order assistance request
|
|
originated. The origin network address must be in the following format:
|
|
|
|
<table cellpadding="5">
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type of network address</em></td>
|
|
<td align="left" valign="top">CHAR(1)<br>
|
|
Currently, only SNA addresses are supported by this API. Therefore, the only
|
|
valid value for this field is 1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Network address</em></td>
|
|
<td align="left" valign="top">CHAR(20)
|
|
|
|
<p>The SNA address must be in the following format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<tr>
|
|
<td align="left" valign="top"><em>Network ID</em></td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Control Point</em></td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Reserved</em></td>
|
|
<td align="left" valign="top">CHAR(4)
|
|
|
|
<p>The reserved field must be set to blanks.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Send or receive option</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>Whether this order request is sent to the specified address, or was received
|
|
from the specified address.</p>
|
|
|
|
<p>Values allowed for this field are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The order assistance request is sent to the specified network
|
|
address. If either requester or contact information are provided, this order
|
|
entry will be appended to the order log of the local machine before being
|
|
sent.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The order assistance request was received from the specified
|
|
network address. An order log entry is appended to the order log of the local
|
|
machine, showing that the request was received from the specified network
|
|
address.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Contact information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The name, phone number, fax number, and address that the service provider
|
|
should use to contact the service requester. The customer number should also be
|
|
associated with this request.</p>
|
|
|
|
<p>The contact information must be in the following format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top">Number of variable length records</td>
|
|
<td align="left" valign="top">BINARY(4)
|
|
|
|
<p>Total number of all of the variable length records.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Variable length records</td>
|
|
<td align="left" valign="top">CHAR(*)
|
|
|
|
<p>The contact information attributes and their values. For more information on
|
|
variable length records, see <a href="#HDRFORVAR">Format for Variable Length
|
|
Record</a>. For information on specific key values, see <a href="#HDRCONINK">
|
|
Contact Information Keys</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Note:</strong> The number of variable length records must be set to
|
|
0 if the user wants to do both of the following:</p>
|
|
|
|
<ul>
|
|
<li>Send ONLY a system configuration file.</li>
|
|
|
|
<li>Not create an order log entry.</li>
|
|
</ul>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Configuration file</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the system configuration file to be sent with this order
|
|
assistance request.</p>
|
|
|
|
<p>The following special values are allowed:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LOCAL</em></td>
|
|
<td align="left" valign="top">A new system configuration file is created and sent with this
|
|
order assistance request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No system configuration file is sent with this order
|
|
assistance request.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If the configuration file sent already exists on the machine this order
|
|
assistance request is sent to, the file is overwritten by the new one.</p>
|
|
|
|
<p><strong>Notes:</strong></p>
|
|
|
|
<ol>
|
|
<li>In order to be unique, the configuration file name is made up of the letter
|
|
"Q" followed by:
|
|
|
|
<ul>
|
|
<li>The 2 character manufacture ID.</li>
|
|
|
|
<li>The 7 character serial number of the machine it was created on.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>It is possible to send ONLY a configuration file without creating an order
|
|
log entry. To do this, the values for the number of variable length records for
|
|
the contact information and request information parameters must be set to
|
|
0.</li>
|
|
</ol>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Network address</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The network address to which this order assistance request should be sent,
|
|
or the network address from which the order assistance request was
|
|
received.</p>
|
|
|
|
<p>The network address must be in the following format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top">Type of network address</td>
|
|
<td align="left" valign="top">BINARY(4)<br>
|
|
Currently, only SNA addresses are supported by this API. Therefore, the only
|
|
valid value for this field is 1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Length of network address</td>
|
|
<td align="left" valign="top">BINARY(4)<br>
|
|
The number of characters in the address.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Network address</td>
|
|
<td align="left" valign="top">CHAR(*)
|
|
|
|
<p>The following special value is allowed:</p>
|
|
|
|
<table cellpadding="5">
|
|
<tr>
|
|
<td valign="top"><em>*IBMSRV</em></td>
|
|
<td valign="top">The order assistance request is sent to IBM
|
|
through an ECS connection to the RETAIN<sup>(R)</sup> technical information network.</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"></td>
|
|
<td align="left" valign="top">The SNA address must be in the following format:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="5">
|
|
<tr>
|
|
<td valign="top"><em>Network ID</em></td>
|
|
<td valign="top">CHAR(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Control Point</em></td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> Any destination other than IBM must be running job
|
|
QECS in order to successfully receive the order assistance request.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Request information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>Information about the order assistance request. This includes both a short
|
|
and a detailed description of the request.</p>
|
|
|
|
<p>The information must be in the following format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top">Number of variable length records</td>
|
|
<td align="left" valign="top">BINARY(4)<br>
|
|
Total number of all of the variable length records.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Variable length records</td>
|
|
<td align="left" valign="top">CHAR(*)<br>
|
|
The order request descriptions and their values.
|
|
|
|
<p>For more information on variable length records, see <a href="#HDRFORVAR">
|
|
Format for Variable Length Record</a>. For information on specific key values,
|
|
see <a href="#HDRREQIKY">Request Information Keys</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> The number of variable length records must be set to
|
|
0 if the user wants to do both of the following:</p>
|
|
|
|
<ul>
|
|
<li>Send ONLY a system configuration file.</li>
|
|
|
|
<li>Not create an order log entry.</li>
|
|
</ul>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>System information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>Information about the system that this order assistance request originated
|
|
on.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top">Number of variable length records</td>
|
|
<td align="left" valign="top">BINARY(4)<br>
|
|
Total number of all of the variable length records.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Variable length records</td>
|
|
<td align="left" valign="top">CHAR(*)<br>
|
|
The system information attributes and their values. For more information on
|
|
variable length records, see <a href="#HDRFORVAR">Format for Variable Length
|
|
Record</a>. For information on specific key values, see <a href="#HDRSYIKY">
|
|
System Information Keys</a>.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> This variable is necessary if the user wants to
|
|
specify system information for a system other than the one the API is executed
|
|
on. Otherwise, the number of variable length records must be set to 0.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRFORVAR">Format for Variable Length Record</a></h3>
|
|
|
|
<p>See <a href="#FIELD_DESC">Field Descriptions</a> for descriptions of these
|
|
fields.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Length of variable length record</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Attribute key</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of data</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Data</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If the length of the data is longer then the key field's maximum data
|
|
length, the data will be truncated. No message will be issued.</p>
|
|
|
|
<p>If the length of the data is smaller than the key identifier's data length,
|
|
the data will be padded with blanks at the right. No message will be
|
|
issued.</p>
|
|
|
|
<p>It is not an error to specify a key more than once. If duplicate keys are
|
|
specified, the last specified value for that key is used.</p>
|
|
|
|
<p>Each variable length record must be 4-byte aligned. If not, unpredictable
|
|
results may occur.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="FIELD_DESC">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Attribute key.</strong> The attribute to be set.</p>
|
|
|
|
<p><strong>Data.</strong> The repository for specific attribute
|
|
information.</p>
|
|
|
|
<p><strong>Length of data.</strong> The length of the value specified in the
|
|
Data field.</p>
|
|
|
|
<p><strong>Length of variable length record.</strong> The length of the entire
|
|
variable length record, including this field.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRCONINK">Contact Information Keys</a></h3>
|
|
|
|
<p>The following table describes the valid contact information keys. Keys 1 and
|
|
2 are required keys. If keys 3 through 12 are not specified, they default to
|
|
blanks. See <a href="#KEY_DESC3">Key Descriptions</a> for descriptions of these
|
|
keys.</p>
|
|
|
|
<table border width="80%">
|
|
<!-- cols="10 20 70" -->
|
|
<tr>
|
|
<th align="left" valign="top">Key</th>
|
|
<th align="left" valign="top">Size</th>
|
|
<th align="left" valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1</td>
|
|
<td align="left" valign="top">CHAR(36)</td>
|
|
<td align="left" valign="top">Contact name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">2</td>
|
|
<td align="left" valign="top">CHAR(30)</td>
|
|
<td align="left" valign="top">Telephone number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">3</td>
|
|
<td align="left" valign="top">CHAR(30)</td>
|
|
<td align="left" valign="top">Fax number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">Customer number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">5</td>
|
|
<td align="left" valign="top">CHAR(36)</td>
|
|
<td align="left" valign="top">Company name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">6</td>
|
|
<td align="left" valign="top">CHAR(48)</td>
|
|
<td align="left" valign="top">Street address line 1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">7</td>
|
|
<td align="left" valign="top">CHAR(48)</td>
|
|
<td align="left" valign="top">Street address line 2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">8</td>
|
|
<td align="left" valign="top">CHAR(48)</td>
|
|
<td align="left" valign="top">Street address line 3</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">9</td>
|
|
<td align="left" valign="top">CHAR(48)</td>
|
|
<td align="left" valign="top">City/State</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">10</td>
|
|
<td align="left" valign="top">CHAR(12)</td>
|
|
<td align="left" valign="top">Zip code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">11</td>
|
|
<td align="left" valign="top">CHAR(20)</td>
|
|
<td align="left" valign="top">Country or region</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">12</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User ID</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h4><a name="KEY_DESC3">Key Descriptions</a></h4>
|
|
|
|
<p><strong>City/state.</strong> The city and state the order should be sent
|
|
to.</p>
|
|
|
|
<p><strong>Note:</strong> The service provider receiving this request will only
|
|
be able to display the first 36 characters of this field.</p>
|
|
|
|
<p><strong>Company name.</strong> The name of the company as it appears on any
|
|
orders sent for this request.</p>
|
|
|
|
<p><strong>Contact name.</strong> The name of the person to contact about this
|
|
order assistance request.</p>
|
|
|
|
<p><strong>Note:</strong> The service provider receiving this request will only
|
|
be able to display the first 28 characters of this field.</p>
|
|
|
|
<p><strong>Country or region.</strong> The country or region to which the order
|
|
should be sent.</p>
|
|
|
|
<p><strong>Customer number.</strong> The customer number used for any orders
|
|
generated by this request.</p>
|
|
|
|
<p><strong>Fax number.</strong> The fax number of the person named in the
|
|
Contact Name field.</p>
|
|
|
|
<p><strong>Note:</strong> The service provider receiving this request will only
|
|
be able to display the first 19 characters of this field.</p>
|
|
|
|
<p><strong>Street address line 1.</strong> The first line in the street address
|
|
this order should be sent to.</p>
|
|
|
|
<p><strong>Note:</strong> The service provider receiving this request will only
|
|
be able to display the first 36 characters of this field.</p>
|
|
|
|
<p><strong>Street address line 2.</strong> The second line in the street
|
|
address this order should be sent to.</p>
|
|
|
|
<p><strong>Note:</strong> The service provider receiving this request will only
|
|
be able to display the first 36 characters of this field.</p>
|
|
|
|
<p><strong>Street address line 3.</strong> The third line in the street address
|
|
this order should be sent to.</p>
|
|
|
|
<p><strong>Note:</strong> The service provider receiving this request will only
|
|
be able to display the first 36 characters of this field.</p>
|
|
|
|
<p><strong>Telephone number.</strong> The telephone number of the person named
|
|
in the Contact Name field.</p>
|
|
|
|
<p><strong>Note:</strong> The service provider receiving this request will only
|
|
be able to display the first 19 characters of this field.</p>
|
|
|
|
<p><strong>User ID.</strong> The user ID of the person creating this
|
|
append.</p>
|
|
|
|
<p><strong>Note:</strong> If this parameter is not specified, the user ID
|
|
defaults to the user ID that the job is running under.</p>
|
|
|
|
<p><strong>Zip code.</strong> The zip code of where the order should be
|
|
sent.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRREQIKY">Request Information Keys</a></h3>
|
|
|
|
<p>The following table describes the valid request information keys. If keys 1
|
|
and 2 are not specified, they default to blanks. See <a href="#KEY_DESC2">Key
|
|
Descriptions</a> for descriptions of these keys.</p>
|
|
|
|
<table border width="80%">
|
|
<!-- cols="10 20 70" -->
|
|
<tr>
|
|
<th align="left" valign="top">Key</th>
|
|
<th align="left" valign="top">Size</th>
|
|
<th align="left" valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1</td>
|
|
<td align="left" valign="top">CHAR(40)</td>
|
|
<td align="left" valign="top">Short description of assistance request</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">2</td>
|
|
<td align="left" valign="top">CHAR(714)</td>
|
|
<td align="left" valign="top">Detailed description of assistance request</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h4><a name="KEY_DESC2">Key Descriptions</a></h4>
|
|
|
|
<p><strong>Detailed description of assistance request.</strong> A full
|
|
explanation of the order assistance request. The length of this field must be
|
|
less than 714 characters.</p>
|
|
|
|
<p><strong>Short description of assistance request.</strong> A summary of the
|
|
order assistance request. The contents of this field will appear as the
|
|
description in the order log. The length of this field must be less than 40
|
|
characters.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRSYIKY">System Information Keys</a></h3>
|
|
|
|
<p>The following table describes the valid system information keys. See <a
|
|
href="#KEY_DESC">Key Descriptions</a> for descriptions of these keys.</p>
|
|
|
|
<table border width="80%">
|
|
<!-- cols="10 20 70" -->
|
|
<tr>
|
|
<th align="left" valign="top">Key</th>
|
|
<th align="left" valign="top">Size</th>
|
|
<th align="left" valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">1</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Serial number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">2</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">System type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">3</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Model number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Country or region code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">5</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Language code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">6</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">CCSID</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h4><a name="KEY_DESC">Key Descriptions</a></h4>
|
|
|
|
<p><strong>CCSID.</strong> The CCSID the data is in.</p>
|
|
|
|
<p>If this key is not specified, the CCSID of the job sending this order
|
|
assistance request is used.</p>
|
|
|
|
<p><strong>Country or region code.</strong> The country or region code of the
|
|
job that originated this order assistance request. If this key is not
|
|
specified, the country or region code of the job sending this order assistance
|
|
request will be used.</p>
|
|
|
|
<p><strong>Language code.</strong> The language code of the job that originated
|
|
this order assistance request.</p>
|
|
|
|
<p>If this key is not specified, the language code of the job sending this
|
|
order assistance request will be used.</p>
|
|
|
|
<p><strong>Model number.</strong> The model number of the machine that
|
|
originated this order assistance request.</p>
|
|
|
|
<p>If this key is not specified, the model number of the machine sending this
|
|
order assistance request is used.</p>
|
|
|
|
<p><strong>Serial number.</strong> The serial number of the machine that
|
|
originated this order assistance request. The serial number is made up of the
|
|
2-digit manufacture ID, followed by a dash, followed by the 7-digit sequential
|
|
machine serial number.</p>
|
|
|
|
<p>If this key is not specified, the serial number of the machine sending this
|
|
order assistance request will be used.</p>
|
|
|
|
<p><strong>System type.</strong> The system type of the machine that originated
|
|
this order assistance request.</p>
|
|
|
|
<p>If this key is not specified, the system type of the machine sending this
|
|
order assistance request will be used.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td align="left" valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td align="left" valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D51 E</td>
|
|
<td align="left" valign="top">The input order ID parameter is a required parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D52 E</td>
|
|
<td align="left" valign="top">&1 is not a valid value for the logging option
|
|
parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D53 E</td>
|
|
<td align="left" valign="top">Contact name and telephone number are required contact
|
|
information fields.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D54 E</td>
|
|
<td align="left" valign="top">&1 is not a valid number of contact information
|
|
fields.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D55 E</td>
|
|
<td align="left" valign="top">&1 is not a valid value for the contact information
|
|
key.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D56 E</td>
|
|
<td align="left" valign="top">&1 is not a valid value for the configuration file
|
|
parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D57 E</td>
|
|
<td align="left" valign="top">The input order ID parameter is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D58 E</td>
|
|
<td align="left" valign="top">&1 is not a valid value for network address type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D59 E</td>
|
|
<td align="left" valign="top">&1 is not a valid value for network address length.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D60 E</td>
|
|
<td align="left" valign="top">&1 is not a valid number of request information
|
|
fields.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D61 E</td>
|
|
<td align="left" valign="top">&1 is not a valid request information key.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D62 E</td>
|
|
<td align="left" valign="top">&1 is not a valid number of system information
|
|
fields.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D63 E</td>
|
|
<td align="left" valign="top">&1 is not a valid system information key.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7D64 E</td>
|
|
<td align="left" valign="top">System configuration file not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V3R1
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"sw1.htm">Software Product APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|