| 1 | Output order ID | Output | Char(31) |
| 2 | Input order ID | Input | Char(31) |
| 3 | Send or receive option | Input | Binary(4) |
| 4 | Contact information | Input | Char(*) |
| 5 | Configuration file | Input | Char(10) |
| 6 | Network address | Input | Char(*) |
| 7 | Request information | Input | Char(*) |
| 8 | System information | Input | Char(*) |
| 9 | Error code | I/O | Char(*) |
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.
None.
The order identifier of the order log entry that was created or appended to.
Note: If only a configuration file was sent without any request information, this variable is set to blanks.
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.
Note: If the input order ID is set to blanks, a new order assistance request will be created with a system-generated order ID.
The input order ID must be in the following format:
| Displayable order ID | CHAR(10)
The order ID as it is shown on the Work with Order Requests (WRKORDRQS) main display. Note: It is recommended that all characters in the displayable order ID be from the invariant character set. |
||||||||||
| Origin network address | CHAR(21) The network address of the system from which this order assistance request originated. The origin network address must be in the following format:
|
Whether this order request is sent to the specified address, or was received from the specified address.
Values allowed for this field are:
| 0 | 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. |
| 1 | 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. |
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.
The contact information must be in the following format:
| Number of variable length records | BINARY(4)
Total number of all of the variable length records. |
| Variable length records | CHAR(*)
The contact information attributes and their values. For more information on variable length records, see Format for Variable Length Record. For information on specific key values, see Contact Information Keys. |
Note: The number of variable length records must be set to 0 if the user wants to do both of the following:
The name of the system configuration file to be sent with this order assistance request.
The following special values are allowed:
| *LOCAL | A new system configuration file is created and sent with this order assistance request. |
| *NONE | No system configuration file is sent with this order assistance request. |
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.
Notes:
The network address to which this order assistance request should be sent, or the network address from which the order assistance request was received.
The network address must be in the following format:
| Type of network address | BINARY(4) Currently, only SNA addresses are supported by this API. Therefore, the only valid value for this field is 1. |
||||
| Length of network address | BINARY(4) The number of characters in the address. |
||||
| Network address | CHAR(*)
The following special value is allowed:
|
||||
The SNA address must be in the following format:
|
Note: Any destination other than IBM must be running job QECS in order to successfully receive the order assistance request.
Information about the order assistance request. This includes both a short and a detailed description of the request.
The information must be in the following format:
| Number of variable length records | BINARY(4) Total number of all of the variable length records. |
| Variable length records | CHAR(*) The order request descriptions and their values. For more information on variable length records, see Format for Variable Length Record. For information on specific key values, see Request Information Keys. |
Note: The number of variable length records must be set to 0 if the user wants to do both of the following:
Information about the system that this order assistance request originated on.
| Number of variable length records | BINARY(4) Total number of all of the variable length records. |
| Variable length records | CHAR(*) The system information attributes and their values. For more information on variable length records, see Format for Variable Length Record. For information on specific key values, see System Information Keys. |
Note: 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.
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
See Field Descriptions for descriptions of these fields.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of variable length record |
| 4 | 4 | BINARY(4) | Attribute key |
| 8 | 8 | BINARY(4) | Length of data |
| 12 | C | CHAR(*) | Data |
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.
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.
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.
Each variable length record must be 4-byte aligned. If not, unpredictable results may occur.
Attribute key. The attribute to be set.
Data. The repository for specific attribute information.
Length of data. The length of the value specified in the Data field.
Length of variable length record. The length of the entire variable length record, including this field.
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 Key Descriptions for descriptions of these keys.
| Key | Size | Description |
|---|---|---|
| 1 | CHAR(36) | Contact name |
| 2 | CHAR(30) | Telephone number |
| 3 | CHAR(30) | Fax number |
| 4 | CHAR(7) | Customer number |
| 5 | CHAR(36) | Company name |
| 6 | CHAR(48) | Street address line 1 |
| 7 | CHAR(48) | Street address line 2 |
| 8 | CHAR(48) | Street address line 3 |
| 9 | CHAR(48) | City/State |
| 10 | CHAR(12) | Zip code |
| 11 | CHAR(20) | Country or region |
| 12 | CHAR(10) | User ID |
City/state. The city and state the order should be sent to.
Note: The service provider receiving this request will only be able to display the first 36 characters of this field.
Company name. The name of the company as it appears on any orders sent for this request.
Contact name. The name of the person to contact about this order assistance request.
Note: The service provider receiving this request will only be able to display the first 28 characters of this field.
Country or region. The country or region to which the order should be sent.
Customer number. The customer number used for any orders generated by this request.
Fax number. The fax number of the person named in the Contact Name field.
Note: The service provider receiving this request will only be able to display the first 19 characters of this field.
Street address line 1. The first line in the street address this order should be sent to.
Note: The service provider receiving this request will only be able to display the first 36 characters of this field.
Street address line 2. The second line in the street address this order should be sent to.
Note: The service provider receiving this request will only be able to display the first 36 characters of this field.
Street address line 3. The third line in the street address this order should be sent to.
Note: The service provider receiving this request will only be able to display the first 36 characters of this field.
Telephone number. The telephone number of the person named in the Contact Name field.
Note: The service provider receiving this request will only be able to display the first 19 characters of this field.
User ID. The user ID of the person creating this append.
Note: If this parameter is not specified, the user ID defaults to the user ID that the job is running under.
Zip code. The zip code of where the order should be sent.
The following table describes the valid request information keys. If keys 1 and 2 are not specified, they default to blanks. See Key Descriptions for descriptions of these keys.
| Key | Size | Description |
|---|---|---|
| 1 | CHAR(40) | Short description of assistance request |
| 2 | CHAR(714) | Detailed description of assistance request |
Detailed description of assistance request. A full explanation of the order assistance request. The length of this field must be less than 714 characters.
Short description of assistance request. 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.
The following table describes the valid system information keys. See Key Descriptions for descriptions of these keys.
| Key | Size | Description |
|---|---|---|
| 1 | CHAR(10) | Serial number |
| 2 | CHAR(10) | System type |
| 3 | CHAR(10) | Model number |
| 4 | CHAR(2) | Country or region code |
| 5 | CHAR(3) | Language code |
| 6 | BINARY(4) | CCSID |
CCSID. The CCSID the data is in.
If this key is not specified, the CCSID of the job sending this order assistance request is used.
Country or region code. 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.
Language code. The language code of the job that originated this order assistance request.
If this key is not specified, the language code of the job sending this order assistance request will be used.
Model number. The model number of the machine that originated this order assistance request.
If this key is not specified, the model number of the machine sending this order assistance request is used.
Serial number. 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.
If this key is not specified, the serial number of the machine sending this order assistance request will be used.
System type. The system type of the machine that originated this order assistance request.
If this key is not specified, the system type of the machine sending this order assistance request will be used.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF7D51 E | The input order ID parameter is a required parameter. |
| CPF7D52 E | &1 is not a valid value for the logging option parameter. |
| CPF7D53 E | Contact name and telephone number are required contact information fields. |
| CPF7D54 E | &1 is not a valid number of contact information fields. |
| CPF7D55 E | &1 is not a valid value for the contact information key. |
| CPF7D56 E | &1 is not a valid value for the configuration file parameter. |
| CPF7D57 E | The input order ID parameter is not valid. |
| CPF7D58 E | &1 is not a valid value for network address type. |
| CPF7D59 E | &1 is not a valid value for network address length. |
| CPF7D60 E | &1 is not a valid number of request information fields. |
| CPF7D61 E | &1 is not a valid request information key. |
| CPF7D62 E | &1 is not a valid number of system information fields. |
| CPF7D63 E | &1 is not a valid system information key. |
| CPF7D64 E | System configuration file not found. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| Top | Software Product APIs | APIs by category |