Get Case Update list for a requested Date.

{
  "type": "object",
  "required": [
    "caseUpdatePreviewArray",
    "nextPageAPI",
    "object",
    "pageNumber",
    "previousPageAPI",
    "totalCount",
    "totalPages"
  ],
  "properties": {
    "caseUpdatePreviewArray": {
      "type": "array",
      "description": "Array of case update objects.",
      "items": {
        "type": "object",
        "required": [
          "object",
          "caseId",
          "status",
          "requestedDate",
          "caseAPI",
          "pacerOptions",
          "exception"
        ],
        "properties": {
          "caseAPI": {
            "type": "string",
            "format": "uri"
          },
          "caseId": {
            "type": "string",
            "description": "Unique Id for a Case in UniCourt."
          },
          "exception": {
            "type": "object",
            "description": "Exception object contains specific error code and its message related to the API request validation error or error occurred during API request processing.",
            "required": [
              "object",
              "code",
              "message",
              "details"
            ],
            "properties": {
              "code": {
                "type": "string",
                "description": "Indicates the type of error occured."
              },
              "details": {
                "type": "string",
                "description": "Describes what went wrong."
              },
              "message": {
                "type": "string",
                "description": "Indicates the error message that describes the error code."
              },
              "object": {
                "type": "string"
              }
            }
          },
          "object": {
            "type": "string",
            "description": "Name of the object."
          },
          "pacerOptions": {
            "type": "object",
            "description": "Applicable for PACER cases.",
            "required": [
              "object",
              "pacerUserId",
              "pacerClientCode",
              "fetchParticipantsIfOlderThanDays",
              "refreshType",
              "additionalPageArray"
            ],
            "properties": {
              "additionalPageArray": {
                "type": "array",
                "description": "Currently this option is only applicable for Federal PACER cases. The default behavior of the Case Update is to fetch the Docket Report from PACER which includes the parties and attorneys too.\n\nHowever if you need to fetch information for other pages in PACER you will need to specify it here.\n- associatedCases:\n> This will fetch the Associated Cases page in PACER if available. This page consists of related cases especially applicable for Multi-District Litigation cases and Member Cases. Including this option will internally link all related cases in our system. Data from this page will be available via the Related Cases API.\n- caseSummary:\n> This will fetch the Case Summary page in PACER if available. This page consists of additional case info which is not present in the Docket Report page. Data from this page will be structured and available as response in the Case API’s ```additional_info``` field.\n- listOfCreditors:\n> This page will fetch the “List Of Creditors” page for PACER Bankruptcy cases of case type \"bk\". Note that this page cannot be extracted for Bankruptcy cases of case type \"ap\" (Adversary Proceedings). This page consists of the Creditor information like the name and address of the Creditors. Data from this page will be structured and available as response in the Case API.\n",
                "items": {
                  "type": "object",
                  "properties": {
                    "fetchIfOlderThanDays": {
                      "type": "integer",
                      "description": "You can limit how often this page information is fetched to reduce your PACER fees.\n\nMin days is 0 and Max days is 100.\n\nExample:\n1.  Specifying a value of 0 ensures that this page is fetched from PACER for this case update irrespective of when the page was last fetched.\n2.  Specifying a value of 30 ensures that this page is fetched from PACER for this case update only if the last fetch was older than 30 days.\n"
                    },
                    "page": {
                      "type": "string",
                      "enum": [
                        "associatedCases",
                        "caseSummary",
                        "listOfCreditors"
                      ]
                    }
                  }
                }
              },
              "fetchParticipantsIfOlderThanDays": {
                "type": "integer",
                "description": "**Currently this option is only applicable for Federal PACER cases. You can limit how often parties and attorneys for a PACER case are fetched to reduce your PACER fees. If you are tracking cases daily or hourly you could easily end up with a large PACER bill.**\n\n**Use Case: Cases are typically updated to check for new docket entry filings. However every update to PACER case costs money. Participants for a case change less often than docket entry filings. So fetching participants for every update might result in unnecessary PACER costs; especially on cases which have a lot of parties and attorneys. So instead of getting charged the minimum cost of $0.10 for an update which might have had few docket entries, you could end up spending $3 for every update because there were a lot of parties for that case that were also fetched.**\n\n**With this option you can choose when to fetch parties for case based on when was it last fetched.**\nYou can limit how often this participants are fetched in a PACER case to keep your PACER costs under control.\n\nMin days is 0 and Max days is 100.\n\nExample:\n1.  Specifying a value of 0 ensures that participants are fetched from PACER for this case update irrespective of when the participants were last fetched.\n2.  Specifying a value of 30 ensures that participants are fetched from PACER for this case update only if the last fetch was older than 30 days.\n"
              },
              "object": {
                "type": "string",
                "description": "Name of the object."
              },
              "pacerClientCode": {
                "type": "string",
                "description": "PACER Client Code. This is mandatory if your setting in PACER website is set to True for required client code."
              },
              "pacerUserId": {
                "type": "string",
                "description": "**Your PACER credentials username. This is mandatory when a PACER Case is being requested in the API. For Non PACER cases this is not mandatory. Suppose your request consists of Non PACER and PACER Cases then this needs to be passed becuase you are requesting a PACER case too.**"
              },
              "refreshType": {
                "type": "string",
                "description": "This flag determines whether to pull only new or pull all the docket entries for a PACER case being requested.\n\nOnly one of the two values is allowed:\n-   fetchNewDocketEntries:\n    >   Updates the PACER case with only new docket entries that have been added after the previous update of the case being requested.\n-   fetchAllDocketEntries:\n    >   Updates the PACER case by re-parsing all dockets from #1 till latest docket entry available.\n",
                "enum": [
                  "fetchNewDocketEntries",
                  "fetchAllDocketEntries"
                ]
              }
            }
          },
          "requestedDate": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when the case was last requested for update "
          },
          "status": {
            "type": "string",
            "description": "Status of the request.",
            "enum": [
              "COMPLETE",
              "FAILURE",
              "IN_PROGRESS"
            ]
          }
        }
      }
    },
    "nextPageAPI": {
      "type": "string",
      "format": "uri",
      "description": "Link for the next page."
    },
    "object": {
      "type": "string",
      "description": "Name of the object."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Current page number."
    },
    "previousPageAPI": {
      "type": "string",
      "format": "uri",
      "description": "Link for the previous page."
    },
    "totalCount": {
      "type": "integer",
      "description": "Total number of case update objects available."
    },
    "totalPages": {
      "type": "integer",
      "description": "Total number of pages available."
    }
  }
}