Application related error messages will be passed as part of SOAP response. For FWA, status messages will be passed in the element fwa-request-status and for PDX, status messages will be passed in the element pdx-request-status. Table 4-1 lists the status messages.
System Error condition
| Status-code | System | Error condition | Error text |
|---|---|---|---|
| 0 | |||
| 1 | |||
| 2 | |||
| 3 | |||
| 4 | |||
| 5 | |||
| 6 | |||
| 7 | |||
0 FWA-status, PDX-status No Error Successful.
1 FWA-status, PDX-status, DAS-status Where application number requested was not found, or the format of the number makes the number unclear, or the number is not valid Where combination of requested application number and its bibliographic data does not match with that of the providing office Application number provided was not found.
2 FWA-status, PDX-status Where the requested application number exists, but no proper bib data is available; or Where the requested application number exists, but is not cleared for dissemination (e.g. security) File is not available.
3 PDX-status Where complete set of required documents (images) for certified copy is not available. Document(s) was not found.
4 FWA-status Document content variables are invalid. Therefore fail to retrieve document content. Document content could not be retrieved.
5 PDX-status Where the requested application exists, but is not published, and no Authorization to Permit Access has been filed File is not available to the public, and no authorization to permit access has been filed.
6 FWA-status Translation of data from native language to English takes longer than the predefined time Delay in translation
7 PDX-status Size of the PD exceeds the Oversize Document – CD will text predefined size, number of pages for transmission electronically through PDX (Current limit is 50 MB or 1000 pages) be mailed.
8 FWA-status Size of the document exceeds the predefined size for transmission electronically through TDA-FWA (Current limit is 1000 pages) Request less than 1000 pages per transaction.
9 DAS-status When the application references and the access code received by the OFF from DAS exist and are correct. Registered.
10 DAS-status When the application references and/or the access code received by the OFF from DAS do not match. Not Registered.
11 DAS-status Valid / Wrong format of Access Code ACC invalid.
12 PDX-status When the application is based on many foreign priority documents and response should wait manual process. The request is under processing, the response will be sent later.
13 PDX-status Only when application number does not correspond with bibliographic data.(Note:This code should not be used if there is not "cross-check-bib-data" element in the Pdrequest.) Application number does not correspond with bibliographic data.
14 DAS-status When the application information sent by OFF has successfully registered at DAS. (Note: Code for DasRegisterResponse. This code is sent only from DAS to OFF.) Successfully Registered.
15 DAS-status When the application information sent by OFF has successfully updated at DAS. (Note: Code for DasRegisterResponse. This code is sent only from DAS to OFF.) Successfully Updated.
16 DAS-status When the application number exists, but the access code and the priority date received by the OFF from DAS did not match. (Note: Code for PDResponse. This code is sent only from OFF to DAS, or from DAS to OSF.) ACC and Priority Date did not match.
17 DAS-status When the application number exists and the access code matches, but the priority date received by the OFF from DAS did not match. (Note: Code for PDResponse. This code is sent only from OFF to DAS, or from DAS to OSF.) Priority Date did not match.
18 DAS-status When the application number exists and the priority date matches, but the access code received by the OFF from DAS did not match. (Note: Code for PDResponse. This code is sent only from OFF to DAS, or from DAS to OSF.) ACC did not match.
19 DAS-status When the application information sent by OFF did not include Priority Date. (Note: Code for DasRegisterResponse. This code is sent only from DAS to OFF.) Priority Date was not provided by OFF.
Errors encountered during the processing of a service request are expected to be returned to the requesting client via the SOAP faults mechanism. In all the WSDLs defined so far a generic “invalidServerDataFault” with an error string message is sent back to the client for any errors encountered. “Error text” in Table 4-2 lists the fault messages used in the “error” element.
Status-System Error condition Error text
code
-1 FWA-fault, PDX-fault When backend system is not available due to scheduled downtime. System is not available due to scheduled downtime.
-2 FWA-fault, PDX-fault System is not available due to backend system problem System is not available due to system problem.
-3 PDX-fault The document is not in the proper requested format (i.e. html instead of PDF or TIFF). The received document can not be imported.
-4 FWA-fault, PDX-fault XML input processing failure, Root cause XML input processing failure, <Unmarshalling-Exception-Message>
-5 FWA-fault, PDX-fault XML output processing failure, Root cause XML output processing failure, <Marshalling-Exception-Message>