Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page covers the first hop: the raw numeric code a hosted helps an Office of First Filing 's (OFF) that currently answers WIPO DAS over the legacy TDA/PDX system sends back to WIPO DAS when DAS forwards it a live retrieval or registration-acknowledgement request.

...

XML protocol figure out what to return instead if it implements the modern "OFF Services" REST interface.

This only concerns the OFF↔DAS exchange. See 5.1.2.- Responses from DAS to OSF via notification endpoint and 5.1.3.- Responses from DAS to OSF via GET for what

...

reaches the requesting office (OSF)Sample exchange over the new REST interface

Instead of a numeric TDA/PDX code, an OFF implementing REST reports status with plain fields: 

Code Block
languagejson
themeDefault
POST /v1/requests/notifications
{
  "systemId": "<office code>",
  "notificationCategory": "document availability",
  "dateTime": "2026-02-25T12:23:24Z",
  "totalQuantity": 1,
  "documentNotificationRetrievalStatusBag": [
    {
      "requestAckId": "USIB20210523120902",
      "requestStatusCategory": "error",
      "errorCode": null,
      "statusMessage": "unmatched access code"
    }
  ]
}


TDA/PDX code → REST equivalent

Source of truth (code, not documentation): - das-app/src/app/das-tda-error-messages.ts — literal TDA/PDX message text - das-app/src/app/das-error-code-mappings.ts — the tdaSystemCodes[] arrays that map a TDA code to a DAS canonical message - das-app/src/app/das-error-codes.ts — the 6 top-level errorCode categories

...

TDA/PDX codeStatus typeTDA/PDX meaning as supplied
DAS canonical messageDAS sub-codeDAS errorCode category
REST requestStatusCategoryREST statusMessage to sendNotes
0FWA-status, PDX-statusNo Error / Successful
Successful.0SUCCESS
successready for download → delivered (two-stage)Report ready for download once the file/URL is available, delivered once retrieved
code 0 is reused for 0 / 14 / 15
1FWA/PDX/DAS-statusApplication number provided was not founderror
Application
document number
provided was
not
found.-4, -7, or -5 (see note)INVALID_INPUT_DATA or OPERATION_FORBIDDEN⚠️ Overloaded: the backend reuses TDA code 1 for three different outcomes depending on internal context: generic invalid input (-4), "document not found" (-7), and "document withdrawn" (-5, under OPERATION_FORBIDDEN)
availableThis code may also represent "document withdrawn" or a generic missing-field condition — send the message matching the actual situation
2FWA-status, PDX-statusFile is not available
File is not available. (security clearance not granted)-8
errordocument awaiting security clearanceClosest available match; the REST vocabulary does not distinguish a temporary "awaiting clearance" from a permanent refusal
OPERATION_FORBIDDEN
3PDX-statusDocuments was not found
Document(s) was not found.-9OPERATION_FORBIDDEN
errordocument incomplete
4FWA-statusDocument content could not be retrieved
—(not mapped)(none)
n/an/aNot used in practice — TDA Error
Not wired up in code; probably unused, as TDA
3 covers the same situation
5PDX-statusNot published, no authorization to permit access filed
File is not available to the public, and no authorization to permit access has been filed.-6
errordocument awaiting security clearanceSame REST phrase as code 2 — no separate "not authorized for public access" message exists
OPERATION_FORBIDDEN
6FWA-statusDelay in translation
—(not mapped)(none)Not wired up in code; probably never used (do not confuse with code -6 below, which is a different, negative code)-6(missing from the original table entirely)XML output processing failure (reused as a generic technical-error code)Duplicate document received / File already uploaded and registered-1 or -107INVALID_INPUT_DATA or OPERATION_FORBIDDEN⚠️ Actively used by the backend for two different outcomes (duplicate document vs. already-registered file), but was never documented on the old matching table
n/an/aNot used in practice
7PDX-statusOversize document/CD will be mailed
Oversize Document – CD will be mailed.-201OPERATION_IN_PROGRESSSee 5.1.2 — no EDI translation exists for this code, so it isn't actually forwarded via the notification webhook today
n/a(no equivalent)Not applicable under REST: large files are handled via presigned-URL upload/download
8FWA-statusRequest less than 1000 pages per transaction
—(not mapped)(none)
n/an/aNot used in practice
Not wired up; probably unused
— TDA code 7 is reported instead
9DAS-statusRegistered
—
n/an/a
DAS-internal
Internal status only, not a counterpart reply code from an OFF
10DAS-statusNot Registered
—
n/an/a
DAS-internal
Internal only
11PDX-statusDas Access Code invalid
ACC invalid.-4INVALID_INPUT_DATA
errorunmatched access code
12PDX-statusRequest under processing, response sent later
The request is under processing, the response will be sent later.-202OPERATION_IN_PROGRESSCode comment marks this "obsolete now... not implemented on DAS side, also we don't expect it from TDA side"
pendingawaiting off responseDefault pending state while the OFF works on the request
13PDX-statusApplication number does not correspond with bibliographic data
—(not mapped)
n/an/aRarely used
— DAS rejects an OSF request with mismatched data before it would reach this point
14DAS-statusSuccessfully Registered DAS to OFF only
Successfully Registered.0
n/an/aRegistration-only — out of scope (this interface covers retrieval only)
SUCCESS
15DAS-statusSuccessfully Updated DAS to OFF only
Successfully Updated.0
n/an/aRegistration-only — out of scope
SUCCESS
16DAS-statusDas Access Code and Priority Date did not match
ACC and Priority Date did not match.-15INVALID_INPUT_DATA
errorunmatched document date and access code
17DAS-statusPriority Date did not match
Priority Date did not match.-12INVALID_INPUT_DATA
errorunmatched document date
18DAS-statusDas Access Code did not match
ACC did not match.-14 or -13 (see note)INVALID_INPUT_DATA
errorunmatched access code
⚠️ Overloaded: same TDA code used both for "mismatched access code" (-14) and "missing access code" (-13)

