Send requests via HTTPS using request character strings shown below. GET or POST is supported. Sample forms for executing requests
Request example (for downloading PDF)
Send a request including the parameters described below at the URL of OPROARTS notified to you by OPRO.
| Parameter | Meaning | Explanation | Remarks |
|---|---|---|---|
| CID | Customer ID | Set the OPROARTS CID notified to you by OPRO. | * Required parameter |
| UID | User ID | Set the OPROARTS UID notified to you by OPRO. | * Required parameter |
| UPW | User password | Set the OPROARTS UPW notified to you by OPRO. | * Required parameter |
| OP | Operation | Specify one of the following parameters: dlo: Download an opr document. dlp: Download a pdf document. mlo: Send mail with an opr document attached (See also "Parameters for sending mail.") mlp: Send mail with a pdf document attached (See also "Parameters for sending mail.") dp: Direct print on a client PC. | * Required parameter |
| TP | Template name | Specify the name of a template (file that defines a form design) created by OPRO. In the case of multi-template (specifying multiple templates), enter, for example, TP(1), TP2, TP3, ... , TPn. * n: A template index (a serial number starting from 1) (Example) Multi-template using nouhin.oxt and seikyu.oxt TP1=nouhin&TP2=seikyu&TP3=nouhin&TP4=seikyu
* If multi-template is not used, you may omit the template index and simply set the parameter "TP." |
* Required parameter |
| TD | Text data set | Specify the content of text data (such as CSV) to be displayed in a form. Specify this item in a format compatible with the templates created by OPRO (delimiters, number of fields, etc.). The formats will be notified to you by OPRO. You can either specify the content of data as the TD values or upload a file in the multipart/form-data format. When uploading a file in the multipart/form-data format, set the file encoding to MS932. <Example of specifying the content of CSV as the TD values> - Content of CSV data field1-1,field2-1,field3-1 field1-2,field2-2,field3-2 field1-3,field2-3,field3-3 - Request content TD=field1-1%2Cfield2-1%2Cfield3-1%0D%0Afield1-2%2Cfield2-2%2Cfield3-2%0D%0Afield1-3%2Cfield2-3%2Cfield3-3
* %2C is a URL-encoded comma character ( , ).* %0D%0A is a URL-encoded linefeed character. To specify multiple text data sets, enter, for example, TD1, TD2, TD3, ..., TDn. * n: A text data set index (a serial number starting from 1) In the case of multi-template, enter, for example, TD1_1, TD1_2, TD2_1, TD2_2, TD2_3, TD3_1, ..., TDn_m. * n: Template index, m: Text data set index For example, "TD2_1" represents "the first text data set of a template specified with TP2." |
|
| RF | Refresh interval | Specify the refresh interval (seconds) of HTML to be returned from OPROARTS. Use this parameter mainly to handle a timeout of a Web browser. When this parameter is specified, an HTML response is received if the generation of a document on OPROARTS takes 30 seconds or longer, and automatic refresh continues at specified intervals (seconds). The document can be downloaded at the next refresh timing after the document (such as PDF) is generated on OPROARTS. |
|
| AC | Content of a file attached to a document | Specify the content of data to be attached to a document created by OPROARTS. You can either specify the content of text data as the AC values or upload a file in any format using the multipart/form-data format. To specify multiple data items, enter, for example, AC(1), AC2, AC3, ..., ACn. * n: An AC index (a serial number starting from 1) |
|
| ACN | File name to be used when attaching the content of AC to a document | Specify the name of a file to be used when attaching it using an AC parameter. * By default, a file name managed by the system is given. |
|
| ACC | Character code to be used to save a file when character strings are specified with AC | If Shift_JIS is specified, for example, the document is attached with Shift_JIS text data. To specify multiple data items, enter, for example, ACC(1), ACC2, ACC3, ..., ACCn. * n: An ACC index (a serial number starting from 1) |
|
| FE | Embedding of a font in PDF | Specify "true" to embed a font in PDF or "false" not to embed one. By default of this parameter, no font is embedded. | This parameter is effective only if the parameter "OP" is set to "dlp" or "mlp." |
These parameters are used if the parameter "OP" is set to "mlo" or "mlp."
| Parameter | Meaning | Explanation | Remarks |
|---|---|---|---|
| MT | Mail destination address | Specify a destination address of mail. To specify multiple destination addresses, enter the mail addresses delimited with a comma. |
* Required parameter |
| MCC | Mail destination address (CC) | Specify a destination address (CC) of mail. To specify multiple destination addresses (CC), enter the mail addresses delimited with a comma. |
|
| MBC | Mail destination address (BCC) | Specify a destination address (BCC) of mail. To specify multiple destination addresses (BCC), enter the mail addresses delimited with a comma. |
|
| MF | Mail source address | Specify a source address of mail. | * Required parameter |
| MSJ | Mail subject | Specify the subject of mail. | |
| MB | Mail message body | Specify the message body of mail. | |
| MA | Attachment file name | Specify the name of an attachment file. It is the name of an attachment file of a generated document. * By default, a file name managed by the system is given. |
|
| MR | Mail return address | Specify a return address of mail. | |
| MEF | Mail Envelope From | Specify "true" or "1" to use the mail source address specified in MF in Envelope From. If it is not specified or specified to be other than "true" or "1," the default value of the server is used. |
The request-response flow is as shown below when OPROARTS is used.
There are the following types of responses: