View Source

This page helps an Office of First Filing (OFF) that currently answers WIPO DAS over the legacy TDA/PDX 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:

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

TDA/PDX code	Status type	TDA/PDX meaning as supplied	REST `requestStatusCategory`	REST `statusMessage` to send	Notes
0	FWA-status, PDX-status	No Error / Successful	`success`	`ready for download` → `delivered` (two-stage)	Report `ready for download` once the file/URL is available, `delivered` once retrieved
1	FWA/PDX/DAS-status	Application number provided was not found	`error`	`document number not available`	This code may also represent "document withdrawn" or a generic missing-field condition — send the message matching the actual situation
2	FWA-status, PDX-status	File is not available	`error`	`document awaiting security clearance`	Closest available match; the REST vocabulary does not distinguish a temporary "awaiting clearance" from a permanent refusal
3	PDX-status	Documents was not found	`error`	`document incomplete`
4	FWA-status	Document content could not be retrieved	n/a	n/a	Not used in practice — TDA Error 3 covers the same situation
5	PDX-status	Not published, no authorization to permit access filed	`error`	`document awaiting security clearance`	Same REST phrase as code 2 — no separate "not authorized for public access" message exists
6	FWA-status	Delay in translation	n/a	n/a	Not used in practice
7	PDX-status	Oversize document/CD will be mailed	n/a	(no equivalent)	Not applicable under REST: large files are handled via presigned-URL upload/download
8	FWA-status	Request less than 1000 pages per transaction	n/a	n/a	Not used in practice — TDA code 7 is reported instead
9	DAS-status	Registered	n/a	n/a	Internal status only, not a counterpart reply code from an OFF
10	DAS-status	Not Registered	n/a	n/a	Internal only
11	PDX-status	Das Access Code invalid	`error`	`unmatched access code`
12	PDX-status	Request under processing, response sent later	`pending`	`awaiting off response`	Default pending state while the OFF works on the request
13	PDX-status	Application number does not correspond with bibliographic data	n/a	n/a	Rarely used
14	DAS-status	Successfully Registered DAS to OFF only	n/a	n/a	Registration-only — out of scope (this interface covers retrieval only)
15	DAS-status	Successfully Updated DAS to OFF only	n/a	n/a	Registration-only — out of scope
16	DAS-status	Das Access Code and Priority Date did not match	`error`	`unmatched document date and access code`
17	DAS-status	Priority Date did not match	`error`	`unmatched document date`
18	DAS-status	Das Access Code did not match	`error`	`unmatched access code`
19	DAS-status	Priority Date was not provided by OFF	`error`	`invalid document details`	Closest available match — there is no separate "missing" vs. "mismatched" date message
-1	FWA-fault, PDX-fault	System not available, scheduled downtime	(reported as a system error, not this vocabulary)	—	Use `code: TDA_SYSTEM_ERROR`, `message: "TDA SYSTEM ERROR"` on the request itself (HTTP 500)
-2	FWA-fault, PDX-fault	System not available, back-end problem	(reported as a system error, not this vocabulary)	—	Same as -1
-3	PDX-fault	Received document cannot be imported	n/a	(no equivalent)	No longer applicable: the REST interface exchanges plain identification data, not document content
-4	FWA-fault, PDX-fault	XML input processing failure	n/a	(no equivalent)	Same as -3
-5	FWA-fault, PDX-fault	XML output processing failure	n/a	(no equivalent)	Same as -3

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

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

Other examples of this shape:

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