19DAS-statusPriority Date was not provided by OFF
Priority Date was not provided by OFF.-13
errorinvalid document detailsClosest available match — there is no separate "missing" vs. "mismatched" date message
INVALID_INPUT_DATA
-1FWA-fault, PDX-faultSystem not available, scheduled downtime
System is not available due to scheduled downtime.-101
(reported as a system error, not this vocabulary)—Use code: TDA
DAS
_SYSTEM_ERROR, message: "TDA SYSTEM ERROR" on the request itself (HTTP 500)
-2FWA-fault, PDX-faultSystem not available, back-end problem
System is not available due to system problem.-101DAS_SYSTEM_ERROR
(reported as a system error, not this vocabulary)—Same as -1
-3PDX-faultReceived document cannot be imported
The received document can not be imported.-2INVALID_INPUT_DATA
n/a(no equivalent)No longer applicable: the REST interface exchanges plain identification data, not document content
Resolves to the "invalid document file format" sub-code, not a generic -3
-4FWA-fault, PDX-faultXML input processing failure
XML input processing failure-3INVALID_INPUT_DATACovers corrupted file / invalid ST.26 package / checksum mismatch / virus infected
n/a(no equivalent)Same as -3
-5FWA-fault, PDX-faultXML output processing failure
XML output processing failure-3INVALID_INPUT_DATAUsed specifically for the "file not available" sub-case

Known gaps / things to keep in mind when testing

...

n/a(no equivalent)Same as -3

Sample of a system-level error (request rejected before it is even processed)

Code Block
languagejson
themeDefault
{
  "code": "TDA_SYSTEM_ERROR",
  "message": "TDA SYSTEM ERROR",
  "details": [
    { "message": "Unexpected internal error", "code": 500 }
  ]
}

Other examples of this shape:

Code Block
languagejson
themeDefault
{
  "code": 400,
  "message": "Invalid input data or document",
  "errorMessage": "DAS Access Code cannot be blank"
}