{ "swagger": "2.0", "info": { "description": "Documents API for U.S. Tax Court EF-CMS", "version": "2019-03-06T15:30:48Z", "title": "dev-ef-cms", "contact": { "url": "https://www.ustaxcourt.gov", "email": "webmaster@ustaxcourt.gov" }, "license": { "name": "Creative Commons 0", "url": "https://creativecommons.org/share-your-work/public-domain/cc0/" } }, "host": "efcms-dev.ustc-case-mgmt.flexion.us", "tags": [ { "name": "ef-cms", "description": "EF-CMS" }, { "name": "documents", "description": "rawDocument service" } ], "schemes": ["https"], "paths": { "/api/court-issued-order": { "post": { "summary": "create a court issued order pdf preview", "description": "create a court issued order pdf preview.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/async/docket-record-pdf": { "post": { "summary": "create a pdf of the docket record for a case", "description": "create a pdf of the docket record for a case.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/api/notifications": { "get": { "tags": ["workitems"], "summary": "gets notifications such as unread item counts", "description": "Get notifications.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/notifications" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/system/maintenance-mode": { "get": { "tags": [], "summary": "get maintenance mode status", "description": "get maintenance mode status. \n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "type": "boolean" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/system/feature-flag/{featureFlag}": { "parameters": [ { "name": "featureFlag", "in": "path", "required": true, "type": "string" } ], "get": { "tags": [], "summary": "get feature flag value", "description": "get feature flag value.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "type": "boolean" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/pending-items": { "get": { "tags": [], "summary": "get all pending items", "description": "get all pending items.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/clerk-dashboard-stats": { "get": { "tags": [], "summary": "get clerk of court dashboard stats", "description": "get aggregated stats for the clerk of court dashboard.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/pending-report": { "get": { "summary": "create a pdf of the pending report", "description": "create a pdf of the pending report.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/pending-report/export": { "get": { "summary": "create a csv of the pending report", "description": "create a csv of the pending report.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/api/run-batch-process": { "post": { "summary": "run IRS batch process", "description": "Run the (temporary) send to IRS batch process, which creates a ZIP file of petition documents and uploads it to S3.\n", "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/policyUrl" } } }, "security": [ { "CognitoUserPool": [] } ] } }, "/api/swagger": { "get": { "produces": ["application/json"], "responses": { "200": { "description": "200 response" } } }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/api/swagger.json": { "get": { "produces": ["application/json"], "responses": { "200": { "description": "200 response" } } }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/trial-calendar-pdf": { "post": { "summary": "create a pdf of the trial session calendar", "description": "create a pdf of the trial session calendar.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases": { "get": { "tags": ["cases"], "summary": "Retrieve open and closed cases for the currently authenticated user", "description": "Retrieve open and closed cases for the currently authenticated user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "post": { "tags": ["cases"], "summary": "create a case", "description": "Create a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-parties/{docketNumber}/counsel/{userId}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "userId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "Updates the counsel on the case", "description": "Updates the counsel on the case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "delete": { "tags": ["cases"], "summary": "Deletes the counsel from the case", "description": "Deletes the counsel from the case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-parties/{docketNumber}/contact-primary": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "Updates the primary contact info on a case", "description": "Updates the primary contact info on a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-parties/{docketNumber}/contact-secondary": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "Updates the secondary contact info on a case", "description": "Updates the secondary contact info on a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases/paper": { "post": { "tags": ["cases"], "summary": "create a case from a paper submission", "description": "Create a case from a paper submission.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/api/cases/{docketNumber}/generate-docket-record": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "summary": "create a pdf of the docket record for a case", "description": "create a pdf of the docket record for a case.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/docket-entries/pending-motion": { "parameters": [ { "name": "judge", "in": "query", "required": false, "type": "string" } ], "get": { "tags": ["pending-motion"], "summary": "gets the pending motions associated to a judge", "description": "Gets the pending motions of a judge.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/pending-motion" } } }, "security": [ { "CognitoUserPool": [] } ] } }, "/docket-entry/{docketEntryId}/worksheet": { "parameters": [ { "name": "docketEntryId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "worksheet", "description": "data for the updated docket entry worksheet", "schema": { "$ref": "#/definitions/pending-motion-worksheet" } } ], "post": { "summary": "update a pending motion docket entry worksheet", "description": "Update a pending motion docket entry worksheet.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/pending-motion-worksheet" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/order-search": { "get": { "tags": ["order-search"], "summary": "search for an order-related document type by keyword within its title or contents", "description": "Search for an order-related document type by keyword within its title or contents.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/opinion-search": { "get": { "tags": ["opinion-search"], "summary": "search for an opinion-related document type by keyword within its title or contents", "description": "Search for an opinion-related document type by keyword within its title or contents.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/search": { "get": { "tags": ["cases"], "summary": "search for a case by name, country, state, and/or year filed", "description": "Search for a case by name, country, state, and/or year filed.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases/search": { "get": { "tags": ["cases"], "summary": "search for a case by name, country, state, and/or year filed", "description": "Search for a case by name, country, state, and/or year filed.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-worksheets": { "get": { "tags": ["cases"], "summary": "search for case worksheets by judge", "description": "Search for case worksheets by judge.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case-worksheet" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/blocked/{trialLocation}": { "parameters": [ { "name": "trialLocation", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get all blocked cases", "description": "get all blocked cases.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/case-inventory-report": { "parameters": [ { "name": "associatedJudge", "in": "query", "required": false, "type": "string" }, { "name": "from", "in": "query", "required": false, "type": "number" }, { "name": "pageSize", "in": "query", "required": false, "type": "number" }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get case inventory report", "description": "get case inventory report.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/printable-case-inventory-report": { "parameters": [ { "name": "associatedJudge", "in": "query", "required": false, "type": "string" }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "get": { "tags": ["cases"], "summary": "generate printable case inventory report", "description": "generate printable case inventory report.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases/{docketNumber}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get a case by docket number", "description": "Get a case by docket number.\n", "produces": ["application/json"], "parameters": [ { "name": "excludeDocketEntries", "in": "query", "required": false, "type": "string", "enum": ["true", "false"], "description": "When set to 'true', returns the case with an empty docketEntries array." } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "head": { "tags": ["cases"], "summary": "get a case existence by docket number", "description": "Get a case existence by docket number.\n", "produces": ["text/plain"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "tags": ["cases"], "summary": "update a case", "description": "Update a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } }, "422": { "description": "422 response", "schema": { "$ref": "#/definitions/unprocessableEntityError" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases/{docketNumber}/docket-entries": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get paginated docket entries for a case", "description": "Get paginated docket entries for a case, enriched with work item information.\n", "produces": ["application/json"], "parameters": [ { "name": "page", "in": "query", "required": false, "type": "integer", "default": 0, "minimum": 0, "maximum": 20, "description": "Zero-indexed page number. Page size is 1000 entries." } ], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/cases/{docketNumber}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get a case by docket number", "description": "Get a case by docket number.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/cases/{docketNumber}/docket-entries": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get paginated public docket entries for a case", "description": "Get paginated docket entries for a case (public, no authentication required).\n", "produces": ["application/json"], "parameters": [ { "name": "page", "in": "query", "required": false, "type": "integer", "default": 0, "minimum": 0, "maximum": 20, "description": "Zero-indexed page number. Page size is 1000 entries." } ], "responses": { "200": { "description": "200 response" } } }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/cases/{docketNumber}/generate-docket-record": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "initiate asynchronous generation of a public docket record PDF", "description": "Initiates asynchronous generation of a docket record PDF for a case (public, no authentication required). Returns a jobId for polling status.\n", "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response" } } }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/docket-record-status/{jobId}": { "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", "description": "The UUID job identifier returned from the generate-docket-record endpoint." } ], "get": { "tags": ["cases"], "summary": "get the status of a public docket record PDF generation job", "description": "Poll for the status of an asynchronous docket record PDF generation job. Returns 'pending', 'ready' (with a presigned URL), or 'error'.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } } }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/docket-number-search/{docketNumber}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get a case by docket number", "description": "Get a case by docketNumber.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/block": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "add a block to a case", "description": "add a block to a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "delete": { "tags": ["cases"], "summary": "removed the block from a case", "description": "removed the block from a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases/{docketNumber}/remove-pending/{docketEntryId}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "delete": { "tags": ["cases"], "summary": "removes a pending item from a case", "description": "removes a pending item from a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases/{docketNumber}/statistics/{statisticId}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "statisticId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "updates statistics on a case", "description": "updates statistics on a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "delete": { "tags": ["cases"], "summary": "removes a statistics entry off a case", "description": "removes a statistics entry off a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/other-statistics": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "update other statistics on a case", "description": "update other statistics on a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/statistics": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "add a statistic to a case", "description": "add a statistic to a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/case-context": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "Updates the caption, status, and judge on the given case.", "description": "Updates the caption, status, and judge on the given case.\n", "produces": ["application/json"], "consumes": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/consolidate-case": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "Consolidates two or more cases associated with the given docket number.", "description": "Consolidates two or more cases associated with the given docket number.\n", "produces": ["application/json"], "consumes": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "delete": { "parameters": [ { "name": "docketNumbersToRemove", "in": "query", "required": true, "type": "string" } ], "tags": ["cases"], "summary": "Unconsolidates the cases passed in the query string.", "description": "Unconsolidates the cases passed in the query string.\n", "produces": ["application/json"], "consumes": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/order-search": { "get": { "tags": ["case-documents"], "summary": "search for an order-related document type by keyword within its title or contents", "description": "Search for an order-related document type by keyword within its title or contents.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/external-document": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["documents"], "summary": "file a new external document on a case", "description": "Creates a new external document and attaches it to a case. It will also create a work item.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{documentContentsId}/document-contents": { "parameters": [ { "name": "documentContentsId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["case-documents"], "summary": "retrieves document contents for a given document contents id", "description": "Retrieves document's contents from S3 for a given ID.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/documentContents" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketEntryId}/append-pdf": { "parameters": [ { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["case-documents"], "summary": "appends a form pdf to the document with the corresponding docketEntryId", "description": "Appends a form pdf to the document with the corresponding docketEntryId.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/async/case-documents/{docketNumber}/paper-filing": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["documents"], "summary": "file a new paper docket entry on a case", "description": "Creates a new paper docket entry/document and attaches it to a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "tags": ["documents"], "summary": "updates a current paper docket entry on a case", "description": "Updates a paper docket entry/document and attaches it to a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/docket-entry-meta": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["documents", "docket record"], "summary": "Updates the docket entry meta data on a case", "description": "Updates the docket entry meta on a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/docket-entry-in-progress": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["documents"], "summary": "updates a current docket entry on a case that is in progress", "description": "Updates a docket entry on a case that is in progress.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/docket-entry-complete": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["documents"], "summary": "completes a docket entry on a case that was previously in progress", "description": "Completes a docket entry on a case that was previously in progress.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/strike": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["documents"], "summary": "strike a docket entry on the docket record", "description": "Strike a docket entry on the docket record.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/seal": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["documents"], "summary": "seals a docket entry on a case to the public", "description": "Seals a docket entry on a case to the public.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/docketEntry" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/unseal": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["documents"], "summary": "unseals a docket entry on a case", "description": "Unseals a docket entry on a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/docketEntry" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases/{docketNumber}/irsPetitionPackage": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "sends the case to the holding queue", "description": "Send a packaged case to the respondent.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } }, "422": { "description": "422 response", "schema": { "$ref": "#/definitions/unprocessableEntityError" } } }, "security": [ { "CognitoUserPool": [] } ] }, "delete": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "tags": ["cases"], "summary": "deletes the petition on the case from the holding queue", "description": "Deletes the petition on the case from the holding queue.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } }, "422": { "description": "422 response", "schema": { "$ref": "#/definitions/unprocessableEntityError" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/documents/upload-policy": { "get": { "tags": ["documents"], "summary": "create a pre-signed url for uploads", "description": "Create a pre-signed url for document uploads to S3.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/policyUrl" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "delete": { "tags": ["documents"], "summary": "deletes a document from a case", "description": "Deletes a document from a case and from S3.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } } }, "put": { "tags": ["documents"], "summary": "archives a document on a case, but does not delete it", "description": "Archives a document on a case, but does not delete it.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } } }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{key}/document-download-url": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "key", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["documents"], "summary": "redirects to the s3 url for downloading a document", "description": "Create and redirects the user to a pre-signed url for document downloads from S3.\n", "produces": ["application/json"], "responses": { "302": { "description": "302 response", "schema": { "$ref": "#/definitions/policyUrl" } } } }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/{docketNumber}/{key}/public-document-download-url": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "key", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["documents"], "summary": "redirects to the s3 url for downloading a public document", "description": "Create and redirects the user to a pre-signed url for document downloads from S3.\n", "produces": ["application/json"], "responses": { "302": { "description": "302 response", "schema": { "$ref": "#/definitions/policyUrl" } } } }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{key}/download-policy-url": { "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["documents"], "summary": "create a pre-signed url for downloads", "description": "Create a pre-signed url for document downloads from S3.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/policyUrl" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/health": { "get": { "tags": ["health"], "summary": "returns the health of various services", "description": "Returns the health of various services.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/health" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/documents/{key}/validate": { "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["documents"], "summary": "triggers the pdf validation function", "description": "Endpoint that triggers the PDF validation function for the specified document.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/irsPractitioners/{respondentId}/cases": { "parameters": [ { "name": "respondentId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get all cases for a user", "description": "Get all cases for a user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/sections/{section}/document-qc/inbox": { "parameters": [ { "name": "section", "in": "path", "required": true, "type": "string" }, { "name": "judgeUserName", "in": "query", "required": false, "type": "string" } ], "get": { "tags": ["workitems"], "summary": "get the section document qc inbox work items", "description": "get the section document qc inbox work items.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/sections/{section}/document-qc/served": { "parameters": [ { "name": "section", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["workitems"], "summary": "get the section document qc served work items", "description": "get the section document qc served work items.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/work-items": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["workitems"], "summary": "creates a new work item and attaches it to the case document", "description": "creates a new work item and attaches it to the case document\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/serve-court-issued": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "serves a court issued document", "description": "serves a court issued document\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/processing-status": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["case-documents"], "summary": "returns the coversheet processing status of a docket entry", "description": "returns the coversheet processing status of a docket entry. Used by the client to poll while a coversheet is being generated asynchronously.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "type": "object", "properties": { "processingStatus": { "type": "string" } } } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/serve": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "serves an externally-filed document", "description": "serves an externally-filed document\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/remove-pdf": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["case-documents"], "summary": "deletes the pdf from a given docket entry", "description": "Deletes the pdf from a given docket entry\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/sections/{section}/users": { "parameters": [ { "name": "section", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["workitems"], "summary": "get all users in a section", "description": "get all users in a section\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users": { "get": { "tags": ["user"], "summary": "gets user data", "description": "gets user data.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "post": { "tags": ["user"], "summary": "creates a user", "description": "creates a user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } }, "422": { "description": "422 response", "schema": { "$ref": "#/definitions/unprocessableEntityError" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/judges": { "post": { "tags": ["judges"], "summary": "creates a judge user", "description": "creates a judge user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/practitioners": { "parameters": [ { "name": "name", "in": "query", "required": true, "type": "string" } ], "get": { "tags": ["practitioners"], "summary": "gets a practitioner by name", "description": "Gets a practitioner by name.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "post": { "tags": ["practitioners"], "summary": "creates a practitioner user", "description": "creates a practitioner user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/practitioners/{userId}/printable-case-list": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["practitioners"], "summary": "generates a printable case list for the practitioner userId provided", "description": "Generates a printable case list for the practitioner userId provided.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/file" } } }, "security": [ { "CognitoUserPool": [] } ] } }, "/practitioners/{barNumber}": { "parameters": [ { "name": "barNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["practitioners"], "summary": "get the practitioner via bar number", "description": "Get the practitioner via bar number.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "tags": ["practitioners"], "summary": "updates a practitioner user", "description": "updates a practitioner user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/practitioners/{barNumber}/documents": { "parameters": [ { "name": "barNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["practitioners"], "summary": "get the practitioner's documents via bar number", "description": "Get the practitioner's documents via bar number.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/practitionerDocument" } } }, "security": [ { "CognitoUserPool": [] } ] }, "post": { "tags": ["practitioners"], "summary": "updates a practitioner user", "description": "updates a practitioner user.\n", "parameters": [ { "in": "body", "name": "practitioner document metadata", "description": "the trial session info needed to print a working copy", "schema": { "type": "object", "properties": { "categoryName": { "type": "string" }, "categoryType": { "type": "string" }, "description": { "type": "string" }, "fileName": { "type": "string" }, "location": { "type": "string" }, "practitionerDocumentFileId": { "type": "string" } }, "required": [ "categoryName", "categoryType", "fileName", "practitionerDocumentFileId" ] } } ], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/practitionerDocument" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/practitioner-documents/{practitionerDocumentFileId}/document-download-url": { "parameters": [ { "name": "practitionerDocumentFileId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["practitioners"], "summary": "Download an uploaded file via document file ID", "description": "Download an uploaded file via document file ID.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/policyUrl" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/internal": { "get": { "tags": ["workitems"], "summary": "get all internal users", "description": "get all internal users\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/{userId}/cases": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "get all cases for a user", "description": "Get all cases for a user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/{userId}/pending-email": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["user"], "summary": "get pending email for a user", "description": "Get pending email for a user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/{userId}/case/{docketNumber}": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" }, { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "submit a case association request for a private or IRS practitioner", "description": "Submit a case association request for a private or IRS practitioner..\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] } }, "/users/{userId}/case/{docketNumber}/pending": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" }, { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["cases"], "summary": "verify if user has pending association with the case", "description": "Verify if user has pending associationwith the case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "tags": ["cases"], "summary": "add pending association for practitioner for case if not associated with the case", "description": "Add pending association for practitioner for case if not associated with the case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/{userId}/contact-info": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["user"], "summary": "updates a user's contact information", "description": "updates a user's contact information.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/pending-email": { "put": { "tags": ["user"], "summary": "updates a user with a pending email", "description": "updates a user with a pending email.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/verify-email": { "put": { "tags": ["user"], "summary": "verifies a user's pending email with a token", "description": "verifies a user's pending email with a token.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/{userId}/document-qc/inbox": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["workitems"], "summary": "get the inbox items from the users document qc section", "description": "get the inbox items from the users document qc section\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/users/{userId}/document-qc/served": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["workitems"], "summary": "get the served items from the users document qc section", "description": "get the served items from the users document qc section\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/work-items": { "put": { "tags": ["workitems"], "summary": "assigns an assigneId to a list of work item ids", "description": "Get a workitem.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/work-items/{workItemId}": { "parameters": [ { "name": "workItemId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["workitems"], "summary": "get a workitem by workItemId", "description": "Get a workitem.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "tags": ["workitems"], "summary": "update a workitem by workItemId", "description": "Update a workitem.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/work-items/{workItemId}/assignee": { "parameters": [ { "name": "workItemId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["workitems"], "summary": "sets the assigneeId of the workitem to a new user", "description": "sets the assigneeId of the workitem to a new user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/work-items/{workItemId}/read": { "parameters": [ { "name": "workItemId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["workitems"], "summary": "marks the work item as read", "description": "marks the work item as read.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{motionDocketEntryId}/stamp": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "motionDocketEntryId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["docketentries"], "summary": "creates a stamped order.", "description": "creates a stamped order.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/{docketEntryId}/sign": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["documents"], "summary": "creates a copy of an existing document, adds a signature, and adds it to the associated case", "description": "creates a copy of an existing document, adds a signature, and adds it to the associated case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/work-items/{workItemId}/complete": { "parameters": [ { "name": "workItemId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["workitems"], "summary": "marks the workitem complete", "description": "marks the workitem complete.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/workItem" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/judges/{judgeId}/trial-sessions": { "parameters": [ { "name": "judgeId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["trialsessions"], "summary": "gets all trial sessions for a judge", "description": "gets all trial sessions for a judge.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] } }, "/trial-sessions/paper-service-pdf/{key}": { "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["trial-sessions"], "summary": "get download url for a previously generated paper service document", "description": "Get download url for a previously generated paper service document.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions": { "get": { "tags": ["trialsessions"], "summary": "gets all trial sessions", "description": "gets all trial sessions.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "post": { "tags": ["trialsessions"], "summary": "creates a new trial session", "description": "creates a new trial session.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "tags": ["trialsessions"], "summary": "updates a trial session", "description": "updates a trial session.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["trialsessions"], "summary": "gets a trial session", "description": "gets a trial session.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/printable-working-copy": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "trial session working copy info", "description": "the trial session info needed to print a working copy", "schema": { "$ref": "#/definitions/printableWorkingCopyData" } } ], "post": { "tags": ["trialsessions"], "summary": "generates a printable trial session copy report", "description": "generates a printable trial session copy report .\n", "produces": ["text/plain"], "responses": { "200": { "description": "200 response", "schema": { "type": "string", "example": "http://www.example.com" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/eligible-cases": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["trialsessions"], "summary": "gets eligible cases for a trial session", "description": "gets eligible cases for a trial session.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/set-calendar": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["trialsessions"], "summary": "sets the calendar for a trial session", "description": "sets the calendar for a trial session.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/generate-notices": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["trialsessions"], "summary": "generates notices of trial and standing pretrial document for cases within a given trial session and returns a PDF for any paper service parties associated", "description": "generates notices of trial and standing pretrial document for cases within a given trial session and returns a PDF for any paper service parties associated.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/getAssociatedCases": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["trialsessions"], "summary": "gets the cases associated with a trial session", "description": "gets the cases associated with a trial session.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/set-hearing/{docketNumber}": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" }, { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["trialsessions"], "summary": "adds the case to the given hearing", "description": "adds the case to the given hearing.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/remove-case/{docketNumber}": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" }, { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["trialsessions"], "summary": "removes a case from a trial session", "description": "removes a case from a trial session.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/cases/{docketNumber}": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" }, { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["trialsessions"], "summary": "adds a case to a trial session", "description": "adds a case to a trial session.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/reports/planning-report": { "post": { "summary": "create a pdf of the trial session planning report", "description": "create a pdf of the trial session planning report.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/court-issued-docket-entry": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "summary": "creates a docket entry for a court-issued document on the case", "description": "creates a docket entry for a court-issued document on the case.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "summary": "updates a docket entry for a court-issued document on the case", "description": "updates a docket entry for a court-issued document on the case.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/court-issued-order": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "summary": "files a court issued order on the case", "description": "files a court issued order on the case.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-documents/{docketNumber}/court-issued-orders/{docketEntryId}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "docketEntryId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "draft order", "description": "the draft order information", "schema": { "type": "object", "properties": { "documentMetadata": { "type": "object", "properties": { "docketNumber": { "type": "string" }, "documentTitle": { "type": "string" }, "documentType": { "type": "string" }, "draftOrderState": { "type": "object" }, "eventCode": { "type": "string" }, "richText": { "type": "string" } } } } } } ], "put": { "summary": "updates the draft court issued order", "description": "updates the draft court issued order.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/documents/filing-receipt-pdf": { "post": { "summary": "create a pdf receipt for filing a document or documents", "description": "create a pdf receipt for filing a document or documents.\n", "produces": ["application/pdf"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-deadlines": { "get": { "tags": ["caseDeadlines"], "summary": "get all case deadlines", "description": "get all case deadlines.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/caseDeadline" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-deadlines/{docketNumber}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["caseDeadlines"], "summary": "gets deadlines for a case", "description": "gets deadlines for a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/caseDeadline" } } }, "security": [ { "CognitoUserPool": [] } ] }, "post": { "tags": ["caseDeadlines"], "summary": "create and associate a deadline to a case", "description": "create and associate a deadline to a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/caseDeadline" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-deadlines/{docketNumber}/{caseDeadlineId}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "caseDeadlineId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["caseDeadlines"], "summary": "updates a case deadline", "description": "updates a case deadline.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSession" } } }, "security": [ { "CognitoUserPool": [] } ] }, "delete": { "tags": ["caseDeadlines"], "summary": "delete a case deadline", "description": "delete a case deadline.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response" } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-parties/{docketNumber}/case-details": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "updates the case details on the case", "description": "updates the case details on the case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-parties/{docketNumber}/petitioner-info": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "updates the petitioner information on the case", "description": "updates the petitioner information on the case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/qc-complete": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "trial session info", "description": "the trial session info needed to identify and update a trial session", "schema": { "type": "object", "properties": { "qcCompleteForTrial": { "type": "boolean" }, "trialSessionId": { "type": "string" } } } } ], "put": { "tags": ["cases"], "summary": "updates the case to be marked as QCed", "description": "updates the case to be marked as QCed.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/seal": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "updates the case as sealed", "description": "updates the case as sealed.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/seal-address/{contactId}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "contactId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "updates the specified case contact address as sealed", "description": "updates the case contact address as sealed.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/unseal-address/{contactId}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" }, { "name": "contactId", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "updates the specified case contact address as unsealed", "description": "updates the case contact address as unsealed.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-meta/{docketNumber}/add-petitioner,": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["cases"], "summary": "adds a petitioner to the case", "description": "adds a petitioner to the case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-parties/{docketNumber}/associate-private-practitioner": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "associates a practitioner with a case", "description": "associates a practitioner with a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-parties/{docketNumber}/associate-respondent": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "tags": ["cases"], "summary": "associates a respondent with a case", "description": "associates a respondent with a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/user" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/trial-sessions/{trialSessionId}/working-copy": { "parameters": [ { "name": "trialSessionId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["trialsessions"], "summary": "gets the trial session working copy for a trial session for the logged in user", "description": "gets the trial session working copy for a trial session for the logged in user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSessionWorkingCopy" } } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "tags": ["trialsessions"], "summary": "updates the trial session working copy for a trial session for the logged in user", "description": "updates the trial session working copy for a trial session for the logged in user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/trialSessionWorkingCopy" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-notes/{docketNumber}/user-notes": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["caseNotes"], "summary": "gets the logged in user's note for a case", "description": "gets the logged in user's note for a case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/userNote" } } }, "security": [ { "CognitoUserPool": [] } ] }, "post": { "tags": ["caseNotes"], "summary": "create and associate a note to a case for the logged in user", "description": "create and associate a note to a case for the logged in user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/userNote" } } }, "security": [ { "CognitoUserPool": [] } ] }, "put": { "tags": ["caseNotes"], "summary": "update a user's note for the logged in user", "description": "update a user's note for the logged in user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/userNote" } } }, "security": [ { "CognitoUserPool": [] } ] }, "delete": { "tags": ["caseNotes"], "summary": "delete the user's note for the logged in user", "description": "delete the user's note for the logged in user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/userNote" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/case-notes/{docketNumber}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "put": { "tags": ["caseNotes"], "summary": "update a case procedural note", "description": "update a case procedural note.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/caseNote" } } }, "security": [ { "CognitoUserPool": [] } ] }, "delete": { "tags": ["caseNotes"], "summary": "delete the case procedural note", "description": "delete the case procedural note.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/caseNote" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages": { "post": { "tags": ["messages"], "summary": "create a message", "description": "Create a message.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/{messageId}": { "parameters": [ { "name": "messageId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["messages"], "summary": "gets the message for the specific id", "description": "Gets the message for the specific id.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/inbox/{userId}": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["messages"], "summary": "gets the inbox messages for the specific user id", "description": "Gets the inbox messages for the specific user id.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/inbox/section/{section}": { "parameters": [ { "name": "section", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["messages"], "summary": "gets the inbox messages for the specific section", "description": "Gets the inbox messages for the specific user section.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/outbox/{userId}": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["messages"], "summary": "gets the outbox messages for the specific user id", "description": "Gets the outbox messages for the specific user id.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/outbox/section/{section}": { "parameters": [ { "name": "section", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["messages"], "summary": "gets the outbox messages for the specific section", "description": "Gets the outbox messages for the specific user section.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/completed/section/{sectionId}": { "parameters": [ { "name": "sectionId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["messages"], "summary": "gets the completed messages for the specific section", "description": "Gets the completed messages for the specific user section.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/completed/{userId}": { "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["messages"], "summary": "gets the completed messages for the specific user", "description": "Gets the completed messages for the specific user.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/case/{docketNumber}": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["messages"], "summary": "gets the messages for the specific case", "description": "Gets the messages for the specific case.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/{parentMessageId}/complete": { "post": { "tags": ["messages"], "summary": "complete a message", "description": "Complete a message.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "parameters": [ { "name": "parentMessageId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "message info", "description": "the message info", "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } ], "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/{parentMessageId}/reply": { "post": { "tags": ["messages"], "summary": "reply to a message", "description": "Reply to a message.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "parameters": [ { "name": "parentMessageId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "message info", "description": "the message info", "schema": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string" }, "documentTitle": { "type": "string" } } } }, "docketNumber": { "type": "string" }, "message": { "type": "string" }, "subject": { "type": "string" }, "toSection": { "type": "string" }, "toUserId": { "type": "string" } } } } ], "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/{parentMessageId}/forward": { "post": { "tags": ["messages"], "summary": "forward a message", "description": "Forward a message.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "parameters": [ { "name": "parentMessageId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "message info", "description": "the message info", "schema": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string" }, "documentTitle": { "type": "string" } } } }, "docketNumber": { "type": "string" }, "message": { "type": "string" }, "subject": { "type": "string" }, "toSection": { "type": "string" }, "toUserId": { "type": "string" } } } } ], "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/messages/{messageId}/read": { "post": { "tags": ["messages"], "summary": "marks a message as read", "description": "Marks a message as read.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/message" } } }, "security": [ { "CognitoUserPool": [] } ] }, "parameters": [ { "name": "messageId", "in": "path", "required": true, "type": "string" }, { "in": "body", "name": "docket number", "description": "the associated docket number", "schema": { "type": "object", "properties": { "docketNumber": { "type": "string" } } } } ], "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/todays-opinions": { "get": { "tags": ["case-documents"], "summary": "returns the opinions created for the current date", "description": "Returns the opinions created for the current date.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/public-api/todays-orders/{page}/{sortOrder}": { "parameters": [ { "name": "page", "in": "path", "required": true, "type": "string" }, { "name": "sortOrder", "in": "path", "required": true, "type": "string" } ], "get": { "tags": ["case-documents"], "summary": "returns the orders served on the current date", "description": "Returns the orders served on the current date.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/document" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/auth/login": { "delete": { "tags": ["auth"], "summary": "expires the refreshToken cookie by setting an old expiration date", "description": "Expires the refreshToken cookie by setting an old expiration date.\n", "produces": ["application/json"], "responses": { "204": { "description": "delete the refreshToken cookie", "headers": { "Set-Cookie": { "type": "string", "description": "an expired refreshToken cookie; the browser will delete this old cookie" } } } }, "security": [ { "CognitoUserPool": [] } ] }, "post": { "parameters": [ { "in": "body", "name": "the oauth2 authorization code", "description": "the oauth2 authorization code", "schema": { "type": "object", "properties": { "accessToken": { "type": "string" }, "idToken": { "type": "string" }, "refreshToken": { "type": "string" } } } } ], "tags": ["auth"], "summary": "logs user in and returns access, id, and refresh tokens", "description": "Logs user in and returns access, id, and refresh tokens. \n", "produces": ["application/json"], "responses": { "200": { "description": "access, id, and refresh tokens", "schema": { "$ref": "#/definitions/authorization" }, "headers": { "Set-Cookie": { "type": "string", "description": "the cookie that securly stores the refreshToken which can be used later when hitting the /auth/refresh endpoint" } } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/auth/refresh": { "post": { "parameters": [ { "in": "header", "name": "Cookie", "description": "the refreshToken cookie", "type": "string", "required": true } ], "tags": ["auth"], "summary": "uses the provided refreshToken cookie to generate a new access token", "description": "Uses the provided refreshToken cookie to generate a new access token.\n", "produces": ["application/json"], "responses": { "200": { "description": "the newly created access token", "schema": { "$ref": "#/definitions/accessToken" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } }, "/cases/{docketNumber}/case-worksheet": { "parameters": [ { "name": "docketNumber", "in": "path", "required": true, "type": "string" } ], "post": { "summary": "update a case worksheet", "description": "Update a case worksheet.\n", "produces": ["application/json"], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/case-worksheet" } } }, "security": [ { "CognitoUserPool": [] } ] }, "options": { "consumes": ["application/json"], "produces": ["application/json"], "responses": { "200": { "description": "200 response", "headers": { "Access-Control-Allow-Origin": { "type": "string" }, "Access-Control-Allow-Methods": { "type": "string" }, "Access-Control-Allow-Credentials": { "type": "string" }, "Access-Control-Allow-Headers": { "type": "string" } } } } } } }, "securityDefinitions": { "CognitoUserPool": { "type": "apiKey", "name": "Authorization", "in": "header", "x-amazon-apigateway-authtype": "cognito_user_pools" } }, "definitions": { "authorization": { "type": "object", "properties": { "accessToken": { "type": "string", "description": "the access token" }, "idToken": { "type": "string", "description": "the identification token" }, "refreshToken": { "type": "string", "description": "the refresh token" } } }, "accessToken": { "type": "object", "properties": { "token": { "type": "string", "description": "the access token" } } }, "file": { "type": "object", "properties": { "fileId": { "type": "string", "description": "the id of the file generated" }, "url": { "type": "string", "description": "the url for downloading the file" } } }, "health": { "type": "object", "properties": { "cognito": { "type": "boolean", "description": "the status of cognito ui" }, "elasticsearch": { "type": "boolean", "description": "the status of elasticsearch" }, "emailService": { "type": "boolean", "description": "the status of ses" }, "s3": { "type": "object", "properties": { "app": { "type": "boolean", "description": "the status of app bucket" }, "appFailover": { "type": "boolean", "description": "the status of app failover bucket" }, "eastDocuments": { "type": "boolean", "description": "the status of east documents bucket" }, "eastTempDocuments": { "type": "boolean", "description": "the status of east temp documents bucket" }, "public": { "type": "boolean", "description": "the status of public ui bucket" }, "publicFailover": { "type": "boolean", "description": "the status of public failover ui bucket" }, "westDocuments": { "type": "boolean", "description": "the status of west documents bucket" }, "westTempDocuments": { "type": "boolean", "description": "the status of west temp documents bucket" } } } } }, "policyUrl": { "type": "object", "properties": { "fields": { "$ref": "#/definitions/fields" }, "url": { "type": "string", "description": "url" } }, "description": "a policy url response" }, "documentContents": { "type": "object", "properties": { "documentContents": { "type": "string", "description": "plain text with line breaks for a an associated docket-entry's document contents" }, "richText": { "type": "string", "description": "rich text with line breaks for a an associated docket-entry's document contents" } }, "description": "a document contents response with both plain and rich-text" }, "document": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "date docket entry was created" }, "documentType": { "type": "string", "description": "type of this document" }, "filedBy": { "type": "boolean", "description": "the user name who filed the docket entry" }, "docketEntryId": { "type": "string", "description": "id of rawDocketEntry" }, "userId": { "type": "string", "description": "id of user who created the docket entry" }, "status": { "type": "string", "description": "the status of the docket entry" } }, "description": "a docket entry response" }, "unprocessableEntityError": { "type": "object", "required": ["message"], "properties": { "message": { "type": "string" } }, "description": "a unprocessable entity error (422), due to a problem in the body or the id in the url" }, "workItem": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "date workItem created" }, "assigneeName": { "type": "string", "description": "the name of the user currently assigned the work item" }, "document": { "type": "object", "properties": { "documentType": { "type": "string" }, "docketEntryId": { "type": "string" }, "createAt": { "type": "string" } } }, "messages": { "type": "array", "description": "array of messages associated with the workitem", "items": { "type": "object", "properties": { "messageType": { "type": "string" }, "messageId": { "type": "string" } } } }, "workItemId": { "type": "string", "description": "id of work item" }, "assigneeId": { "type": "string", "description": "id of user currently assigned the work item" }, "docketNumber": { "type": "string", "description": "date workItem created" }, "sentBy": { "type": "string", "description": "the user or system function that generate or sent this original work item" }, "updatedAt": { "type": "string", "description": "date workItem created" } }, "description": "a workItem response" }, "fields": { "type": "object", "properties": { "bucket": { "type": "string", "description": "The bucket name." }, "Policy": { "type": "string", "description": "The policy." }, "X-Amz-Date": { "type": "string", "description": "The date." }, "X-Amz-Algorithm": { "type": "string", "description": "The algorithm." }, "X-Amz-Signature": { "type": "string", "description": "The signature." }, "X-Amz-Security-Token": { "type": "string", "description": "The security token." }, "X-Amz-Credential": { "type": "string", "description": "The credential." } }, "description": "a policy url response" }, "notifications": { "type": "object", "properties": { "unreadCount": { "type": "number", "description": "unread work items" } }, "description": "a user object" }, "user": { "type": "object", "properties": { "userId": { "type": "string", "description": "the userId" } }, "description": "a user object" }, "case": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "date case created" }, "docketEntries": { "type": "array", "description": "array of rawDocketEntry ids and types associated with the case", "items": { "type": "object", "properties": { "documentType": { "type": "string" }, "workItem": { "type": "object", "properties": {} }, "docketEntryId": { "type": "string" } } } }, "respondent": { "type": "string", "description": "the respondent who is associated with the case" }, "petitioners": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" } } } }, "userId": { "type": "string", "description": "id of user who created the case" }, "docketNumber": { "type": "string", "description": "the unique docket number associated with the case" }, "status": { "type": "string", "description": "the status of the case" } }, "description": "a case response" }, "trialSession": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "date trial session created" }, "sessionType": { "type": "string", "description": "type of the session" }, "maxCases": { "type": "string", "description": "max number of cases on the session" }, "startDate": { "type": "string", "description": "start date of the session" }, "startTime": { "type": "string", "description": "start time of the session" }, "trialLocation": { "type": "string", "description": "location of the session" }, "trialSessionId": { "type": "string", "description": "id of trial session" } }, "description": "a trial session" }, "trialSessionWorkingCopy": { "type": "object", "properties": { "sort": { "type": "string", "description": "field to sort the cases by" }, "sortOrder": { "type": "string", "description": "sort order" }, "caseMetadata": { "type": "object", "description": "map of cases to trial statuses" }, "filters": { "type": "object", "description": "trial status filters with boolean values" }, "trialSessionId": { "type": "string", "description": "id of the trial session" } }, "description": "a trial session" }, "caseDeadline": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "case deadline created time" }, "docketNumber": { "type": "string", "description": "docket number of the case" }, "caseDeadlineId": { "type": "string", "description": "id of the case deadline" }, "deadlineDate": { "type": "string", "description": "date of the deadline" }, "description": { "type": "string", "description": "description of the deadline" } }, "description": "a case deadline" }, "pending-motion": { "type": "object", "properties": { "docketEntries": { "type": "array", "items": { "type": "object", "properties": { "daysSinceCreated": { "type": "number", "description": "Number of days since the pending motion has been created" }, "caseCaption": { "type": "string", "description": "Case caption from the docket entry's case" }, "consolidatedGroupCount": { "type": "number", "description": "Number of consolidated cases the docket entry's case is in" }, "leadDocketNumber": { "type": "number", "description": "Lead docket number" }, "docketEntryId": { "type": "string", "description": "Docket entry ID" }, "docketEntryWorksheet": { "type": "object", "properties": { "primaryIssue": { "type": "string", "description": "the primary issue noted for the case in Submitted/CAV status to which the worksheet belongs" }, "finalBriefDueDate": { "type": "string", "description": "the date the final briefs are due for the case to which the worksheet belongs" }, "statusOfMatter": { "type": "string", "description": "status of matter" } } } } } } }, "description": "a judge's pending motion results with worksheets" }, "pending-motion-worksheet": { "type": "object", "properties": { "primaryIssue": { "type": "string", "description": "the primary issue noted for the case in Submitted/CAV status to which the worksheet belongs" }, "finalBriefDueDate": { "type": "string", "description": "the date the final briefs are due for the case to which the worksheet belongs" }, "statusOfMatter": { "type": "string", "description": "status of matter" } }, "description": "Updated docket entry worksheet" }, "userNote": { "type": "object", "properties": { "docketNumber": { "type": "string", "description": "docket number of the case" }, "userId": { "type": "string", "description": "id of the user who owns the note" }, "notes": { "type": "string", "description": "user's notes for the case" } }, "description": "a case user's note" }, "caseNote": { "type": "object", "properties": { "docketNumber": { "type": "string", "description": "docket number of the case" }, "notes": { "type": "string", "description": "notes for the case" } }, "description": "a case procedural note" }, "case-worksheet": { "type": "object", "properties": { "primaryIssue": { "type": "string", "description": "the primary issue noted for the case in Submitted/CAV status to which the worksheet belongs" }, "finalBriefDueDate": { "type": "string", "description": "the date the final briefs are due for the case to which the worksheet belongs" }, "statusOfMatter": { "type": "string", "description": "" }, "entityName": { "type": "string", "description": "the name of the entity - CaseWorksheet" } }, "description": "a case deadline" }, "message": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string" }, "documentTitle": { "type": "string" } } }, "description": "array of document metadata objects attached to the message" }, "caseStatus": { "type": "string", "description": "status of the associated case" }, "caseTitle": { "type": "string", "description": "case title for the associated cases" }, "completedAt": { "type": "string", "description": "when the message was marked as completed" }, "completedBy": { "type": "string", "description": "the name of the user who completed the message thread" }, "completedBySection": { "type": "string", "description": "the section of the user who completed the message thread" }, "completedByUserId": { "type": "string", "description": "the ID of the user who completed the message thread" }, "completedMessage": { "type": "string", "description": "the message entered when completing the message thread" }, "createdAt": { "type": "string", "description": "message created time" }, "docketNumber": { "type": "string", "description": "docket number of the associated case" }, "docketNumberWithSuffix": { "type": "string", "description": "docket number of the associated case with its suffix" }, "entityName": { "type": "string", "description": "the name of the entity - Message" }, "from": { "type": "string", "description": "the name of the user who sent the message" }, "fromSection": { "type": "string", "description": "the section of the user who sent the message" }, "fromUserId": { "type": "string", "description": "the ID of the user who sent the message" }, "isCompleted": { "type": "boolean", "description": "whether the message thread has been completed" }, "isRepliedTo": { "type": "boolean", "description": "whether the message has been replied to or forwarded" }, "message": { "type": "string", "description": "the message text" }, "messageId": { "type": "string", "description": "the unique ID generated by the system to represent the message" }, "parentMessageId": { "type": "string", "description": "the unique ID generated by the system to represent the parent / initial message" }, "subject": { "type": "string", "description": "the subject line of the message" }, "to": { "type": "string", "description": "the name of the user who is the recipient of the message" }, "toSection": { "type": "string", "description": "the section of the user who is the recipient of the message" }, "toUserId": { "type": "string", "description": "the ID of the user who is the recipient of the message" } }, "description": "a case deadline" }, "docketEntry": { "type": "object", "description": "a docket entry", "properties": { "addToCoversheet": { "type": "boolean", "description": "if the docket entry was added to the coversheet" }, "createdAt": { "type": "string", "description": "the date the docket entry was created" }, "docketEntryId": { "type": "string", "description": "the docket entry id to identify the docket entry" }, "docketNumber": { "type": "string", "description": "the docket number the docket entry belongs to" }, "documentTitle": { "type": "string", "description": "the title of the docket entry" }, "documentType": { "type": "string", "description": "the type of docket entry" }, "draftOrderState": { "type": "object", "description": "keeps track of the text written inside the draft order" }, "entityName": { "type": "string", "description": "the type of entity" }, "eventCode": { "type": "string", "description": "the event code type of entity" }, "filedBy": { "type": "string", "description": "who filed the docket entry" }, "filingDate": { "type": "string", "description": "the date the docket entry was filed" }, "index": { "type": "number", "description": "the position in the docket record" }, "isDraft": { "type": "boolean", "description": "used to know if the docket entry is a draft" }, "isFileAttached": { "type": "boolean", "description": "used to know if a file is attached to the docket entry" }, "isOnDocketRecord": { "type": "boolean", "description": "used to know if the docket entry is on the docket record" }, "isSealed": { "type": "boolean", "description": "used to know if the docket entry has been sealed" }, "isStricken": { "type": "boolean", "description": "used to know if the docket entry has been stricken" }, "pending": { "type": "boolean", "description": "used to know if the docket entry is pending" }, "processingStatus": { "type": "string", "description": "keeps track of the processing state of the docket entry" }, "receivedAt": { "type": "string", "description": "the date the docket entry was received" }, "sealedTo": { "type": "string", "description": "who the docket entry is sealed to" }, "servedAt": { "type": "string", "description": "when the docket entry was served" }, "signedAt": { "type": "string", "description": "when the docket entry was signed" }, "signedByUserId": { "type": "string", "description": "who signed the docket entry" }, "signedJudgeName": { "type": "string", "description": "the name of the judge who signed the docket entry" }, "userId": { "type": "string", "description": "the userId of who created the docket entry" } } }, "practitionerDocument": { "type": "object", "properties": { "categoryName": { "type": "string", "description": "the name of the document category type, appended with location if applicable" }, "categoryType": { "type": "string", "description": "the type of document category" }, "description": { "type": "string", "description": "a description of the uploaded document" }, "location": { "type": "string", "description": "the location where the Cerificate of Good Standing was issued, if Certificate of G.S. was selected" }, "fileName": { "type": "string", "description": "the file name of the document" }, "practitionerDocumentFileId": { "type": "string", "description": "the auto-generated ID of the uploaded file" }, "uploadDate": { "type": "string", "description": "date when the document was uploaded" } }, "description": "a user object" }, "printableWorkingCopyData": { "type": "object", "properties": { "filters": { "type": "object", "properties": { "showAll": { "type": "boolean" }, "setForTrial": { "type": "boolean" }, "settled": { "type": "boolean" }, "recall": { "type": "boolean" }, "dismissed": { "type": "boolean" }, "rule122": { "type": "boolean" }, "continued": { "type": "boolean" }, "basisReached": { "type": "boolean" }, "submittedCAV": { "type": "boolean" }, "statusUnassigned": { "type": "boolean" }, "definiteTrial": { "type": "boolean" }, "motionToDismiss": { "type": "boolean" }, "probableSettlement": { "type": "boolean" }, "probableTrial": { "type": "boolean" } } }, "formattedCases": { "type": "array", "items": { "type": "object", "properties": { "caseTitle": { "type": "string" }, "docketNumber": { "type": "string" }, "docketNumberWithSuffix": { "type": "string" }, "inConsolidatedGroup": { "type": "boolean" }, "irsPractitioners": { "type": "array", "items": { "type": "object", "properties": { "entityName": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "userId": { "type": "string" }, "contact": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "countryType": { "type": "string" }, "phone": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "barNumber": { "type": "string" }, "serviceIndicator": { "type": "string" } } } }, "leadCase": { "type": "boolean" }, "privatePractitioners": { "type": "array", "items": { "type": "object", "properties": { "entityName": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "userId": { "type": "string" }, "contact": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "countryType": { "type": "string" }, "phone": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "barNumber": { "type": "string" }, "firmName": { "type": "string" }, "representing": { "type": "array", "items": { "type": "string" } }, "serviceIndicator": { "type": "string" } } } } } } }, "formattedTrialSession": { "type": "object", "properties": { "sessionStatus": { "type": "string" }, "formattedJudge": { "type": "string" }, "formattedStartDateFull": { "type": "string" }, "formattedTerm": { "type": "string" }, "startDateForAdditionalPageHeaders": { "type": "string" }, "trialLocation": { "type": "string" } } }, "showCaseNotes": { "type": "boolean" }, "sort": { "type": "string" }, "trialSessionId": { "type": "string" }, "userHeading": { "type": "string" } }, "required": [ "showCaseNotes", "filters", "formattedCases", "formattedTrialSession", "sort", "userHeading" ] } } }