Below is a reference guide to help use the client-facing TAX request APIs.
Included are URLs, how-to’s and documentation to help guide clients in
utilizing the API.
Description: Retrieves a list of all available TAX Progress objects.
Params: None
Response: An array of TAX Progress objects.
Status Codes:
200 OK: Successfully retrieved a list of TAX Progress objects.
500 Internal Server Error: An error occurred on
the server.
Description: Retrieves info on a specific TAX Progress object.
Params:
Path:
taxProgressId: The id of the TAX Progress object.
Response: A single TAX Progress object.
Status Codes:
200 OK: Successfully retrieved the TAX Progress object.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Retrieves a list of Questionnaire objects associated with a TAX Progresser object.
Params:
Path:
taxProgressId: The id of the TAX Progress object.
Response: An array of questionnaires.
Status Codes:
200 OK: Successfully retrieved a list of questionnaires.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Retrieves a Questionnaire objects associated with a TAX Progress object.
Params:
Path:
taxProgressId: The id of the TAX Progress object.
questionnaire-id: The id of the Questionnaire
Response: A questionnaire.
Status Codes:
200 OK: Successfully retrieved the questionnaire.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Retrieves a list of Document objects associated with a TAX Progress object.
Params:
Path:
taxProgressId: The id of the TAX Progress object.
Response: An array of documents.
Status Codes:
200 OK: Successfully retrieved a list of documents.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Retrieves a Documents associated with a TAX Progress object.
Params:
Path:
taxProgressId: The id of the TAX Progress object.
documentId: The id of the document requested.
Response: A document.
Status Codes:
200 OK: Successfully retrieved the document.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Retrieves a list of Tasks associated with a TAX Progress object.
Params:
Path:
taxProgressId: The id of the Tax Progress object.
Response: An array of tasks.
Status Codes:
200 OK: Successfully retrieved the task list.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Retrieves a Task associated with a TAX Progress object.
Params:
Path:
taxProgressId: The id of the Tax Progress object.
taskId: The id of the Task
Response: A task.
Status Codes:
200 OK: Successfully retrieved the task.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Retrieves the status associated with a TAX Progress object.
Params:
Path:
taxProgressId: The id of the Tax Progress object.
Response: The status of the TAX Progress object.
Status Codes:
200 OK: Successfully retrieved the task.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Adds a questionnaire to the Tax Progress object.
Params:
Path:
taxProgressId: The id of the Tax Progress object.
Body:
questionnaireId: The id of the questionnaire.
Response: No Content.
Status:
204 No Content: Questionnaire was successfully added.
400 Bad Request: The request was invalid. This can occur if any of the required fields are missing or if any fields are the wrong type.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Adds a document to the Tax Progress object.
Params:
Path:
taxProgressId: The id of the Tax Progress object.
Body:
documentId: The id of the document.
Response: No Content.
Status:
204 No Content: Document was successfully added.
400 Bad Request: The request was invalid. This can occur if any of the required fields are missing or if any fields are the wrong type.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Adds a comment to a document within a Tax Progress object.
Params:
Path:
taxProgressId: The id of the Tax Progress object.
documentId: The id of the document.
Body:
comment: An object describing a comment.
Response: No Content.
Status:
204 No Content: Comment was successfully added.
400 Bad Request: The request was invalid. This can occur if any of the required fields are missing or if any fields are the wrong type.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on
the server.
Description: Updates the status of a Tax Progress object.
Params:
Path:
taxProgressId: The id of the Tax Progress object.
Body:
status: An object describing the status of a Tax Progress object.
Response: No Content.
Status:
204 No Content: status was successfully updated.
400 Bad Request: The request was invalid. This can occur if any of the required fields are missing or if any fields are the wrong type.
404 Not Found: No id association was established.
500 Internal Server Error: An error occurred on the server.