friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qedchgin.htm

663 lines
20 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>Change Contact Information (QEDCHGIN) 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. -->
<!-- Created for V5R4 on 041119 by cmwood -->
<!-- Change history: -->
<!-- 041119 CMWOOD New API -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2><img src="delta.gif" alt="Start of change">Change Contact Information (QEDCHGIN)
API</h2>
<div class="box" style="width: 90%;">
<br>
&nbsp;&nbsp;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%">Contact information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of contact information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</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>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>Change Contact Information (QEDCHGIN)</strong> API updates the contact information that is supplied to a service provider when a problem is reported or a PTF is requested.</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>
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Contact information </strong></dt>
<dd>INPUT; CHAR(*)
<p>The contact information that is changed.</p>
</dd>
<dt><strong>Length of contact information </strong></dt>
<dd>INPUT; BINARY(4)
<p>The total length in bytes of the contact information input variable.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the contact information input data. The possible values are:</p>
<dl>
<dt>CNTC0100</dt>
<dd>This format updates all of the contact information. See <a href="#FORMAT1">Format CNTC0100 </a> for details.</dd>
</dl>
</dd>
<dt><br><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>
<br>
<h3><a name="FORMAT1">CNTC0100 Format</a></h3>
<p>Use this format when changing contact information. For detailed descriptions of the fields in this table, see <a href="#FIELDDESC1">Field Descriptions</a></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="left" valign="bottom">Dec</th>
<th align="left" 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%">Char(36)</td>
<td align="left" valign="top" width="60%">Company name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">36</td>
<td align="center" valign="top" width="10%">24</td>
<td align="left" valign="top" width="20%">Char(36)</td>
<td align="left" valign="top" width="60%">Contact name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">72</td>
<td align="center" valign="top" width="10%">48</td>
<td align="left" valign="top" width="20%">Char(20)</td>
<td align="left" valign="top" width="60%">Primary telephone number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">92</td>
<td align="center" valign="top" width="10%">5C</td>
<td align="left" valign="top" width="20%">Char(20)</td>
<td align="left" valign="top" width="60%">Help desk or pager number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">112</td>
<td align="center" valign="top" width="10%">70</td>
<td align="left" valign="top" width="20%">Char(20)</td>
<td align="left" valign="top" width="60%">Primary fax number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">132</td>
<td align="center" valign="top" width="10%">84</td>
<td align="left" valign="top" width="20%">Char(20)</td>
<td align="left" valign="top" width="60%">Alternative fax number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">152</td>
<td align="center" valign="top" width="10%">98</td>
<td align="left" valign="top" width="20%">Char(36)</td>
<td align="left" valign="top" width="60%">Street address line 1</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">188</td>
<td align="center" valign="top" width="10%">BC</td>
<td align="left" valign="top" width="20%">Char(36)</td>
<td align="left" valign="top" width="60%">Street address line 2</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">224</td>
<td align="center" valign="top" width="10%">E0</td>
<td align="left" valign="top" width="20%">Char(36)</td>
<td align="left" valign="top" width="60%">Street address line 3</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">260</td>
<td align="center" valign="top" width="10%">104</td>
<td align="left" valign="top" width="20%">Char(36)</td>
<td align="left" valign="top" width="60%">City or locality</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">296</td>
<td align="center" valign="top" width="10%">128</td>
<td align="left" valign="top" width="20%">Char(36)</td>
<td align="left" valign="top" width="60%">State or province</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">332</td>
<td align="center" valign="top" width="10%">14C</td>
<td align="left" valign="top" width="20%">Char(20)</td>
<td align="left" valign="top" width="60%">Country or region</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">352</td>
<td align="center" valign="top" width="10%">160</td>
<td align="left" valign="top" width="20%">Char(12)</td>
<td align="left" valign="top" width="60%">Postal code</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">364</td>
<td align="center" valign="top" width="10%">16C</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
<td align="left" valign="top" width="60%">Offset to primary electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">368</td>
<td align="center" valign="top" width="10%">170</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
<td align="left" valign="top" width="60%">Length of primary electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">372</td>
<td align="center" valign="top" width="10%">174</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
<td align="left" valign="top" width="60%">Offset to alternative electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">376</td>
<td align="center" valign="top" width="10%">178</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
<td align="left" valign="top" width="60%">Length of alternative electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">380</td>
<td align="center" valign="top" width="10%">17C</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
<td align="left" valign="top" width="60%">Media for mailing PTFs</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">384</td>
<td align="center" valign="top" width="10%">180</td>
<td align="left" valign="top" width="20%">Char(10)</td>
<td align="left" valign="top" width="60%">National language version</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">*</td>
<td align="center" valign="top" width="10%">*</td>
<td align="left" valign="top" width="20%">Char(*)</td>
<td align="left" valign="top" width="60%">Primary electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">*</td>
<td align="center" valign="top" width="10%">*</td>
<td align="left" valign="top" width="20%">Char(*)</td>
<td align="left" valign="top" width="60%">Alternative electronic mail address</td>
</tr>
</table>
<br>
<br>
<h3><a name="FIELDDESC1">Field Descriptions</a></h3>
<p><strong>Alternative electronic mail address.</strong>
The electronic mail (e-mail) address where information for the person specified for the Contact can be sent, if the primary e-mail address is not available.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no alternative electronic mail address for the contact person.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the alternative electronic mail address.</td>
</tr>
</table>
<p><strong>Alternative fax number.</strong>
The complete telephone number where information for the Contact can be faxed, if the primary fax number is not available. This number should include the area code, exchange numbers, and the extension.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no alternative fax number for the contact person.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the alternative fax number.</td>
</tr>
</table>
<p><strong>City or locality.</strong>
The city or locality name for the location to which you want your service provider to send parts or assistance.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the city or locality.</td>
</tr>
</table>
<p><strong>Company name.</strong>
The name of the organization that owns or is responsible for this system. The name should appear in this field as it appears on a mailing label.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the company name.</td>
</tr>
</table>
<p><strong>Contact name.</strong>
The name of the person in your organization who is responsible for repairs and maintenance on the system. This person may be called by the service provider with information or assistance for a system problem. Also, parts or PTFs may be sent to this person.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the contact person's name.</td>
</tr>
</table>
<p><strong>Country or region.</strong>
The country or region where the company is located to which the service provider should send parts or assistance.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the country or region.</td>
</tr>
</table>
<p><strong>Help desk or pager number.</strong>
The complete Help desk or pager number. This number should include the area code, exchange numbers, and the extension.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no Help desk telephone number.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the Help desk telephone number.</td>
</tr>
</table>
<p><strong>Length of alternative electronic mail address.</strong>
The length of the alternative electronic mail address.
</p>
<p><strong>Length of primary electronic mail address.</strong>
The length of the primary electronic mail address.
</p>
<p><strong>Media for mailing PTFs.</strong>
The media currently used for mailing program temporary fixes (PTFs). The media options available are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0 = *SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1 = *AUTOMATIC</em></td>
<td align="left" valign="top">The system will automatically select the media to be used for sending PTFs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2 = *CDROM</em></td>
<td align="left" valign="top">PTFs will be sent on CD-ROM media.</td>
</tr>
</table>
<p><strong>National language version.</strong>
The national language version code currently being used for PTF cover letters. If the cover letter you ordered has not been translated into this language the cover letter will be sent in U.S. English.
</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PRIMARY</em></td>
<td align="left" valign="top">The language version for the currently installed primary national language on the system is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the preferred language version code to be used for PTF cover letters.</td>
</tr>
</table>
<p><strong>Offset to alternative electronic mail address.</strong>
The offset to the alternative electronic mail address.
</p>
<p><strong>Offset to primary electronic mail address.</strong>
The offset to the primary electronic mail address.
</p>
<p><strong>Postal code.</strong>
The Postal code for the location to which the service provider should send parts or assistance.
</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the Postal code.</td>
</tr>
</table>
<p><strong>Primary electronic mail address.</strong>
The electronic mail (e-mail) address where information for the person specified for the Contact can be sent.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no primary electronic mail address for the contact person.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the primary electronic mail address.</td>
</tr>
</table>
<p><strong>Primary fax number.</strong>
The complete telephone number where information for the Contact can be faxed. This number should include the area code, exchange numbers, and the extension</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no primary fax number for the contact person.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the primary fax number.</td>
</tr>
</table>
<p><strong>Primary telephone number.</strong>
The complete telephone number where the person named for the Contact may be reached most often. This number should include the area code, exchange numbers, and the extension.
</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the primary telephone number.</td>
</tr>
</table>
<p><strong>State or province.</strong>
The state or province names for the location to which you want your service provider to send parts or assistance.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no State or province.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the State or province.</td>
</tr>
</table>
<p><strong>Street address lines 1, 2 and 3.</strong>
The postal number and street name of the location to which you want your service provider to send parts or assistance for the problem. This should not be a post office box.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No additional street address information is provided. This value is valid for lines 2 and 3, but not for line 1.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the street address. Up to three lines of street address information can be specified. Each line is a separate parameter element, which can be up to 36 characters long.</td>
</tr>
</table>
<br>
<br>
<h3><a name="errmsg">Error Messages</a></h3>
<p>The following messages may be sent from this function:</p>
<table width="100%">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3CF1</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF2</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF3C19</td>
<td valign="top">Error occurred with receiver variable specified.</td>
</tr>
<tr>
<td valign="top">CPF3C21</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C24</td>
<td valign="top">Length of the receiver variable is not valid.</td>
</tr>
<tr>
<td valign="top">CPF8C83</td>
<td valign="top">One or more required fields to add contact information missing. See previous messages.</td>
</tr>
</table>
<br>
<br>
<img src="deltaend.gif" alt="End of change">
<hr>
API introduced: V5R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"pm1.htm">Problem Management APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue Copy Permalink