Showing:

Annotations
Diagrams
Facets
Instances
Model
Properties
Source
Used by
Main schema schema.xsd
Namespace http://www.bkwservice.com/api/2020-07-01
Properties
attribute form default unqualified
element form default qualified
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:prefix
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Text that appears before a name, e.g., Dr. or Ms.
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="prefix" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Text that appears before a name, e.g., Dr. or Ms.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:firstName
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A first name or initial
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="firstName" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A first name or initial</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:middleName
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A middle name or initial; if there is more than one given
name or initial, the first is stored in the element firstName
and the remaining are stored in the element middleName
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="middleName" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A middle name or initial; if there is more than one given name or initial, the first is stored in the element firstName and the remaining are stored in the element middleName</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:lastName
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A surname
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="lastName" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A surname</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:generation
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Part of a name indicating a position in a family inheritance
relationship, e.g., "Sr", "Jr", "II"
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="generation" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Part of a name indicating a position in a family inheritance relationship, e.g., "Sr", "Jr", "II"</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:title
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A job title
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="title" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A job title</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:organization
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A business, institution, or department name
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="organization" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A business, institution, or department name</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:attention
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The content of an "attn: xxx" address line, not including the
"attn:" label
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="attention" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The content of an "attn: xxx" address line, not including the "attn:" label</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:careOf
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The content of an "c/o xxx" address line, not including the
"c/o" label
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="careOf" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The content of an "c/o xxx" address line, not including the "c/o" label</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:street1
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
First line of street address
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="street1" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>First line of street address</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:street2
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Second line of street address
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="street2" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Second line of street address</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:street3
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Third line of street address
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="street3" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Third line of street address</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:city
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A city name
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="city" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A city name</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:county
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A county name
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="county" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A county name</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:state
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A two-letter US state abbreviation
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="state" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A two-letter US state abbreviation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:zip
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A postal code or 5-digit US ZIP code
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="zip" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A postal code or 5-digit US ZIP code</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:zip4
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The four digits of the US "ZIP + 4" code
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="zip4" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The four digits of the US "ZIP + 4" code</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:country
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The country
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="country" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The country</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:phone1
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
First phone number
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="phone1" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>First phone number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:phone2
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Second phone number
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="phone2" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Second phone number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:phone3
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Third phone number
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="phone3" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Third phone number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:fax
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Fax number
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="fax" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Fax number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:email
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Email address
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="email" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Email address</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:latitude
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The latitude, in degrees
Diagram
Diagram
Type decimal
Properties
content simple
minOccurs 0
Source
 
<element name="latitude" type="xsd:decimal" minOccurs="0">
  <annotation>
    <documentation>The latitude, in degrees</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:longitude
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The longitude, in degrees
Diagram
Diagram
Type decimal
Properties
content simple
minOccurs 0
Source
 
<element name="longitude" type="xsd:decimal" minOccurs="0">
  <annotation>
    <documentation>The longitude, in degrees</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:ssn
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Social Security number
Diagram
Diagram schema_xsd.tmp#obfuscatedSsn
Type bkw:obfuscatedSsn
Properties
content simple
minOccurs 0
Facets
pattern (\d{3}-\d{2}-\d{4})|(xxx-xx-\d{4})
Source
 
<element name="ssn" type="bkw:obfuscatedSsn" minOccurs="0">
  <annotation>
    <documentation>Social Security number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:eins
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
List of Tax ID numbers
Diagram
Diagram schema_xsd.tmp#einList
Type bkw:einList
Properties
content simple
minOccurs 0
Facets
pattern \d{2}-\d{7}(,\d{2}-\d{7})*
Source
 
<element name="eins" type="bkw:einList" minOccurs="0">
  <annotation>
    <documentation>List of Tax ID numbers</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:address / bkw:url
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Tax ID number
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="url" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Tax ID number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:searchFilterList / bkw:filter
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#searchFilter
Type bkw:searchFilter
Properties
content simple
maxOccurs unbounded
Facets
pattern [_a-zA-Z][_a-zA-Z0-9]*,(eq|ne|gt|ge|lt|le|lk|nl),.*
Source
 
<element name="filter" type="bkw:searchFilter" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID used to identify the case in calls to webservice
operations
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The ID used to identify the case in calls to webservice operations</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:division
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The division name, as it appears in the Cases Report search form
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="division" type="bkw:requiredText">
  <annotation>
    <documentation>The division name, as it appears in the Cases Report search form</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:county
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The county
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="county" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The county</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:caseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="caseNumber" type="bkw:extendedCaseNumber"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:title
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case title, e.g., "Ernest Singer and Darlene Singer"
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="title" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The case title, e.g., "Ernest Singer and Darlene Singer"</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:chapter
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#chapter
Type bkw:chapter
Properties
content simple
minOccurs 0
Facets
enumeration 7
enumeration 9
enumeration 11
enumeration 12
enumeration 13
enumeration 15
enumeration 304
Source
 
<element name="chapter" type="bkw:chapter" minOccurs="0"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:previousChapter
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The previous chapter, for bankruptcy cases that have been
converted
Diagram
Diagram schema_xsd.tmp#chapter
Type bkw:chapter
Properties
content simple
minOccurs 0
Facets
enumeration 7
enumeration 9
enumeration 11
enumeration 12
enumeration 13
enumeration 15
enumeration 304
Source
 
<element name="previousChapter" type="bkw:chapter" minOccurs="0">
  <annotation>
    <documentation>The previous chapter, for bankruptcy cases that have been converted</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateClosed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date the case was closed
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateClosed" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date the case was closed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateConverted
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date of the last conversion
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateConverted" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date of the last conversion</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateDischarged
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The discharge date
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateDischarged" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The discharge date</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateDismissed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The dismissal date
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateDismissed" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The dismissal date</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateEntered
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date the case was entered into CM/ECF
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateEntered" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date the case was entered into CM/ECF</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateFiled
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The filing date
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateFiled" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The filing date</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateJointDebtorDischarged
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date joint debtor was discharged
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateJointDebtorDischarged" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date joint debtor was discharged</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateJointDebtorDismissed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date joint debtor was dismissed
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateJointDebtorDismissed" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date joint debtor was dismissed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:datePlanConfirmed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date the chapter 13 plan was confirmed
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="datePlanConfirmed" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date the chapter 13 plan was confirmed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateReopened
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date case was reopened
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateReopened" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date case was reopened</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateTerminated
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The termination date
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateTerminated" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The termination date</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:dateTransferred
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date case was transferred
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateTransferred" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date case was transferred</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:lastDateToFileClaims
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The last date to file claims
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="lastDateToFileClaims" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The last date to file claims</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:lastDateToFileClaimsGovt
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The last date for the government to file claims
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="lastDateToFileClaimsGovt" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The last date for the government to file claims</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:closed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
True if the case is closed; the availability of this information
is independent of the availability of the "dateClosed" property
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="closed" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>True if the case is closed; the availability of this information is independent of the availability of the "dateClosed" property</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:disposition
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case disposition
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="disposition" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The case disposition</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:jointDebtorDisposition
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case disposition with respect to the joint debtor in a
bankruptcy case
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="jointDebtorDisposition" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The case disposition with respect to the joint debtor in a bankruptcy case</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:filingFeeStatus
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The filing fee status
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="filingFeeStatus" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The filing fee status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:assets
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether the case involves assets
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="assets" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether the case involves assets</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:voluntary
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether the bankruptcy is voluntary
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="voluntary" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether the bankruptcy is voluntary</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:debtorType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Type debtor type
Diagram
Diagram schema_xsd.tmp#debtorType
Type bkw:debtorType
Properties
content simple
minOccurs 0
Facets
enumeration INDIVIDUAL
enumeration PARTNERSHIP
enumeration CORPORATION
enumeration OTHER
Source
 
<element name="debtorType" type="bkw:debtorType" minOccurs="0">
  <annotation>
    <documentation>Type debtor type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:debtType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Type debt type
Diagram
Diagram schema_xsd.tmp#debtType
Type bkw:debtType
Properties
content simple
minOccurs 0
Facets
enumeration CONSUMER
enumeration BUSINESS
enumeration OTHER
Source
 
<element name="debtType" type="bkw:debtType" minOccurs="0">
  <annotation>
    <documentation>Type debt type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:parties
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of parties
Diagram
Diagram schema_xsd.tmp#case_case_parties_party
Properties
content complex
minOccurs 0
Model
Children bkw:party
Instance
 
<bkw:parties xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:party>{1,unbounded}</bkw:party>
</bkw:parties>
Source
 
<element name="parties" minOccurs="0">
  <annotation>
    <documentation>The list of parties</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="party" type="bkw:party" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:parties / bkw:party
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#party_id schema_xsd.tmp#party_case schema_xsd.tmp#party_role schema_xsd.tmp#party_address schema_xsd.tmp#party_dateAdded schema_xsd.tmp#party_dateTerminated schema_xsd.tmp#party_attorneys schema_xsd.tmp#party
Type bkw:party
Properties
content complex
maxOccurs unbounded
Model
Children bkw:address, bkw:attorneys, bkw:case, bkw:dateAdded, bkw:dateTerminated, bkw:id, bkw:role
Instance
 
<bkw:party xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:role>{1,1}</bkw:role>
  <bkw:address>{1,1}</bkw:address>
  <bkw:dateAdded>{0,1}</bkw:dateAdded>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:attorneys>{0,1}</bkw:attorneys>
</bkw:party>
Source
 
<element name="party" type="bkw:party" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:party / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID used to identify the party in calls to webservice
operations
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The ID used to identify the party in calls to webservice operations</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:party / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case containing the party; used when the party appears
as a standalone object rather than embedded in a case object
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>The case containing the party; used when the party appears as a standalone object rather than embedded in a case object</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:claims
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of claims
Diagram
Diagram schema_xsd.tmp#case_case_claims_claim
Properties
content complex
minOccurs 0
Model
Children bkw:claim
Instance
 
<bkw:claims xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:claim>{1,unbounded}</bkw:claim>
</bkw:claims>
Source
 
<element name="claims" minOccurs="0">
  <annotation>
    <documentation>The list of claims</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="claim" type="bkw:claim" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:claims / bkw:claim
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#claim_id schema_xsd.tmp#claim_case schema_xsd.tmp#claim_claimNumber schema_xsd.tmp#claim_creditor schema_xsd.tmp#claim_dateFiled schema_xsd.tmp#claim_amendedDateFiled schema_xsd.tmp#claim_dateModified schema_xsd.tmp#claim_unsecuredClaimed schema_xsd.tmp#claim_securedClaimed schema_xsd.tmp#claim_priorityClaimed schema_xsd.tmp#claim_unknownClaimed schema_xsd.tmp#claim_administrativeClaimed schema_xsd.tmp#claim_totalClaimed schema_xsd.tmp#claim_unsecuredAllowed schema_xsd.tmp#claim_securedAllowed schema_xsd.tmp#claim_priorityAllowed schema_xsd.tmp#claim_unknownAllowed schema_xsd.tmp#claim_administrativeAllowed schema_xsd.tmp#claim_totalAllowed schema_xsd.tmp#claim_statusText schema_xsd.tmp#claim_filings schema_xsd.tmp#claim
Type bkw:claim
Properties
content complex
maxOccurs unbounded
Model
Children bkw:administrativeAllowed, bkw:administrativeClaimed, bkw:amendedDateFiled, bkw:case, bkw:claimNumber, bkw:creditor, bkw:dateFiled, bkw:dateModified, bkw:filings, bkw:id, bkw:priorityAllowed, bkw:priorityClaimed, bkw:securedAllowed, bkw:securedClaimed, bkw:statusText, bkw:totalAllowed, bkw:totalClaimed, bkw:unknownAllowed, bkw:unknownClaimed, bkw:unsecuredAllowed, bkw:unsecuredClaimed
Instance
 
<bkw:claim xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:claimNumber>{1,1}</bkw:claimNumber>
  <bkw:creditor>{0,1}</bkw:creditor>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:amendedDateFiled>{0,1}</bkw:amendedDateFiled>
  <bkw:dateModified>{0,1}</bkw:dateModified>
  <bkw:unsecuredClaimed>{0,1}</bkw:unsecuredClaimed>
  <bkw:securedClaimed>{0,1}</bkw:securedClaimed>
  <bkw:priorityClaimed>{0,1}</bkw:priorityClaimed>
  <bkw:unknownClaimed>{0,1}</bkw:unknownClaimed>
  <bkw:administrativeClaimed>{0,1}</bkw:administrativeClaimed>
  <bkw:totalClaimed>{0,1}</bkw:totalClaimed>
  <bkw:unsecuredAllowed>{0,1}</bkw:unsecuredAllowed>
  <bkw:securedAllowed>{0,1}</bkw:securedAllowed>
  <bkw:priorityAllowed>{0,1}</bkw:priorityAllowed>
  <bkw:unknownAllowed>{0,1}</bkw:unknownAllowed>
  <bkw:administrativeAllowed>{0,1}</bkw:administrativeAllowed>
  <bkw:totalAllowed>{0,1}</bkw:totalAllowed>
  <bkw:statusText>{0,1}</bkw:statusText>
  <bkw:filings>{0,1}</bkw:filings>
</bkw:claim>
Source
 
<element name="claim" type="bkw:claim" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID used to identify the claim in calls to webservice
operations
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The ID used to identify the claim in calls to webservice operations</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case containing the claim; used when the claim appears
as a standalone object rather than embedded in a case object
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>The case containing the claim; used when the claim appears as a standalone object rather than embedded in a case object</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:creditors
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of creditors
Diagram
Diagram schema_xsd.tmp#case_case_creditors_creditor
Properties
content complex
minOccurs 0
Model
Children bkw:creditor
Instance
 
<bkw:creditors xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:creditor>{1,unbounded}</bkw:creditor>
</bkw:creditors>
Source
 
<element name="creditors" minOccurs="0">
  <annotation>
    <documentation>The list of creditors</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="creditor" type="bkw:creditor" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:creditors / bkw:creditor
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#creditor_id schema_xsd.tmp#creditor_case schema_xsd.tmp#creditor_name schema_xsd.tmp#creditor_creditorNumber schema_xsd.tmp#creditor_address schema_xsd.tmp#creditor
Type bkw:creditor
Properties
content complex
maxOccurs unbounded
Model
Children bkw:address, bkw:case, bkw:creditorNumber, bkw:id, bkw:name
Instance
 
<bkw:creditor xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{0,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:name>{1,1}</bkw:name>
  <bkw:creditorNumber>{0,1}</bkw:creditorNumber>
  <bkw:address>{1,1}</bkw:address>
</bkw:creditor>
Source
 
<element name="creditor" type="bkw:creditor" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:creditor / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID used to identify the creditor in calls to webservice
operations
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The ID used to identify the creditor in calls to webservice operations</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:creditor / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case containing the creditor; used when the creditor appears
as a standalone object rather than embedded in a case object
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>The case containing the creditor; used when the creditor appears as a standalone object rather than embedded in a case object</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:docketItems
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of docket items
Diagram
Diagram schema_xsd.tmp#case_case_docketItems_docketItem
Properties
content complex
minOccurs 0
Model
Children bkw:docketItem
Instance
 
<bkw:docketItems xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:docketItem>{1,unbounded}</bkw:docketItem>
</bkw:docketItems>
Source
 
<element name="docketItems" minOccurs="0">
  <annotation>
    <documentation>The list of docket items</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="docketItem" type="bkw:filing" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:docketItems / bkw:docketItem
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#filing_id schema_xsd.tmp#filing_case schema_xsd.tmp#filing_type schema_xsd.tmp#filing_dateFiled schema_xsd.tmp#filing_claimNumber schema_xsd.tmp#filing_itemNumber schema_xsd.tmp#filing_title schema_xsd.tmp#filing_text schema_xsd.tmp#filing_url schema_xsd.tmp#filing_documents schema_xsd.tmp#filing
Type bkw:filing
Properties
content complex
maxOccurs unbounded
Model
Children bkw:case, bkw:claimNumber, bkw:dateFiled, bkw:documents, bkw:id, bkw:itemNumber, bkw:text, bkw:title, bkw:type, bkw:url
Instance
 
<bkw:docketItem xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:type>{0,1}</bkw:type>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:claimNumber>{0,1}</bkw:claimNumber>
  <bkw:itemNumber>{0,1}</bkw:itemNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:text>{0,1}</bkw:text>
  <bkw:url>{0,1}</bkw:url>
  <bkw:documents>{0,1}</bkw:documents>
</bkw:docketItem>
Source
 
<element name="docketItem" type="bkw:filing" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID used to identify the filing in calls to webservice
operations
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The ID used to identify the filing in calls to webservice operations</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case containing the filing; used when the filing appears
as a standalone object rather than embedded in a case object
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>The case containing the filing; used when the filing appears as a standalone object rather than embedded in a case object</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:case / bkw:data
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The data, in XML format, extracted from documents filed in the
case
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="data" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The data, in XML format, extracted from documents filed in the case</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:type
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether the filing is a docket item or proof of
claim. The type must be present unless the filing appears
in a case's list of docket items
Diagram
Diagram schema_xsd.tmp#filingType
Type bkw:filingType
Properties
content simple
minOccurs 0
Facets
enumeration DOCKET
enumeration PROOF
Source
 
<element name="type" type="bkw:filingType" minOccurs="0">
  <annotation>
    <documentation>Indicates whether the filing is a docket item or proof of claim. The type must be present unless the filing appears in a case's list of docket items</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:dateFiled
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The filing date; may not be the same as the date the
docket item was entered into Pacer
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateFiled" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The filing date; may not be the same as the date the docket item was entered into Pacer</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:claimNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The number of the claim with which the filing is associated.
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="claimNumber" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The number of the claim with which the filing is associated.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:itemNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The offset of the filing within the list of docket items for
a case or the list of proofs of claim for a specific claim. In
some jurisdictions, docket items that do not represent documents
are not assigned a sequence number.
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="itemNumber" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The offset of the filing within the list of docket items for a case or the list of proofs of claim for a specific claim. In some jurisdictions, docket items that do not represent documents are not assigned a sequence number.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:title
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The docket item title
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="title" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The docket item title</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:text
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The docket item text
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="text" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The docket item text</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:url
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The court URL associated with the filing, if the filing has
associated documents
Diagram
Diagram
Type anyURI
Properties
content simple
minOccurs 0
Source
 
<element name="url" type="xsd:anyURI" minOccurs="0">
  <annotation>
    <documentation>The court URL associated with the filing, if the filing has associated documents</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:filing / bkw:documents
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of documents associated with the docket item. Depending
on the operation called, the document list may be absent even
though there are documents associated with the filing. Use the
operation ViewFiling to view the document list
Diagram
Diagram schema_xsd.tmp#documentList_document schema_xsd.tmp#documentList
Type bkw:documentList
Properties
content complex
minOccurs 0
Model
Children bkw:document
Instance
 
<bkw:documents xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:document>{0,unbounded}</bkw:document>
</bkw:documents>
Source
 
<element name="documents" type="bkw:documentList" minOccurs="0">
  <annotation>
    <documentation>The list of documents associated with the docket item. Depending on the operation called, the document list may be absent even though there are documents associated with the filing. Use the operation ViewFiling to view the document list</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:documentList / bkw:document
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#document_id schema_xsd.tmp#document_title schema_xsd.tmp#document_description schema_xsd.tmp#document_created schema_xsd.tmp#document_contentType schema_xsd.tmp#document_charset schema_xsd.tmp#document_language schema_xsd.tmp#document_size schema_xsd.tmp#document_sha1 schema_xsd.tmp#document_metadata schema_xsd.tmp#document_url schema_xsd.tmp#document
Type bkw:document
Properties
content complex
minOccurs 0
maxOccurs unbounded
Model
Children bkw:charset, bkw:contentType, bkw:created, bkw:description, bkw:id, bkw:language, bkw:metadata, bkw:sha1, bkw:size, bkw:title, bkw:url
Instance
 
<bkw:document xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:title>{1,1}</bkw:title>
  <bkw:description>{0,1}</bkw:description>
  <bkw:created>{0,1}</bkw:created>
  <bkw:contentType>{0,1}</bkw:contentType>
  <bkw:charset>{0,1}</bkw:charset>
  <bkw:language>{0,1}</bkw:language>
  <bkw:size>{0,1}</bkw:size>
  <bkw:sha1>{0,1}</bkw:sha1>
  <bkw:metadata>{0,1}</bkw:metadata>
  <bkw:url>{0,1}</bkw:url>
</bkw:document>
Source
 
<element name="document" type="bkw:document" minOccurs="0" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID used to identify the document in calls to webservice
operations
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The ID used to identify the document in calls to webservice operations</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:title
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The document title
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="title" type="xsd:string">
  <annotation>
    <documentation>The document title</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:description
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The document description
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="description" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The document description</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:created
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The document creation date
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="created" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The document creation date</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:contentType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The MIME media type
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
maxLength 50
Source
 
<element name="contentType" minOccurs="0">
  <annotation>
    <documentation>The MIME media type</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <maxLength value="50"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:charset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The character set
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
maxLength 20
Source
 
<element name="charset" minOccurs="0">
  <annotation>
    <documentation>The character set</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <maxLength value="20"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:language
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
An IETF language tag
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
maxLength 10
Source
 
<element name="language" minOccurs="0">
  <annotation>
    <documentation>An IETF language tag</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <maxLength value="10"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:size
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The size, in byte
Diagram
Diagram
Type unsignedInt
Properties
content simple
minOccurs 0
Source
 
<element name="size" type="xsd:unsignedInt" minOccurs="0">
  <annotation>
    <documentation>The size, in byte</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:sha1
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The SHA1 hash
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
maxLength 40
Source
 
<element name="sha1" minOccurs="0">
  <annotation>
    <documentation>The SHA1 hash</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <maxLength value="40"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:metadata
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Describes document metadata
Diagram
Diagram schema_xsd.tmp#document_document_metadata_property
Properties
content complex
minOccurs 0
Model
Children bkw:property
Instance
 
<bkw:metadata xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:property>{0,unbounded}</bkw:property>
</bkw:metadata>
Source
 
<element name="metadata" minOccurs="0">
  <annotation>
    <documentation>Describes document metadata</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="property" type="bkw:metadataProperty" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:metadata / bkw:property
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#metadataProperty_name schema_xsd.tmp#metadataProperty_value schema_xsd.tmp#metadataProperty
Type bkw:metadataProperty
Properties
content complex
minOccurs 0
maxOccurs unbounded
Model
Children bkw:name, bkw:value
Instance
 
<bkw:property xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:name>{1,1}</bkw:name>
  <bkw:value>{1,1}</bkw:value>
</bkw:property>
Source
 
<element name="property" type="bkw:metadataProperty" minOccurs="0" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:metadataProperty / bkw:name
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The name of the metadata property, e.g., "us-patent-number"
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="name" type="bkw:requiredText">
  <annotation>
    <documentation>The name of the metadata property, e.g., "us-patent-number"</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:metadataProperty / bkw:value
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The value of the metadata property, e.g., "D621409"
Diagram
Diagram schema_xsd.tmp#text
Type bkw:text
Properties
content simple
Facets
maxLength 255
Source
 
<element name="value" type="bkw:text">
  <annotation>
    <documentation>The value of the metadata property, e.g., "D621409"</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:document / bkw:url
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A URL for downloading the document, if available
Diagram
Diagram
Type anyURI
Properties
content simple
minOccurs 0
Source
 
<element name="url" type="xsd:anyURI" minOccurs="0">
  <annotation>
    <documentation>A URL for downloading the document, if available</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:creditor / bkw:name
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor name
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="name" type="bkw:requiredText">
  <annotation>
    <documentation>The creditor name</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:creditor / bkw:creditorNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor number
Diagram
Diagram schema_xsd.tmp#creditorNumber
Type bkw:creditorNumber
Properties
content simple
minOccurs 0
Facets
pattern [0-9]+
Source
 
<element name="creditorNumber" type="bkw:creditorNumber" minOccurs="0">
  <annotation>
    <documentation>The creditor number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:creditor / bkw:address
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:address xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:address>
Source
 
<element name="address" type="bkw:address"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:claimNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The claim number; the claims for a given case are numbered
1, 2, 3, ....
Diagram
Diagram
Type positiveInteger
Properties
content simple
Source
 
<element name="claimNumber" type="xsd:positiveInteger">
  <annotation>
    <documentation>The claim number; the claims for a given case are numbered 1, 2, 3, ....</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:creditor
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor
Diagram
Diagram schema_xsd.tmp#creditor_id schema_xsd.tmp#creditor_case schema_xsd.tmp#creditor_name schema_xsd.tmp#creditor_creditorNumber schema_xsd.tmp#creditor_address schema_xsd.tmp#creditor
Type bkw:creditor
Properties
content complex
minOccurs 0
Model
Children bkw:address, bkw:case, bkw:creditorNumber, bkw:id, bkw:name
Instance
 
<bkw:creditor xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{0,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:name>{1,1}</bkw:name>
  <bkw:creditorNumber>{0,1}</bkw:creditorNumber>
  <bkw:address>{1,1}</bkw:address>
</bkw:creditor>
Source
 
<element name="creditor" type="bkw:creditor" minOccurs="0">
  <annotation>
    <documentation>The creditor</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:dateFiled
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Date claim was filed
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateFiled" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>Date claim was filed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:amendedDateFiled
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Date claim was last ammended
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="amendedDateFiled" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>Date claim was last ammended</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:dateModified
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Date claim was last modified
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateModified" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>Date claim was last modified</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:unsecuredClaimed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Unsecured amount claimed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="unsecuredClaimed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Unsecured amount claimed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:securedClaimed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Secured amount claimed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="securedClaimed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Secured amount claimed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:priorityClaimed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Priority amount claimed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="priorityClaimed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Priority amount claimed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:unknownClaimed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Unknown amount claimed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="unknownClaimed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Unknown amount claimed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:administrativeClaimed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Administrative amount claimed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="administrativeClaimed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Administrative amount claimed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:totalClaimed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Total amount claimed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="totalClaimed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Total amount claimed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:unsecuredAllowed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Unsecured amount allowed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="unsecuredAllowed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Unsecured amount allowed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:securedAllowed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Secured amount allowed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="securedAllowed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Secured amount allowed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:priorityAllowed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Priority amount allowed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="priorityAllowed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Priority amount allowed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:unknownAllowed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Unknown amount allowed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="unknownAllowed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Unknown amount allowed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:administrativeAllowed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Administrative amount allowed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="administrativeAllowed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Administrative amount allowed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:totalAllowed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Total amount allowed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="totalAllowed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Total amount allowed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:statusText
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Description of claim status
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="statusText" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Description of claim status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:filings
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
List of proofs of claim and docket items relating to the claim
Diagram
Diagram schema_xsd.tmp#claim_claim_filings_filing
Properties
content complex
minOccurs 0
Model
Children bkw:filing
Instance
 
<bkw:filings xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filing>{1,unbounded}</bkw:filing>
</bkw:filings>
Source
 
<element name="filings" minOccurs="0">
  <annotation>
    <documentation>List of proofs of claim and docket items relating to the claim</documentation>
  </annotation>
  <complexType>
    <sequence>
      <choice>
        <element name="filing" type="bkw:filing" maxOccurs="unbounded"/>
      </choice>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:claim / bkw:filings / bkw:filing
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#filing_id schema_xsd.tmp#filing_case schema_xsd.tmp#filing_type schema_xsd.tmp#filing_dateFiled schema_xsd.tmp#filing_claimNumber schema_xsd.tmp#filing_itemNumber schema_xsd.tmp#filing_title schema_xsd.tmp#filing_text schema_xsd.tmp#filing_url schema_xsd.tmp#filing_documents schema_xsd.tmp#filing
Type bkw:filing
Properties
content complex
maxOccurs unbounded
Model
Children bkw:case, bkw:claimNumber, bkw:dateFiled, bkw:documents, bkw:id, bkw:itemNumber, bkw:text, bkw:title, bkw:type, bkw:url
Instance
 
<bkw:filing xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:type>{0,1}</bkw:type>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:claimNumber>{0,1}</bkw:claimNumber>
  <bkw:itemNumber>{0,1}</bkw:itemNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:text>{0,1}</bkw:text>
  <bkw:url>{0,1}</bkw:url>
  <bkw:documents>{0,1}</bkw:documents>
</bkw:filing>
Source
 
<element name="filing" type="bkw:filing" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:party / bkw:role
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#partyRole
Type bkw:partyRole
Properties
content simple
Facets
enumeration ATTORNEY
enumeration BANKRUPTCY_ADMINISTRATOR
enumeration CLAIMS_AND_NOTICING_AGENT
enumeration CONSUMER_PRIVACY_OMBUDSMAN
enumeration COUNTER_CLAIMANT
enumeration COUNTER_DEFENDANT
enumeration COUNTER_PLAINTIFF
enumeration CREDITORS_ATTORNEY
enumeration CREDITOR_COMMITTEE
enumeration CREDITOR_COMMITTEE_CHAIR
enumeration CROSS_CLAIMANT
enumeration CROSS_DEFENDANT
enumeration DEBTOR
enumeration DEBTOR_DESIGNEE
enumeration DEBTOR_IN_POSSESSION
enumeration DEFENDANT
enumeration INTERESTED_PARTY
enumeration INTERIM_TRUSTEE
enumeration INTERVENOR
enumeration JNT_ADMIN_DEBTOR
enumeration JOINT_DEBTOR
enumeration JUDGE
enumeration MISCELLANEOUS_PROCEEDING_MOVANT_PLAINTIFF
enumeration NON_FILING_SPOUSE
enumeration PATIENT_CARE_OMBUDSMAN
enumeration PETITIONING_CREDITOR
enumeration PETITION_PREPARER
enumeration PLAINTIFF
enumeration SPECIAL_COUNSEL
enumeration THIRD_PARTY_DEFENDANT
enumeration THIRD_PARTY_PLAINTIFF
enumeration TRUSTEE
enumeration TRUSTEES_ATTORNEY
enumeration US_TRUSTEE
enumeration OTHER
Source
 
<element name="role" type="bkw:partyRole"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:party / bkw:address
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:address xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:address>
Source
 
<element name="address" type="bkw:address"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:party / bkw:dateAdded
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateAdded" type="xsd:date" minOccurs="0"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:party / bkw:dateTerminated
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="dateTerminated" type="xsd:date" minOccurs="0"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:party / bkw:attorneys
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of attorneys
Diagram
Diagram schema_xsd.tmp#party_party_attorneys_attorney
Properties
content complex
minOccurs 0
Model
Children bkw:attorney
Instance
 
<bkw:attorneys xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:attorney>{1,unbounded}</bkw:attorney>
</bkw:attorneys>
Source
 
<element name="attorneys" minOccurs="0">
  <annotation>
    <documentation>The list of attorneys</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="attorney" type="bkw:party" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:party / bkw:attorneys / bkw:attorney
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#party_id schema_xsd.tmp#party_case schema_xsd.tmp#party_role schema_xsd.tmp#party_address schema_xsd.tmp#party_dateAdded schema_xsd.tmp#party_dateTerminated schema_xsd.tmp#party_attorneys schema_xsd.tmp#party
Type bkw:party
Properties
content complex
maxOccurs unbounded
Model
Children bkw:address, bkw:attorneys, bkw:case, bkw:dateAdded, bkw:dateTerminated, bkw:id, bkw:role
Instance
 
<bkw:attorney xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:role>{1,1}</bkw:role>
  <bkw:address>{1,1}</bkw:address>
  <bkw:dateAdded>{0,1}</bkw:dateAdded>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:attorneys>{0,1}</bkw:attorneys>
</bkw:attorney>
Source
 
<element name="attorney" type="bkw:party" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:caseList / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
maxOccurs unbounded
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DocumentError
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#DocumentError_status schema_xsd.tmp#DocumentError_message
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:DocumentError xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:DocumentError>
Source
 
<element name="DocumentError">
  <complexType>
    <annotation>
      <documentation>Reports errors that occur when a document is requested via HTTP</documentation>
    </annotation>
    <sequence>
      <element name="status" type="bkw:statusCode"/>
      <element name="message" type="xsd:string">
        <annotation>
          <documentation>The error message</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DocumentError / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DocumentError / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The error message
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>The error message</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerAccount / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The account ID, of the form pacer-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The account ID, of the form pacer-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerAccount / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText">
  <annotation>
    <documentation>The username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerAccount / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerAccount / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district, for current generation CM/ECF accounts
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
minOccurs 0
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district" minOccurs="0">
  <annotation>
    <documentation>The district, for current generation CM/ECF accounts</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerAccount / bkw:description
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Descriptive text associated with the account
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="description" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Descriptive text associated with the account</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerAccount / bkw:default
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
true if the PACER account is the default account of the user
who owns it
Diagram
Diagram
Type boolean
Properties
content simple
Source
 
<element name="default" type="xsd:boolean">
  <annotation>
    <documentation>true if the PACER account is the default account of the user who owns it</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerTransaction / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The transaction ID, of the form trans-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The transaction ID, of the form trans-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerTransaction / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID of the PACER account associated with the transaction,
as an identifier of the form pacer-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The ID of the PACER account associated with the transaction, as an identifier of the form pacer-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerTransaction / bkw:user
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID of the BankruptcyWatch user responsible for the
transaction, as an identifier of the form user-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="user" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The ID of the BankruptcyWatch user responsible for the transaction, as an identifier of the form user-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerTransaction / bkw:datetime
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The transaction timestamp
Diagram
Diagram
Type dateTime
Properties
content simple
Source
 
<element name="datetime" type="xsd:dateTime">
  <annotation>
    <documentation>The transaction timestamp</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerTransaction / bkw:description
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A description of the transaction
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="description" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A description of the transaction</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerTransaction / bkw:searchCriteria
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search parameters associated with the transaction
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="searchCriteria" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The search parameters associated with the transaction</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerTransaction / bkw:billablePages
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The number of PACER billable pages associated with the
transaction
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="billablePages" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The number of PACER billable pages associated with the transaction</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerTransaction / bkw:cost
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The cost of the transaction
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="cost" type="bkw:dollarValue">
  <annotation>
    <documentation>The cost of the transaction</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerReport / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The report ID, of the form report-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The report ID, of the form report-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerReport / bkw:type
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The report type
Diagram
Diagram schema_xsd.tmp#pacerReportType
Type bkw:pacerReportType
Properties
content simple
Facets
enumeration CASE_LOCATOR 
Case Locator output, in XML format
enumeration CASE_NUMBERS 
Case Numbers output, in XML format
enumeration CASES 
Cases Report output, in pipe-separated values format
enumeration CLAIMS_REGISTER 
Claims Register output, in HTML format
enumeration CREDITOR_LIST 
Creditor List output, in CSV format
enumeration DOCKET 
Docket Report output, in HTML format
enumeration DOCUMENT 
Content of a document filed with the court, in PDF format
Source
 
<element name="type" type="bkw:pacerReportType">
  <annotation>
    <documentation>The report type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerReport / bkw:document
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A document ID of the form doc-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="document" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>A document ID of the form doc-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerReport / bkw:timestamp
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The time the report was downloaded from PACER
Diagram
Diagram
Type dateTime
Properties
content simple
Source
 
<element name="timestamp" type="xsd:dateTime">
  <annotation>
    <documentation>The time the report was downloaded from PACER</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerReport / bkw:transaction
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The PACER transaction receipt
Diagram
Diagram schema_xsd.tmp#pacerTransaction_id schema_xsd.tmp#pacerTransaction_pacerAccount schema_xsd.tmp#pacerTransaction_user schema_xsd.tmp#pacerTransaction_datetime schema_xsd.tmp#pacerTransaction_description schema_xsd.tmp#pacerTransaction_searchCriteria schema_xsd.tmp#pacerTransaction_billablePages schema_xsd.tmp#pacerTransaction_cost schema_xsd.tmp#pacerTransaction
Type bkw:pacerTransaction
Properties
content complex
minOccurs 0
Model
Children bkw:billablePages, bkw:cost, bkw:datetime, bkw:description, bkw:id, bkw:pacerAccount, bkw:searchCriteria, bkw:user
Instance
 
<bkw:transaction xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
  <bkw:user>{0,1}</bkw:user>
  <bkw:datetime>{1,1}</bkw:datetime>
  <bkw:description>{0,1}</bkw:description>
  <bkw:searchCriteria>{0,1}</bkw:searchCriteria>
  <bkw:billablePages>{0,1}</bkw:billablePages>
  <bkw:cost>{1,1}</bkw:cost>
</bkw:transaction>
Source
 
<element name="transaction" type="bkw:pacerTransaction" minOccurs="0">
  <annotation>
    <documentation>The PACER transaction receipt</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:pacerReport / bkw:cases
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of cases referenced in the document, ir any
Diagram
Diagram schema_xsd.tmp#caseList_case schema_xsd.tmp#caseList
Type bkw:caseList
Properties
content complex
minOccurs 0
Model
Children bkw:case
Instance
 
<bkw:cases xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,unbounded}</bkw:case>
</bkw:cases>
Source
 
<element name="cases" type="bkw:caseList" minOccurs="0">
  <annotation>
    <documentation>The list of cases referenced in the document, ir any</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:deliveryMethod / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The delivery method ID, or the form delivery-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The delivery method ID, or the form delivery-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:deliveryMethod / bkw:transport
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#messageTransport
Type bkw:messageTransport
Properties
content simple
Facets
enumeration FAX 
Notification by fax
enumeration POSTAL 
Notification by USPS
enumeration SFTP 
Notification by SFTP
enumeration SMTP 
Notification by email
enumeration WEB_PUSH 
Notification by POSTing to a client-provided URL
enumeration WEB_PULL 
Client retrieves notifications by calling ListNotifications
Source
 
<element name="transport" type="bkw:messageTransport"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:deliveryMethod / bkw:format
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Must be XML or unspecified when transport is WEB_PULL
Diagram
Diagram schema_xsd.tmp#messageFormat
Type bkw:messageFormat
Properties
content simple
minOccurs 0
Facets
enumeration TEXT 
Plain Text
enumeration HTML 
Hypertext Markup Language
enumeration XML 
Extensible Markup Language
enumeration CSV 
Comma-Separated Values
enumeration PDF 
Portable Document Format
enumeration JSON 
JavaScript Object Notation
Source
 
<element name="format" type="bkw:messageFormat" minOccurs="0">
  <annotation>
    <documentation>Must be XML or unspecified when transport is WEB_PULL</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:deliveryMethod / bkw:batch
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
true if notifications should be delivered in batches;
must be true or unspecified when transport is WEB_PULL
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="batch" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>true if notifications should be delivered in batches; must be true or unspecified when transport is WEB_PULL</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:deliveryMethod / bkw:address
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
must be unspecified when transport is WEB_PULL
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
minOccurs 0
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:address xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:address>
Source
 
<element name="address" type="bkw:address" minOccurs="0">
  <annotation>
    <documentation>must be unspecified when transport is WEB_PULL</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:portfolioItem / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
An optional text string selected by the subscriber for internal
use; for example, it could be a client identifier
Diagram
Diagram schema_xsd.tmp#text
Type bkw:text
Properties
content simple
minOccurs 0
Facets
maxLength 255
Source
 
<element name="id" type="bkw:text" minOccurs="0">
  <annotation>
    <documentation>An optional text string selected by the subscriber for internal use; for example, it could be a client identifier</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:portfolioItem / bkw:properties
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of name/value pairs that define the portfolio item;
for example, an item in a Case Portfolio has two properties:
district and caseNumber
Diagram
Diagram schema_xsd.tmp#portfolioItem_portfolioItem_properties_property
Properties
content complex
Model
Children bkw:property
Instance
 
<bkw:properties xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:property>{0,unbounded}</bkw:property>
</bkw:properties>
Source
 
<element name="properties">
  <annotation>
    <documentation>The list of name/value pairs that define the portfolio item; for example, an item in a Case Portfolio has two properties: district and caseNumber</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="property" minOccurs="0" maxOccurs="unbounded">
        <complexType>
          <sequence>
            <element name="name" type="xsd:string"/>
            <element name="value" type="xsd:string"/>
          </sequence>
        </complexType>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:portfolioItem / bkw:properties / bkw:property
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#portfolioItem_portfolioItem_properties_portfolioItem_portfolioItem_properties_property_name schema_xsd.tmp#portfolioItem_portfolioItem_properties_portfolioItem_portfolioItem_properties_property_value
Properties
content complex
minOccurs 0
maxOccurs unbounded
Model
Children bkw:name, bkw:value
Instance
 
<bkw:property xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:name>{1,1}</bkw:name>
  <bkw:value>{1,1}</bkw:value>
</bkw:property>
Source
 
<element name="property" minOccurs="0" maxOccurs="unbounded">
  <complexType>
    <sequence>
      <element name="name" type="xsd:string"/>
      <element name="value" type="xsd:string"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:portfolioItem / bkw:properties / bkw:property / bkw:name
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="name" type="xsd:string"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:portfolioItem / bkw:properties / bkw:property / bkw:value
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="value" type="xsd:string"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:portfolioItem / bkw:added
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The time the item was added to the portfolio
Diagram
Diagram
Type dateTime
Properties
content simple
minOccurs 0
Source
 
<element name="added" type="xsd:dateTime" minOccurs="0">
  <annotation>
    <documentation>The time the item was added to the portfolio</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:portfolioItem / bkw:removed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The time the item was removed from the portfolio
Diagram
Diagram
Type dateTime
Properties
content simple
minOccurs 0
Source
 
<element name="removed" type="xsd:dateTime" minOccurs="0">
  <annotation>
    <documentation>The time the item was removed from the portfolio</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:parameterList / bkw:param
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#parameterList_parameterList_param_name schema_xsd.tmp#parameterList_parameterList_param_value
Properties
content complex
minOccurs 1
maxOccurs unbounded
Model
Children bkw:name, bkw:value
Instance
 
<bkw:param xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:name>{1,1}</bkw:name>
  <bkw:value>{1,1}</bkw:value>
</bkw:param>
Source
 
<element name="param" minOccurs="1" maxOccurs="unbounded">
  <complexType>
    <sequence>
      <element name="name" type="xsd:string"/>
      <element name="value" type="xsd:string"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:parameterList / bkw:param / bkw:name
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="name" type="xsd:string"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:parameterList / bkw:param / bkw:value
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="value" type="xsd:string"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:subscription / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID, or the form sub-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The subscription ID, or the form sub-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:subscription / bkw:type
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription type
Diagram
Diagram schema_xsd.tmp#subscriptionType
Type bkw:subscriptionType
Properties
content simple
Facets
enumeration CONSUMER_PORTFOLIO 
Receive notifications when consumers in a specified collection
file for banrkuptcy
enumeration CASE_PORTFOLIO 
Receive notifications when events occur for cases in a specified
collection
enumeration CASE_LISTS 
Receive notifications when events occur for cases in a specified
geographic area
enumeration CM_ECF 
Receive notifications when emails arrive from the court
(a.k.a. Free Looks)
enumeration PACER_INFO 
Receive notifications of PACER announcements and service status
changes
Source
 
<element name="type" type="bkw:subscriptionType">
  <annotation>
    <documentation>The subscription type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:subscription / bkw:eventTypes
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of notification types;
required for CASE_PORTFOLIO and CASE_LISTS subscriptions.
For CASE_LISTS subscriptions, exactly one notification type
must be specified
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="eventTypes" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of notification types; required for CASE_PORTFOLIO and CASE_LISTS subscriptions. For CASE_LISTS subscriptions, exactly one notification type must be specified</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:subscription / bkw:params
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#parameterList_param schema_xsd.tmp#parameterList
Type bkw:parameterList
Properties
content complex
minOccurs 0
Model
Children bkw:param
Instance
 
<bkw:params xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:param>{1,unbounded}</bkw:param>
</bkw:params>
Source
 
<element name="params" type="bkw:parameterList" minOccurs="0"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:subscription / bkw:deliveryMethods
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#subscription_subscription_deliveryMethods_deliveryMethod
Properties
content complex
minOccurs 0
Model
Children bkw:deliveryMethod
Instance
 
<bkw:deliveryMethods xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:deliveryMethod>{1,unbounded}</bkw:deliveryMethod>
</bkw:deliveryMethods>
Source
 
<element name="deliveryMethods" minOccurs="0">
  <complexType>
    <annotation>
      <documentation>List of delivery methods</documentation>
    </annotation>
    <sequence>
      <element name="deliveryMethod" type="bkw:deliveryMethod" minOccurs="1" maxOccurs="unbounded"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:subscription / bkw:deliveryMethods / bkw:deliveryMethod
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#deliveryMethod_id schema_xsd.tmp#deliveryMethod_transport schema_xsd.tmp#deliveryMethod_format schema_xsd.tmp#deliveryMethod_batch schema_xsd.tmp#deliveryMethod_address schema_xsd.tmp#deliveryMethod
Type bkw:deliveryMethod
Properties
content complex
minOccurs 1
maxOccurs unbounded
Model
Children bkw:address, bkw:batch, bkw:format, bkw:id, bkw:transport
Instance
 
<bkw:deliveryMethod xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:transport>{1,1}</bkw:transport>
  <bkw:format>{0,1}</bkw:format>
  <bkw:batch>{0,1}</bkw:batch>
  <bkw:address>{0,1}</bkw:address>
</bkw:deliveryMethod>
Source
 
<element name="deliveryMethod" type="bkw:deliveryMethod" minOccurs="1" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The notification ID, or the form not-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The notification ID, or the form not-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="subscriptionId" type="bkw:resourceId">
  <annotation>
    <documentation>The subscription ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:timestamp
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The time at which the notification was generated
Diagram
Diagram
Type dateTime
Properties
content simple
minOccurs 0
Source
 
<element name="timestamp" type="xsd:dateTime" minOccurs="0">
  <annotation>
    <documentation>The time at which the notification was generated</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:type
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The event type
Diagram
Diagram schema_xsd.tmp#eventType
Type bkw:eventType
Properties
content simple
Facets
enumeration CASES_FILED 
A list of cases was filed (used by CASE_LISTS subscriptions)
enumeration CASES_DISCHARGED 
A list of cases was discharged (used by CASE_LISTS
subscriptions)
enumeration CASES_DISMISSED 
A list of cases was dismissed (used by CASE_LISTS subscriptions)
enumeration CASES_CLOSED 
A list of cases was closed (used by CASE_LISTS subscriptions)
enumeration CASES_CONVERTED 
A list of cases was conveted (used by CASE_LISTS subscriptions)
enumeration CASES_REOPENED 
A list of cases was reopened  (used by CASE_LISTS subscriptions)
enumeration CASES_TRANSFERRED 
A list of cases was transferred from one division to another
(used by CASE_LISTS subscriptions)
enumeration CASES_SPLIT 
A list of cases was split (used by CASE_LISTS subscriptions)
enumeration CASE_FILED 
A case was filed (used by CASE_PORTFOLIO AND CONSUMER_PORTFOLIO
subscriptions)
enumeration CASE_DISCHARGED 
A case was discharged (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_DISMISSED 
A case was dismissed (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_CLOSED 
A case was closed (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_CONVERTED 
A case was conveted (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_REOPENED 
A case was reopened (used by CASE_PORTFOLIO subscriptions)
subscriptions)
enumeration CASE_TRANSFERRED 
A case was transferred from one division to another (used by
CASE_PORTFOLIO subscriptions)
enumeration CASE_TERMINATED 
A case was terminated (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_SPLIT 
A case was split (used by CASE_PORTFOLIO subscriptions)
enumeration JOINT_DEBTOR_DISCHARGED 
The joint debtor was discharged (used by CASE_PORTFOLIO
subscriptions)
enumeration JOINT_DEBTOR_DISMISSED 
The joint debtor was dismissed (used by CASE_PORTFOLIO
subscriptions)
enumeration PLAN_CONFIRMED 
A chapter 13 plan was confirmed (used by CASE_PORTFOLIO
subscriptions)
enumeration MEETING_OF_CREDITORS_SCHEDULED 
A meeting of creditors was scheduled (used by CASE_PORTFOLIO
subscriptions)
enumeration MEETING_OF_CREDITORS_CANCELED 
A meeting of creditors was canceled (used by CASE_PORTFOLIO
subscriptions)
enumeration MEETING_OF_CREDITORS_OCCURRED 
A meeting of creditors occurred (used by CASE_PORTFOLIO
subscriptions)
enumeration CASE_UPDATED 
An event has occurred that affects a case as a whole (used by
CM_ECF subscriptions)
enumeration DOCKET_ITEM_FILED 
A docket item has been filed (used by CM_ECF subscriptions)
enumeration PROOF_OF_CLAIM_FILED 
A proof of claim has been filed (used by CM_ECF subscriptions)
enumeration DOCKET_ITEM_UPDATED 
A docket item has been updated (used by CM_ECF subscriptions)
enumeration PROOF_OF_CLAIM_UPDATED 
A proof of claim has been updated (used by CM_ECF subscriptions)
enumeration CLAIM_UPDATED 
A claim has been updated (used by CM_ECF subscriptions)
enumeration EMAIL_RECEIVED 
An email not containing any of the other CM_ECF notification
types was received at the address registered with the court
(used by CM_ECF subscriptions)
Source
 
<element name="type" type="bkw:eventType">
  <annotation>
    <documentation>The event type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:eventDate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The event date
Diagram
Diagram
Type date
Properties
content simple
Source
 
<element name="eventDate" type="xsd:date">
  <annotation>
    <documentation>The event date</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:description
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A brief description of the notification
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="description" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A brief description of the notification</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:params
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#parameterList_param schema_xsd.tmp#parameterList
Type bkw:parameterList
Properties
content complex
minOccurs 0
Model
Children bkw:param
Instance
 
<bkw:params xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:param>{1,unbounded}</bkw:param>
</bkw:params>
Source
 
<element name="params" type="bkw:parameterList" minOccurs="0"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:portfolioItem
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The portfolio item associated with the notification
Diagram
Diagram schema_xsd.tmp#portfolioItem_id schema_xsd.tmp#portfolioItem_properties schema_xsd.tmp#portfolioItem_added schema_xsd.tmp#portfolioItem_removed schema_xsd.tmp#portfolioItem
Type bkw:portfolioItem
Properties
content complex
minOccurs 0
Model
Children bkw:added, bkw:id, bkw:properties, bkw:removed
Instance
 
<bkw:portfolioItem xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{0,1}</bkw:id>
  <bkw:properties>{1,1}</bkw:properties>
  <bkw:added>{0,1}</bkw:added>
  <bkw:removed>{0,1}</bkw:removed>
</bkw:portfolioItem>
Source
 
<element name="portfolioItem" type="bkw:portfolioItem" minOccurs="0">
  <annotation>
    <documentation>The portfolio item associated with the notification</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:delivered
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The delivery date, if the notification has been delivered
Diagram
Diagram
Type dateTime
Properties
content simple
minOccurs 0
Source
 
<element name="delivered" type="xsd:dateTime" minOccurs="0">
  <annotation>
    <documentation>The delivery date, if the notification has been delivered</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:cases
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of cases associated with the notification
Diagram
Diagram schema_xsd.tmp#caseList_case schema_xsd.tmp#caseList
Type bkw:caseList
Properties
content complex
minOccurs 0
Model
Children bkw:case
Instance
 
<bkw:cases xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,unbounded}</bkw:case>
</bkw:cases>
Source
 
<element name="cases" type="bkw:caseList" minOccurs="0">
  <annotation>
    <documentation>A list of cases associated with the notification</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notification / bkw:documents
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of documents associated with the notification
Diagram
Diagram schema_xsd.tmp#documentList_document schema_xsd.tmp#documentList
Type bkw:documentList
Properties
content complex
minOccurs 0
Model
Children bkw:document
Instance
 
<bkw:documents xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:document>{0,unbounded}</bkw:document>
</bkw:documents>
Source
 
<element name="documents" type="bkw:documentList" minOccurs="0">
  <annotation>
    <documentation>A list of documents associated with the notification</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:notificationsList / bkw:notification
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#notification_id schema_xsd.tmp#notification_subscriptionId schema_xsd.tmp#notification_timestamp schema_xsd.tmp#notification_type schema_xsd.tmp#notification_eventDate schema_xsd.tmp#notification_description schema_xsd.tmp#notification_params schema_xsd.tmp#notification_portfolioItem schema_xsd.tmp#notification_delivered schema_xsd.tmp#notification_cases schema_xsd.tmp#notification_documents schema_xsd.tmp#notification
Type bkw:notification
Properties
content complex
minOccurs 0
maxOccurs unbounded
Model
Children bkw:cases, bkw:delivered, bkw:description, bkw:documents, bkw:eventDate, bkw:id, bkw:params, bkw:portfolioItem, bkw:subscriptionId, bkw:timestamp, bkw:type
Instance
 
<bkw:notification xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:subscriptionId>{1,1}</bkw:subscriptionId>
  <bkw:timestamp>{0,1}</bkw:timestamp>
  <bkw:type>{1,1}</bkw:type>
  <bkw:eventDate>{1,1}</bkw:eventDate>
  <bkw:description>{0,1}</bkw:description>
  <bkw:params>{0,1}</bkw:params>
  <bkw:portfolioItem>{0,1}</bkw:portfolioItem>
  <bkw:delivered>{0,1}</bkw:delivered>
  <bkw:cases>{0,1}</bkw:cases>
  <bkw:documents>{0,1}</bkw:documents>
</bkw:notification>
Source
 
<element name="notification" type="bkw:notification" minOccurs="0" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:Notifications
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#notificationsList_notification schema_xsd.tmp#notificationsList
Type bkw:notificationsList
Properties
content complex
Model
Children bkw:notification
Instance
 
<bkw:Notifications xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:notification>{0,unbounded}</bkw:notification>
</bkw:Notifications>
Source
 
<element name="Notifications" type="bkw:notificationsList"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:number
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The check number
Diagram
Diagram
Type restriction of string
Properties
content simple
Facets
pattern [^,*]+
Source
 
<element name="number">
  <annotation>
    <documentation>The check number</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <pattern value="[^,*]+"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:date
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The check date
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="date" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The check date</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:amount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total payment amount
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="amount" type="bkw:dollarValue">
  <annotation>
    <documentation>The total payment amount</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:trusteeAddress
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The trustee address
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:trusteeAddress xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:trusteeAddress>
Source
 
<element name="trusteeAddress" type="bkw:address">
  <annotation>
    <documentation>The trustee address</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of chapter 13 plan payments covered by the check
Diagram
Diagram schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_payment
Properties
content complex
Model
Children bkw:payment
Instance
 
<bkw:payments xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:payment>{1,unbounded}</bkw:payment>
</bkw:payments>
Source
 
<element name="payments">
  <annotation>
    <documentation>The list of chapter 13 plan payments covered by the check</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="payment" maxOccurs="unbounded">
        <annotation>
          <documentation>The chapter 13 plan payment covered by the check</documentation>
        </annotation>
        <complexType>
          <sequence>
            <element name="caseNumber" type="bkw:compactCaseNumber">
              <annotation>
                <documentation>The seven-digit case number</documentation>
              </annotation>
            </element>
            <element name="amount" type="bkw:dollarValue">
              <annotation>
                <documentation>The payment amount</documentation>
              </annotation>
            </element>
            <element name="interest" type="bkw:dollarValue" minOccurs="0">
              <annotation>
                <documentation>The portion of the payment that represents an interest payment</documentation>
              </annotation>
            </element>
            <element name="date" type="xsd:date" minOccurs="0">
              <annotation>
                <documentation>The check date</documentation>
              </annotation>
            </element>
            <element name="accountNumber" type="xsd:string" minOccurs="0">
              <annotation>
                <documentation>The account number</documentation>
              </annotation>
            </element>
            <element name="comment" type="xsd:string" minOccurs="0">
              <annotation>
                <documentation>A description of the payment added by the trustee</documentation>
              </annotation>
            </element>
            <element name="debtor1" type="bkw:address">
              <annotation>
                <documentation>The address of the debtor</documentation>
              </annotation>
            </element>
            <element name="debtor2" type="bkw:address" minOccurs="0">
              <annotation>
                <documentation>The address of the joint debtor</documentation>
              </annotation>
            </element>
            <element name="creditor" type="xsd:string">
              <annotation>
                <documentation>The creditor name</documentation>
              </annotation>
            </element>
            <element name="claim">
              <annotation>
                <documentation>Information about the claim</documentation>
              </annotation>
              <complexType>
                <sequence>
                  <element name="amount" type="bkw:dollarValue">
                    <annotation>
                      <documentation>The claim amount</documentation>
                    </annotation>
                  </element>
                  <element name="number" type="xsd:nonNegativeInteger">
                    <annotation>
                      <documentation>The claim number</documentation>
                    </annotation>
                  </element>
                  <element name="description" type="xsd:string" minOccurs="0">
                    <annotation>
                      <documentation>The claim description</documentation>
                    </annotation>
                  </element>
                  <element name="interestDue" type="bkw:dollarValue" minOccurs="0">
                    <annotation>
                      <documentation>The interest due</documentation>
                    </annotation>
                  </element>
                  <element name="interestPaid" type="bkw:dollarValue" minOccurs="0">
                    <annotation>
                      <documentation>The interest paid</documentation>
                    </annotation>
                  </element>
                  <element name="interestRate" type="xsd:decimal" minOccurs="0">
                    <annotation>
                      <documentation>The interest rate</documentation>
                    </annotation>
                  </element>
                  <element name="principleDue" type="bkw:dollarValue" minOccurs="0">
                    <annotation>
                      <documentation>The principle due</documentation>
                    </annotation>
                  </element>
                  <element name="principleOwed" type="bkw:dollarValue" minOccurs="0">
                    <annotation>
                      <documentation>The principle owed</documentation>
                    </annotation>
                  </element>
                  <element name="principlePaid" type="bkw:dollarValue" minOccurs="0">
                    <annotation>
                      <documentation>The principle paid</documentation>
                    </annotation>
                  </element>
                  <element name="scheduledAmount" type="bkw:dollarValue" minOccurs="0">
                    <annotation>
                      <documentation>The scheduled amount</documentation>
                    </annotation>
                  </element>
                  <element name="monthlyPayment" type="bkw:dollarValue" minOccurs="0">
                    <annotation>
                      <documentation>The montly payment amount</documentation>
                    </annotation>
                  </element>
                </sequence>
              </complexType>
            </element>
          </sequence>
        </complexType>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The chapter 13 plan payment covered by the check
Diagram
Diagram schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_caseNumber schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_amount schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_interest schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_date schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_accountNumber schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_comment schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_debtor1 schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_debtor2 schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_creditor schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim
Properties
content complex
maxOccurs unbounded
Model
Children bkw:accountNumber, bkw:amount, bkw:caseNumber, bkw:claim, bkw:comment, bkw:creditor, bkw:date, bkw:debtor1, bkw:debtor2, bkw:interest
Instance
 
<bkw:payment xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:amount>{1,1}</bkw:amount>
  <bkw:interest>{0,1}</bkw:interest>
  <bkw:date>{0,1}</bkw:date>
  <bkw:accountNumber>{0,1}</bkw:accountNumber>
  <bkw:comment>{0,1}</bkw:comment>
  <bkw:debtor1>{1,1}</bkw:debtor1>
  <bkw:debtor2>{0,1}</bkw:debtor2>
  <bkw:creditor>{1,1}</bkw:creditor>
  <bkw:claim>{1,1}</bkw:claim>
</bkw:payment>
Source
 
<element name="payment" maxOccurs="unbounded">
  <annotation>
    <documentation>The chapter 13 plan payment covered by the check</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="caseNumber" type="bkw:compactCaseNumber">
        <annotation>
          <documentation>The seven-digit case number</documentation>
        </annotation>
      </element>
      <element name="amount" type="bkw:dollarValue">
        <annotation>
          <documentation>The payment amount</documentation>
        </annotation>
      </element>
      <element name="interest" type="bkw:dollarValue" minOccurs="0">
        <annotation>
          <documentation>The portion of the payment that represents an interest payment</documentation>
        </annotation>
      </element>
      <element name="date" type="xsd:date" minOccurs="0">
        <annotation>
          <documentation>The check date</documentation>
        </annotation>
      </element>
      <element name="accountNumber" type="xsd:string" minOccurs="0">
        <annotation>
          <documentation>The account number</documentation>
        </annotation>
      </element>
      <element name="comment" type="xsd:string" minOccurs="0">
        <annotation>
          <documentation>A description of the payment added by the trustee</documentation>
        </annotation>
      </element>
      <element name="debtor1" type="bkw:address">
        <annotation>
          <documentation>The address of the debtor</documentation>
        </annotation>
      </element>
      <element name="debtor2" type="bkw:address" minOccurs="0">
        <annotation>
          <documentation>The address of the joint debtor</documentation>
        </annotation>
      </element>
      <element name="creditor" type="xsd:string">
        <annotation>
          <documentation>The creditor name</documentation>
        </annotation>
      </element>
      <element name="claim">
        <annotation>
          <documentation>Information about the claim</documentation>
        </annotation>
        <complexType>
          <sequence>
            <element name="amount" type="bkw:dollarValue">
              <annotation>
                <documentation>The claim amount</documentation>
              </annotation>
            </element>
            <element name="number" type="xsd:nonNegativeInteger">
              <annotation>
                <documentation>The claim number</documentation>
              </annotation>
            </element>
            <element name="description" type="xsd:string" minOccurs="0">
              <annotation>
                <documentation>The claim description</documentation>
              </annotation>
            </element>
            <element name="interestDue" type="bkw:dollarValue" minOccurs="0">
              <annotation>
                <documentation>The interest due</documentation>
              </annotation>
            </element>
            <element name="interestPaid" type="bkw:dollarValue" minOccurs="0">
              <annotation>
                <documentation>The interest paid</documentation>
              </annotation>
            </element>
            <element name="interestRate" type="xsd:decimal" minOccurs="0">
              <annotation>
                <documentation>The interest rate</documentation>
              </annotation>
            </element>
            <element name="principleDue" type="bkw:dollarValue" minOccurs="0">
              <annotation>
                <documentation>The principle due</documentation>
              </annotation>
            </element>
            <element name="principleOwed" type="bkw:dollarValue" minOccurs="0">
              <annotation>
                <documentation>The principle owed</documentation>
              </annotation>
            </element>
            <element name="principlePaid" type="bkw:dollarValue" minOccurs="0">
              <annotation>
                <documentation>The principle paid</documentation>
              </annotation>
            </element>
            <element name="scheduledAmount" type="bkw:dollarValue" minOccurs="0">
              <annotation>
                <documentation>The scheduled amount</documentation>
              </annotation>
            </element>
            <element name="monthlyPayment" type="bkw:dollarValue" minOccurs="0">
              <annotation>
                <documentation>The montly payment amount</documentation>
              </annotation>
            </element>
          </sequence>
        </complexType>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:caseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The seven-digit case number
Diagram
Diagram schema_xsd.tmp#compactCaseNumber
Type bkw:compactCaseNumber
Properties
content simple
Facets
pattern \d{2}-\d{5}
Source
 
<element name="caseNumber" type="bkw:compactCaseNumber">
  <annotation>
    <documentation>The seven-digit case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:amount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The payment amount
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="amount" type="bkw:dollarValue">
  <annotation>
    <documentation>The payment amount</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:interest
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The portion of the payment that represents an interest payment
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="interest" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The portion of the payment that represents an interest payment</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:date
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The check date
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="date" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The check date</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:accountNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The account number
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="accountNumber" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The account number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:comment
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A description of the payment added by the trustee
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="comment" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A description of the payment added by the trustee</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:debtor1
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The address of the debtor
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:debtor1 xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:debtor1>
Source
 
<element name="debtor1" type="bkw:address">
  <annotation>
    <documentation>The address of the debtor</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:debtor2
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The address of the joint debtor
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
minOccurs 0
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:debtor2 xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:debtor2>
Source
 
<element name="debtor2" type="bkw:address" minOccurs="0">
  <annotation>
    <documentation>The address of the joint debtor</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:creditor
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor name
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="creditor" type="xsd:string">
  <annotation>
    <documentation>The creditor name</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Information about the claim
Diagram
Diagram schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_amount schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_number schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_description schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_interestDue schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_interestPaid schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_interestRate schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_principleDue schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_principleOwed schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_principlePaid schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_scheduledAmount schema_xsd.tmp#trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_trusteeCheck_trusteeCheck_payments_trusteeCheck_trusteeCheck_payments_payment_claim_monthlyPayment
Properties
content complex
Model
Children bkw:amount, bkw:description, bkw:interestDue, bkw:interestPaid, bkw:interestRate, bkw:monthlyPayment, bkw:number, bkw:principleDue, bkw:principleOwed, bkw:principlePaid, bkw:scheduledAmount
Instance
 
<bkw:claim xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:amount>{1,1}</bkw:amount>
  <bkw:number>{1,1}</bkw:number>
  <bkw:description>{0,1}</bkw:description>
  <bkw:interestDue>{0,1}</bkw:interestDue>
  <bkw:interestPaid>{0,1}</bkw:interestPaid>
  <bkw:interestRate>{0,1}</bkw:interestRate>
  <bkw:principleDue>{0,1}</bkw:principleDue>
  <bkw:principleOwed>{0,1}</bkw:principleOwed>
  <bkw:principlePaid>{0,1}</bkw:principlePaid>
  <bkw:scheduledAmount>{0,1}</bkw:scheduledAmount>
  <bkw:monthlyPayment>{0,1}</bkw:monthlyPayment>
</bkw:claim>
Source
 
<element name="claim">
  <annotation>
    <documentation>Information about the claim</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="amount" type="bkw:dollarValue">
        <annotation>
          <documentation>The claim amount</documentation>
        </annotation>
      </element>
      <element name="number" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The claim number</documentation>
        </annotation>
      </element>
      <element name="description" type="xsd:string" minOccurs="0">
        <annotation>
          <documentation>The claim description</documentation>
        </annotation>
      </element>
      <element name="interestDue" type="bkw:dollarValue" minOccurs="0">
        <annotation>
          <documentation>The interest due</documentation>
        </annotation>
      </element>
      <element name="interestPaid" type="bkw:dollarValue" minOccurs="0">
        <annotation>
          <documentation>The interest paid</documentation>
        </annotation>
      </element>
      <element name="interestRate" type="xsd:decimal" minOccurs="0">
        <annotation>
          <documentation>The interest rate</documentation>
        </annotation>
      </element>
      <element name="principleDue" type="bkw:dollarValue" minOccurs="0">
        <annotation>
          <documentation>The principle due</documentation>
        </annotation>
      </element>
      <element name="principleOwed" type="bkw:dollarValue" minOccurs="0">
        <annotation>
          <documentation>The principle owed</documentation>
        </annotation>
      </element>
      <element name="principlePaid" type="bkw:dollarValue" minOccurs="0">
        <annotation>
          <documentation>The principle paid</documentation>
        </annotation>
      </element>
      <element name="scheduledAmount" type="bkw:dollarValue" minOccurs="0">
        <annotation>
          <documentation>The scheduled amount</documentation>
        </annotation>
      </element>
      <element name="monthlyPayment" type="bkw:dollarValue" minOccurs="0">
        <annotation>
          <documentation>The montly payment amount</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:amount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The claim amount
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="amount" type="bkw:dollarValue">
  <annotation>
    <documentation>The claim amount</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:number
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The claim number
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="number" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The claim number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:description
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The claim description
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="description" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The claim description</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:interestDue
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The interest due
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="interestDue" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The interest due</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:interestPaid
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The interest paid
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="interestPaid" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The interest paid</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:interestRate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The interest rate
Diagram
Diagram
Type decimal
Properties
content simple
minOccurs 0
Source
 
<element name="interestRate" type="xsd:decimal" minOccurs="0">
  <annotation>
    <documentation>The interest rate</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:principleDue
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The principle due
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="principleDue" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The principle due</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:principleOwed
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The principle owed
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="principleOwed" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The principle owed</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:principlePaid
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The principle paid
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="principlePaid" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The principle paid</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:scheduledAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The scheduled amount
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="scheduledAmount" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The scheduled amount</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trusteeCheck / bkw:payments / bkw:payment / bkw:claim / bkw:monthlyPayment
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The montly payment amount
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="monthlyPayment" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The montly payment amount</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The trustee ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The trustee ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:chapters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of chapters
Diagram
Diagram schema_xsd.tmp#chapterList
Type bkw:chapterList
Properties
content simple
Facets
pattern (7|9|11|12|13|15|304)(,(7|9|11|12|13|15|304))*
Source
 
<element name="chapters" type="bkw:chapterList">
  <annotation>
    <documentation>A comma-separated list of chapters</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:address
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The trustee address
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:address xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:address>
Source
 
<element name="address" type="bkw:address">
  <annotation>
    <documentation>The trustee address</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:active
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicate if trustee is active or inactive
Diagram
Diagram
Type boolean
Properties
content simple
Source
 
<element name="active" type="boolean">
  <annotation>
    <documentation>Indicate if trustee is active or inactive</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:chapter13Services
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of chapter 13 trustee payment services
Diagram
Diagram schema_xsd.tmp#trustee_trustee_chapter13Services_chapter13Service
Properties
content complex
minOccurs 0
Model
Children bkw:chapter13Service
Instance
 
<bkw:chapter13Services xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:chapter13Service>{1,unbounded}</bkw:chapter13Service>
</bkw:chapter13Services>
Source
 
<element name="chapter13Services" minOccurs="0">
  <annotation>
    <documentation>A list of chapter 13 trustee payment services</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="chapter13Service" maxOccurs="unbounded">
        <annotation>
          <documentation>A chapter 13 payment service</documentation>
        </annotation>
        <complexType>
          <sequence>
            <element name="id" type="bkw:resourceId">
              <annotation>
                <documentation>The service ID</documentation>
              </annotation>
            </element>
            <element name="division" type="string" minOccurs="0">
              <annotation>
                <documentation>The name of a division within the district, if the service is limited to a specific division</documentation>
              </annotation>
            </element>
          </sequence>
        </complexType>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:chapter13Services / bkw:chapter13Service
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A chapter 13 payment service
Diagram
Diagram schema_xsd.tmp#trustee_trustee_chapter13Services_trustee_trustee_chapter13Services_chapter13Service_id schema_xsd.tmp#trustee_trustee_chapter13Services_trustee_trustee_chapter13Services_chapter13Service_division
Properties
content complex
maxOccurs unbounded
Model
Children bkw:division, bkw:id
Instance
 
<bkw:chapter13Service xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:division>{0,1}</bkw:division>
</bkw:chapter13Service>
Source
 
<element name="chapter13Service" maxOccurs="unbounded">
  <annotation>
    <documentation>A chapter 13 payment service</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="id" type="bkw:resourceId">
        <annotation>
          <documentation>The service ID</documentation>
        </annotation>
      </element>
      <element name="division" type="string" minOccurs="0">
        <annotation>
          <documentation>The name of a division within the district, if the service is limited to a specific division</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:chapter13Services / bkw:chapter13Service / bkw:id
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The service ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="id" type="bkw:resourceId">
  <annotation>
    <documentation>The service ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:trustee / bkw:chapter13Services / bkw:chapter13Service / bkw:division
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The name of a division within the district, if the
service is limited to a specific division
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="division" type="string" minOccurs="0">
  <annotation>
    <documentation>The name of a division within the district, if the service is limited to a specific division</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenRequestType / bkw:lifetime
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The token lifetime, in seconds
Diagram
Diagram
Type positiveInteger
Properties
content simple
Source
 
<element name="lifetime" type="xsd:positiveInteger">
  <annotation>
    <documentation>The token lifetime, in seconds</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenRequestType / bkw:label
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A descriptive label
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="label" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A descriptive label</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenResponseType / bkw:token
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The alphanumeric identifier
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="token" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The alphanumeric identifier</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CreateAuthTokenRequestType_username schema_xsd.tmp#CreateAuthTokenRequestType_password schema_xsd.tmp#CreateAuthTokenRequestType_authtoken schema_xsd.tmp#CreateAuthTokenRequestType_lifetime schema_xsd.tmp#CreateAuthTokenRequestType_label schema_xsd.tmp#CreateAuthTokenRequestType
Type bkw:CreateAuthTokenRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:label, bkw:lifetime, bkw:password, bkw:username
Instance
 
<bkw:CreateAuthTokenRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:lifetime>{1,1}</bkw:lifetime>
  <bkw:label>{0,1}</bkw:label>
</bkw:CreateAuthTokenRequest>
Source
 
<element name="CreateAuthTokenRequest" type="bkw:CreateAuthTokenRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateAuthTokenResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CreateAuthTokenResponseType_token schema_xsd.tmp#CreateAuthTokenResponseType_status schema_xsd.tmp#CreateAuthTokenResponseType_message schema_xsd.tmp#CreateAuthTokenResponseType
Type bkw:CreateAuthTokenResponseType
Properties
content complex
Model
Children bkw:message, bkw:status, bkw:token
Instance
 
<bkw:CreateAuthTokenResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:token>{0,1}</bkw:token>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:CreateAuthTokenResponse>
Source
 
<element name="CreateAuthTokenResponse" type="bkw:CreateAuthTokenResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RevokeAuthTokenRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RevokeAuthTokenRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RevokeAuthTokenRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RevokeAuthTokenRequestType / bkw:token
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The alphanumeric identifier
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="token" type="bkw:requiredText">
  <annotation>
    <documentation>The alphanumeric identifier</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RevokeAuthTokenResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RevokeAuthTokenResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RevokeAuthTokenRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RevokeAuthTokenRequestType_username schema_xsd.tmp#RevokeAuthTokenRequestType_password schema_xsd.tmp#RevokeAuthTokenRequestType_authtoken schema_xsd.tmp#RevokeAuthTokenRequestType_token schema_xsd.tmp#RevokeAuthTokenRequestType
Type bkw:RevokeAuthTokenRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:password, bkw:token, bkw:username
Instance
 
<bkw:RevokeAuthTokenRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:token>{1,1}</bkw:token>
</bkw:RevokeAuthTokenRequest>
Source
 
<element name="RevokeAuthTokenRequest" type="bkw:RevokeAuthTokenRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RevokeAuthTokenResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RevokeAuthTokenResponseType_status schema_xsd.tmp#RevokeAuthTokenResponseType_message schema_xsd.tmp#RevokeAuthTokenResponseType
Type bkw:RevokeAuthTokenResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:RevokeAuthTokenResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RevokeAuthTokenResponse>
Source
 
<element name="RevokeAuthTokenResponse" type="bkw:RevokeAuthTokenResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first district to be returned,
within the collection of all districts matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first district to be returned, within the collection of all districts matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last district to be returned, within
the collection of all districts matching the search criteria;
the search may return fewer district than requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last district to be returned, within the collection of all districts matching the search criteria; the search may return fewer district than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters. Supported fields are:

                  name (bkw:district)
                  code (xsd:integer)
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters. Supported fields are: name (bkw:district) code (xsd:integer)</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListDistrictsResponseType_ListDistrictsResponseType_results_items schema_xsd.tmp#ListDistrictsResponseType_ListDistrictsResponseType_results_offset schema_xsd.tmp#ListDistrictsResponseType_ListDistrictsResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" minOccurs="0">
        <annotation>
          <documentation>List of district names and codes</documentation>
        </annotation>
        <complexType>
          <sequence>
            <element name="district" maxOccurs="unbounded">
              <complexType>
                <sequence>
                  <element name="name" type="bkw:requiredText"/>
                  <element name="code" type="bkw:district"/>
                </sequence>
              </complexType>
            </element>
          </sequence>
        </complexType>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned district, within the collection of all districts matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of districts matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
List of district names and codes
Diagram
Diagram schema_xsd.tmp#ListDistrictsResponseType_ListDistrictsResponseType_results_ListDistrictsResponseType_ListDistrictsResponseType_results_items_district
Properties
content complex
minOccurs 0
Model
Children bkw:district
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:district>{1,unbounded}</bkw:district>
</bkw:items>
Source
 
<element name="items" minOccurs="0">
  <annotation>
    <documentation>List of district names and codes</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="district" maxOccurs="unbounded">
        <complexType>
          <sequence>
            <element name="name" type="bkw:requiredText"/>
            <element name="code" type="bkw:district"/>
          </sequence>
        </complexType>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:results / bkw:items / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListDistrictsResponseType_ListDistrictsResponseType_results_ListDistrictsResponseType_ListDistrictsResponseType_results_items_ListDistrictsResponseType_ListDistrictsResponseType_results_ListDistrictsResponseType_ListDistrictsResponseType_results_items_district_name schema_xsd.tmp#ListDistrictsResponseType_ListDistrictsResponseType_results_ListDistrictsResponseType_ListDistrictsResponseType_results_items_ListDistrictsResponseType_ListDistrictsResponseType_results_ListDistrictsResponseType_ListDistrictsResponseType_results_items_district_code
Properties
content complex
maxOccurs unbounded
Model
Children bkw:code, bkw:name
Instance
 
<bkw:district xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:name>{1,1}</bkw:name>
  <bkw:code>{1,1}</bkw:code>
</bkw:district>
Source
 
<element name="district" maxOccurs="unbounded">
  <complexType>
    <sequence>
      <element name="name" type="bkw:requiredText"/>
      <element name="code" type="bkw:district"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:results / bkw:items / bkw:district / bkw:name
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="name" type="bkw:requiredText"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:results / bkw:items / bkw:district / bkw:code
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="code" type="bkw:district"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned district, within
the collection of all districts matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned district, within the collection of all districts matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of districts matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of districts matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListDistrictsRequestType_username schema_xsd.tmp#ListDistrictsRequestType_password schema_xsd.tmp#ListDistrictsRequestType_authtoken schema_xsd.tmp#ListDistrictsRequestType_from schema_xsd.tmp#ListDistrictsRequestType_to schema_xsd.tmp#ListDistrictsRequestType_filters schema_xsd.tmp#ListDistrictsRequestType_sort schema_xsd.tmp#ListDistrictsRequestType
Type bkw:ListDistrictsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Instance
 
<bkw:ListDistrictsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
</bkw:ListDistrictsRequest>
Source
 
<element name="ListDistrictsRequest" type="bkw:ListDistrictsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDistrictsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListDistrictsResponseType_results schema_xsd.tmp#ListDistrictsResponseType_status schema_xsd.tmp#ListDistrictsResponseType_message schema_xsd.tmp#ListDistrictsResponseType
Type bkw:ListDistrictsResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListDistrictsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListDistrictsResponse>
Source
 
<element name="ListDistrictsResponse" type="bkw:ListDistrictsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first division to be returned,
within the collection of all divisions matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first division to be returned, within the collection of all divisions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last division to be returned, within
the collection of all divisions matching the search criteria;
the search may return fewer division than requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last division to be returned, within the collection of all divisions matching the search criteria; the search may return fewer division than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters. Supported fields are:

                  district (bkw:district)
                  name (xsd:string)
                  officeNumber (xsd:integer)
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters. Supported fields are: district (bkw:district) name (xsd:string) officeNumber (xsd:integer)</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListDivisionsResponseType_ListDivisionsResponseType_results_items schema_xsd.tmp#ListDivisionsResponseType_ListDivisionsResponseType_results_offset schema_xsd.tmp#ListDivisionsResponseType_ListDivisionsResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" minOccurs="0">
        <complexType>
          <sequence>
            <element name="division" maxOccurs="unbounded">
              <complexType>
                <sequence>
                  <element name="district" type="bkw:district">
                    <annotation>
                      <documentation>The district</documentation>
                    </annotation>
                  </element>
                  <element name="name" type="bkw:requiredText">
                    <annotation>
                      <documentation>The division name; typically a city name</documentation>
                    </annotation>
                  </element>
                  <element name="officeNumber" type="xsd:int">
                    <annotation>
                      <documentation>The office number</documentation>
                    </annotation>
                  </element>
                </sequence>
              </complexType>
            </element>
          </sequence>
        </complexType>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned division, within the collection of all divisions matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of divisions matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListDivisionsResponseType_ListDivisionsResponseType_results_ListDivisionsResponseType_ListDivisionsResponseType_results_items_division
Properties
content complex
minOccurs 0
Model
Children bkw:division
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:division>{1,unbounded}</bkw:division>
</bkw:items>
Source
 
<element name="items" minOccurs="0">
  <complexType>
    <sequence>
      <element name="division" maxOccurs="unbounded">
        <complexType>
          <sequence>
            <element name="district" type="bkw:district">
              <annotation>
                <documentation>The district</documentation>
              </annotation>
            </element>
            <element name="name" type="bkw:requiredText">
              <annotation>
                <documentation>The division name; typically a city name</documentation>
              </annotation>
            </element>
            <element name="officeNumber" type="xsd:int">
              <annotation>
                <documentation>The office number</documentation>
              </annotation>
            </element>
          </sequence>
        </complexType>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:results / bkw:items / bkw:division
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListDivisionsResponseType_ListDivisionsResponseType_results_ListDivisionsResponseType_ListDivisionsResponseType_results_items_ListDivisionsResponseType_ListDivisionsResponseType_results_ListDivisionsResponseType_ListDivisionsResponseType_results_items_division_district schema_xsd.tmp#ListDivisionsResponseType_ListDivisionsResponseType_results_ListDivisionsResponseType_ListDivisionsResponseType_results_items_ListDivisionsResponseType_ListDivisionsResponseType_results_ListDivisionsResponseType_ListDivisionsResponseType_results_items_division_name schema_xsd.tmp#ListDivisionsResponseType_ListDivisionsResponseType_results_ListDivisionsResponseType_ListDivisionsResponseType_results_items_ListDivisionsResponseType_ListDivisionsResponseType_results_ListDivisionsResponseType_ListDivisionsResponseType_results_items_division_officeNumber
Properties
content complex
maxOccurs unbounded
Model
Children bkw:district, bkw:name, bkw:officeNumber
Instance
 
<bkw:division xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:district>{1,1}</bkw:district>
  <bkw:name>{1,1}</bkw:name>
  <bkw:officeNumber>{1,1}</bkw:officeNumber>
</bkw:division>
Source
 
<element name="division" maxOccurs="unbounded">
  <complexType>
    <sequence>
      <element name="district" type="bkw:district">
        <annotation>
          <documentation>The district</documentation>
        </annotation>
      </element>
      <element name="name" type="bkw:requiredText">
        <annotation>
          <documentation>The division name; typically a city name</documentation>
        </annotation>
      </element>
      <element name="officeNumber" type="xsd:int">
        <annotation>
          <documentation>The office number</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:results / bkw:items / bkw:division / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:results / bkw:items / bkw:division / bkw:name
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The division name; typically a city name
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="name" type="bkw:requiredText">
  <annotation>
    <documentation>The division name; typically a city name</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:results / bkw:items / bkw:division / bkw:officeNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The office number
Diagram
Diagram
Type int
Properties
content simple
Source
 
<element name="officeNumber" type="xsd:int">
  <annotation>
    <documentation>The office number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned division, within
the collection of all divisions matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned division, within the collection of all divisions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of divisions matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of divisions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListDivisionsRequestType_username schema_xsd.tmp#ListDivisionsRequestType_password schema_xsd.tmp#ListDivisionsRequestType_authtoken schema_xsd.tmp#ListDivisionsRequestType_from schema_xsd.tmp#ListDivisionsRequestType_to schema_xsd.tmp#ListDivisionsRequestType_filters schema_xsd.tmp#ListDivisionsRequestType_sort schema_xsd.tmp#ListDivisionsRequestType
Type bkw:ListDivisionsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Instance
 
<bkw:ListDivisionsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
</bkw:ListDivisionsRequest>
Source
 
<element name="ListDivisionsRequest" type="bkw:ListDivisionsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListDivisionsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListDivisionsResponseType_results schema_xsd.tmp#ListDivisionsResponseType_status schema_xsd.tmp#ListDivisionsResponseType_message schema_xsd.tmp#ListDivisionsResponseType
Type bkw:ListDivisionsResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListDivisionsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListDivisionsResponse>
Source
 
<element name="ListDivisionsResponse" type="bkw:ListDivisionsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseRequestType / bkw:caseId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case ID, of the form case-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="caseId" type="bkw:resourceId">
  <annotation>
    <documentation>The case ID, of the form case-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A whitespace-separated list of output format names; supported
format names are: claims, creditors, docket, filings, parties
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>A whitespace-separated list of output format names; supported format names are: claims, creditors, docket, filings, parties</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseResponseType / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case with the specified ID
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>The case with the specified ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewCaseRequestType_username schema_xsd.tmp#ViewCaseRequestType_password schema_xsd.tmp#ViewCaseRequestType_authtoken schema_xsd.tmp#ViewCaseRequestType_caseId schema_xsd.tmp#ViewCaseRequestType_outputFormat schema_xsd.tmp#ViewCaseRequestType
Type bkw:ViewCaseRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:caseId, bkw:outputFormat, bkw:password, bkw:username
Instance
 
<bkw:ViewCaseRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:caseId>{1,1}</bkw:caseId>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ViewCaseRequest>
Source
 
<element name="ViewCaseRequest" type="bkw:ViewCaseRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCaseResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewCaseResponseType_case schema_xsd.tmp#ViewCaseResponseType_status schema_xsd.tmp#ViewCaseResponseType_message schema_xsd.tmp#ViewCaseResponseType
Type bkw:ViewCaseResponseType
Properties
content complex
Model
Children bkw:case, bkw:message, bkw:status
Instance
 
<bkw:ViewCaseResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,1}</bkw:case>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ViewCaseResponse>
Source
 
<element name="ViewCaseResponse" type="bkw:ViewCaseResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimRequestType / bkw:claimId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The claim ID, of the form claim-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="claimId" type="bkw:resourceId">
  <annotation>
    <documentation>The claim ID, of the form claim-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A whitespace-separated list of output format names; supported
format names are: filings, case.summary
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>A whitespace-separated list of output format names; supported format names are: filings, case.summary</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimResponseType / bkw:claim
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The claim with the specified ID
Diagram
Diagram schema_xsd.tmp#claim_id schema_xsd.tmp#claim_case schema_xsd.tmp#claim_claimNumber schema_xsd.tmp#claim_creditor schema_xsd.tmp#claim_dateFiled schema_xsd.tmp#claim_amendedDateFiled schema_xsd.tmp#claim_dateModified schema_xsd.tmp#claim_unsecuredClaimed schema_xsd.tmp#claim_securedClaimed schema_xsd.tmp#claim_priorityClaimed schema_xsd.tmp#claim_unknownClaimed schema_xsd.tmp#claim_administrativeClaimed schema_xsd.tmp#claim_totalClaimed schema_xsd.tmp#claim_unsecuredAllowed schema_xsd.tmp#claim_securedAllowed schema_xsd.tmp#claim_priorityAllowed schema_xsd.tmp#claim_unknownAllowed schema_xsd.tmp#claim_administrativeAllowed schema_xsd.tmp#claim_totalAllowed schema_xsd.tmp#claim_statusText schema_xsd.tmp#claim_filings schema_xsd.tmp#claim
Type bkw:claim
Properties
content complex
minOccurs 0
Model
Children bkw:administrativeAllowed, bkw:administrativeClaimed, bkw:amendedDateFiled, bkw:case, bkw:claimNumber, bkw:creditor, bkw:dateFiled, bkw:dateModified, bkw:filings, bkw:id, bkw:priorityAllowed, bkw:priorityClaimed, bkw:securedAllowed, bkw:securedClaimed, bkw:statusText, bkw:totalAllowed, bkw:totalClaimed, bkw:unknownAllowed, bkw:unknownClaimed, bkw:unsecuredAllowed, bkw:unsecuredClaimed
Instance
 
<bkw:claim xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:claimNumber>{1,1}</bkw:claimNumber>
  <bkw:creditor>{0,1}</bkw:creditor>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:amendedDateFiled>{0,1}</bkw:amendedDateFiled>
  <bkw:dateModified>{0,1}</bkw:dateModified>
  <bkw:unsecuredClaimed>{0,1}</bkw:unsecuredClaimed>
  <bkw:securedClaimed>{0,1}</bkw:securedClaimed>
  <bkw:priorityClaimed>{0,1}</bkw:priorityClaimed>
  <bkw:unknownClaimed>{0,1}</bkw:unknownClaimed>
  <bkw:administrativeClaimed>{0,1}</bkw:administrativeClaimed>
  <bkw:totalClaimed>{0,1}</bkw:totalClaimed>
  <bkw:unsecuredAllowed>{0,1}</bkw:unsecuredAllowed>
  <bkw:securedAllowed>{0,1}</bkw:securedAllowed>
  <bkw:priorityAllowed>{0,1}</bkw:priorityAllowed>
  <bkw:unknownAllowed>{0,1}</bkw:unknownAllowed>
  <bkw:administrativeAllowed>{0,1}</bkw:administrativeAllowed>
  <bkw:totalAllowed>{0,1}</bkw:totalAllowed>
  <bkw:statusText>{0,1}</bkw:statusText>
  <bkw:filings>{0,1}</bkw:filings>
</bkw:claim>
Source
 
<element name="claim" type="bkw:claim" minOccurs="0">
  <annotation>
    <documentation>The claim with the specified ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewClaimRequestType_username schema_xsd.tmp#ViewClaimRequestType_password schema_xsd.tmp#ViewClaimRequestType_authtoken schema_xsd.tmp#ViewClaimRequestType_claimId schema_xsd.tmp#ViewClaimRequestType_outputFormat schema_xsd.tmp#ViewClaimRequestType
Type bkw:ViewClaimRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:claimId, bkw:outputFormat, bkw:password, bkw:username
Instance
 
<bkw:ViewClaimRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:claimId>{1,1}</bkw:claimId>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ViewClaimRequest>
Source
 
<element name="ViewClaimRequest" type="bkw:ViewClaimRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewClaimResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewClaimResponseType_claim schema_xsd.tmp#ViewClaimResponseType_status schema_xsd.tmp#ViewClaimResponseType_message schema_xsd.tmp#ViewClaimResponseType
Type bkw:ViewClaimResponseType
Properties
content complex
Model
Children bkw:claim, bkw:message, bkw:status
Instance
 
<bkw:ViewClaimResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:claim>{0,1}</bkw:claim>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ViewClaimResponse>
Source
 
<element name="ViewClaimResponse" type="bkw:ViewClaimResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorRequestType / bkw:creditorId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor ID, of the form creditor-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="creditorId" type="bkw:resourceId">
  <annotation>
    <documentation>The creditor ID, of the form creditor-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A whitespace-separated list of output format names; supported
format names are: case.summary
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>A whitespace-separated list of output format names; supported format names are: case.summary</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorResponseType / bkw:creditor
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor with the specified ID
Diagram
Diagram schema_xsd.tmp#creditor_id schema_xsd.tmp#creditor_case schema_xsd.tmp#creditor_name schema_xsd.tmp#creditor_creditorNumber schema_xsd.tmp#creditor_address schema_xsd.tmp#creditor
Type bkw:creditor
Properties
content complex
minOccurs 0
Model
Children bkw:address, bkw:case, bkw:creditorNumber, bkw:id, bkw:name
Instance
 
<bkw:creditor xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{0,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:name>{1,1}</bkw:name>
  <bkw:creditorNumber>{0,1}</bkw:creditorNumber>
  <bkw:address>{1,1}</bkw:address>
</bkw:creditor>
Source
 
<element name="creditor" type="bkw:creditor" minOccurs="0">
  <annotation>
    <documentation>The creditor with the specified ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewCreditorRequestType_username schema_xsd.tmp#ViewCreditorRequestType_password schema_xsd.tmp#ViewCreditorRequestType_authtoken schema_xsd.tmp#ViewCreditorRequestType_creditorId schema_xsd.tmp#ViewCreditorRequestType_outputFormat schema_xsd.tmp#ViewCreditorRequestType
Type bkw:ViewCreditorRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:creditorId, bkw:outputFormat, bkw:password, bkw:username
Instance
 
<bkw:ViewCreditorRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:creditorId>{1,1}</bkw:creditorId>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ViewCreditorRequest>
Source
 
<element name="ViewCreditorRequest" type="bkw:ViewCreditorRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewCreditorResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewCreditorResponseType_creditor schema_xsd.tmp#ViewCreditorResponseType_status schema_xsd.tmp#ViewCreditorResponseType_message schema_xsd.tmp#ViewCreditorResponseType
Type bkw:ViewCreditorResponseType
Properties
content complex
Model
Children bkw:creditor, bkw:message, bkw:status
Instance
 
<bkw:ViewCreditorResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:creditor>{0,1}</bkw:creditor>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ViewCreditorResponse>
Source
 
<element name="ViewCreditorResponse" type="bkw:ViewCreditorResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingRequestType / bkw:filingId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The filing ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="filingId" type="bkw:resourceId">
  <annotation>
    <documentation>The filing ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A whitespace-separated list of output format names; supported
format names are: documents, case.summary. Defaults to
"documents".
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>A whitespace-separated list of output format names; supported format names are: documents, case.summary. Defaults to "documents".</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingResponseType / bkw:filing
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The fililng with the specified ID
Diagram
Diagram schema_xsd.tmp#filing_id schema_xsd.tmp#filing_case schema_xsd.tmp#filing_type schema_xsd.tmp#filing_dateFiled schema_xsd.tmp#filing_claimNumber schema_xsd.tmp#filing_itemNumber schema_xsd.tmp#filing_title schema_xsd.tmp#filing_text schema_xsd.tmp#filing_url schema_xsd.tmp#filing_documents schema_xsd.tmp#filing
Type bkw:filing
Properties
content complex
minOccurs 0
Model
Children bkw:case, bkw:claimNumber, bkw:dateFiled, bkw:documents, bkw:id, bkw:itemNumber, bkw:text, bkw:title, bkw:type, bkw:url
Instance
 
<bkw:filing xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:type>{0,1}</bkw:type>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:claimNumber>{0,1}</bkw:claimNumber>
  <bkw:itemNumber>{0,1}</bkw:itemNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:text>{0,1}</bkw:text>
  <bkw:url>{0,1}</bkw:url>
  <bkw:documents>{0,1}</bkw:documents>
</bkw:filing>
Source
 
<element name="filing" type="bkw:filing" minOccurs="0">
  <annotation>
    <documentation>The fililng with the specified ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewFilingRequestType_username schema_xsd.tmp#ViewFilingRequestType_password schema_xsd.tmp#ViewFilingRequestType_authtoken schema_xsd.tmp#ViewFilingRequestType_filingId schema_xsd.tmp#ViewFilingRequestType_outputFormat schema_xsd.tmp#ViewFilingRequestType
Type bkw:ViewFilingRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filingId, bkw:outputFormat, bkw:password, bkw:username
Instance
 
<bkw:ViewFilingRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:filingId>{1,1}</bkw:filingId>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ViewFilingRequest>
Source
 
<element name="ViewFilingRequest" type="bkw:ViewFilingRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewFilingResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewFilingResponseType_filing schema_xsd.tmp#ViewFilingResponseType_status schema_xsd.tmp#ViewFilingResponseType_message schema_xsd.tmp#ViewFilingResponseType
Type bkw:ViewFilingResponseType
Properties
content complex
Model
Children bkw:filing, bkw:message, bkw:status
Instance
 
<bkw:ViewFilingResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filing>{0,1}</bkw:filing>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ViewFilingResponse>
Source
 
<element name="ViewFilingResponse" type="bkw:ViewFilingResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyRequestType / bkw:partyId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The party ID, of the form party-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="partyId" type="bkw:resourceId">
  <annotation>
    <documentation>The party ID, of the form party-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A whitespace-separated list of output format names; supported
format names are: attorneys, case.summary.
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>A whitespace-separated list of output format names; supported format names are: attorneys, case.summary.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyResponseType / bkw:party
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The party with the specified ID
Diagram
Diagram schema_xsd.tmp#party_id schema_xsd.tmp#party_case schema_xsd.tmp#party_role schema_xsd.tmp#party_address schema_xsd.tmp#party_dateAdded schema_xsd.tmp#party_dateTerminated schema_xsd.tmp#party_attorneys schema_xsd.tmp#party
Type bkw:party
Properties
content complex
minOccurs 0
Model
Children bkw:address, bkw:attorneys, bkw:case, bkw:dateAdded, bkw:dateTerminated, bkw:id, bkw:role
Instance
 
<bkw:party xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:case>{0,1}</bkw:case>
  <bkw:role>{1,1}</bkw:role>
  <bkw:address>{1,1}</bkw:address>
  <bkw:dateAdded>{0,1}</bkw:dateAdded>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:attorneys>{0,1}</bkw:attorneys>
</bkw:party>
Source
 
<element name="party" type="bkw:party" minOccurs="0">
  <annotation>
    <documentation>The party with the specified ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewPartyRequestType_username schema_xsd.tmp#ViewPartyRequestType_password schema_xsd.tmp#ViewPartyRequestType_authtoken schema_xsd.tmp#ViewPartyRequestType_partyId schema_xsd.tmp#ViewPartyRequestType_outputFormat schema_xsd.tmp#ViewPartyRequestType
Type bkw:ViewPartyRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:outputFormat, bkw:partyId, bkw:password, bkw:username
Instance
 
<bkw:ViewPartyRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:partyId>{1,1}</bkw:partyId>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ViewPartyRequest>
Source
 
<element name="ViewPartyRequest" type="bkw:ViewPartyRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPartyResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewPartyResponseType_party schema_xsd.tmp#ViewPartyResponseType_status schema_xsd.tmp#ViewPartyResponseType_message schema_xsd.tmp#ViewPartyResponseType
Type bkw:ViewPartyResponseType
Properties
content complex
Model
Children bkw:message, bkw:party, bkw:status
Instance
 
<bkw:ViewPartyResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:party>{0,1}</bkw:party>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ViewPartyResponse>
Source
 
<element name="ViewPartyResponse" type="bkw:ViewPartyResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first trustee to be returned,
within the collection of all trustees matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first trustee to be returned, within the collection of all trustees matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last trustee to be returned, within
the collection of all trustees matching the search criteria;
the search may return fewer trustees than requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last trustee to be returned, within the collection of all trustees matching the search criteria; the search may return fewer trustees than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters. Supported fields are:

                  id (bkw:resourceId)
                  district (bkw:district)
                  state (bkw:usState)
                  chapter (bkw:chapter)
                  active (xsd:boolean)
                  firstName (xsd:string)
                  lastName (xsd:string)
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters. Supported fields are: id (bkw:resourceId) district (bkw:district) state (bkw:usState) chapter (bkw:chapter) active (xsd:boolean) firstName (xsd:string) lastName (xsd:string)</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListTrusteesResponseType_ListTrusteesResponseType_results_items schema_xsd.tmp#ListTrusteesResponseType_ListTrusteesResponseType_results_offset schema_xsd.tmp#ListTrusteesResponseType_ListTrusteesResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" minOccurs="0">
        <annotation>
          <documentation>The list of trustees</documentation>
        </annotation>
        <complexType>
          <sequence>
            <element name="trustee" type="bkw:trustee" maxOccurs="unbounded">
              <annotation>
                <documentation>The trustee</documentation>
              </annotation>
            </element>
          </sequence>
        </complexType>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned trustee, within the collection of all trustees matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of trustees matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of trustees
Diagram
Diagram schema_xsd.tmp#ListTrusteesResponseType_ListTrusteesResponseType_results_ListTrusteesResponseType_ListTrusteesResponseType_results_items_trustee
Properties
content complex
minOccurs 0
Model
Children bkw:trustee
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:trustee>{1,unbounded}</bkw:trustee>
</bkw:items>
Source
 
<element name="items" minOccurs="0">
  <annotation>
    <documentation>The list of trustees</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="trustee" type="bkw:trustee" maxOccurs="unbounded">
        <annotation>
          <documentation>The trustee</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesResponseType / bkw:results / bkw:items / bkw:trustee
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The trustee
Diagram
Diagram schema_xsd.tmp#trustee_id schema_xsd.tmp#trustee_district schema_xsd.tmp#trustee_chapters schema_xsd.tmp#trustee_address schema_xsd.tmp#trustee_active schema_xsd.tmp#trustee_chapter13Services schema_xsd.tmp#trustee
Type bkw:trustee
Properties
content complex
maxOccurs unbounded
Model
Children bkw:active, bkw:address, bkw:chapter13Services, bkw:chapters, bkw:district, bkw:id
Instance
 
<bkw:trustee xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:chapters>{1,1}</bkw:chapters>
  <bkw:address>{1,1}</bkw:address>
  <bkw:active>{1,1}</bkw:active>
  <bkw:chapter13Services>{0,1}</bkw:chapter13Services>
</bkw:trustee>
Source
 
<element name="trustee" type="bkw:trustee" maxOccurs="unbounded">
  <annotation>
    <documentation>The trustee</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned trustee, within
the collection of all trustees matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned trustee, within the collection of all trustees matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of trustees matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of trustees matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListTrusteesRequestType_username schema_xsd.tmp#ListTrusteesRequestType_password schema_xsd.tmp#ListTrusteesRequestType_authtoken schema_xsd.tmp#ListTrusteesRequestType_from schema_xsd.tmp#ListTrusteesRequestType_to schema_xsd.tmp#ListTrusteesRequestType_filters schema_xsd.tmp#ListTrusteesRequestType_sort schema_xsd.tmp#ListTrusteesRequestType
Type bkw:ListTrusteesRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Instance
 
<bkw:ListTrusteesRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
</bkw:ListTrusteesRequest>
Source
 
<element name="ListTrusteesRequest" type="bkw:ListTrusteesRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteesResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListTrusteesResponseType_results schema_xsd.tmp#ListTrusteesResponseType_status schema_xsd.tmp#ListTrusteesResponseType_message schema_xsd.tmp#ListTrusteesResponseType
Type bkw:ListTrusteesResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListTrusteesResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListTrusteesResponse>
Source
 
<element name="ListTrusteesResponse" type="bkw:ListTrusteesResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountRequestType / bkw:accountUsername
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The account username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="accountUsername" type="bkw:requiredText">
  <annotation>
    <documentation>The account username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountRequestType / bkw:accountPassword
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The account password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="accountPassword" type="bkw:requiredText">
  <annotation>
    <documentation>The account password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district, for current generation CM/ECF accounts
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
minOccurs 0
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district" minOccurs="0">
  <annotation>
    <documentation>The district, for current generation CM/ECF accounts</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountRequestType / bkw:description
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The account description
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="description" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The account description</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountResponseType / bkw:accountId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the newly created account, of the form
pacer-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="accountId" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the newly created account, of the form pacer-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CreatePacerAccountRequestType_username schema_xsd.tmp#CreatePacerAccountRequestType_password schema_xsd.tmp#CreatePacerAccountRequestType_authtoken schema_xsd.tmp#CreatePacerAccountRequestType_accountUsername schema_xsd.tmp#CreatePacerAccountRequestType_accountPassword schema_xsd.tmp#CreatePacerAccountRequestType_district schema_xsd.tmp#CreatePacerAccountRequestType_description schema_xsd.tmp#CreatePacerAccountRequestType
Type bkw:CreatePacerAccountRequestType
Properties
content complex
Model
Children bkw:accountPassword, bkw:accountUsername, bkw:authtoken, bkw:description, bkw:district, bkw:password, bkw:username
Instance
 
<bkw:CreatePacerAccountRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:accountUsername>{1,1}</bkw:accountUsername>
  <bkw:accountPassword>{1,1}</bkw:accountPassword>
  <bkw:district>{0,1}</bkw:district>
  <bkw:description>{0,1}</bkw:description>
</bkw:CreatePacerAccountRequest>
Source
 
<element name="CreatePacerAccountRequest" type="bkw:CreatePacerAccountRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreatePacerAccountResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CreatePacerAccountResponseType_accountId schema_xsd.tmp#CreatePacerAccountResponseType_status schema_xsd.tmp#CreatePacerAccountResponseType_message schema_xsd.tmp#CreatePacerAccountResponseType
Type bkw:CreatePacerAccountResponseType
Properties
content complex
Model
Children bkw:accountId, bkw:message, bkw:status
Instance
 
<bkw:CreatePacerAccountResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:accountId>{0,1}</bkw:accountId>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:CreatePacerAccountResponse>
Source
 
<element name="CreatePacerAccountResponse" type="bkw:CreatePacerAccountResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountRequestType / bkw:accountId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the account to be updated, of the form
pacer-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="accountId" type="bkw:resourceId">
  <annotation>
    <documentation>Identifier of the account to be updated, of the form pacer-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountRequestType / bkw:accountPassword
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The new account password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="accountPassword" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The new account password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountRequestType / bkw:description
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The new account description
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="description" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The new account description</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#UpdatePacerAccountRequestType_username schema_xsd.tmp#UpdatePacerAccountRequestType_password schema_xsd.tmp#UpdatePacerAccountRequestType_authtoken schema_xsd.tmp#UpdatePacerAccountRequestType_accountId schema_xsd.tmp#UpdatePacerAccountRequestType_accountPassword schema_xsd.tmp#UpdatePacerAccountRequestType_description schema_xsd.tmp#UpdatePacerAccountRequestType
Type bkw:UpdatePacerAccountRequestType
Properties
content complex
Model
Children bkw:accountId, bkw:accountPassword, bkw:authtoken, bkw:description, bkw:password, bkw:username
Instance
 
<bkw:UpdatePacerAccountRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:accountId>{1,1}</bkw:accountId>
  <bkw:accountPassword>{0,1}</bkw:accountPassword>
  <bkw:description>{0,1}</bkw:description>
</bkw:UpdatePacerAccountRequest>
Source
 
<element name="UpdatePacerAccountRequest" type="bkw:UpdatePacerAccountRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:UpdatePacerAccountResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#UpdatePacerAccountResponseType_status schema_xsd.tmp#UpdatePacerAccountResponseType_message schema_xsd.tmp#UpdatePacerAccountResponseType
Type bkw:UpdatePacerAccountResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:UpdatePacerAccountResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:UpdatePacerAccountResponse>
Source
 
<element name="UpdatePacerAccountResponse" type="bkw:UpdatePacerAccountResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first account to be returned,
within the collection of all accounts matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first account to be returned, within the collection of all accounts matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last account to be returned, within
the collection of all accounts matching the search criteria;
the search may return fewer accounts than requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last account to be returned, within the collection of all accounts matching the search criteria; the search may return fewer accounts than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters. Supported fields are:

                  id (bkw:resourceId)
                  description (xsd:string)
                  district (bkw:district)
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters. Supported fields are: id (bkw:resourceId) description (xsd:string) district (bkw:district)</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListPacerAccountsResponseType_ListPacerAccountsResponseType_results_items schema_xsd.tmp#ListPacerAccountsResponseType_ListPacerAccountsResponseType_results_offset schema_xsd.tmp#ListPacerAccountsResponseType_ListPacerAccountsResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" minOccurs="0">
        <annotation>
          <documentation>List of registered PACER or current generation CM/ECF accounts</documentation>
        </annotation>
        <complexType>
          <sequence>
            <element name="account" type="bkw:pacerAccount" maxOccurs="unbounded"/>
          </sequence>
        </complexType>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned account, within the collection of all accounts matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of accounts matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
List of registered PACER or current generation CM/ECF accounts
Diagram
Diagram schema_xsd.tmp#ListPacerAccountsResponseType_ListPacerAccountsResponseType_results_ListPacerAccountsResponseType_ListPacerAccountsResponseType_results_items_account
Properties
content complex
minOccurs 0
Model
Children bkw:account
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:account>{1,unbounded}</bkw:account>
</bkw:items>
Source
 
<element name="items" minOccurs="0">
  <annotation>
    <documentation>List of registered PACER or current generation CM/ECF accounts</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="account" type="bkw:pacerAccount" maxOccurs="unbounded"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsResponseType / bkw:results / bkw:items / bkw:account
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#pacerAccount_id schema_xsd.tmp#pacerAccount_username schema_xsd.tmp#pacerAccount_password schema_xsd.tmp#pacerAccount_district schema_xsd.tmp#pacerAccount_description schema_xsd.tmp#pacerAccount_default schema_xsd.tmp#pacerAccount
Type bkw:pacerAccount
Properties
content complex
maxOccurs unbounded
Model
Children bkw:default, bkw:description, bkw:district, bkw:id, bkw:password, bkw:username
Instance
 
<bkw:account xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:username>{1,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:district>{0,1}</bkw:district>
  <bkw:description>{0,1}</bkw:description>
  <bkw:default>{1,1}</bkw:default>
</bkw:account>
Source
 
<element name="account" type="bkw:pacerAccount" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned account, within
the collection of all accounts matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned account, within the collection of all accounts matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of accounts matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of accounts matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListPacerAccountsRequestType_username schema_xsd.tmp#ListPacerAccountsRequestType_password schema_xsd.tmp#ListPacerAccountsRequestType_authtoken schema_xsd.tmp#ListPacerAccountsRequestType_from schema_xsd.tmp#ListPacerAccountsRequestType_to schema_xsd.tmp#ListPacerAccountsRequestType_filters schema_xsd.tmp#ListPacerAccountsRequestType_sort schema_xsd.tmp#ListPacerAccountsRequestType
Type bkw:ListPacerAccountsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Instance
 
<bkw:ListPacerAccountsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
</bkw:ListPacerAccountsRequest>
Source
 
<element name="ListPacerAccountsRequest" type="bkw:ListPacerAccountsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerAccountsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListPacerAccountsResponseType_results schema_xsd.tmp#ListPacerAccountsResponseType_status schema_xsd.tmp#ListPacerAccountsResponseType_message schema_xsd.tmp#ListPacerAccountsResponseType
Type bkw:ListPacerAccountsResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListPacerAccountsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListPacerAccountsResponse>
Source
 
<element name="ListPacerAccountsResponse" type="bkw:ListPacerAccountsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeletePacerAccountRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeletePacerAccountRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeletePacerAccountRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeletePacerAccountRequestType / bkw:accountId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the account to be deleted, of the form
pacer-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="accountId" type="bkw:resourceId">
  <annotation>
    <documentation>Identifier of the account to be deleted, of the form pacer-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeletePacerAccountResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeletePacerAccountResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeletePacerAccountRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#DeletePacerAccountRequestType_username schema_xsd.tmp#DeletePacerAccountRequestType_password schema_xsd.tmp#DeletePacerAccountRequestType_authtoken schema_xsd.tmp#DeletePacerAccountRequestType_accountId schema_xsd.tmp#DeletePacerAccountRequestType
Type bkw:DeletePacerAccountRequestType
Properties
content complex
Model
Children bkw:accountId, bkw:authtoken, bkw:password, bkw:username
Instance
 
<bkw:DeletePacerAccountRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:accountId>{1,1}</bkw:accountId>
</bkw:DeletePacerAccountRequest>
Source
 
<element name="DeletePacerAccountRequest" type="bkw:DeletePacerAccountRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeletePacerAccountResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#DeletePacerAccountResponseType_status schema_xsd.tmp#DeletePacerAccountResponseType_message schema_xsd.tmp#DeletePacerAccountResponseType
Type bkw:DeletePacerAccountResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:DeletePacerAccountResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:DeletePacerAccountResponse>
Source
 
<element name="DeletePacerAccountResponse" type="bkw:DeletePacerAccountResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountRequestType / bkw:accountId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the account to be updated
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="accountId" type="bkw:resourceId">
  <annotation>
    <documentation>Identifier of the account to be updated</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountRequestType / bkw:default
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
true to set the default status of the account, and false to
clear it; defaults to true. If true, the default status of
all other registered PACER accounts is cleared.
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="default" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>true to set the default status of the account, and false to clear it; defaults to true. If true, the default status of all other registered PACER accounts is cleared.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#SetDefaultPacerAccountRequestType_username schema_xsd.tmp#SetDefaultPacerAccountRequestType_password schema_xsd.tmp#SetDefaultPacerAccountRequestType_authtoken schema_xsd.tmp#SetDefaultPacerAccountRequestType_accountId schema_xsd.tmp#SetDefaultPacerAccountRequestType_default schema_xsd.tmp#SetDefaultPacerAccountRequestType
Type bkw:SetDefaultPacerAccountRequestType
Properties
content complex
Model
Children bkw:accountId, bkw:authtoken, bkw:default, bkw:password, bkw:username
Instance
 
<bkw:SetDefaultPacerAccountRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:accountId>{1,1}</bkw:accountId>
  <bkw:default>{0,1}</bkw:default>
</bkw:SetDefaultPacerAccountRequest>
Source
 
<element name="SetDefaultPacerAccountRequest" type="bkw:SetDefaultPacerAccountRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:SetDefaultPacerAccountResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#SetDefaultPacerAccountResponseType_status schema_xsd.tmp#SetDefaultPacerAccountResponseType_message schema_xsd.tmp#SetDefaultPacerAccountResponseType
Type bkw:SetDefaultPacerAccountResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:SetDefaultPacerAccountResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:SetDefaultPacerAccountResponse>
Source
 
<element name="SetDefaultPacerAccountResponse" type="bkw:SetDefaultPacerAccountResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportRequestType / bkw:reportId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The report ID, of the form report-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="reportId" type="bkw:resourceId">
  <annotation>
    <documentation>The report ID, of the form report-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The output format
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>The output format</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportResponseType / bkw:report
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The PACER report with the specified ID
Diagram
Diagram schema_xsd.tmp#pacerReport_id schema_xsd.tmp#pacerReport_type schema_xsd.tmp#pacerReport_document schema_xsd.tmp#pacerReport_timestamp schema_xsd.tmp#pacerReport_transaction schema_xsd.tmp#pacerReport_cases schema_xsd.tmp#pacerReport
Type bkw:pacerReport
Properties
content complex
minOccurs 0
Model
Children bkw:cases, bkw:document, bkw:id, bkw:timestamp, bkw:transaction, bkw:type
Instance
 
<bkw:report xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:type>{1,1}</bkw:type>
  <bkw:document>{0,1}</bkw:document>
  <bkw:timestamp>{1,1}</bkw:timestamp>
  <bkw:transaction>{0,1}</bkw:transaction>
  <bkw:cases>{0,1}</bkw:cases>
</bkw:report>
Source
 
<element name="report" type="bkw:pacerReport" minOccurs="0">
  <annotation>
    <documentation>The PACER report with the specified ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewPacerReportRequestType_username schema_xsd.tmp#ViewPacerReportRequestType_password schema_xsd.tmp#ViewPacerReportRequestType_authtoken schema_xsd.tmp#ViewPacerReportRequestType_reportId schema_xsd.tmp#ViewPacerReportRequestType_outputFormat schema_xsd.tmp#ViewPacerReportRequestType
Type bkw:ViewPacerReportRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:outputFormat, bkw:password, bkw:reportId, bkw:username
Instance
 
<bkw:ViewPacerReportRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:reportId>{1,1}</bkw:reportId>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ViewPacerReportRequest>
Source
 
<element name="ViewPacerReportRequest" type="bkw:ViewPacerReportRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerReportResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewPacerReportResponseType_report schema_xsd.tmp#ViewPacerReportResponseType_status schema_xsd.tmp#ViewPacerReportResponseType_message schema_xsd.tmp#ViewPacerReportResponseType
Type bkw:ViewPacerReportResponseType
Properties
content complex
Model
Children bkw:message, bkw:report, bkw:status
Instance
 
<bkw:ViewPacerReportResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:report>{0,1}</bkw:report>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ViewPacerReportResponse>
Source
 
<element name="ViewPacerReportResponse" type="bkw:ViewPacerReportResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first report to be returned,
within the collection of all reports matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first report to be returned, within the collection of all reports matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last report to be returned, within
the collection of all reports matching the search criteria;
the search may return fewer reports than requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last report to be returned, within the collection of all reports matching the search criteria; the search may return fewer reports than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The output format
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>The output format</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListPacerReportsResponseType_ListPacerReportsResponseType_results_items schema_xsd.tmp#ListPacerReportsResponseType_ListPacerReportsResponseType_results_offset schema_xsd.tmp#ListPacerReportsResponseType_ListPacerReportsResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" minOccurs="0">
        <annotation>
          <documentation>The list of reports</documentation>
        </annotation>
        <complexType>
          <choice>
            <element name="report" type="bkw:pacerReport" maxOccurs="unbounded"/>
          </choice>
        </complexType>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned report, within the collection of all reports matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of reports matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of reports
Diagram
Diagram schema_xsd.tmp#ListPacerReportsResponseType_ListPacerReportsResponseType_results_ListPacerReportsResponseType_ListPacerReportsResponseType_results_items_report
Properties
content complex
minOccurs 0
Model
Children bkw:report
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:report>{1,unbounded}</bkw:report>
</bkw:items>
Source
 
<element name="items" minOccurs="0">
  <annotation>
    <documentation>The list of reports</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="report" type="bkw:pacerReport" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsResponseType / bkw:results / bkw:items / bkw:report
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#pacerReport_id schema_xsd.tmp#pacerReport_type schema_xsd.tmp#pacerReport_document schema_xsd.tmp#pacerReport_timestamp schema_xsd.tmp#pacerReport_transaction schema_xsd.tmp#pacerReport_cases schema_xsd.tmp#pacerReport
Type bkw:pacerReport
Properties
content complex
maxOccurs unbounded
Model
Children bkw:cases, bkw:document, bkw:id, bkw:timestamp, bkw:transaction, bkw:type
Instance
 
<bkw:report xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:type>{1,1}</bkw:type>
  <bkw:document>{0,1}</bkw:document>
  <bkw:timestamp>{1,1}</bkw:timestamp>
  <bkw:transaction>{0,1}</bkw:transaction>
  <bkw:cases>{0,1}</bkw:cases>
</bkw:report>
Source
 
<element name="report" type="bkw:pacerReport" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned report, within
the collection of all reports matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned report, within the collection of all reports matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of reports matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of reports matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListPacerReportsRequestType_username schema_xsd.tmp#ListPacerReportsRequestType_password schema_xsd.tmp#ListPacerReportsRequestType_authtoken schema_xsd.tmp#ListPacerReportsRequestType_from schema_xsd.tmp#ListPacerReportsRequestType_to schema_xsd.tmp#ListPacerReportsRequestType_filters schema_xsd.tmp#ListPacerReportsRequestType_sort schema_xsd.tmp#ListPacerReportsRequestType_outputFormat schema_xsd.tmp#ListPacerReportsRequestType
Type bkw:ListPacerReportsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:outputFormat, bkw:password, bkw:sort, bkw:to, bkw:username
Instance
 
<bkw:ListPacerReportsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ListPacerReportsRequest>
Source
 
<element name="ListPacerReportsRequest" type="bkw:ListPacerReportsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerReportsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListPacerReportsResponseType_results schema_xsd.tmp#ListPacerReportsResponseType_status schema_xsd.tmp#ListPacerReportsResponseType_message schema_xsd.tmp#ListPacerReportsResponseType
Type bkw:ListPacerReportsResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListPacerReportsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListPacerReportsResponse>
Source
 
<element name="ListPacerReportsResponse" type="bkw:ListPacerReportsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionRequestType / bkw:transactionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The transaction ID, of the form trans-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="transactionId" type="bkw:resourceId">
  <annotation>
    <documentation>The transaction ID, of the form trans-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The output format
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>The output format</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionResponseType / bkw:transaction
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The PACER transaction with the specified ID
Diagram
Diagram schema_xsd.tmp#pacerTransaction_id schema_xsd.tmp#pacerTransaction_pacerAccount schema_xsd.tmp#pacerTransaction_user schema_xsd.tmp#pacerTransaction_datetime schema_xsd.tmp#pacerTransaction_description schema_xsd.tmp#pacerTransaction_searchCriteria schema_xsd.tmp#pacerTransaction_billablePages schema_xsd.tmp#pacerTransaction_cost schema_xsd.tmp#pacerTransaction
Type bkw:pacerTransaction
Properties
content complex
minOccurs 0
Model
Children bkw:billablePages, bkw:cost, bkw:datetime, bkw:description, bkw:id, bkw:pacerAccount, bkw:searchCriteria, bkw:user
Instance
 
<bkw:transaction xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
  <bkw:user>{0,1}</bkw:user>
  <bkw:datetime>{1,1}</bkw:datetime>
  <bkw:description>{0,1}</bkw:description>
  <bkw:searchCriteria>{0,1}</bkw:searchCriteria>
  <bkw:billablePages>{0,1}</bkw:billablePages>
  <bkw:cost>{1,1}</bkw:cost>
</bkw:transaction>
Source
 
<element name="transaction" type="bkw:pacerTransaction" minOccurs="0">
  <annotation>
    <documentation>The PACER transaction with the specified ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewPacerTransactionRequestType_username schema_xsd.tmp#ViewPacerTransactionRequestType_password schema_xsd.tmp#ViewPacerTransactionRequestType_authtoken schema_xsd.tmp#ViewPacerTransactionRequestType_transactionId schema_xsd.tmp#ViewPacerTransactionRequestType_outputFormat schema_xsd.tmp#ViewPacerTransactionRequestType
Type bkw:ViewPacerTransactionRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:outputFormat, bkw:password, bkw:transactionId, bkw:username
Instance
 
<bkw:ViewPacerTransactionRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:transactionId>{1,1}</bkw:transactionId>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ViewPacerTransactionRequest>
Source
 
<element name="ViewPacerTransactionRequest" type="bkw:ViewPacerTransactionRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ViewPacerTransactionResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ViewPacerTransactionResponseType_transaction schema_xsd.tmp#ViewPacerTransactionResponseType_status schema_xsd.tmp#ViewPacerTransactionResponseType_message schema_xsd.tmp#ViewPacerTransactionResponseType
Type bkw:ViewPacerTransactionResponseType
Properties
content complex
Model
Children bkw:message, bkw:status, bkw:transaction
Instance
 
<bkw:ViewPacerTransactionResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:transaction>{0,1}</bkw:transaction>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ViewPacerTransactionResponse>
Source
 
<element name="ViewPacerTransactionResponse" type="bkw:ViewPacerTransactionResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first transaction to be returned,
within the collection of all transactions matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first transaction to be returned, within the collection of all transactions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last transaction to be returned,
within the collection of all transactions matching the search
criteria; the search may return fewer transactions than
requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last transaction to be returned, within the collection of all transactions matching the search criteria; the search may return fewer transactions than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequestType / bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The output format
Diagram
Diagram schema_xsd.tmp#outputFormat
Type bkw:outputFormat
Properties
content simple
minOccurs 0
Source
 
<element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
  <annotation>
    <documentation>The output format</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListPacerTransactionsResponseType_ListPacerTransactionsResponseType_results_items schema_xsd.tmp#ListPacerTransactionsResponseType_ListPacerTransactionsResponseType_results_offset schema_xsd.tmp#ListPacerTransactionsResponseType_ListPacerTransactionsResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" minOccurs="0">
        <annotation>
          <documentation>The list of transactions</documentation>
        </annotation>
        <complexType>
          <choice>
            <element name="transaction" type="bkw:pacerTransaction" maxOccurs="unbounded"/>
          </choice>
        </complexType>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned transaction, within the collection of all transactions matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of transactions matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of transactions
Diagram
Diagram schema_xsd.tmp#ListPacerTransactionsResponseType_ListPacerTransactionsResponseType_results_ListPacerTransactionsResponseType_ListPacerTransactionsResponseType_results_items_transaction
Properties
content complex
minOccurs 0
Model
Children bkw:transaction
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:transaction>{1,unbounded}</bkw:transaction>
</bkw:items>
Source
 
<element name="items" minOccurs="0">
  <annotation>
    <documentation>The list of transactions</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="transaction" type="bkw:pacerTransaction" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsResponseType / bkw:results / bkw:items / bkw:transaction
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#pacerTransaction_id schema_xsd.tmp#pacerTransaction_pacerAccount schema_xsd.tmp#pacerTransaction_user schema_xsd.tmp#pacerTransaction_datetime schema_xsd.tmp#pacerTransaction_description schema_xsd.tmp#pacerTransaction_searchCriteria schema_xsd.tmp#pacerTransaction_billablePages schema_xsd.tmp#pacerTransaction_cost schema_xsd.tmp#pacerTransaction
Type bkw:pacerTransaction
Properties
content complex
maxOccurs unbounded
Model
Children bkw:billablePages, bkw:cost, bkw:datetime, bkw:description, bkw:id, bkw:pacerAccount, bkw:searchCriteria, bkw:user
Instance
 
<bkw:transaction xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
  <bkw:user>{0,1}</bkw:user>
  <bkw:datetime>{1,1}</bkw:datetime>
  <bkw:description>{0,1}</bkw:description>
  <bkw:searchCriteria>{0,1}</bkw:searchCriteria>
  <bkw:billablePages>{0,1}</bkw:billablePages>
  <bkw:cost>{1,1}</bkw:cost>
</bkw:transaction>
Source
 
<element name="transaction" type="bkw:pacerTransaction" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned transaction,
within the collection of all transactions matching the
search criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned transaction, within the collection of all transactions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of transactions matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of transactions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListPacerTransactionsRequestType_username schema_xsd.tmp#ListPacerTransactionsRequestType_password schema_xsd.tmp#ListPacerTransactionsRequestType_authtoken schema_xsd.tmp#ListPacerTransactionsRequestType_from schema_xsd.tmp#ListPacerTransactionsRequestType_to schema_xsd.tmp#ListPacerTransactionsRequestType_filters schema_xsd.tmp#ListPacerTransactionsRequestType_sort schema_xsd.tmp#ListPacerTransactionsRequestType_outputFormat schema_xsd.tmp#ListPacerTransactionsRequestType
Type bkw:ListPacerTransactionsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:outputFormat, bkw:password, bkw:sort, bkw:to, bkw:username
Instance
 
<bkw:ListPacerTransactionsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
  <bkw:outputFormat>{0,1}</bkw:outputFormat>
</bkw:ListPacerTransactionsRequest>
Source
 
<element name="ListPacerTransactionsRequest" type="bkw:ListPacerTransactionsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPacerTransactionsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListPacerTransactionsResponseType_results schema_xsd.tmp#ListPacerTransactionsResponseType_status schema_xsd.tmp#ListPacerTransactionsResponseType_message schema_xsd.tmp#ListPacerTransactionsResponseType
Type bkw:ListPacerTransactionsResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListPacerTransactionsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListPacerTransactionsResponse>
Source
 
<element name="ListPacerTransactionsResponse" type="bkw:ListPacerTransactionsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
minOccurs 0
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district" minOccurs="0">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:caseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case number
Diagram
Diagram schema_xsd.tmp#caseNumber
Type bkw:caseNumber
Properties
content simple
minOccurs 0
Facets
pattern \d{2}-\d{5}|\d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="caseNumber" type="bkw:caseNumber" minOccurs="0">
  <annotation>
    <documentation>The case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:chapter
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The chapter
Diagram
Diagram schema_xsd.tmp#chapter
Type bkw:chapter
Properties
content simple
minOccurs 0
Facets
enumeration 7
enumeration 9
enumeration 11
enumeration 12
enumeration 13
enumeration 15
enumeration 304
Source
 
<element name="chapter" type="bkw:chapter" minOccurs="0">
  <annotation>
    <documentation>The chapter</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:party
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The party name, in the format "last, first"
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="party" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The party name, in the format "last, first"</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:partyExact
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Enables exact party name matching; defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="partyExact" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Enables exact party name matching; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:ssn
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The party Social Security or Tax ID number
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="ssn" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The party Social Security or Tax ID number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:ssn4
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The last four digits of the the party Social Security or
Tax ID number
Diagram
Diagram schema_xsd.tmp#ssn4
Type bkw:ssn4
Properties
content simple
minOccurs 0
Facets
pattern \d{4}
Source
 
<element name="ssn4" type="bkw:ssn4" minOccurs="0">
  <annotation>
    <documentation>The last four digits of the the party Social Security or Tax ID number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:cache
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether cached data should returned, if available,
without accessing PACER; defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="cache" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequestType / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the PACER account to be used, of the form
pacer-xxxxxxxx; if not specified, the user's default PACER
account will be used; if the user does not have a default
PACER account, the operation will fail
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorResponseType / bkw:cases
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of cases matching the search criteria
Diagram
Diagram schema_xsd.tmp#caseList_case schema_xsd.tmp#caseList
Type bkw:caseList
Properties
content complex
minOccurs 0
Model
Children bkw:case
Instance
 
<bkw:cases xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,unbounded}</bkw:case>
</bkw:cases>
Source
 
<element name="cases" type="bkw:caseList" minOccurs="0">
  <annotation>
    <documentation>The list of cases matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunCaseLocatorRequestType_username schema_xsd.tmp#RunCaseLocatorRequestType_password schema_xsd.tmp#RunCaseLocatorRequestType_authtoken schema_xsd.tmp#RunCaseLocatorRequestType_district schema_xsd.tmp#RunCaseLocatorRequestType_caseNumber schema_xsd.tmp#RunCaseLocatorRequestType_chapter schema_xsd.tmp#RunCaseLocatorRequestType_party schema_xsd.tmp#RunCaseLocatorRequestType_partyExact schema_xsd.tmp#RunCaseLocatorRequestType_ssn schema_xsd.tmp#RunCaseLocatorRequestType_ssn4 schema_xsd.tmp#RunCaseLocatorRequestType_cache schema_xsd.tmp#RunCaseLocatorRequestType_pacerAccount schema_xsd.tmp#RunCaseLocatorRequestType
Type bkw:RunCaseLocatorRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:cache, bkw:caseNumber, bkw:chapter, bkw:district, bkw:pacerAccount, bkw:party, bkw:partyExact, bkw:password, bkw:ssn, bkw:ssn4, bkw:username
Instance
 
<bkw:RunCaseLocatorRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{0,1}</bkw:district>
  <bkw:caseNumber>{0,1}</bkw:caseNumber>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:party>{0,1}</bkw:party>
  <bkw:partyExact>{0,1}</bkw:partyExact>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:ssn4>{0,1}</bkw:ssn4>
  <bkw:cache>{0,1}</bkw:cache>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
</bkw:RunCaseLocatorRequest>
Source
 
<element name="RunCaseLocatorRequest" type="bkw:RunCaseLocatorRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseLocatorResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunCaseLocatorResponseType_cases schema_xsd.tmp#RunCaseLocatorResponseType_status schema_xsd.tmp#RunCaseLocatorResponseType_message schema_xsd.tmp#RunCaseLocatorResponseType
Type bkw:RunCaseLocatorResponseType
Properties
content complex
Model
Children bkw:cases, bkw:message, bkw:status
Instance
 
<bkw:RunCaseLocatorResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:cases>{0,1}</bkw:cases>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RunCaseLocatorResponse>
Source
 
<element name="RunCaseLocatorResponse" type="bkw:RunCaseLocatorResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersRequestType / bkw:caseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A free-form case number
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="caseNumber" type="bkw:requiredText">
  <annotation>
    <documentation>A free-form case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersResponseType / bkw:cases
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of matching cases
Diagram
Diagram schema_xsd.tmp#caseList_case schema_xsd.tmp#caseList
Type bkw:caseList
Properties
content complex
minOccurs 0
Model
Children bkw:case
Instance
 
<bkw:cases xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,unbounded}</bkw:case>
</bkw:cases>
Source
 
<element name="cases" type="bkw:caseList" minOccurs="0">
  <annotation>
    <documentation>The list of matching cases</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunCaseNumbersRequestType_username schema_xsd.tmp#RunCaseNumbersRequestType_password schema_xsd.tmp#RunCaseNumbersRequestType_authtoken schema_xsd.tmp#RunCaseNumbersRequestType_district schema_xsd.tmp#RunCaseNumbersRequestType_caseNumber schema_xsd.tmp#RunCaseNumbersRequestType
Type bkw:RunCaseNumbersRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:caseNumber, bkw:district, bkw:password, bkw:username
Instance
 
<bkw:RunCaseNumbersRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
</bkw:RunCaseNumbersRequest>
Source
 
<element name="RunCaseNumbersRequest" type="bkw:RunCaseNumbersRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCaseNumbersResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunCaseNumbersResponseType_cases schema_xsd.tmp#RunCaseNumbersResponseType_status schema_xsd.tmp#RunCaseNumbersResponseType_message schema_xsd.tmp#RunCaseNumbersResponseType
Type bkw:RunCaseNumbersResponseType
Properties
content complex
Model
Children bkw:cases, bkw:message, bkw:status
Instance
 
<bkw:RunCaseNumbersResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:cases>{0,1}</bkw:cases>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RunCaseNumbersResponse>
Source
 
<element name="RunCaseNumbersResponse" type="bkw:RunCaseNumbersResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:division
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The division name or office number
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="division" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The division name or office number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:caseTypes
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of case types; by default cases of any
type are returned
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="caseTypes" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of case types; by default cases of any type are returned</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:chapters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of chapters; by default cases are not
filtered by chapter
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="chapters" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of chapters; by default cases are not filtered by chapter</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The current case status; defaults to "all"
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
enumeration open
enumeration closed
enumeration all
Source
 
<element name="status" minOccurs="0">
  <annotation>
    <documentation>The current case status; defaults to "all"</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <enumeration value="open"/>
      <enumeration value="closed"/>
      <enumeration value="all"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:includeParties
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
True if party information should be included in the output;
defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="includeParties" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>True if party information should be included in the output; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:proSeOnly
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
True to include only pre se cases; defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="proSeOnly" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>True to include only pre se cases; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:counties
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of county names
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="counties" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of county names</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:trustee
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-sperated list of trustee IDs of form trustee-xxxxxxxx
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="trustee" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A comma-sperated list of trustee IDs of form trustee-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:debtorType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The debtor type
Diagram
Diagram schema_xsd.tmp#debtorType
Type bkw:debtorType
Properties
content simple
minOccurs 0
Facets
enumeration INDIVIDUAL
enumeration PARTNERSHIP
enumeration CORPORATION
enumeration OTHER
Source
 
<element name="debtorType" type="bkw:debtorType" minOccurs="0">
  <annotation>
    <documentation>The debtor type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:debtType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The debt type
Diagram
Diagram schema_xsd.tmp#debtType
Type bkw:debtType
Properties
content simple
minOccurs 0
Facets
enumeration CONSUMER
enumeration BUSINESS
enumeration OTHER
Source
 
<element name="debtType" type="bkw:debtType" minOccurs="0">
  <annotation>
    <documentation>The debt type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:dateType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The type of case event to which the "from" and "to" options
apply
Diagram
Diagram
Type restriction of string
Properties
content simple
Facets
enumeration filed
enumeration entered
enumeration discharged
enumeration dismissed
enumeration closed
enumeration converted
Source
 
<element name="dateType">
  <annotation>
    <documentation>The type of case event to which the "from" and "to" options apply</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <enumeration value="filed"/>
      <enumeration value="entered"/>
      <enumeration value="discharged"/>
      <enumeration value="dismissed"/>
      <enumeration value="closed"/>
      <enumeration value="converted"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The beginning of the date range of cases to be returned
Diagram
Diagram
Type date
Properties
content simple
Source
 
<element name="from" type="xsd:date">
  <annotation>
    <documentation>The beginning of the date range of cases to be returned</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The end of the date range of cases to be returned
Diagram
Diagram
Type date
Properties
content simple
Source
 
<element name="to" type="xsd:date">
  <annotation>
    <documentation>The end of the date range of cases to be returned</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:cache
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether cached data should returned, if available,
without accessing PACER; defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="cache" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequestType / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the PACER account to be used, of the form
pacer-xxxxxxxx; if not specified, the user's default PACER
account will be used; if the user does not have a default
PACER account, the operation will fail
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesResponseType / bkw:cases
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of cases
Diagram
Diagram schema_xsd.tmp#caseList_case schema_xsd.tmp#caseList
Type bkw:caseList
Properties
content complex
minOccurs 0
Model
Children bkw:case
Instance
 
<bkw:cases xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,unbounded}</bkw:case>
</bkw:cases>
Source
 
<element name="cases" type="bkw:caseList" minOccurs="0">
  <annotation>
    <documentation>A list of cases</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunCasesRequestType_username schema_xsd.tmp#RunCasesRequestType_password schema_xsd.tmp#RunCasesRequestType_authtoken schema_xsd.tmp#RunCasesRequestType_district schema_xsd.tmp#RunCasesRequestType_division schema_xsd.tmp#RunCasesRequestType_caseTypes schema_xsd.tmp#RunCasesRequestType_chapters schema_xsd.tmp#RunCasesRequestType_status schema_xsd.tmp#RunCasesRequestType_includeParties schema_xsd.tmp#RunCasesRequestType_proSeOnly schema_xsd.tmp#RunCasesRequestType_counties schema_xsd.tmp#RunCasesRequestType_trustee schema_xsd.tmp#RunCasesRequestType_debtorType schema_xsd.tmp#RunCasesRequestType_debtType schema_xsd.tmp#RunCasesRequestType_dateType schema_xsd.tmp#RunCasesRequestType_from schema_xsd.tmp#RunCasesRequestType_to schema_xsd.tmp#RunCasesRequestType_cache schema_xsd.tmp#RunCasesRequestType_pacerAccount schema_xsd.tmp#RunCasesRequestType
Type bkw:RunCasesRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:cache, bkw:caseTypes, bkw:chapters, bkw:counties, bkw:dateType, bkw:debtType, bkw:debtorType, bkw:district, bkw:division, bkw:from, bkw:includeParties, bkw:pacerAccount, bkw:password, bkw:proSeOnly, bkw:status, bkw:to, bkw:trustee, bkw:username
Instance
 
<bkw:RunCasesRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{0,1}</bkw:division>
  <bkw:caseTypes>{0,1}</bkw:caseTypes>
  <bkw:chapters>{0,1}</bkw:chapters>
  <bkw:status>{0,1}</bkw:status>
  <bkw:includeParties>{0,1}</bkw:includeParties>
  <bkw:proSeOnly>{0,1}</bkw:proSeOnly>
  <bkw:counties>{0,1}</bkw:counties>
  <bkw:trustee>{0,1}</bkw:trustee>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:dateType>{1,1}</bkw:dateType>
  <bkw:from>{1,1}</bkw:from>
  <bkw:to>{1,1}</bkw:to>
  <bkw:cache>{0,1}</bkw:cache>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
</bkw:RunCasesRequest>
Source
 
<element name="RunCasesRequest" type="bkw:RunCasesRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCasesResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunCasesResponseType_cases schema_xsd.tmp#RunCasesResponseType_status schema_xsd.tmp#RunCasesResponseType_message schema_xsd.tmp#RunCasesResponseType
Type bkw:RunCasesResponseType
Properties
content complex
Model
Children bkw:cases, bkw:message, bkw:status
Instance
 
<bkw:RunCasesResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:cases>{0,1}</bkw:cases>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RunCasesResponse>
Source
 
<element name="RunCasesResponse" type="bkw:RunCasesResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The extended case number
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
  <annotation>
    <documentation>The extended case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:fromDate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The beginning of the range of filing dates of claims to
be included in the result
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="fromDate" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The beginning of the range of filing dates of claims to be included in the result</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:toDate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The end of the range of filing dates of claims to
be included in the result
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="toDate" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The end of the range of filing dates of claims to be included in the result</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:fromClaim
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The beginning of the range of claim numbers of claims to
be included in the result
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="fromClaim" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The beginning of the range of claim numbers of claims to be included in the result</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:toClaim
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The end of the range of claim numbers of claims to
be included in the result
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="toClaim" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The end of the range of claim numbers of claims to be included in the result</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:cache
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether cached data should returned, if available,
without accessing PACER; defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="cache" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequestType / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the PACER account to be used, of the form
pacer-xxxxxxxx; if not specified, the user's default PACER
account will be used; if the user does not have a default
PACER account, the operation will fail
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterResponseType / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A case containing a list of claims
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>A case containing a list of claims</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunClaimsRegisterRequestType_username schema_xsd.tmp#RunClaimsRegisterRequestType_password schema_xsd.tmp#RunClaimsRegisterRequestType_authtoken schema_xsd.tmp#RunClaimsRegisterRequestType_district schema_xsd.tmp#RunClaimsRegisterRequestType_extendedCaseNumber schema_xsd.tmp#RunClaimsRegisterRequestType_fromDate schema_xsd.tmp#RunClaimsRegisterRequestType_toDate schema_xsd.tmp#RunClaimsRegisterRequestType_fromClaim schema_xsd.tmp#RunClaimsRegisterRequestType_toClaim schema_xsd.tmp#RunClaimsRegisterRequestType_cache schema_xsd.tmp#RunClaimsRegisterRequestType_pacerAccount schema_xsd.tmp#RunClaimsRegisterRequestType
Type bkw:RunClaimsRegisterRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:cache, bkw:district, bkw:extendedCaseNumber, bkw:fromClaim, bkw:fromDate, bkw:pacerAccount, bkw:password, bkw:toClaim, bkw:toDate, bkw:username
Instance
 
<bkw:RunClaimsRegisterRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:extendedCaseNumber>{1,1}</bkw:extendedCaseNumber>
  <bkw:fromDate>{0,1}</bkw:fromDate>
  <bkw:toDate>{0,1}</bkw:toDate>
  <bkw:fromClaim>{0,1}</bkw:fromClaim>
  <bkw:toClaim>{0,1}</bkw:toClaim>
  <bkw:cache>{0,1}</bkw:cache>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
</bkw:RunClaimsRegisterRequest>
Source
 
<element name="RunClaimsRegisterRequest" type="bkw:RunClaimsRegisterRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunClaimsRegisterResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunClaimsRegisterResponseType_case schema_xsd.tmp#RunClaimsRegisterResponseType_status schema_xsd.tmp#RunClaimsRegisterResponseType_message schema_xsd.tmp#RunClaimsRegisterResponseType
Type bkw:RunClaimsRegisterResponseType
Properties
content complex
Model
Children bkw:case, bkw:message, bkw:status
Instance
 
<bkw:RunClaimsRegisterResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,1}</bkw:case>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RunClaimsRegisterResponse>
Source
 
<element name="RunClaimsRegisterResponse" type="bkw:RunClaimsRegisterResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListRequestType / bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The extended case number
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
  <annotation>
    <documentation>The extended case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListRequestType / bkw:cache
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether cached data should returned, if available,
without accessing PACER; defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="cache" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListRequestType / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the PACER account to be used, of the form
pacer-xxxxxxxx; if not specified, the user's default PACER
account will be used; if the user does not have a default
PACER account, the operation will fail
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListResponseType / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A case containing a list of creditors
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>A case containing a list of creditors</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunCreditorListRequestType_username schema_xsd.tmp#RunCreditorListRequestType_password schema_xsd.tmp#RunCreditorListRequestType_authtoken schema_xsd.tmp#RunCreditorListRequestType_district schema_xsd.tmp#RunCreditorListRequestType_extendedCaseNumber schema_xsd.tmp#RunCreditorListRequestType_cache schema_xsd.tmp#RunCreditorListRequestType_pacerAccount schema_xsd.tmp#RunCreditorListRequestType
Type bkw:RunCreditorListRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:cache, bkw:district, bkw:extendedCaseNumber, bkw:pacerAccount, bkw:password, bkw:username
Instance
 
<bkw:RunCreditorListRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:extendedCaseNumber>{1,1}</bkw:extendedCaseNumber>
  <bkw:cache>{0,1}</bkw:cache>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
</bkw:RunCreditorListRequest>
Source
 
<element name="RunCreditorListRequest" type="bkw:RunCreditorListRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunCreditorListResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunCreditorListResponseType_case schema_xsd.tmp#RunCreditorListResponseType_status schema_xsd.tmp#RunCreditorListResponseType_message schema_xsd.tmp#RunCreditorListResponseType
Type bkw:RunCreditorListResponseType
Properties
content complex
Model
Children bkw:case, bkw:message, bkw:status
Instance
 
<bkw:RunCreditorListResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,1}</bkw:case>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RunCreditorListResponse>
Source
 
<element name="RunCreditorListResponse" type="bkw:RunCreditorListResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The extended case number
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
  <annotation>
    <documentation>The extended case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:fromDate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The beginning of the range of filing dates of docket items to
be included in the result
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="fromDate" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The beginning of the range of filing dates of docket items to be included in the result</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:toDate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The end of the range of filing dates of docket items to
be included in the result
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="toDate" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The end of the range of filing dates of docket items to be included in the result</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:fromItem
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The beginning of the range of item numbers of docket items to
be included in the result. The voluntary petition in bankruptcy
cases is usually the first or second docket item.
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="fromItem" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The beginning of the range of item numbers of docket items to be included in the result. The voluntary petition in bankruptcy cases is usually the first or second docket item.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:toItem
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The end of the range of item numbers of docket items to
be included in the result. The voluntary petition in bankruptcy
cases is usually the first or second docket item.
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="toItem" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The end of the range of item numbers of docket items to be included in the result. The voluntary petition in bankruptcy cases is usually the first or second docket item.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:cache
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether cached data should returned, if available,
without accessing PACER; defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="cache" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequestType / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the PACER account to be used, of the form
pacer-xxxxxxxx; if not specified, the user's default PACER
account will be used; if the user does not have a default
PACER account, the operation will fail
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketResponseType / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A case containing a list of docket items
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>A case containing a list of docket items</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunDocketRequestType_username schema_xsd.tmp#RunDocketRequestType_password schema_xsd.tmp#RunDocketRequestType_authtoken schema_xsd.tmp#RunDocketRequestType_district schema_xsd.tmp#RunDocketRequestType_extendedCaseNumber schema_xsd.tmp#RunDocketRequestType_fromDate schema_xsd.tmp#RunDocketRequestType_toDate schema_xsd.tmp#RunDocketRequestType_fromItem schema_xsd.tmp#RunDocketRequestType_toItem schema_xsd.tmp#RunDocketRequestType_cache schema_xsd.tmp#RunDocketRequestType_pacerAccount schema_xsd.tmp#RunDocketRequestType
Type bkw:RunDocketRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:cache, bkw:district, bkw:extendedCaseNumber, bkw:fromDate, bkw:fromItem, bkw:pacerAccount, bkw:password, bkw:toDate, bkw:toItem, bkw:username
Instance
 
<bkw:RunDocketRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:extendedCaseNumber>{1,1}</bkw:extendedCaseNumber>
  <bkw:fromDate>{0,1}</bkw:fromDate>
  <bkw:toDate>{0,1}</bkw:toDate>
  <bkw:fromItem>{0,1}</bkw:fromItem>
  <bkw:toItem>{0,1}</bkw:toItem>
  <bkw:cache>{0,1}</bkw:cache>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
</bkw:RunDocketRequest>
Source
 
<element name="RunDocketRequest" type="bkw:RunDocketRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunDocketResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunDocketResponseType_case schema_xsd.tmp#RunDocketResponseType_status schema_xsd.tmp#RunDocketResponseType_message schema_xsd.tmp#RunDocketResponseType
Type bkw:RunDocketResponseType
Properties
content complex
Model
Children bkw:case, bkw:message, bkw:status
Instance
 
<bkw:RunDocketResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,1}</bkw:case>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RunDocketResponse>
Source
 
<element name="RunDocketResponse" type="bkw:RunDocketResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlRequestType / bkw:documentId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The document IDs
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="documentId" type="bkw:requiredText">
  <annotation>
    <documentation>The document IDs</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlRequestType / bkw:lifetime
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The number of seconds that the URL will be valid; the maximum
allowed value is 2592000; defaults to one week
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="lifetime" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The number of seconds that the URL will be valid; the maximum allowed value is 2592000; defaults to one week</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlRequestType / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the PACER account to be used, of the form
pacer-xxxxxxxx; if not specified, the user's default PACER
account will be used; if the user does not have a default
PACER account, the operation will fail unless the parameter
"acceptCharges" is set to false
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail unless the parameter "acceptCharges" is set to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlRequestType / bkw:acceptCharges
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether a document should be puchased if it is not
free; defaults to true; if a pacer account is not specified,
may not be set to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="acceptCharges" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether a document should be puchased if it is not free; defaults to true; if a pacer account is not specified, may not be set to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlResponseType / bkw:url
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The URL
Diagram
Diagram
Type anyURI
Properties
content simple
minOccurs 0
Source
 
<element name="url" type="xsd:anyURI" minOccurs="0">
  <annotation>
    <documentation>The URL</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#GenerateUrlRequestType_username schema_xsd.tmp#GenerateUrlRequestType_password schema_xsd.tmp#GenerateUrlRequestType_authtoken schema_xsd.tmp#GenerateUrlRequestType_documentId schema_xsd.tmp#GenerateUrlRequestType_lifetime schema_xsd.tmp#GenerateUrlRequestType_pacerAccount schema_xsd.tmp#GenerateUrlRequestType_acceptCharges schema_xsd.tmp#GenerateUrlRequestType
Type bkw:GenerateUrlRequestType
Properties
content complex
Model
Children bkw:acceptCharges, bkw:authtoken, bkw:documentId, bkw:lifetime, bkw:pacerAccount, bkw:password, bkw:username
Instance
 
<bkw:GenerateUrlRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:documentId>{1,1}</bkw:documentId>
  <bkw:lifetime>{0,1}</bkw:lifetime>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
  <bkw:acceptCharges>{0,1}</bkw:acceptCharges>
</bkw:GenerateUrlRequest>
Source
 
<element name="GenerateUrlRequest" type="bkw:GenerateUrlRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:GenerateUrlResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#GenerateUrlResponseType_url schema_xsd.tmp#GenerateUrlResponseType_status schema_xsd.tmp#GenerateUrlResponseType_message schema_xsd.tmp#GenerateUrlResponseType
Type bkw:GenerateUrlResponseType
Properties
content complex
Model
Children bkw:message, bkw:status, bkw:url
Instance
 
<bkw:GenerateUrlResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:url>{0,1}</bkw:url>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:GenerateUrlResponse>
Source
 
<element name="GenerateUrlResponse" type="bkw:GenerateUrlResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:title
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The document title
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="title" type="bkw:requiredText">
  <annotation>
    <documentation>The document title</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:description
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The document description
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="description" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The document description</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:contentType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The MIME media type
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="contentType" type="bkw:requiredText">
  <annotation>
    <documentation>The MIME media type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:charset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The character set identifier
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="charset" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The character set identifier</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:language
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
An IETF language tag
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="language" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>An IETF language tag</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequestType / bkw:data
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The base64-encoded document data
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="data" type="bkw:requiredText">
  <annotation>
    <documentation>The base64-encoded document data</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentResponseType / bkw:documentId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The document ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="documentId" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The document ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CreateDocumentRequestType_username schema_xsd.tmp#CreateDocumentRequestType_password schema_xsd.tmp#CreateDocumentRequestType_authtoken schema_xsd.tmp#CreateDocumentRequestType_title schema_xsd.tmp#CreateDocumentRequestType_description schema_xsd.tmp#CreateDocumentRequestType_contentType schema_xsd.tmp#CreateDocumentRequestType_charset schema_xsd.tmp#CreateDocumentRequestType_language schema_xsd.tmp#CreateDocumentRequestType_data schema_xsd.tmp#CreateDocumentRequestType
Type bkw:CreateDocumentRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:charset, bkw:contentType, bkw:data, bkw:description, bkw:language, bkw:password, bkw:title, bkw:username
Instance
 
<bkw:CreateDocumentRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:title>{1,1}</bkw:title>
  <bkw:description>{0,1}</bkw:description>
  <bkw:contentType>{1,1}</bkw:contentType>
  <bkw:charset>{0,1}</bkw:charset>
  <bkw:language>{0,1}</bkw:language>
  <bkw:data>{1,1}</bkw:data>
</bkw:CreateDocumentRequest>
Source
 
<element name="CreateDocumentRequest" type="bkw:CreateDocumentRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateDocumentResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CreateDocumentResponseType_documentId schema_xsd.tmp#CreateDocumentResponseType_status schema_xsd.tmp#CreateDocumentResponseType_message schema_xsd.tmp#CreateDocumentResponseType
Type bkw:CreateDocumentResponseType
Properties
content complex
Model
Children bkw:documentId, bkw:message, bkw:status
Instance
 
<bkw:CreateDocumentResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:documentId>{0,1}</bkw:documentId>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:CreateDocumentResponse>
Source
 
<element name="CreateDocumentResponse" type="bkw:CreateDocumentResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:chapter
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The bankruptcy chapter
Diagram
Diagram schema_xsd.tmp#chapter
Type bkw:chapter
Properties
content simple
minOccurs 0
Facets
enumeration 7
enumeration 9
enumeration 11
enumeration 12
enumeration 13
enumeration 15
enumeration 304
Source
 
<element name="chapter" type="bkw:chapter" minOccurs="0">
  <annotation>
    <documentation>The bankruptcy chapter</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:party
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The party name, in the format "last, first"
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="party" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The party name, in the format "last, first"</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:ssn
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The party Social Security number or Tax ID number
Diagram
Diagram schema_xsd.tmp#ssn
Type bkw:ssn
Properties
content simple
minOccurs 0
Facets
pattern \d{3}-\d{2}-\d{4}|\d{2}-\d{7}
Source
 
<element name="ssn" type="bkw:ssn" minOccurs="0">
  <annotation>
    <documentation>The party Social Security number or Tax ID number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:ssn4
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The last four digits of the party Social Security number or
Tax ID number
Diagram
Diagram schema_xsd.tmp#ssn4
Type bkw:ssn4
Properties
content simple
minOccurs 0
Facets
pattern \d{4}
Source
 
<element name="ssn4" type="bkw:ssn4" minOccurs="0">
  <annotation>
    <documentation>The last four digits of the party Social Security number or Tax ID number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:outputType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The type of information to return
Diagram
Diagram schema_xsd.tmp#caseInfoOutputType
Type bkw:caseInfoOutputType
Properties
content simple
Facets
enumeration CASE_SUMMARY 
Indicates that all the returned cases will include only scalar-
valued properties; no parties, filings, creditors, claims, or
parsed data will be included.
enumeration DOCKET 
Indicates that the most recently filed case will include its
collections of parties and filings; no creditors, claims, or
parsed data will be included. Cases filed earlier, if any, will
include only scalar-valued properties.
enumeration DATA 
Indicates that the most recently filed case will include its
collections of parties and filings, as well as the data
extracted from the documents filed in the case; no creditors or
claims will be included. Cases filed earlier, if any, will
include only scalar-valued properties.
Source
 
<element name="outputType" type="bkw:caseInfoOutputType">
  <annotation>
    <documentation>The type of information to return</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:cache
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates which parts of the returned information should be
retrieved from the cache, if available, without accessing PACER
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
enumeration NONE 
Indicates that no cached information should be returned
enumeration CASE_LIST 
Indicates that a cached case list should returned, if
available
enumeration DOCKET 
Indicates that a cached docket should be returned, if
available; if this option is specified case, parsed data,
if any, will also be retrieved from the cache
Source
 
<element name="cache" minOccurs="0">
  <annotation>
    <documentation>Indicates which parts of the returned information should be retrieved from the cache, if available, without accessing PACER</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <enumeration value="NONE">
        <annotation>
          <documentation>Indicates that no cached information should be returned</documentation>
        </annotation>
      </enumeration>
      <enumeration value="CASE_LIST">
        <annotation>
          <documentation>Indicates that a cached case list should returned, if available</documentation>
        </annotation>
      </enumeration>
      <enumeration value="DOCKET">
        <annotation>
          <documentation>Indicates that a cached docket should be returned, if available; if this option is specified case, parsed data, if any, will also be retrieved from the cache</documentation>
        </annotation>
      </enumeration>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:formNumbers
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of form numbers, indicating the type of
forms to parse; by default, all supported forms are parsed.
This parameter may not be specified if the output format is
CASE_SUMMARY or DOCKET.
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="formNumbers" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of form numbers, indicating the type of forms to parse; by default, all supported forms are parsed. This parameter may not be specified if the output format is CASE_SUMMARY or DOCKET.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:bkmlFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates the format of the data that will be returned; defaults
to STANDARD. This parameter may not be specified if the output
format is CASE_SUMMARY or DOCKET.
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
enumeration STANDARD 
Indicates that the parsed data will be returned in
BKML format
enumeration ANALYTICS 
Indicates that the parsed data will be returned in
analytics format
Source
 
<element name="bkmlFormat" minOccurs="0">
  <annotation>
    <documentation>Indicates the format of the data that will be returned; defaults to STANDARD. This parameter may not be specified if the output format is CASE_SUMMARY or DOCKET.</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <enumeration value="STANDARD">
        <annotation>
          <documentation>Indicates that the parsed data will be returned in BKML format</documentation>
        </annotation>
      </enumeration>
      <enumeration value="ANALYTICS">
        <annotation>
          <documentation>Indicates that the parsed data will be returned in analytics format</documentation>
        </annotation>
      </enumeration>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequestType / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the PACER account to be used, of the form
pacer-xxxxxxxx; if not specified, the user's default PACER
account will be used
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoResponseType / bkw:cases
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of cases matching the search criteria
Diagram
Diagram schema_xsd.tmp#caseList_case schema_xsd.tmp#caseList
Type bkw:caseList
Properties
content complex
minOccurs 0
Model
Children bkw:case
Instance
 
<bkw:cases xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,unbounded}</bkw:case>
</bkw:cases>
Source
 
<element name="cases" type="bkw:caseList" minOccurs="0">
  <annotation>
    <documentation>The list of cases matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CaseInfoRequestType_username schema_xsd.tmp#CaseInfoRequestType_password schema_xsd.tmp#CaseInfoRequestType_authtoken schema_xsd.tmp#CaseInfoRequestType_chapter schema_xsd.tmp#CaseInfoRequestType_party schema_xsd.tmp#CaseInfoRequestType_ssn schema_xsd.tmp#CaseInfoRequestType_ssn4 schema_xsd.tmp#CaseInfoRequestType_outputType schema_xsd.tmp#CaseInfoRequestType_cache schema_xsd.tmp#CaseInfoRequestType_formNumbers schema_xsd.tmp#CaseInfoRequestType_bkmlFormat schema_xsd.tmp#CaseInfoRequestType_pacerAccount schema_xsd.tmp#CaseInfoRequestType
Type bkw:CaseInfoRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:bkmlFormat, bkw:cache, bkw:chapter, bkw:formNumbers, bkw:outputType, bkw:pacerAccount, bkw:party, bkw:password, bkw:ssn, bkw:ssn4, bkw:username
Instance
 
<bkw:CaseInfoRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:party>{0,1}</bkw:party>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:ssn4>{0,1}</bkw:ssn4>
  <bkw:outputType>{1,1}</bkw:outputType>
  <bkw:cache>{0,1}</bkw:cache>
  <bkw:formNumbers>{0,1}</bkw:formNumbers>
  <bkw:bkmlFormat>{0,1}</bkw:bkmlFormat>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
</bkw:CaseInfoRequest>
Source
 
<element name="CaseInfoRequest" type="bkw:CaseInfoRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseInfoResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CaseInfoResponseType_cases schema_xsd.tmp#CaseInfoResponseType_status schema_xsd.tmp#CaseInfoResponseType_message schema_xsd.tmp#CaseInfoResponseType
Type bkw:CaseInfoResponseType
Properties
content complex
Model
Children bkw:cases, bkw:message, bkw:status
Instance
 
<bkw:CaseInfoResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:cases>{0,1}</bkw:cases>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:CaseInfoResponse>
Source
 
<element name="CaseInfoResponse" type="bkw:CaseInfoResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
minOccurs 0
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district" minOccurs="0">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The extended case number
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
minOccurs 0
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="extendedCaseNumber" type="bkw:extendedCaseNumber" minOccurs="0">
  <annotation>
    <documentation>The extended case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:documentIds
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of document IDs
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="documentIds" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of document IDs</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:formNumbers
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of elements of the enumeration
bkw:formNumber
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="formNumbers" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of elements of the enumeration bkw:formNumber</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:bkmlFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BKML format; defaults to STANDARD
Diagram
Diagram schema_xsd.tmp#bkmlFormat
Type bkw:bkmlFormat
Properties
content simple
minOccurs 0
Facets
enumeration STANDARD 
The standard document-oriented BKML format
enumeration ANALYTICS 
The alternate case-oriented BKML format
enumeration STANDARD_JSON 
The standard document-oriented BKML format rendered in JSON
instead of XML
Source
 
<element name="bkmlFormat" type="bkw:bkmlFormat" minOccurs="0">
  <annotation>
    <documentation>The BKML format; defaults to STANDARD</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:cache
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether cached data should returned, if available,
without accessing PACER; defaults to false
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="cache" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequestType / bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Identifier of the PACER account to be used, of the form
pacer-xxxxxxxx; if not specified, the user's default PACER
account will be used
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsResponseType / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case, if a district and case number were specified
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>The case, if a district and case number were specified</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsResponseType / bkw:documents
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of parsed documents
Diagram
Diagram schema_xsd.tmp#documentList_document schema_xsd.tmp#documentList
Type bkw:documentList
Properties
content complex
minOccurs 0
Model
Children bkw:document
Instance
 
<bkw:documents xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:document>{0,unbounded}</bkw:document>
</bkw:documents>
Source
 
<element name="documents" type="bkw:documentList" minOccurs="0">
  <annotation>
    <documentation>The list of parsed documents</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsResponseType / bkw:data
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The data, in XML format
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="data" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The data, in XML format</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ParseDocumentsRequestType_username schema_xsd.tmp#ParseDocumentsRequestType_password schema_xsd.tmp#ParseDocumentsRequestType_authtoken schema_xsd.tmp#ParseDocumentsRequestType_district schema_xsd.tmp#ParseDocumentsRequestType_extendedCaseNumber schema_xsd.tmp#ParseDocumentsRequestType_documentIds schema_xsd.tmp#ParseDocumentsRequestType_formNumbers schema_xsd.tmp#ParseDocumentsRequestType_bkmlFormat schema_xsd.tmp#ParseDocumentsRequestType_cache schema_xsd.tmp#ParseDocumentsRequestType_pacerAccount schema_xsd.tmp#ParseDocumentsRequestType
Type bkw:ParseDocumentsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:bkmlFormat, bkw:cache, bkw:district, bkw:documentIds, bkw:extendedCaseNumber, bkw:formNumbers, bkw:pacerAccount, bkw:password, bkw:username
Instance
 
<bkw:ParseDocumentsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{0,1}</bkw:district>
  <bkw:extendedCaseNumber>{0,1}</bkw:extendedCaseNumber>
  <bkw:documentIds>{0,1}</bkw:documentIds>
  <bkw:formNumbers>{0,1}</bkw:formNumbers>
  <bkw:bkmlFormat>{0,1}</bkw:bkmlFormat>
  <bkw:cache>{0,1}</bkw:cache>
  <bkw:pacerAccount>{0,1}</bkw:pacerAccount>
</bkw:ParseDocumentsRequest>
Source
 
<element name="ParseDocumentsRequest" type="bkw:ParseDocumentsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ParseDocumentsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ParseDocumentsResponseType_case schema_xsd.tmp#ParseDocumentsResponseType_documents schema_xsd.tmp#ParseDocumentsResponseType_data schema_xsd.tmp#ParseDocumentsResponseType_status schema_xsd.tmp#ParseDocumentsResponseType_message schema_xsd.tmp#ParseDocumentsResponseType
Type bkw:ParseDocumentsResponseType
Properties
content complex
Model
Children bkw:case, bkw:data, bkw:documents, bkw:message, bkw:status
Instance
 
<bkw:ParseDocumentsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,1}</bkw:case>
  <bkw:documents>{0,1}</bkw:documents>
  <bkw:data>{0,1}</bkw:data>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ParseDocumentsResponse>
Source
 
<element name="ParseDocumentsResponse" type="bkw:ParseDocumentsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionRequestType / bkw:type
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription type
Diagram
Diagram schema_xsd.tmp#subscriptionType
Type bkw:subscriptionType
Properties
content simple
Facets
enumeration CONSUMER_PORTFOLIO 
Receive notifications when consumers in a specified collection
file for banrkuptcy
enumeration CASE_PORTFOLIO 
Receive notifications when events occur for cases in a specified
collection
enumeration CASE_LISTS 
Receive notifications when events occur for cases in a specified
geographic area
enumeration CM_ECF 
Receive notifications when emails arrive from the court
(a.k.a. Free Looks)
enumeration PACER_INFO 
Receive notifications of PACER announcements and service status
changes
Source
 
<element name="type" type="bkw:subscriptionType">
  <annotation>
    <documentation>The subscription type</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionRequestType / bkw:eventTypes
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of event types; required for
CASE_PORTFOLIO and CASE_LISTS subscriptions. For CASE_LISTS
subscriptions, exactly one notification type must be specified
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="eventTypes" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of event types; required for CASE_PORTFOLIO and CASE_LISTS subscriptions. For CASE_LISTS subscriptions, exactly one notification type must be specified</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionRequestType / bkw:params
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#parameterList_param schema_xsd.tmp#parameterList
Type bkw:parameterList
Properties
content complex
minOccurs 0
Model
Children bkw:param
Instance
 
<bkw:params xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:param>{1,unbounded}</bkw:param>
</bkw:params>
Source
 
<element name="params" type="bkw:parameterList" minOccurs="0"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionResponseType / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="subscriptionId" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The subscription ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CreateSubscriptionRequestType_username schema_xsd.tmp#CreateSubscriptionRequestType_password schema_xsd.tmp#CreateSubscriptionRequestType_authtoken schema_xsd.tmp#CreateSubscriptionRequestType_type schema_xsd.tmp#CreateSubscriptionRequestType_eventTypes schema_xsd.tmp#CreateSubscriptionRequestType_params schema_xsd.tmp#CreateSubscriptionRequestType
Type bkw:CreateSubscriptionRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:eventTypes, bkw:params, bkw:password, bkw:type, bkw:username
Instance
 
<bkw:CreateSubscriptionRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:type>{1,1}</bkw:type>
  <bkw:eventTypes>{0,1}</bkw:eventTypes>
  <bkw:params>{0,1}</bkw:params>
</bkw:CreateSubscriptionRequest>
Source
 
<element name="CreateSubscriptionRequest" type="bkw:CreateSubscriptionRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CreateSubscriptionResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CreateSubscriptionResponseType_subscriptionId schema_xsd.tmp#CreateSubscriptionResponseType_status schema_xsd.tmp#CreateSubscriptionResponseType_message schema_xsd.tmp#CreateSubscriptionResponseType
Type bkw:CreateSubscriptionResponseType
Properties
content complex
Model
Children bkw:message, bkw:status, bkw:subscriptionId
Instance
 
<bkw:CreateSubscriptionResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:subscriptionId>{0,1}</bkw:subscriptionId>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:CreateSubscriptionResponse>
Source
 
<element name="CreateSubscriptionResponse" type="bkw:CreateSubscriptionResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeleteSubscriptionRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeleteSubscriptionRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeleteSubscriptionRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeleteSubscriptionRequestType / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="subscriptionId" type="bkw:resourceId">
  <annotation>
    <documentation>The subscription ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeleteSubscriptionResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeleteSubscriptionResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeleteSubscriptionRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#DeleteSubscriptionRequestType_username schema_xsd.tmp#DeleteSubscriptionRequestType_password schema_xsd.tmp#DeleteSubscriptionRequestType_authtoken schema_xsd.tmp#DeleteSubscriptionRequestType_subscriptionId schema_xsd.tmp#DeleteSubscriptionRequestType
Type bkw:DeleteSubscriptionRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:password, bkw:subscriptionId, bkw:username
Instance
 
<bkw:DeleteSubscriptionRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:subscriptionId>{1,1}</bkw:subscriptionId>
</bkw:DeleteSubscriptionRequest>
Source
 
<element name="DeleteSubscriptionRequest" type="bkw:DeleteSubscriptionRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:DeleteSubscriptionResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#DeleteSubscriptionResponseType_status schema_xsd.tmp#DeleteSubscriptionResponseType_message schema_xsd.tmp#DeleteSubscriptionResponseType
Type bkw:DeleteSubscriptionResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:DeleteSubscriptionResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:DeleteSubscriptionResponse>
Source
 
<element name="DeleteSubscriptionResponse" type="bkw:DeleteSubscriptionResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first subscription to be returned,
within the collection of all subscriptions matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first subscription to be returned, within the collection of all subscriptions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last subscription to be returned, within
the collection of all subscriptions matching the search criteria;
the search may return fewer subscriptions than requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last subscription to be returned, within the collection of all subscriptions matching the search criteria; the search may return fewer subscriptions than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters. Supported fields are:

                  id (bkw:resourceId)
                  type (bkw:subscriptionType)
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters. Supported fields are: id (bkw:resourceId) type (bkw:subscriptionType)</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListSubscriptionsResponseType_ListSubscriptionsResponseType_results_items schema_xsd.tmp#ListSubscriptionsResponseType_ListSubscriptionsResponseType_results_offset schema_xsd.tmp#ListSubscriptionsResponseType_ListSubscriptionsResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" minOccurs="0">
        <annotation>
          <documentation>The list of creditors</documentation>
        </annotation>
        <complexType>
          <choice>
            <element name="subscription" type="bkw:subscription" maxOccurs="unbounded"/>
          </choice>
        </complexType>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned subscription, within the collection of all subscriptions matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of subscriptions matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of creditors
Diagram
Diagram schema_xsd.tmp#ListSubscriptionsResponseType_ListSubscriptionsResponseType_results_ListSubscriptionsResponseType_ListSubscriptionsResponseType_results_items_subscription
Properties
content complex
minOccurs 0
Model
Children bkw:subscription
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:subscription>{1,unbounded}</bkw:subscription>
</bkw:items>
Source
 
<element name="items" minOccurs="0">
  <annotation>
    <documentation>The list of creditors</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="subscription" type="bkw:subscription" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsResponseType / bkw:results / bkw:items / bkw:subscription
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#subscription_id schema_xsd.tmp#subscription_type schema_xsd.tmp#subscription_eventTypes schema_xsd.tmp#subscription_params schema_xsd.tmp#subscription_deliveryMethods schema_xsd.tmp#subscription
Type bkw:subscription
Properties
content complex
maxOccurs unbounded
Model
Children bkw:deliveryMethods, bkw:eventTypes, bkw:id, bkw:params, bkw:type
Instance
 
<bkw:subscription xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:type>{1,1}</bkw:type>
  <bkw:eventTypes>{0,1}</bkw:eventTypes>
  <bkw:params>{0,1}</bkw:params>
  <bkw:deliveryMethods>{0,1}</bkw:deliveryMethods>
</bkw:subscription>
Source
 
<element name="subscription" type="bkw:subscription" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned subscription,
within the collection of all subscriptions matching the
search criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned subscription, within the collection of all subscriptions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of subscriptions matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of subscriptions matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListSubscriptionsRequestType_username schema_xsd.tmp#ListSubscriptionsRequestType_password schema_xsd.tmp#ListSubscriptionsRequestType_authtoken schema_xsd.tmp#ListSubscriptionsRequestType_from schema_xsd.tmp#ListSubscriptionsRequestType_to schema_xsd.tmp#ListSubscriptionsRequestType_filters schema_xsd.tmp#ListSubscriptionsRequestType_sort schema_xsd.tmp#ListSubscriptionsRequestType
Type bkw:ListSubscriptionsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Instance
 
<bkw:ListSubscriptionsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
</bkw:ListSubscriptionsRequest>
Source
 
<element name="ListSubscriptionsRequest" type="bkw:ListSubscriptionsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListSubscriptionsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListSubscriptionsResponseType_results schema_xsd.tmp#ListSubscriptionsResponseType_status schema_xsd.tmp#ListSubscriptionsResponseType_message schema_xsd.tmp#ListSubscriptionsResponseType
Type bkw:ListSubscriptionsResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListSubscriptionsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListSubscriptionsResponse>
Source
 
<element name="ListSubscriptionsResponse" type="bkw:ListSubscriptionsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequestType / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="subscriptionId" type="bkw:resourceId">
  <annotation>
    <documentation>The subscription ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequestType / bkw:transport
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#messageTransport
Type bkw:messageTransport
Properties
content simple
Facets
enumeration FAX 
Notification by fax
enumeration POSTAL 
Notification by USPS
enumeration SFTP 
Notification by SFTP
enumeration SMTP 
Notification by email
enumeration WEB_PUSH 
Notification by POSTing to a client-provided URL
enumeration WEB_PULL 
Client retrieves notifications by calling ListNotifications
Source
 
<element name="transport" type="bkw:messageTransport"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequestType / bkw:format
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The message format. The value depends on the transport, as
                follows

                EMAIL - defauls to HTML
                FAX - must be unspecified or equal to TEXT; defaults to TEXT
                POSTAL - must be unspecified or equal to TEXT; defaults to TEXT
                WEB_PUSH - must be unspecified or equal to XML; defaults to XML
                WEB_PULL - must be unspecified or equal to XML; defaults to XML
Diagram
Diagram schema_xsd.tmp#messageFormat
Type bkw:messageFormat
Properties
content simple
minOccurs 0
Facets
enumeration TEXT 
Plain Text
enumeration HTML 
Hypertext Markup Language
enumeration XML 
Extensible Markup Language
enumeration CSV 
Comma-Separated Values
enumeration PDF 
Portable Document Format
enumeration JSON 
JavaScript Object Notation
Source
 
<element name="format" type="bkw:messageFormat" minOccurs="0">
  <annotation>
    <documentation>The message format. The value depends on the transport, as follows EMAIL - defauls to HTML FAX - must be unspecified or equal to TEXT; defaults to TEXT POSTAL - must be unspecified or equal to TEXT; defaults to TEXT WEB_PUSH - must be unspecified or equal to XML; defaults to XML WEB_PULL - must be unspecified or equal to XML; defaults to XML</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequestType / bkw:batch
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
true if notifications should be delivered in batches.
                Must be absent when transport is WEB_PULL. The
                value depends on the transport, as follows

                EMAIL - defaults to false
                FAX - defaults to false
                POSTAL - must be unspecified or true; defaults to true
                WEB_PUSH - defaults to false
                WEB_PULL - must be unspecified or true; defaults to true
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="batch" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>true if notifications should be delivered in batches. Must be absent when transport is WEB_PULL. The value depends on the transport, as follows EMAIL - defaults to false FAX - defaults to false POSTAL - must be unspecified or true; defaults to true WEB_PUSH - defaults to false WEB_PULL - must be unspecified or true; defaults to true</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequestType / bkw:address
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
An address indicating where the notification should be sent.
Must be present unless transport is WEB_PULL, in which case it
must be absent.
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
minOccurs 0
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:address xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:address>
Source
 
<element name="address" type="bkw:address" minOccurs="0">
  <annotation>
    <documentation>An address indicating where the notification should be sent. Must be present unless transport is WEB_PULL, in which case it must be absent.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#AddDeliveryMethodRequestType_username schema_xsd.tmp#AddDeliveryMethodRequestType_password schema_xsd.tmp#AddDeliveryMethodRequestType_authtoken schema_xsd.tmp#AddDeliveryMethodRequestType_subscriptionId schema_xsd.tmp#AddDeliveryMethodRequestType_transport schema_xsd.tmp#AddDeliveryMethodRequestType_format schema_xsd.tmp#AddDeliveryMethodRequestType_batch schema_xsd.tmp#AddDeliveryMethodRequestType_address schema_xsd.tmp#AddDeliveryMethodRequestType
Type bkw:AddDeliveryMethodRequestType
Properties
content complex
Model
Children bkw:address, bkw:authtoken, bkw:batch, bkw:format, bkw:password, bkw:subscriptionId, bkw:transport, bkw:username
Instance
 
<bkw:AddDeliveryMethodRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:subscriptionId>{1,1}</bkw:subscriptionId>
  <bkw:transport>{1,1}</bkw:transport>
  <bkw:format>{0,1}</bkw:format>
  <bkw:batch>{0,1}</bkw:batch>
  <bkw:address>{0,1}</bkw:address>
</bkw:AddDeliveryMethodRequest>
Source
 
<element name="AddDeliveryMethodRequest" type="bkw:AddDeliveryMethodRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddDeliveryMethodResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#AddDeliveryMethodResponseType_status schema_xsd.tmp#AddDeliveryMethodResponseType_message schema_xsd.tmp#AddDeliveryMethodResponseType
Type bkw:AddDeliveryMethodResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:AddDeliveryMethodResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:AddDeliveryMethodResponse>
Source
 
<element name="AddDeliveryMethodResponse" type="bkw:AddDeliveryMethodResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodRequestType / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="subscriptionId" type="bkw:resourceId">
  <annotation>
    <documentation>The subscription ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodRequestType / bkw:transport
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The type of delivery method
Diagram
Diagram schema_xsd.tmp#messageTransport
Type bkw:messageTransport
Properties
content simple
Facets
enumeration FAX 
Notification by fax
enumeration POSTAL 
Notification by USPS
enumeration SFTP 
Notification by SFTP
enumeration SMTP 
Notification by email
enumeration WEB_PUSH 
Notification by POSTing to a client-provided URL
enumeration WEB_PULL 
Client retrieves notifications by calling ListNotifications
Source
 
<element name="transport" type="bkw:messageTransport">
  <annotation>
    <documentation>The type of delivery method</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodRequestType / bkw:address
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The address
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
minOccurs 0
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:address xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:address>
Source
 
<element name="address" type="bkw:address" minOccurs="0">
  <annotation>
    <documentation>The address</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RemoveDeliveryMethodRequestType_username schema_xsd.tmp#RemoveDeliveryMethodRequestType_password schema_xsd.tmp#RemoveDeliveryMethodRequestType_authtoken schema_xsd.tmp#RemoveDeliveryMethodRequestType_subscriptionId schema_xsd.tmp#RemoveDeliveryMethodRequestType_transport schema_xsd.tmp#RemoveDeliveryMethodRequestType_address schema_xsd.tmp#RemoveDeliveryMethodRequestType
Type bkw:RemoveDeliveryMethodRequestType
Properties
content complex
Model
Children bkw:address, bkw:authtoken, bkw:password, bkw:subscriptionId, bkw:transport, bkw:username
Instance
 
<bkw:RemoveDeliveryMethodRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:subscriptionId>{1,1}</bkw:subscriptionId>
  <bkw:transport>{1,1}</bkw:transport>
  <bkw:address>{0,1}</bkw:address>
</bkw:RemoveDeliveryMethodRequest>
Source
 
<element name="RemoveDeliveryMethodRequest" type="bkw:RemoveDeliveryMethodRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemoveDeliveryMethodResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RemoveDeliveryMethodResponseType_status schema_xsd.tmp#RemoveDeliveryMethodResponseType_message schema_xsd.tmp#RemoveDeliveryMethodResponseType
Type bkw:RemoveDeliveryMethodResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:RemoveDeliveryMethodResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RemoveDeliveryMethodResponse>
Source
 
<element name="RemoveDeliveryMethodResponse" type="bkw:RemoveDeliveryMethodResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The ID of a subscription with a delivery method with transport
WEB_PULL; excatly one of "subscriptionId" and
"deliveryMethodId" must be supplied
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="subscriptionId" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The ID of a subscription with a delivery method with transport WEB_PULL; excatly one of "subscriptionId" and "deliveryMethodId" must be supplied</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:deliveryMethodId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The delivery method ID; excatly one of "subscriptionId" and
"deliveryMethodId" must be supplied
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="deliveryMethodId" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The delivery method ID; excatly one of "subscriptionId" and "deliveryMethodId" must be supplied</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first notification to be returned,
within the collection of all notifications matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first notification to be returned, within the collection of all notifications matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last notification to be returned,
within the collection of all notifications matching the search
criteria; the search may return fewer notifications than
requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last notification to be returned, within the collection of all notifications matching the search criteria; the search may return fewer notifications than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters. All subscription types support the
                following fields:

                  id (bkw:resourceId)
                  timestamp (bkw:dateTime)
                  eventType (xsd:eventType)
                  eventDate (xsd:date)
                  description (xsd:string)
                  delivered (bkw:dateTime)

              In addition, subscriptions of type CONSUMER_PORTFOLIO support the
              following fields:

                  item.id (xsd:string)
                  item.firstName (xsd:string)
                  item.middleName (xsd:string)
                  item.lastName (xsd:string)
                  item.ssn4 (xsd:string)

              Subscriptions of type CASE_PORTFOLIO support the following fields

                  item.id (xsd:string)
                  item.district (xsd:string)
                  item.caseNumber (xsd:string)
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters. All subscription types support the following fields: id (bkw:resourceId) timestamp (bkw:dateTime) eventType (xsd:eventType) eventDate (xsd:date) description (xsd:string) delivered (bkw:dateTime) In addition, subscriptions of type CONSUMER_PORTFOLIO support the following fields: item.id (xsd:string) item.firstName (xsd:string) item.middleName (xsd:string) item.lastName (xsd:string) item.ssn4 (xsd:string) Subscriptions of type CASE_PORTFOLIO support the following fields item.id (xsd:string) item.district (xsd:string) item.caseNumber (xsd:string)</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListNotificationsResponseType_ListNotificationsResponseType_results_items schema_xsd.tmp#ListNotificationsResponseType_ListNotificationsResponseType_results_offset schema_xsd.tmp#ListNotificationsResponseType_ListNotificationsResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" type="bkw:notificationsList" minOccurs="0">
        <annotation>
          <documentation>The list of notifications</documentation>
        </annotation>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned notification, within the collection of all notifications matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of notifications matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of notifications
Diagram
Diagram schema_xsd.tmp#notificationsList_notification schema_xsd.tmp#notificationsList
Type bkw:notificationsList
Properties
content complex
minOccurs 0
Model
Children bkw:notification
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:notification>{0,unbounded}</bkw:notification>
</bkw:items>
Source
 
<element name="items" type="bkw:notificationsList" minOccurs="0">
  <annotation>
    <documentation>The list of notifications</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned notification,
within the collection of all notifications matching the
search criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned notification, within the collection of all notifications matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of notifications matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of notifications matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListNotificationsRequestType_username schema_xsd.tmp#ListNotificationsRequestType_password schema_xsd.tmp#ListNotificationsRequestType_authtoken schema_xsd.tmp#ListNotificationsRequestType_subscriptionId schema_xsd.tmp#ListNotificationsRequestType_deliveryMethodId schema_xsd.tmp#ListNotificationsRequestType_from schema_xsd.tmp#ListNotificationsRequestType_to schema_xsd.tmp#ListNotificationsRequestType_filters schema_xsd.tmp#ListNotificationsRequestType_sort schema_xsd.tmp#ListNotificationsRequestType
Type bkw:ListNotificationsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:deliveryMethodId, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:subscriptionId, bkw:to, bkw:username
Instance
 
<bkw:ListNotificationsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:subscriptionId>{0,1}</bkw:subscriptionId>
  <bkw:deliveryMethodId>{0,1}</bkw:deliveryMethodId>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
</bkw:ListNotificationsRequest>
Source
 
<element name="ListNotificationsRequest" type="bkw:ListNotificationsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListNotificationsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListNotificationsResponseType_results schema_xsd.tmp#ListNotificationsResponseType_status schema_xsd.tmp#ListNotificationsResponseType_message schema_xsd.tmp#ListNotificationsResponseType
Type bkw:ListNotificationsResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListNotificationsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListNotificationsResponse>
Source
 
<element name="ListNotificationsResponse" type="bkw:ListNotificationsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsRequestType / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="subscriptionId" type="bkw:resourceId">
  <annotation>
    <documentation>The subscription ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsRequestType / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of portfolio items
Diagram
Diagram schema_xsd.tmp#AddPortfolioItemsRequestType_AddPortfolioItemsRequestType_items_item
Properties
content complex
Model
Children bkw:item
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:item>{1,unbounded}</bkw:item>
</bkw:items>
Source
 
<element name="items">
  <annotation>
    <documentation>A list of portfolio items</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="item" type="bkw:portfolioItem" minOccurs="1" maxOccurs="unbounded"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsRequestType / bkw:items / bkw:item
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#portfolioItem_id schema_xsd.tmp#portfolioItem_properties schema_xsd.tmp#portfolioItem_added schema_xsd.tmp#portfolioItem_removed schema_xsd.tmp#portfolioItem
Type bkw:portfolioItem
Properties
content complex
minOccurs 1
maxOccurs unbounded
Model
Children bkw:added, bkw:id, bkw:properties, bkw:removed
Instance
 
<bkw:item xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{0,1}</bkw:id>
  <bkw:properties>{1,1}</bkw:properties>
  <bkw:added>{0,1}</bkw:added>
  <bkw:removed>{0,1}</bkw:removed>
</bkw:item>
Source
 
<element name="item" type="bkw:portfolioItem" minOccurs="1" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#AddPortfolioItemsRequestType_username schema_xsd.tmp#AddPortfolioItemsRequestType_password schema_xsd.tmp#AddPortfolioItemsRequestType_authtoken schema_xsd.tmp#AddPortfolioItemsRequestType_subscriptionId schema_xsd.tmp#AddPortfolioItemsRequestType_items schema_xsd.tmp#AddPortfolioItemsRequestType
Type bkw:AddPortfolioItemsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:items, bkw:password, bkw:subscriptionId, bkw:username
Instance
 
<bkw:AddPortfolioItemsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:subscriptionId>{1,1}</bkw:subscriptionId>
  <bkw:items>{1,1}</bkw:items>
</bkw:AddPortfolioItemsRequest>
Source
 
<element name="AddPortfolioItemsRequest" type="bkw:AddPortfolioItemsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddPortfolioItemsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#AddPortfolioItemsResponseType_status schema_xsd.tmp#AddPortfolioItemsResponseType_message schema_xsd.tmp#AddPortfolioItemsResponseType
Type bkw:AddPortfolioItemsResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:AddPortfolioItemsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:AddPortfolioItemsResponse>
Source
 
<element name="AddPortfolioItemsResponse" type="bkw:AddPortfolioItemsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsRequestType / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="subscriptionId" type="bkw:resourceId">
  <annotation>
    <documentation>The subscription ID</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsRequestType / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of portfolio items
Diagram
Diagram schema_xsd.tmp#RemovePortfolioItemsRequestType_RemovePortfolioItemsRequestType_items_item
Properties
content complex
Model
Children bkw:item
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:item>{1,unbounded}</bkw:item>
</bkw:items>
Source
 
<element name="items">
  <annotation>
    <documentation>A list of portfolio items</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="item" type="bkw:portfolioItem" minOccurs="1" maxOccurs="unbounded"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsRequestType / bkw:items / bkw:item
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#portfolioItem_id schema_xsd.tmp#portfolioItem_properties schema_xsd.tmp#portfolioItem_added schema_xsd.tmp#portfolioItem_removed schema_xsd.tmp#portfolioItem
Type bkw:portfolioItem
Properties
content complex
minOccurs 1
maxOccurs unbounded
Model
Children bkw:added, bkw:id, bkw:properties, bkw:removed
Instance
 
<bkw:item xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{0,1}</bkw:id>
  <bkw:properties>{1,1}</bkw:properties>
  <bkw:added>{0,1}</bkw:added>
  <bkw:removed>{0,1}</bkw:removed>
</bkw:item>
Source
 
<element name="item" type="bkw:portfolioItem" minOccurs="1" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RemovePortfolioItemsRequestType_username schema_xsd.tmp#RemovePortfolioItemsRequestType_password schema_xsd.tmp#RemovePortfolioItemsRequestType_authtoken schema_xsd.tmp#RemovePortfolioItemsRequestType_subscriptionId schema_xsd.tmp#RemovePortfolioItemsRequestType_items schema_xsd.tmp#RemovePortfolioItemsRequestType
Type bkw:RemovePortfolioItemsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:items, bkw:password, bkw:subscriptionId, bkw:username
Instance
 
<bkw:RemovePortfolioItemsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:subscriptionId>{1,1}</bkw:subscriptionId>
  <bkw:items>{1,1}</bkw:items>
</bkw:RemovePortfolioItemsRequest>
Source
 
<element name="RemovePortfolioItemsRequest" type="bkw:RemovePortfolioItemsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RemovePortfolioItemsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RemovePortfolioItemsResponseType_status schema_xsd.tmp#RemovePortfolioItemsResponseType_message schema_xsd.tmp#RemovePortfolioItemsResponseType
Type bkw:RemovePortfolioItemsResponseType
Properties
content complex
Model
Children bkw:message, bkw:status
Instance
 
<bkw:RemovePortfolioItemsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RemovePortfolioItemsResponse>
Source
 
<element name="RemovePortfolioItemsResponse" type="bkw:RemovePortfolioItemsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token; used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token; used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequestType / bkw:subscriptionId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subscription ID, of the form sub-xxxxxxxx
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="subscriptionId" type="bkw:requiredText">
  <annotation>
    <documentation>The subscription ID, of the form sub-xxxxxxxx password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequestType / bkw:from
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first portfolio item to be returned,
within the collection of all portfolio items matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="from" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first portfolio item to be returned, within the collection of all portfolio items matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequestType / bkw:to
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the last portfolio item to be returned,
within the collection of all portfolio items matching the search
criteria; the search may return fewer portfolio items than
requested
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="to" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the last portfolio item to be returned, within the collection of all portfolio items matching the search criteria; the search may return fewer portfolio items than requested</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequestType / bkw:filters
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter schema_xsd.tmp#searchFilterList
Type bkw:searchFilterList
Properties
content complex
minOccurs 0
Model
Children bkw:filter
Instance
 
<bkw:filters xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:filter>{1,unbounded}</bkw:filter>
</bkw:filters>
Source
 
<element name="filters" type="bkw:searchFilterList" minOccurs="0">
  <annotation>
    <documentation>A list of search filters</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequestType / bkw:sort
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The sort criteria
Diagram
Diagram schema_xsd.tmp#sortCriteria
Type bkw:sortCriteria
Properties
content simple
minOccurs 0
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Source
 
<element name="sort" type="bkw:sortCriteria" minOccurs="0">
  <annotation>
    <documentation>The sort criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsResponseType / bkw:results
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The search results
Diagram
Diagram schema_xsd.tmp#ListPortfolioItemsResponseType_ListPortfolioItemsResponseType_results_items schema_xsd.tmp#ListPortfolioItemsResponseType_ListPortfolioItemsResponseType_results_offset schema_xsd.tmp#ListPortfolioItemsResponseType_ListPortfolioItemsResponseType_results_total
Properties
content complex
minOccurs 0
Model
Children bkw:items, bkw:offset, bkw:total
Instance
 
<bkw:results xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:items>{0,1}</bkw:items>
  <bkw:offset>{0,1}</bkw:offset>
  <bkw:total>{1,1}</bkw:total>
</bkw:results>
Source
 
<element name="results" minOccurs="0">
  <annotation>
    <documentation>The search results</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="items" minOccurs="0">
        <annotation>
          <documentation>The list of portfolio items</documentation>
        </annotation>
        <complexType>
          <choice>
            <element name="item" type="bkw:portfolioItem" maxOccurs="unbounded"/>
          </choice>
        </complexType>
      </element>
      <element name="offset" type="xsd:positiveInteger" minOccurs="0">
        <annotation>
          <documentation>The 1-based offset of the first returned case, within the collection of all creditors matching the search criteria</documentation>
        </annotation>
      </element>
      <element name="total" type="xsd:nonNegativeInteger">
        <annotation>
          <documentation>The total number of creditors matching the search criteria</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsResponseType / bkw:results / bkw:items
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The list of portfolio items
Diagram
Diagram schema_xsd.tmp#ListPortfolioItemsResponseType_ListPortfolioItemsResponseType_results_ListPortfolioItemsResponseType_ListPortfolioItemsResponseType_results_items_item
Properties
content complex
minOccurs 0
Model
Children bkw:item
Instance
 
<bkw:items xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:item>{1,unbounded}</bkw:item>
</bkw:items>
Source
 
<element name="items" minOccurs="0">
  <annotation>
    <documentation>The list of portfolio items</documentation>
  </annotation>
  <complexType>
    <choice>
      <element name="item" type="bkw:portfolioItem" maxOccurs="unbounded"/>
    </choice>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsResponseType / bkw:results / bkw:items / bkw:item
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#portfolioItem_id schema_xsd.tmp#portfolioItem_properties schema_xsd.tmp#portfolioItem_added schema_xsd.tmp#portfolioItem_removed schema_xsd.tmp#portfolioItem
Type bkw:portfolioItem
Properties
content complex
maxOccurs unbounded
Model
Children bkw:added, bkw:id, bkw:properties, bkw:removed
Instance
 
<bkw:item xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{0,1}</bkw:id>
  <bkw:properties>{1,1}</bkw:properties>
  <bkw:added>{0,1}</bkw:added>
  <bkw:removed>{0,1}</bkw:removed>
</bkw:item>
Source
 
<element name="item" type="bkw:portfolioItem" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsResponseType / bkw:results / bkw:offset
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 1-based offset of the first returned case, within
the collection of all creditors matching the search
criteria
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="offset" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The 1-based offset of the first returned case, within the collection of all creditors matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsResponseType / bkw:results / bkw:total
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The total number of creditors matching the search
criteria
Diagram
Diagram
Type nonNegativeInteger
Properties
content simple
Source
 
<element name="total" type="xsd:nonNegativeInteger">
  <annotation>
    <documentation>The total number of creditors matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListPortfolioItemsRequestType_username schema_xsd.tmp#ListPortfolioItemsRequestType_password schema_xsd.tmp#ListPortfolioItemsRequestType_authtoken schema_xsd.tmp#ListPortfolioItemsRequestType_subscriptionId schema_xsd.tmp#ListPortfolioItemsRequestType_from schema_xsd.tmp#ListPortfolioItemsRequestType_to schema_xsd.tmp#ListPortfolioItemsRequestType_filters schema_xsd.tmp#ListPortfolioItemsRequestType_sort schema_xsd.tmp#ListPortfolioItemsRequestType
Type bkw:ListPortfolioItemsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:subscriptionId, bkw:to, bkw:username
Instance
 
<bkw:ListPortfolioItemsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:subscriptionId>{1,1}</bkw:subscriptionId>
  <bkw:from>{0,1}</bkw:from>
  <bkw:to>{0,1}</bkw:to>
  <bkw:filters>{0,1}</bkw:filters>
  <bkw:sort>{0,1}</bkw:sort>
</bkw:ListPortfolioItemsRequest>
Source
 
<element name="ListPortfolioItemsRequest" type="bkw:ListPortfolioItemsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListPortfolioItemsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListPortfolioItemsResponseType_results schema_xsd.tmp#ListPortfolioItemsResponseType_status schema_xsd.tmp#ListPortfolioItemsResponseType_message schema_xsd.tmp#ListPortfolioItemsResponseType
Type bkw:ListPortfolioItemsResponseType
Properties
content complex
Model
Children bkw:message, bkw:results, bkw:status
Instance
 
<bkw:ListPortfolioItemsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:results>{0,1}</bkw:results>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListPortfolioItemsResponse>
Source
 
<element name="ListPortfolioItemsResponse" type="bkw:ListPortfolioItemsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryRequestType / bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The extended case number
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
  <annotation>
    <documentation>The extended case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryResponseType / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case matching the search criteria
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>The case matching the search criteria</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CaseSummaryRequestType_username schema_xsd.tmp#CaseSummaryRequestType_password schema_xsd.tmp#CaseSummaryRequestType_authtoken schema_xsd.tmp#CaseSummaryRequestType_district schema_xsd.tmp#CaseSummaryRequestType_extendedCaseNumber schema_xsd.tmp#CaseSummaryRequestType
Type bkw:CaseSummaryRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:district, bkw:extendedCaseNumber, bkw:password, bkw:username
Instance
 
<bkw:CaseSummaryRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:extendedCaseNumber>{1,1}</bkw:extendedCaseNumber>
</bkw:CaseSummaryRequest>
Source
 
<element name="CaseSummaryRequest" type="bkw:CaseSummaryRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:CaseSummaryResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#CaseSummaryResponseType_case schema_xsd.tmp#CaseSummaryResponseType_status schema_xsd.tmp#CaseSummaryResponseType_message schema_xsd.tmp#CaseSummaryResponseType
Type bkw:CaseSummaryResponseType
Properties
content complex
Model
Children bkw:case, bkw:message, bkw:status
Instance
 
<bkw:CaseSummaryResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,1}</bkw:case>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:CaseSummaryResponse>
Source
 
<element name="CaseSummaryResponse" type="bkw:CaseSummaryResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsRequestType / bkw:serviceId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The trustee payment service ID, of the form ch13-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="serviceId" type="bkw:requiredText">
  <annotation>
    <documentation>The trustee payment service ID, of the form ch13-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsRequestType / bkw:checkNumbers
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of check numbers
Diagram
Diagram
Type restriction of string
Properties
content simple
Facets
pattern [a-zA-Z0-9]+(,[a-zA-Z0-9]+)*
Source
 
<element name="checkNumbers">
  <annotation>
    <documentation>A comma-separated list of check numbers</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <pattern value="[a-zA-Z0-9]+(,[a-zA-Z0-9]+)*"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsResponseType / bkw:checks
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of trustee checks
Diagram
Diagram schema_xsd.tmp#ListTrusteeCheckPaymentsResponseType_ListTrusteeCheckPaymentsResponseType_checks_check
Properties
content complex
minOccurs 0
Model
Children bkw:check
Instance
 
<bkw:checks xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:check>{0,unbounded}</bkw:check>
</bkw:checks>
Source
 
<element name="checks" minOccurs="0">
  <annotation>
    <documentation>A list of trustee checks</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="check" type="bkw:trusteeCheck" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
  </complexType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsResponseType / bkw:checks / bkw:check
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#trusteeCheck_number schema_xsd.tmp#trusteeCheck_date schema_xsd.tmp#trusteeCheck_amount schema_xsd.tmp#trusteeCheck_trusteeAddress schema_xsd.tmp#trusteeCheck_payments schema_xsd.tmp#trusteeCheck
Type bkw:trusteeCheck
Properties
content complex
minOccurs 0
maxOccurs unbounded
Model
Children bkw:amount, bkw:date, bkw:number, bkw:payments, bkw:trusteeAddress
Instance
 
<bkw:check xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:number>{1,1}</bkw:number>
  <bkw:date>{0,1}</bkw:date>
  <bkw:amount>{1,1}</bkw:amount>
  <bkw:trusteeAddress>{1,1}</bkw:trusteeAddress>
  <bkw:payments>{1,1}</bkw:payments>
</bkw:check>
Source
 
<element name="check" type="bkw:trusteeCheck" minOccurs="0" maxOccurs="unbounded"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_username schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_password schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_authtoken schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_serviceId schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_checkNumbers schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType
Type bkw:ListTrusteeCheckPaymentsRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:checkNumbers, bkw:password, bkw:serviceId, bkw:username
Instance
 
<bkw:ListTrusteeCheckPaymentsRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:serviceId>{1,1}</bkw:serviceId>
  <bkw:checkNumbers>{1,1}</bkw:checkNumbers>
</bkw:ListTrusteeCheckPaymentsRequest>
Source
 
<element name="ListTrusteeCheckPaymentsRequest" type="bkw:ListTrusteeCheckPaymentsRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:ListTrusteeCheckPaymentsResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#ListTrusteeCheckPaymentsResponseType_checks schema_xsd.tmp#ListTrusteeCheckPaymentsResponseType_status schema_xsd.tmp#ListTrusteeCheckPaymentsResponseType_message schema_xsd.tmp#ListTrusteeCheckPaymentsResponseType
Type bkw:ListTrusteeCheckPaymentsResponseType
Properties
content complex
Model
Children bkw:checks, bkw:message, bkw:status
Instance
 
<bkw:ListTrusteeCheckPaymentsResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:checks>{0,1}</bkw:checks>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:ListTrusteeCheckPaymentsResponse>
Source
 
<element name="ListTrusteeCheckPaymentsResponse" type="bkw:ListTrusteeCheckPaymentsResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListRequestType / bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The extended case number
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
  <annotation>
    <documentation>The extended case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListRequestType / bkw:ecfAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A CM/ECF account id of a form pacer-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="ecfAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>A CM/ECF account id of a form pacer-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListResponseType / bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A case containing a list of creditors with creditor numbers
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data schema_xsd.tmp#case
Type bkw:case
Properties
content complex
minOccurs 0
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Instance
 
<bkw:case xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:id>{1,1}</bkw:id>
  <bkw:district>{1,1}</bkw:district>
  <bkw:division>{1,1}</bkw:division>
  <bkw:county>{0,1}</bkw:county>
  <bkw:caseNumber>{1,1}</bkw:caseNumber>
  <bkw:title>{0,1}</bkw:title>
  <bkw:chapter>{0,1}</bkw:chapter>
  <bkw:previousChapter>{0,1}</bkw:previousChapter>
  <bkw:dateClosed>{0,1}</bkw:dateClosed>
  <bkw:dateConverted>{0,1}</bkw:dateConverted>
  <bkw:dateDischarged>{0,1}</bkw:dateDischarged>
  <bkw:dateDismissed>{0,1}</bkw:dateDismissed>
  <bkw:dateEntered>{0,1}</bkw:dateEntered>
  <bkw:dateFiled>{0,1}</bkw:dateFiled>
  <bkw:dateJointDebtorDischarged>{0,1}</bkw:dateJointDebtorDischarged>
  <bkw:dateJointDebtorDismissed>{0,1}</bkw:dateJointDebtorDismissed>
  <bkw:datePlanConfirmed>{0,1}</bkw:datePlanConfirmed>
  <bkw:dateReopened>{0,1}</bkw:dateReopened>
  <bkw:dateTerminated>{0,1}</bkw:dateTerminated>
  <bkw:dateTransferred>{0,1}</bkw:dateTransferred>
  <bkw:lastDateToFileClaims>{0,1}</bkw:lastDateToFileClaims>
  <bkw:lastDateToFileClaimsGovt>{0,1}</bkw:lastDateToFileClaimsGovt>
  <bkw:closed>{0,1}</bkw:closed>
  <bkw:disposition>{0,1}</bkw:disposition>
  <bkw:jointDebtorDisposition>{0,1}</bkw:jointDebtorDisposition>
  <bkw:filingFeeStatus>{0,1}</bkw:filingFeeStatus>
  <bkw:assets>{0,1}</bkw:assets>
  <bkw:voluntary>{0,1}</bkw:voluntary>
  <bkw:debtorType>{0,1}</bkw:debtorType>
  <bkw:debtType>{0,1}</bkw:debtType>
  <bkw:parties>{0,1}</bkw:parties>
  <bkw:claims>{0,1}</bkw:claims>
  <bkw:creditors>{0,1}</bkw:creditors>
  <bkw:docketItems>{0,1}</bkw:docketItems>
  <bkw:data>{0,1}</bkw:data>
</bkw:case>
Source
 
<element name="case" type="bkw:case" minOccurs="0">
  <annotation>
    <documentation>A case containing a list of creditors with creditor numbers</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunEcfCreditorListRequestType_username schema_xsd.tmp#RunEcfCreditorListRequestType_password schema_xsd.tmp#RunEcfCreditorListRequestType_authtoken schema_xsd.tmp#RunEcfCreditorListRequestType_district schema_xsd.tmp#RunEcfCreditorListRequestType_extendedCaseNumber schema_xsd.tmp#RunEcfCreditorListRequestType_ecfAccount schema_xsd.tmp#RunEcfCreditorListRequestType
Type bkw:RunEcfCreditorListRequestType
Properties
content complex
Model
Children bkw:authtoken, bkw:district, bkw:ecfAccount, bkw:extendedCaseNumber, bkw:password, bkw:username
Instance
 
<bkw:RunEcfCreditorListRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:extendedCaseNumber>{1,1}</bkw:extendedCaseNumber>
  <bkw:ecfAccount>{0,1}</bkw:ecfAccount>
</bkw:RunEcfCreditorListRequest>
Source
 
<element name="RunEcfCreditorListRequest" type="bkw:RunEcfCreditorListRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:RunEcfCreditorListResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#RunEcfCreditorListResponseType_case schema_xsd.tmp#RunEcfCreditorListResponseType_status schema_xsd.tmp#RunEcfCreditorListResponseType_message schema_xsd.tmp#RunEcfCreditorListResponseType
Type bkw:RunEcfCreditorListResponseType
Properties
content complex
Model
Children bkw:case, bkw:message, bkw:status
Instance
 
<bkw:RunEcfCreditorListResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:case>{0,1}</bkw:case>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:RunEcfCreditorListResponse>
Source
 
<element name="RunEcfCreditorListResponse" type="bkw:RunEcfCreditorListResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorRequestType / bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The extended case number
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
  <annotation>
    <documentation>The extended case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorRequestType / bkw:address
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor address
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
Facets
minLength 1
Source
 
<element name="address" type="bkw:requiredText">
  <annotation>
    <documentation>The creditor address</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorRequestType / bkw:ecfAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A CM/ECF account id of a form pacer-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="ecfAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>A CM/ECF account id of a form pacer-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorResponseType / bkw:documents
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of CM/ECF filing confirmations in HTML format
Diagram
Diagram schema_xsd.tmp#documentList_document schema_xsd.tmp#documentList
Type bkw:documentList
Properties
content complex
minOccurs 0
Model
Children bkw:document
Instance
 
<bkw:documents xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:document>{0,unbounded}</bkw:document>
</bkw:documents>
Source
 
<element name="documents" type="bkw:documentList" minOccurs="0">
  <annotation>
    <documentation>A list of CM/ECF filing confirmations in HTML format</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#AddCreditorRequestType_username schema_xsd.tmp#AddCreditorRequestType_password schema_xsd.tmp#AddCreditorRequestType_authtoken schema_xsd.tmp#AddCreditorRequestType_district schema_xsd.tmp#AddCreditorRequestType_extendedCaseNumber schema_xsd.tmp#AddCreditorRequestType_address schema_xsd.tmp#AddCreditorRequestType_ecfAccount schema_xsd.tmp#AddCreditorRequestType
Type bkw:AddCreditorRequestType
Properties
content complex
Model
Children bkw:address, bkw:authtoken, bkw:district, bkw:ecfAccount, bkw:extendedCaseNumber, bkw:password, bkw:username
Instance
 
<bkw:AddCreditorRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:extendedCaseNumber>{1,1}</bkw:extendedCaseNumber>
  <bkw:address>{1,1}</bkw:address>
  <bkw:ecfAccount>{0,1}</bkw:ecfAccount>
</bkw:AddCreditorRequest>
Source
 
<element name="AddCreditorRequest" type="bkw:AddCreditorRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:AddCreditorResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#AddCreditorResponseType_documents schema_xsd.tmp#AddCreditorResponseType_status schema_xsd.tmp#AddCreditorResponseType_message schema_xsd.tmp#AddCreditorResponseType
Type bkw:AddCreditorResponseType
Properties
content complex
Model
Children bkw:documents, bkw:message, bkw:status
Instance
 
<bkw:AddCreditorResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:documents>{0,1}</bkw:documents>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:AddCreditorResponse>
Source
 
<element name="AddCreditorResponse" type="bkw:AddCreditorResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:username
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch username
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="username" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch username</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:password
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BankruptcyWatch password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="password" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The BankruptcyWatch password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:authtoken
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The authentication token, used in place of a username and
password
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="authtoken" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The authentication token, used in place of a username and password</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The district
Diagram
Diagram schema_xsd.tmp#district
Type bkw:district
Properties
content simple
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Source
 
<element name="district" type="bkw:district">
  <annotation>
    <documentation>The district</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The extended case number
Diagram
Diagram schema_xsd.tmp#extendedCaseNumber
Type bkw:extendedCaseNumber
Properties
content simple
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Source
 
<element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
  <annotation>
    <documentation>The extended case number</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:creditorNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor number, if the creditor has already been added to
the case. Exactly one of the elements "creditorNumber" and
"creditorName" must be provided.
Diagram
Diagram schema_xsd.tmp#creditorNumber
Type bkw:creditorNumber
Properties
content simple
minOccurs 0
Facets
pattern [0-9]+
Source
 
<element name="creditorNumber" type="bkw:creditorNumber" minOccurs="0">
  <annotation>
    <documentation>The creditor number, if the creditor has already been added to the case. Exactly one of the elements "creditorNumber" and "creditorName" must be provided.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:creditorAddress
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The creditor address. If the element "creditorNumber", is
present, the address must consist of just "phone1" and "email"
address elements. Otherwise, the two elements must be present
together with a complete street address and personal name or
organization.
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
minOccurs 0
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:creditorAddress xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:creditorAddress>
Source
 
<element name="creditorAddress" type="bkw:address" minOccurs="0">
  <annotation>
    <documentation>The creditor address. If the element "creditorNumber", is present, the address must consist of just "phone1" and "email" address elements. Otherwise, the two elements must be present together with a complete street address and personal name or organization.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:paymentAddress
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The address to which payments should be sent, if different
from the address to which notices should be sent
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
minOccurs 0
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:paymentAddress xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:paymentAddress>
Source
 
<element name="paymentAddress" type="bkw:address" minOccurs="0">
  <annotation>
    <documentation>The address to which payments should be sent, if different from the address to which notices should be sent</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:otherNames
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Other names the creditor used with the debtor
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="otherNames" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Other names the creditor used with the debtor</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:previousCreditor
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The entity from whom claim has been acquired, if applicable
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="previousCreditor" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The entity from whom claim has been acquired, if applicable</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:uci
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Te uiform claim identifier for electronic payments in chapter 13
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="uci" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Te uiform claim identifier for electronic payments in chapter 13</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:claimNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The claim number of original claim, if the claim being filed is
an amendment
Diagram
Diagram
Type positiveInteger
Properties
content simple
minOccurs 0
Source
 
<element name="claimNumber" type="xsd:positiveInteger" minOccurs="0">
  <annotation>
    <documentation>The claim number of original claim, if the claim being filed is an amendment</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:claimDate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The date on which original claim was filed, if the claim being
filed is an amendment
Diagram
Diagram
Type date
Properties
content simple
minOccurs 0
Source
 
<element name="claimDate" type="xsd:date" minOccurs="0">
  <annotation>
    <documentation>The date on which original claim was filed, if the claim being filed is an amendment</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:previousFiler
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The person or entity that previously filed a proof of claim for
the claim, if applicable
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="previousFiler" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>The person or entity that previously filed a proof of claim for the claim, if applicable</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:accountNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The last 4 digits of the account number used to identify the
debtor, if any
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
pattern [0-9a-zA-Z]{4}
Source
 
<element name="accountNumber" minOccurs="0">
  <annotation>
    <documentation>The last 4 digits of the account number used to identify the debtor, if any</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <pattern value="[0-9a-zA-Z]{4}"/>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:claimAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The amount of the claim
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="claimAmount" type="bkw:dollarValue">
  <annotation>
    <documentation>The amount of the claim</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:includesInterest
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
true if claim amount includes interest or other charges
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="includesInterest" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>true if claim amount includes interest or other charges</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:basisOfClaim
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The basis of the claim
Diagram
Diagram
Properties
minOccurs 0
Source
 
<element name="basisOfClaim" minOccurs="0">
  <annotation>
    <documentation>The basis of the claim</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:securedByRealEstate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
True if the claim is secured by real estate
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="securedByRealEstate" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>True if the claim is secured by real estate</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:securedByMotorVehicle
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
True if the claim is secured by one or more motor vehicles
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="securedByMotorVehicle" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>True if the claim is secured by one or more motor vehicles</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:securedByOther
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
True if the claim is secured by property other than real estate
or motor vehicles
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="securedByOther" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>True if the claim is secured by property other than real estate or motor vehicles</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:securedByDescription
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Description of property other than real estate or motor vehicles
securing claim
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="securedByDescription" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Description of property other than real estate or motor vehicles securing claim</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:basisForPerfection
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Basis for perfection of claim, if claim is secured
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="basisForPerfection" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Basis for perfection of claim, if claim is secured</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:propertyValue
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The value of the property securing the claim, if claim is
secured
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="propertyValue" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The value of the property securing the claim, if claim is secured</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:securedAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Amount of the claim that is secured, if claim is secured
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="securedAmount" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Amount of the claim that is secured, if claim is secured</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:unsecuredAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Amount of the claim that is unsecured, if claim is secured
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="unsecuredAmount" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Amount of the claim that is unsecured, if claim is secured</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:amountToCureDefault
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Amount necessary to cure any default as of the date of the
petition, if claim is secured
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="amountToCureDefault" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Amount necessary to cure any default as of the date of the petition, if claim is secured</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:interestRate
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Annual interest rate, if claim is secured
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="interestRate" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>Annual interest rate, if claim is secured</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:interestRateType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Type of interest rate, if claim is secured
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
enumeration FIXED 
Fixed
enumeration VARIABLE 
Variable
Source
 
<element name="interestRateType" minOccurs="0">
  <annotation>
    <documentation>Type of interest rate, if claim is secured</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <enumeration value="FIXED">
        <annotation>
          <documentation>Fixed</documentation>
        </annotation>
      </enumeration>
      <enumeration value="VARIABLE">
        <annotation>
          <documentation>Variable</documentation>
        </annotation>
      </enumeration>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:lease
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
true if claim is based on lease
Diagram
Diagram
Type boolean
Properties
content simple
minOccurs 0
Source
 
<element name="lease" type="xsd:boolean" minOccurs="0">
  <annotation>
    <documentation>true if claim is based on lease</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:amountToCureLeaseDefault
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Amount necessary to cure any default as of the date of the
petition
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="amountToCureLeaseDefault" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>Amount necessary to cure any default as of the date of the petition</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:rightOfSetoff
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Description of the property associated with the right of setoff,
if applicable
Diagram
Diagram schema_xsd.tmp#requiredText
Type bkw:requiredText
Properties
content simple
minOccurs 0
Facets
minLength 1
Source
 
<element name="rightOfSetoff" type="bkw:requiredText" minOccurs="0">
  <annotation>
    <documentation>Description of the property associated with the right of setoff, if applicable</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:domesticSupportObligationsAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The amount of the claim that is entitled to priority
under 11 U.S.C.507(a)(1)(A) or (a)(1)(B), if any
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="domesticSupportObligationsAmount" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(1)(A) or (a)(1)(B), if any</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:depositsAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The amount of the claim that is entitled to priority
under 11 U.S.C.507(a)(7), if any
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="depositsAmount" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(7), if any</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:wagesSalariesCommissionAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The amount of the claim that is entitled to priority
under 11 U.S.C.507(a)(4), if any
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="wagesSalariesCommissionAmount" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(4), if any</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:taxesOrPenaltiesAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The amount of the claim that is entitled to priority
under 11 U.S.C.507(a)(8), if any
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="taxesOrPenaltiesAmount" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(8), if any</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:contributionsAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The amount of the claim that is entitled to priority
under 11 U.S.C.507(a)(5), if any
Diagram
Diagram schema_xsd.tmp#dollarValue
Type bkw:dollarValue
Properties
content simple
minOccurs 0
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Source
 
<element name="contributionsAmount" type="bkw:dollarValue" minOccurs="0">
  <annotation>
    <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(5), if any</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:otherPriorityAmount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The amount of the claim that is entitled to priority
under a subsection of 11 U.S.C.507(a) not specified
above, if any
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="otherPriorityAmount" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The amount of the claim that is entitled to priority under a subsection of 11 U.S.C.&#xA7;507(a) not specified above, if any</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:otherPrioritySubsection
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The subsection of 11 U.S.C.507(a) not specified above
under which all or part of the claim is entitled to priority,
if any
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="otherPrioritySubsection" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>The subsection of 11 U.S.C.&#xA7;507(a) not specified above under which all or part of the claim is entitled to priority, if any</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:attachments
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of document IDs
Diagram
Diagram
Type string
Properties
content simple
minOccurs 0
Source
 
<element name="attachments" type="xsd:string" minOccurs="0">
  <annotation>
    <documentation>A comma-separated list of document IDs</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:signatureType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The role of the person signing the form
Diagram
Diagram
Type restriction of string
Properties
content simple
minOccurs 0
Facets
enumeration CREDITOR 
Signer is the creditor
enumeration CREDITOR_ATTORNEY 
Signer is the creditor's attorney or authorized agent
enumeration GUARANTOR 
Signer is a guarantor, surety, endorser, or other codebtor
Source
 
<element name="signatureType" minOccurs="0">
  <annotation>
    <documentation>The role of the person signing the form</documentation>
  </annotation>
  <simpleType>
    <restriction base="xsd:string">
      <enumeration value="CREDITOR">
        <annotation>
          <documentation>Signer is the creditor</documentation>
        </annotation>
      </enumeration>
      <enumeration value="CREDITOR_ATTORNEY">
        <annotation>
          <documentation>Signer is the creditor's attorney or authorized agent</documentation>
        </annotation>
      </enumeration>
      <enumeration value="GUARANTOR">
        <annotation>
          <documentation>Signer is a guarantor, surety, endorser, or other codebtor</documentation>
        </annotation>
      </enumeration>
    </restriction>
  </simpleType>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:signatureAddress
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The address of the person signing the form. Personal name,
street address, email, and phone1 are required.
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url schema_xsd.tmp#address
Type bkw:address
Properties
content complex
minOccurs 0
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Instance
 
<bkw:signatureAddress xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:prefix>{0,1}</bkw:prefix>
  <bkw:firstName>{0,1}</bkw:firstName>
  <bkw:middleName>{0,1}</bkw:middleName>
  <bkw:lastName>{0,1}</bkw:lastName>
  <bkw:generation>{0,1}</bkw:generation>
  <bkw:title>{0,1}</bkw:title>
  <bkw:organization>{0,1}</bkw:organization>
  <bkw:attention>{0,1}</bkw:attention>
  <bkw:careOf>{0,1}</bkw:careOf>
  <bkw:street1>{0,1}</bkw:street1>
  <bkw:street2>{0,1}</bkw:street2>
  <bkw:street3>{0,1}</bkw:street3>
  <bkw:city>{0,1}</bkw:city>
  <bkw:county>{0,1}</bkw:county>
  <bkw:state>{0,1}</bkw:state>
  <bkw:zip>{0,1}</bkw:zip>
  <bkw:zip4>{0,1}</bkw:zip4>
  <bkw:country>{0,1}</bkw:country>
  <bkw:phone1>{0,1}</bkw:phone1>
  <bkw:phone2>{0,1}</bkw:phone2>
  <bkw:phone3>{0,1}</bkw:phone3>
  <bkw:fax>{0,1}</bkw:fax>
  <bkw:email>{0,1}</bkw:email>
  <bkw:latitude>{0,1}</bkw:latitude>
  <bkw:longitude>{0,1}</bkw:longitude>
  <bkw:ssn>{0,1}</bkw:ssn>
  <bkw:eins>{0,1}</bkw:eins>
  <bkw:url>{0,1}</bkw:url>
</bkw:signatureAddress>
Source
 
<element name="signatureAddress" type="bkw:address" minOccurs="0">
  <annotation>
    <documentation>The address of the person signing the form. Personal name, street address, email, and phone1 are required.</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:mainDocument
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The proof of claim form to be filed with the court, if any,
as an identifier of the form doc-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="mainDocument" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>The proof of claim form to be filed with the court, if any, as an identifier of the form doc-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequestType / bkw:ecfAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A CM/ECF account id of a form pacer-xxxxxxxx
Diagram
Diagram schema_xsd.tmp#resourceId
Type bkw:resourceId
Properties
content simple
minOccurs 0
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Source
 
<element name="ecfAccount" type="bkw:resourceId" minOccurs="0">
  <annotation>
    <documentation>A CM/ECF account id of a form pacer-xxxxxxxx</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimResponseType / bkw:documents
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of filed documents in PDF format and CM/ECF filing
confirmations in HTML format
Diagram
Diagram schema_xsd.tmp#documentList_document schema_xsd.tmp#documentList
Type bkw:documentList
Properties
content complex
minOccurs 0
Model
Children bkw:document
Instance
 
<bkw:documents xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:document>{0,unbounded}</bkw:document>
</bkw:documents>
Source
 
<element name="documents" type="bkw:documentList" minOccurs="0">
  <annotation>
    <documentation>A list of filed documents in PDF format and CM/ECF filing confirmations in HTML format</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimResponseType / bkw:status
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Status of the operation
Diagram
Diagram schema_xsd.tmp#statusCode
Type bkw:statusCode
Properties
content simple
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Source
 
<element name="status" type="bkw:statusCode">
  <annotation>
    <documentation>Status of the operation</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimResponseType / bkw:message
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Brief message explaining the status
Diagram
Diagram
Type string
Properties
content simple
Source
 
<element name="message" type="xsd:string">
  <annotation>
    <documentation>Brief message explaining the status</documentation>
  </annotation>
</element>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimRequest
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#FileClaimRequestType_username schema_xsd.tmp#FileClaimRequestType_password schema_xsd.tmp#FileClaimRequestType_authtoken schema_xsd.tmp#FileClaimRequestType_district schema_xsd.tmp#FileClaimRequestType_extendedCaseNumber schema_xsd.tmp#FileClaimRequestType_creditorNumber schema_xsd.tmp#FileClaimRequestType_creditorAddress schema_xsd.tmp#FileClaimRequestType_paymentAddress schema_xsd.tmp#FileClaimRequestType_otherNames schema_xsd.tmp#FileClaimRequestType_previousCreditor schema_xsd.tmp#FileClaimRequestType_uci schema_xsd.tmp#FileClaimRequestType_claimNumber schema_xsd.tmp#FileClaimRequestType_claimDate schema_xsd.tmp#FileClaimRequestType_previousFiler schema_xsd.tmp#FileClaimRequestType_accountNumber schema_xsd.tmp#FileClaimRequestType_claimAmount schema_xsd.tmp#FileClaimRequestType_includesInterest schema_xsd.tmp#FileClaimRequestType_basisOfClaim schema_xsd.tmp#FileClaimRequestType_securedByRealEstate schema_xsd.tmp#FileClaimRequestType_securedByMotorVehicle schema_xsd.tmp#FileClaimRequestType_securedByOther schema_xsd.tmp#FileClaimRequestType_securedByDescription schema_xsd.tmp#FileClaimRequestType_basisForPerfection schema_xsd.tmp#FileClaimRequestType_propertyValue schema_xsd.tmp#FileClaimRequestType_securedAmount schema_xsd.tmp#FileClaimRequestType_unsecuredAmount schema_xsd.tmp#FileClaimRequestType_amountToCureDefault schema_xsd.tmp#FileClaimRequestType_interestRate schema_xsd.tmp#FileClaimRequestType_interestRateType schema_xsd.tmp#FileClaimRequestType_lease schema_xsd.tmp#FileClaimRequestType_amountToCureLeaseDefault schema_xsd.tmp#FileClaimRequestType_rightOfSetoff schema_xsd.tmp#FileClaimRequestType_domesticSupportObligationsAmount schema_xsd.tmp#FileClaimRequestType_depositsAmount schema_xsd.tmp#FileClaimRequestType_wagesSalariesCommissionAmount schema_xsd.tmp#FileClaimRequestType_taxesOrPenaltiesAmount schema_xsd.tmp#FileClaimRequestType_contributionsAmount schema_xsd.tmp#FileClaimRequestType_otherPriorityAmount schema_xsd.tmp#FileClaimRequestType_otherPrioritySubsection schema_xsd.tmp#FileClaimRequestType_attachments schema_xsd.tmp#FileClaimRequestType_signatureType schema_xsd.tmp#FileClaimRequestType_signatureAddress schema_xsd.tmp#FileClaimRequestType_mainDocument schema_xsd.tmp#FileClaimRequestType_ecfAccount schema_xsd.tmp#FileClaimRequestType
Type bkw:FileClaimRequestType
Properties
content complex
Model
Children bkw:accountNumber, bkw:amountToCureDefault, bkw:amountToCureLeaseDefault, bkw:attachments, bkw:authtoken, bkw:basisForPerfection, bkw:basisOfClaim, bkw:claimAmount, bkw:claimDate, bkw:claimNumber, bkw:contributionsAmount, bkw:creditorAddress, bkw:creditorNumber, bkw:depositsAmount, bkw:district, bkw:domesticSupportObligationsAmount, bkw:ecfAccount, bkw:extendedCaseNumber, bkw:includesInterest, bkw:interestRate, bkw:interestRateType, bkw:lease, bkw:mainDocument, bkw:otherNames, bkw:otherPriorityAmount, bkw:otherPrioritySubsection, bkw:password, bkw:paymentAddress, bkw:previousCreditor, bkw:previousFiler, bkw:propertyValue, bkw:rightOfSetoff, bkw:securedAmount, bkw:securedByDescription, bkw:securedByMotorVehicle, bkw:securedByOther, bkw:securedByRealEstate, bkw:signatureAddress, bkw:signatureType, bkw:taxesOrPenaltiesAmount, bkw:uci, bkw:unsecuredAmount, bkw:username, bkw:wagesSalariesCommissionAmount
Instance
 
<bkw:FileClaimRequest xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:username>{0,1}</bkw:username>
  <bkw:password>{0,1}</bkw:password>
  <bkw:authtoken>{0,1}</bkw:authtoken>
  <bkw:district>{1,1}</bkw:district>
  <bkw:extendedCaseNumber>{1,1}</bkw:extendedCaseNumber>
  <bkw:creditorNumber>{0,1}</bkw:creditorNumber>
  <bkw:creditorAddress>{0,1}</bkw:creditorAddress>
  <bkw:paymentAddress>{0,1}</bkw:paymentAddress>
  <bkw:otherNames>{0,1}</bkw:otherNames>
  <bkw:previousCreditor>{0,1}</bkw:previousCreditor>
  <bkw:uci>{0,1}</bkw:uci>
  <bkw:claimNumber>{0,1}</bkw:claimNumber>
  <bkw:claimDate>{0,1}</bkw:claimDate>
  <bkw:previousFiler>{0,1}</bkw:previousFiler>
  <bkw:accountNumber>{0,1}</bkw:accountNumber>
  <bkw:claimAmount>{1,1}</bkw:claimAmount>
  <bkw:includesInterest>{0,1}</bkw:includesInterest>
  <bkw:basisOfClaim>{0,1}</bkw:basisOfClaim>
  <bkw:securedByRealEstate>{0,1}</bkw:securedByRealEstate>
  <bkw:securedByMotorVehicle>{0,1}</bkw:securedByMotorVehicle>
  <bkw:securedByOther>{0,1}</bkw:securedByOther>
  <bkw:securedByDescription>{0,1}</bkw:securedByDescription>
  <bkw:basisForPerfection>{0,1}</bkw:basisForPerfection>
  <bkw:propertyValue>{0,1}</bkw:propertyValue>
  <bkw:securedAmount>{0,1}</bkw:securedAmount>
  <bkw:unsecuredAmount>{0,1}</bkw:unsecuredAmount>
  <bkw:amountToCureDefault>{0,1}</bkw:amountToCureDefault>
  <bkw:interestRate>{0,1}</bkw:interestRate>
  <bkw:interestRateType>{0,1}</bkw:interestRateType>
  <bkw:lease>{0,1}</bkw:lease>
  <bkw:amountToCureLeaseDefault>{0,1}</bkw:amountToCureLeaseDefault>
  <bkw:rightOfSetoff>{0,1}</bkw:rightOfSetoff>
  <bkw:domesticSupportObligationsAmount>{0,1}</bkw:domesticSupportObligationsAmount>
  <bkw:depositsAmount>{0,1}</bkw:depositsAmount>
  <bkw:wagesSalariesCommissionAmount>{0,1}</bkw:wagesSalariesCommissionAmount>
  <bkw:taxesOrPenaltiesAmount>{0,1}</bkw:taxesOrPenaltiesAmount>
  <bkw:contributionsAmount>{0,1}</bkw:contributionsAmount>
  <bkw:otherPriorityAmount>{0,1}</bkw:otherPriorityAmount>
  <bkw:otherPrioritySubsection>{0,1}</bkw:otherPrioritySubsection>
  <bkw:attachments>{0,1}</bkw:attachments>
  <bkw:signatureType>{0,1}</bkw:signatureType>
  <bkw:signatureAddress>{0,1}</bkw:signatureAddress>
  <bkw:mainDocument>{0,1}</bkw:mainDocument>
  <bkw:ecfAccount>{0,1}</bkw:ecfAccount>
</bkw:FileClaimRequest>
Source
 
<element name="FileClaimRequest" type="bkw:FileClaimRequestType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Element bkw:FileClaimResponse
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#FileClaimResponseType_documents schema_xsd.tmp#FileClaimResponseType_status schema_xsd.tmp#FileClaimResponseType_message schema_xsd.tmp#FileClaimResponseType
Type bkw:FileClaimResponseType
Properties
content complex
Model
Children bkw:documents, bkw:message, bkw:status
Instance
 
<bkw:FileClaimResponse xmlns:bkw="http://www.bkwservice.com/api/2020-07-01">
  <bkw:documents>{0,1}</bkw:documents>
  <bkw:status>{1,1}</bkw:status>
  <bkw:message>{1,1}</bkw:message>
</bkw:FileClaimResponse>
Source
 
<element name="FileClaimResponse" type="bkw:FileClaimResponseType"/>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:address
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The name and address of a party or attorney
Diagram
Diagram schema_xsd.tmp#address_prefix schema_xsd.tmp#address_firstName schema_xsd.tmp#address_middleName schema_xsd.tmp#address_lastName schema_xsd.tmp#address_generation schema_xsd.tmp#address_title schema_xsd.tmp#address_organization schema_xsd.tmp#address_attention schema_xsd.tmp#address_careOf schema_xsd.tmp#address_street1 schema_xsd.tmp#address_street2 schema_xsd.tmp#address_street3 schema_xsd.tmp#address_city schema_xsd.tmp#address_county schema_xsd.tmp#address_state schema_xsd.tmp#address_zip schema_xsd.tmp#address_zip4 schema_xsd.tmp#address_country schema_xsd.tmp#address_phone1 schema_xsd.tmp#address_phone2 schema_xsd.tmp#address_phone3 schema_xsd.tmp#address_fax schema_xsd.tmp#address_email schema_xsd.tmp#address_latitude schema_xsd.tmp#address_longitude schema_xsd.tmp#address_ssn schema_xsd.tmp#address_eins schema_xsd.tmp#address_url
Used by
Model
Children bkw:attention, bkw:careOf, bkw:city, bkw:country, bkw:county, bkw:eins, bkw:email, bkw:fax, bkw:firstName, bkw:generation, bkw:lastName, bkw:latitude, bkw:longitude, bkw:middleName, bkw:organization, bkw:phone1, bkw:phone2, bkw:phone3, bkw:prefix, bkw:ssn, bkw:state, bkw:street1, bkw:street2, bkw:street3, bkw:title, bkw:url, bkw:zip, bkw:zip4
Source
 
<complexType name="address">
  <annotation>
    <documentation>The name and address of a party or attorney</documentation>
  </annotation>
  <sequence>
    <element name="prefix" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Text that appears before a name, e.g., Dr. or Ms.</documentation>
      </annotation>
    </element>
    <element name="firstName" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A first name or initial</documentation>
      </annotation>
    </element>
    <element name="middleName" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A middle name or initial; if there is more than one given name or initial, the first is stored in the element firstName and the remaining are stored in the element middleName</documentation>
      </annotation>
    </element>
    <element name="lastName" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A surname</documentation>
      </annotation>
    </element>
    <element name="generation" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Part of a name indicating a position in a family inheritance relationship, e.g., "Sr", "Jr", "II"</documentation>
      </annotation>
    </element>
    <element name="title" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A job title</documentation>
      </annotation>
    </element>
    <element name="organization" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A business, institution, or department name</documentation>
      </annotation>
    </element>
    <element name="attention" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The content of an "attn: xxx" address line, not including the "attn:" label</documentation>
      </annotation>
    </element>
    <element name="careOf" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The content of an "c/o xxx" address line, not including the "c/o" label</documentation>
      </annotation>
    </element>
    <element name="street1" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>First line of street address</documentation>
      </annotation>
    </element>
    <element name="street2" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Second line of street address</documentation>
      </annotation>
    </element>
    <element name="street3" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Third line of street address</documentation>
      </annotation>
    </element>
    <element name="city" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A city name</documentation>
      </annotation>
    </element>
    <element name="county" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A county name</documentation>
      </annotation>
    </element>
    <element name="state" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A two-letter US state abbreviation</documentation>
      </annotation>
    </element>
    <element name="zip" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A postal code or 5-digit US ZIP code</documentation>
      </annotation>
    </element>
    <element name="zip4" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The four digits of the US "ZIP + 4" code</documentation>
      </annotation>
    </element>
    <element name="country" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The country</documentation>
      </annotation>
    </element>
    <element name="phone1" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>First phone number</documentation>
      </annotation>
    </element>
    <element name="phone2" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Second phone number</documentation>
      </annotation>
    </element>
    <element name="phone3" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Third phone number</documentation>
      </annotation>
    </element>
    <element name="fax" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Fax number</documentation>
      </annotation>
    </element>
    <element name="email" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Email address</documentation>
      </annotation>
    </element>
    <element name="latitude" type="xsd:decimal" minOccurs="0">
      <annotation>
        <documentation>The latitude, in degrees</documentation>
      </annotation>
    </element>
    <element name="longitude" type="xsd:decimal" minOccurs="0">
      <annotation>
        <documentation>The longitude, in degrees</documentation>
      </annotation>
    </element>
    <element name="ssn" type="bkw:obfuscatedSsn" minOccurs="0">
      <annotation>
        <documentation>Social Security number</documentation>
      </annotation>
    </element>
    <element name="eins" type="bkw:einList" minOccurs="0">
      <annotation>
        <documentation>List of Tax ID numbers</documentation>
      </annotation>
    </element>
    <element name="url" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Tax ID number</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:requiredText
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A short, non-empty string containing arbitrary character data
Diagram
Diagram
Type restriction of string
Facets
minLength 1
Used by
Elements bkw:AddCreditorRequestType/bkw:address, bkw:AddCreditorRequestType/bkw:authtoken, bkw:AddCreditorRequestType/bkw:password, bkw:AddCreditorRequestType/bkw:username, bkw:AddDeliveryMethodRequestType/bkw:authtoken, bkw:AddDeliveryMethodRequestType/bkw:password, bkw:AddDeliveryMethodRequestType/bkw:username, bkw:AddPortfolioItemsRequestType/bkw:authtoken, bkw:AddPortfolioItemsRequestType/bkw:password, bkw:AddPortfolioItemsRequestType/bkw:username, bkw:CaseInfoRequestType/bkw:authtoken, bkw:CaseInfoRequestType/bkw:party, bkw:CaseInfoRequestType/bkw:password, bkw:CaseInfoRequestType/bkw:username, bkw:CaseSummaryRequestType/bkw:authtoken, bkw:CaseSummaryRequestType/bkw:password, bkw:CaseSummaryRequestType/bkw:username, bkw:CreateAuthTokenRequestType/bkw:authtoken, bkw:CreateAuthTokenRequestType/bkw:label, bkw:CreateAuthTokenRequestType/bkw:password, bkw:CreateAuthTokenRequestType/bkw:username, bkw:CreateAuthTokenResponseType/bkw:token, bkw:CreateDocumentRequestType/bkw:authtoken, bkw:CreateDocumentRequestType/bkw:charset, bkw:CreateDocumentRequestType/bkw:contentType, bkw:CreateDocumentRequestType/bkw:data, bkw:CreateDocumentRequestType/bkw:description, bkw:CreateDocumentRequestType/bkw:language, bkw:CreateDocumentRequestType/bkw:password, bkw:CreateDocumentRequestType/bkw:title, bkw:CreateDocumentRequestType/bkw:username, bkw:CreatePacerAccountRequestType/bkw:accountPassword, bkw:CreatePacerAccountRequestType/bkw:accountUsername, bkw:CreatePacerAccountRequestType/bkw:authtoken, bkw:CreatePacerAccountRequestType/bkw:description, bkw:CreatePacerAccountRequestType/bkw:password, bkw:CreatePacerAccountRequestType/bkw:username, bkw:CreateSubscriptionRequestType/bkw:authtoken, bkw:CreateSubscriptionRequestType/bkw:password, bkw:CreateSubscriptionRequestType/bkw:username, bkw:DeletePacerAccountRequestType/bkw:authtoken, bkw:DeletePacerAccountRequestType/bkw:password, bkw:DeletePacerAccountRequestType/bkw:username, bkw:DeleteSubscriptionRequestType/bkw:authtoken, bkw:DeleteSubscriptionRequestType/bkw:password, bkw:DeleteSubscriptionRequestType/bkw:username, bkw:FileClaimRequestType/bkw:authtoken, bkw:FileClaimRequestType/bkw:basisForPerfection, bkw:FileClaimRequestType/bkw:otherNames, bkw:FileClaimRequestType/bkw:password, bkw:FileClaimRequestType/bkw:previousCreditor, bkw:FileClaimRequestType/bkw:previousFiler, bkw:FileClaimRequestType/bkw:rightOfSetoff, bkw:FileClaimRequestType/bkw:securedByDescription, bkw:FileClaimRequestType/bkw:uci, bkw:FileClaimRequestType/bkw:username, bkw:GenerateUrlRequestType/bkw:authtoken, bkw:GenerateUrlRequestType/bkw:documentId, bkw:GenerateUrlRequestType/bkw:password, bkw:GenerateUrlRequestType/bkw:username, bkw:ListDistrictsRequestType/bkw:authtoken, bkw:ListDistrictsRequestType/bkw:password, bkw:ListDistrictsRequestType/bkw:username, bkw:ListDistrictsResponseType/bkw:results/bkw:items/bkw:district/bkw:name, bkw:ListDivisionsRequestType/bkw:authtoken, bkw:ListDivisionsRequestType/bkw:password, bkw:ListDivisionsRequestType/bkw:username, bkw:ListDivisionsResponseType/bkw:results/bkw:items/bkw:division/bkw:name, bkw:ListNotificationsRequestType/bkw:authtoken, bkw:ListNotificationsRequestType/bkw:password, bkw:ListNotificationsRequestType/bkw:username, bkw:ListPacerAccountsRequestType/bkw:authtoken, bkw:ListPacerAccountsRequestType/bkw:password, bkw:ListPacerAccountsRequestType/bkw:username, bkw:ListPacerReportsRequestType/bkw:authtoken, bkw:ListPacerReportsRequestType/bkw:password, bkw:ListPacerReportsRequestType/bkw:username, bkw:ListPacerTransactionsRequestType/bkw:authtoken, bkw:ListPacerTransactionsRequestType/bkw:password, bkw:ListPacerTransactionsRequestType/bkw:username, bkw:ListPortfolioItemsRequestType/bkw:authtoken, bkw:ListPortfolioItemsRequestType/bkw:password, bkw:ListPortfolioItemsRequestType/bkw:subscriptionId, bkw:ListPortfolioItemsRequestType/bkw:username, bkw:ListSubscriptionsRequestType/bkw:authtoken, bkw:ListSubscriptionsRequestType/bkw:password, bkw:ListSubscriptionsRequestType/bkw:username, bkw:ListTrusteeCheckPaymentsRequestType/bkw:authtoken, bkw:ListTrusteeCheckPaymentsRequestType/bkw:password, bkw:ListTrusteeCheckPaymentsRequestType/bkw:serviceId, bkw:ListTrusteeCheckPaymentsRequestType/bkw:username, bkw:ListTrusteesRequestType/bkw:authtoken, bkw:ListTrusteesRequestType/bkw:password, bkw:ListTrusteesRequestType/bkw:username, bkw:ParseDocumentsRequestType/bkw:authtoken, bkw:ParseDocumentsRequestType/bkw:password, bkw:ParseDocumentsRequestType/bkw:username, bkw:RemoveDeliveryMethodRequestType/bkw:authtoken, bkw:RemoveDeliveryMethodRequestType/bkw:password, bkw:RemoveDeliveryMethodRequestType/bkw:username, bkw:RemovePortfolioItemsRequestType/bkw:authtoken, bkw:RemovePortfolioItemsRequestType/bkw:password, bkw:RemovePortfolioItemsRequestType/bkw:username, bkw:RevokeAuthTokenRequestType/bkw:authtoken, bkw:RevokeAuthTokenRequestType/bkw:password, bkw:RevokeAuthTokenRequestType/bkw:token, bkw:RevokeAuthTokenRequestType/bkw:username, bkw:RunCaseLocatorRequestType/bkw:authtoken, bkw:RunCaseLocatorRequestType/bkw:party, bkw:RunCaseLocatorRequestType/bkw:password, bkw:RunCaseLocatorRequestType/bkw:ssn, bkw:RunCaseLocatorRequestType/bkw:username, bkw:RunCaseNumbersRequestType/bkw:authtoken, bkw:RunCaseNumbersRequestType/bkw:caseNumber, bkw:RunCaseNumbersRequestType/bkw:password, bkw:RunCaseNumbersRequestType/bkw:username, bkw:RunCasesRequestType/bkw:authtoken, bkw:RunCasesRequestType/bkw:caseTypes, bkw:RunCasesRequestType/bkw:chapters, bkw:RunCasesRequestType/bkw:division, bkw:RunCasesRequestType/bkw:password, bkw:RunCasesRequestType/bkw:username, bkw:RunClaimsRegisterRequestType/bkw:authtoken, bkw:RunClaimsRegisterRequestType/bkw:password, bkw:RunClaimsRegisterRequestType/bkw:username, bkw:RunCreditorListRequestType/bkw:authtoken, bkw:RunCreditorListRequestType/bkw:password, bkw:RunCreditorListRequestType/bkw:username, bkw:RunDocketRequestType/bkw:authtoken, bkw:RunDocketRequestType/bkw:password, bkw:RunDocketRequestType/bkw:username, bkw:RunEcfCreditorListRequestType/bkw:authtoken, bkw:RunEcfCreditorListRequestType/bkw:password, bkw:RunEcfCreditorListRequestType/bkw:username, bkw:SetDefaultPacerAccountRequestType/bkw:authtoken, bkw:SetDefaultPacerAccountRequestType/bkw:password, bkw:SetDefaultPacerAccountRequestType/bkw:username, bkw:UpdatePacerAccountRequestType/bkw:accountPassword, bkw:UpdatePacerAccountRequestType/bkw:authtoken, bkw:UpdatePacerAccountRequestType/bkw:description, bkw:UpdatePacerAccountRequestType/bkw:password, bkw:UpdatePacerAccountRequestType/bkw:username, bkw:ViewCaseRequestType/bkw:authtoken, bkw:ViewCaseRequestType/bkw:password, bkw:ViewCaseRequestType/bkw:username, bkw:ViewClaimRequestType/bkw:authtoken, bkw:ViewClaimRequestType/bkw:password, bkw:ViewClaimRequestType/bkw:username, bkw:ViewCreditorRequestType/bkw:authtoken, bkw:ViewCreditorRequestType/bkw:password, bkw:ViewCreditorRequestType/bkw:username, bkw:ViewFilingRequestType/bkw:authtoken, bkw:ViewFilingRequestType/bkw:password, bkw:ViewFilingRequestType/bkw:username, bkw:ViewPacerReportRequestType/bkw:authtoken, bkw:ViewPacerReportRequestType/bkw:password, bkw:ViewPacerReportRequestType/bkw:username, bkw:ViewPacerTransactionRequestType/bkw:authtoken, bkw:ViewPacerTransactionRequestType/bkw:password, bkw:ViewPacerTransactionRequestType/bkw:username, bkw:ViewPartyRequestType/bkw:authtoken, bkw:ViewPartyRequestType/bkw:password, bkw:ViewPartyRequestType/bkw:username, bkw:address/bkw:attention, bkw:address/bkw:careOf, bkw:address/bkw:city, bkw:address/bkw:country, bkw:address/bkw:county, bkw:address/bkw:email, bkw:address/bkw:fax, bkw:address/bkw:firstName, bkw:address/bkw:generation, bkw:address/bkw:lastName, bkw:address/bkw:middleName, bkw:address/bkw:organization, bkw:address/bkw:phone1, bkw:address/bkw:phone2, bkw:address/bkw:phone3, bkw:address/bkw:prefix, bkw:address/bkw:state, bkw:address/bkw:street1, bkw:address/bkw:street2, bkw:address/bkw:street3, bkw:address/bkw:title, bkw:address/bkw:url, bkw:address/bkw:zip, bkw:address/bkw:zip4, bkw:case/bkw:county, bkw:case/bkw:division, bkw:case/bkw:title, bkw:claim/bkw:statusText, bkw:creditor/bkw:name, bkw:metadataProperty/bkw:name, bkw:pacerAccount/bkw:description, bkw:pacerAccount/bkw:password, bkw:pacerAccount/bkw:username
Source
 
<simpleType name="requiredText">
  <annotation>
    <documentation>A short, non-empty string containing arbitrary character data</documentation>
  </annotation>
  <restriction base="xsd:string">
    <minLength value="1"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:obfuscatedSsn
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A Social Security number, possibly with the first 5 digits replaced
with 'x'
Diagram
Diagram
Type restriction of string
Facets
pattern (\d{3}-\d{2}-\d{4})|(xxx-xx-\d{4})
Used by
Source
 
<simpleType name="obfuscatedSsn">
  <annotation>
    <documentation>A Social Security number, possibly with the first 5 digits replaced with 'x'</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="\d{3}-\d{2}-\d{4}"/>
    <pattern value="xxx-xx-\d{4}"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:einList
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of Tax ID numbers
Diagram
Diagram
Type restriction of string
Facets
pattern \d{2}-\d{7}(,\d{2}-\d{7})*
Used by
Source
 
<simpleType name="einList">
  <annotation>
    <documentation>A comma-separated list of Tax ID numbers</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="\d{2}-\d{7}(,\d{2}-\d{7})*"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:dollarValue
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A value in US dollars
Diagram
Diagram
Type restriction of string
Facets
pattern -?(0|[1-9][0-9]*)\.\d{2}
Used by
Elements bkw:FileClaimRequestType/bkw:amountToCureDefault, bkw:FileClaimRequestType/bkw:amountToCureLeaseDefault, bkw:FileClaimRequestType/bkw:claimAmount, bkw:FileClaimRequestType/bkw:contributionsAmount, bkw:FileClaimRequestType/bkw:depositsAmount, bkw:FileClaimRequestType/bkw:domesticSupportObligationsAmount, bkw:FileClaimRequestType/bkw:propertyValue, bkw:FileClaimRequestType/bkw:securedAmount, bkw:FileClaimRequestType/bkw:taxesOrPenaltiesAmount, bkw:FileClaimRequestType/bkw:unsecuredAmount, bkw:FileClaimRequestType/bkw:wagesSalariesCommissionAmount, bkw:claim/bkw:administrativeAllowed, bkw:claim/bkw:administrativeClaimed, bkw:claim/bkw:priorityAllowed, bkw:claim/bkw:priorityClaimed, bkw:claim/bkw:securedAllowed, bkw:claim/bkw:securedClaimed, bkw:claim/bkw:totalAllowed, bkw:claim/bkw:totalClaimed, bkw:claim/bkw:unknownAllowed, bkw:claim/bkw:unknownClaimed, bkw:claim/bkw:unsecuredAllowed, bkw:claim/bkw:unsecuredClaimed, bkw:pacerTransaction/bkw:cost, bkw:trusteeCheck/bkw:amount, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:amount, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:claim/bkw:amount, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:claim/bkw:interestDue, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:claim/bkw:interestPaid, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:claim/bkw:monthlyPayment, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:claim/bkw:principleDue, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:claim/bkw:principleOwed, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:claim/bkw:principlePaid, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:claim/bkw:scheduledAmount, bkw:trusteeCheck/bkw:payments/bkw:payment/bkw:interest
Source
 
<simpleType name="dollarValue">
  <annotation>
    <documentation>A value in US dollars</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="-?(0|[1-9][0-9]*)\.\d{2}"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:emailAddress
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
An email address
Diagram
Diagram
Type restriction of string
Facets
pattern [\-a-zA-Z0-9.]+@[\-a-zA-Z0-9.]+
Source
 
<simpleType name="emailAddress">
  <annotation>
    <documentation>An email address</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="[\-a-zA-Z0-9.]+@[\-a-zA-Z0-9.]+"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:hostname
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A domain name or an IP address in dotted quad notation
Diagram
Diagram
Type restriction of string
Facets
pattern ([\-a-zA-Z0-9]+(\.[\-a-zA-Z0-9]+)+)|([1-9][0-9]*(\.[1-9][0-9]*){3})
Source
 
<simpleType name="hostname">
  <annotation>
    <documentation>A domain name or an IP address in dotted quad notation</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="[\-a-zA-Z0-9]+(\.[\-a-zA-Z0-9]+)+"/>
    <pattern value="[1-9][0-9]*(\.[1-9][0-9]*){3}"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:ssn
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A Social Security number or Tax ID number.
Diagram
Diagram
Type restriction of string
Facets
pattern \d{3}-\d{2}-\d{4}|\d{2}-\d{7}
Used by
Source
 
<simpleType name="ssn">
  <annotation>
    <documentation>A Social Security number or Tax ID number.</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="\d{3}-\d{2}-\d{4}|\d{2}-\d{7}"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:ssn4
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The last four digits of a Social Security number or Tax ID number.
Diagram
Diagram
Type restriction of string
Facets
pattern \d{4}
Used by
Source
 
<simpleType name="ssn4">
  <annotation>
    <documentation>The last four digits of a Social Security number or Tax ID number.</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="\d{4}"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:text
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A short string containing arbitrary character data
Diagram
Diagram
Type restriction of string
Facets
maxLength 255
Used by
Elements bkw:metadataProperty/bkw:value, bkw:portfolioItem/bkw:id
Source
 
<simpleType name="text">
  <annotation>
    <documentation>A short string containing arbitrary character data</documentation>
  </annotation>
  <restriction base="xsd:string">
    <maxLength value="255"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:usState
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A USPS state abbreviation
Diagram
Diagram
Type restriction of string
Facets
pattern AL|AK|AS|AZ|AR|CA|CO|CT|DE|DC|FM|FL|GA|GU|HI|ID|IL|IN|IA|KS|KY|LA|ME|MH|MD|MA|MI|MN|MS|MO|MT|NE|NV|NH|NJ|NM|NY|NC|ND|MP|OH|OK|OR|PW|PA|PR|RI|SC|SD|TN|TX|UT|VT|VI|VA|WA|WV|WI|WY
Source
 
<simpleType name="usState">
  <annotation>
    <documentation>A USPS state abbreviation</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="AL|AK|AS|AZ|AR|CA|CO|CT|DE|DC|FM|FL|GA|GU|HI|ID|IL|IN|IA|KS|KY|LA|ME|MH|MD|MA|MI|MN|MS|MO|MT|NE|NV|NH|NJ|NM|NY|NC|ND|MP|OH|OK|OR|PW|PA|PR|RI|SC|SD|TN|TX|UT|VT|VI|VA|WA|WV|WI|WY"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:searchFilter
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A string used to filter a collection of search results, consisting
of a field name, operation, and value, separated by commas. The
following operations are supported:
  eq - equals
  ne - not equals
  gt - greater than
  ge - greater than or equal to
  lt - greater than
  le - greater than or equal to
  in - field occurs in a specified list of values; the value is
    specified in CSV format; for maximum portability, list items
    should contain only alphanumeric characters, hyphens, and dots
  notin - field does not occur in a specified list of values
  like - wildcard match, using the placeholders "*" and "?"
  notlike - no wildcard match
  match - regular expression match
  notmatch - no regular expression match
  exists - field has a value (is not null)
  notexists - field has no value (is null)
Diagram
Diagram
Type restriction of string
Facets
pattern [_a-zA-Z][_a-zA-Z0-9]*,(eq|ne|gt|ge|lt|le|lk|nl),.*
Used by
Source
 
<simpleType name="searchFilter">
  <annotation>
    <documentation>A string used to filter a collection of search results, consisting of a field name, operation, and value, separated by commas. The following operations are supported: eq - equals ne - not equals gt - greater than ge - greater than or equal to lt - greater than le - greater than or equal to in - field occurs in a specified list of values; the value is specified in CSV format; for maximum portability, list items should contain only alphanumeric characters, hyphens, and dots notin - field does not occur in a specified list of values like - wildcard match, using the placeholders "*" and "?" notlike - no wildcard match match - regular expression match notmatch - no regular expression match exists - field has a value (is not null) notexists - field has no value (is null)</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="[_a-zA-Z][_a-zA-Z0-9]*,(eq|ne|gt|ge|lt|le|lk|nl),.*"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:searchFilterList
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of search filters
Diagram
Diagram schema_xsd.tmp#searchFilterList_filter
Used by
Model
Children bkw:filter
Source
 
<complexType name="searchFilterList">
  <annotation>
    <documentation>A list of search filters</documentation>
  </annotation>
  <sequence>
    <element name="filter" type="bkw:searchFilter" maxOccurs="unbounded"/>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:sortCriteria
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A string used to sort a collection of search results, consisting
of a comma-separated list of items of the form field, +field, or
-field,
Diagram
Diagram
Type restriction of string
Facets
pattern [-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*
Used by
Source
 
<simpleType name="sortCriteria">
  <annotation>
    <documentation>A string used to sort a collection of search results, consisting of a comma-separated list of items of the form field, +field, or -field,</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="[-+]?[_a-zA-Z][_a-zA-Z0-9]*(,[-+]?[_a-zA-Z][_a-zA-Z0-9]*)*"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:outputFormatName
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The name of an output format, for inclusion in a value of type
"outputFormat"
Diagram
Diagram
Type restriction of string
Facets
pattern [\-._a-zA-Z0-9]+
Source
 
<simpleType name="outputFormatName">
  <annotation>
    <documentation>The name of an output format, for inclusion in a value of type "outputFormat"</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="[\-._a-zA-Z0-9]+"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:outputFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
An whitespace-separated list of output format names, used to
customize the output of ViewXXX and ListXXX operations
Diagram
Diagram schema_xsd.tmp#outputFormatName
Type list of bkw:outputFormatName
Used by
Source
 
<simpleType name="outputFormat">
  <annotation>
    <documentation>An whitespace-separated list of output format names, used to customize the output of ViewXXX and ListXXX operations</documentation>
  </annotation>
  <list itemType="bkw:outputFormatName"/>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:resourceId
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
An identifier for a BKWatch user, document, case,
or other resource managed by BKWatch
Diagram
Diagram
Type restriction of string
Facets
pattern [a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}
Used by
Elements bkw:AddCreditorRequestType/bkw:ecfAccount, bkw:AddDeliveryMethodRequestType/bkw:subscriptionId, bkw:AddPortfolioItemsRequestType/bkw:subscriptionId, bkw:CaseInfoRequestType/bkw:pacerAccount, bkw:CreateDocumentResponseType/bkw:documentId, bkw:CreatePacerAccountResponseType/bkw:accountId, bkw:CreateSubscriptionResponseType/bkw:subscriptionId, bkw:DeletePacerAccountRequestType/bkw:accountId, bkw:DeleteSubscriptionRequestType/bkw:subscriptionId, bkw:FileClaimRequestType/bkw:ecfAccount, bkw:FileClaimRequestType/bkw:mainDocument, bkw:GenerateUrlRequestType/bkw:lifetime, bkw:GenerateUrlRequestType/bkw:pacerAccount, bkw:ListNotificationsRequestType/bkw:deliveryMethodId, bkw:ListNotificationsRequestType/bkw:subscriptionId, bkw:ParseDocumentsRequestType/bkw:pacerAccount, bkw:RemoveDeliveryMethodRequestType/bkw:subscriptionId, bkw:RemovePortfolioItemsRequestType/bkw:subscriptionId, bkw:RunCaseLocatorRequestType/bkw:pacerAccount, bkw:RunCasesRequestType/bkw:pacerAccount, bkw:RunClaimsRegisterRequestType/bkw:pacerAccount, bkw:RunCreditorListRequestType/bkw:pacerAccount, bkw:RunDocketRequestType/bkw:pacerAccount, bkw:RunEcfCreditorListRequestType/bkw:ecfAccount, bkw:SetDefaultPacerAccountRequestType/bkw:accountId, bkw:UpdatePacerAccountRequestType/bkw:accountId, bkw:ViewCaseRequestType/bkw:caseId, bkw:ViewClaimRequestType/bkw:claimId, bkw:ViewCreditorRequestType/bkw:creditorId, bkw:ViewFilingRequestType/bkw:filingId, bkw:ViewPacerReportRequestType/bkw:reportId, bkw:ViewPacerTransactionRequestType/bkw:transactionId, bkw:ViewPartyRequestType/bkw:partyId, bkw:case/bkw:id, bkw:claim/bkw:id, bkw:creditor/bkw:id, bkw:deliveryMethod/bkw:id, bkw:document/bkw:id, bkw:filing/bkw:id, bkw:notification/bkw:id, bkw:notification/bkw:subscriptionId, bkw:pacerAccount/bkw:id, bkw:pacerReport/bkw:document, bkw:pacerReport/bkw:id, bkw:pacerTransaction/bkw:id, bkw:pacerTransaction/bkw:pacerAccount, bkw:pacerTransaction/bkw:user, bkw:party/bkw:id, bkw:subscription/bkw:id, bkw:trustee/bkw:chapter13Services/bkw:chapter13Service/bkw:id, bkw:trustee/bkw:id
Source
 
<simpleType name="resourceId">
  <annotation>
    <documentation>An identifier for a BKWatch user, document, case, or other resource managed by BKWatch</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="[a-z][\-a-z0-9]{1,24}-[0-9a-fA-F]{8}"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:statusCode
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Web service status code
Diagram
Diagram
Type restriction of string
Facets
enumeration 0 
Success
enumeration 1 
Wrong number of parameters
enumeration 2 
Missing parameter
enumeration 3 
Invalid parameter
enumeration 4 
Authentication failed
enumeration 5 
PACER unavailable
enumeration 6 
Data limit exceeded. Some extremely large documents cannot
be processed; rarely applies.
enumeration 7 
PACER authentication failed
enumeration 8 
Unsupported operation
enumeration 9 
Object exists
enumeration 10 
Object does not exist
enumeration 11 
PACER access denied
enumeration 12 
PACER image not available
enumeration 13 
Payment required
enumeration 15 
Access denied
enumeration -1 
Internal error
Used by
Elements bkw:AddCreditorResponseType/bkw:status, bkw:AddDeliveryMethodResponseType/bkw:status, bkw:AddPortfolioItemsResponseType/bkw:status, bkw:CaseInfoResponseType/bkw:status, bkw:CaseSummaryResponseType/bkw:status, bkw:CreateAuthTokenResponseType/bkw:status, bkw:CreateDocumentResponseType/bkw:status, bkw:CreatePacerAccountResponseType/bkw:status, bkw:CreateSubscriptionResponseType/bkw:status, bkw:DeletePacerAccountResponseType/bkw:status, bkw:DeleteSubscriptionResponseType/bkw:status, bkw:DocumentError/bkw:status, bkw:FileClaimResponseType/bkw:status, bkw:GenerateUrlResponseType/bkw:status, bkw:ListDistrictsResponseType/bkw:status, bkw:ListDivisionsResponseType/bkw:status, bkw:ListNotificationsResponseType/bkw:status, bkw:ListPacerAccountsResponseType/bkw:status, bkw:ListPacerReportsResponseType/bkw:status, bkw:ListPacerTransactionsResponseType/bkw:status, bkw:ListPortfolioItemsResponseType/bkw:status, bkw:ListSubscriptionsResponseType/bkw:status, bkw:ListTrusteeCheckPaymentsResponseType/bkw:status, bkw:ListTrusteesResponseType/bkw:status, bkw:ParseDocumentsResponseType/bkw:status, bkw:RemoveDeliveryMethodResponseType/bkw:status, bkw:RemovePortfolioItemsResponseType/bkw:status, bkw:RevokeAuthTokenResponseType/bkw:status, bkw:RunCaseLocatorResponseType/bkw:status, bkw:RunCaseNumbersResponseType/bkw:status, bkw:RunCasesResponseType/bkw:status, bkw:RunClaimsRegisterResponseType/bkw:status, bkw:RunCreditorListResponseType/bkw:status, bkw:RunDocketResponseType/bkw:status, bkw:RunEcfCreditorListResponseType/bkw:status, bkw:SetDefaultPacerAccountResponseType/bkw:status, bkw:UpdatePacerAccountResponseType/bkw:status, bkw:ViewCaseResponseType/bkw:status, bkw:ViewClaimResponseType/bkw:status, bkw:ViewCreditorResponseType/bkw:status, bkw:ViewFilingResponseType/bkw:status, bkw:ViewPacerReportResponseType/bkw:status, bkw:ViewPacerTransactionResponseType/bkw:status, bkw:ViewPartyResponseType/bkw:status
Source
 
<simpleType name="statusCode">
  <annotation>
    <documentation>Web service status code</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="0">
      <annotation>
        <documentation>Success</documentation>
      </annotation>
    </enumeration>
    <enumeration value="1">
      <annotation>
        <documentation>Wrong number of parameters</documentation>
      </annotation>
    </enumeration>
    <enumeration value="2">
      <annotation>
        <documentation>Missing parameter</documentation>
      </annotation>
    </enumeration>
    <enumeration value="3">
      <annotation>
        <documentation>Invalid parameter</documentation>
      </annotation>
    </enumeration>
    <enumeration value="4">
      <annotation>
        <documentation>Authentication failed</documentation>
      </annotation>
    </enumeration>
    <enumeration value="5">
      <annotation>
        <documentation>PACER unavailable</documentation>
      </annotation>
    </enumeration>
    <enumeration value="6">
      <annotation>
        <documentation>Data limit exceeded. Some extremely large documents cannot be processed; rarely applies.</documentation>
      </annotation>
    </enumeration>
    <enumeration value="7">
      <annotation>
        <documentation>PACER authentication failed</documentation>
      </annotation>
    </enumeration>
    <enumeration value="8">
      <annotation>
        <documentation>Unsupported operation</documentation>
      </annotation>
    </enumeration>
    <enumeration value="9">
      <annotation>
        <documentation>Object exists</documentation>
      </annotation>
    </enumeration>
    <enumeration value="10">
      <annotation>
        <documentation>Object does not exist</documentation>
      </annotation>
    </enumeration>
    <enumeration value="11">
      <annotation>
        <documentation>PACER access denied</documentation>
      </annotation>
    </enumeration>
    <enumeration value="12">
      <annotation>
        <documentation>PACER image not available</documentation>
      </annotation>
    </enumeration>
    <enumeration value="13">
      <annotation>
        <documentation>Payment required</documentation>
      </annotation>
    </enumeration>
    <enumeration value="15">
      <annotation>
        <documentation>Access denied</documentation>
      </annotation>
    </enumeration>
    <enumeration value="-1">
      <annotation>
        <documentation>Internal error</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:caseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case number assigned by the court, in either the
compact or the extended form
Diagram
Diagram
Type restriction of string
Facets
pattern \d{2}-\d{5}|\d:\d{2}-[a-zA-Z]{2}-\d+
Used by
Source
 
<simpleType name="caseNumber">
  <annotation>
    <documentation>The case number assigned by the court, in either the compact or the extended form</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="\d{2}-\d{5}|\d:\d{2}-[a-zA-Z]{2}-\d+"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:compactCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The 7-digit form of the bankruptcy case number assigned by the
court. Compact case numbers do not necessarily identify a unique
case within a district.
Diagram
Diagram
Type restriction of string
Facets
pattern \d{2}-\d{5}
Used by
Source
 
<simpleType name="compactCaseNumber">
  <annotation>
    <documentation>The 7-digit form of the bankruptcy case number assigned by the court. Compact case numbers do not necessarily identify a unique case within a district.</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="\d{2}-\d{5}"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:extendedCaseNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The case number assigned by the court, in the extended form
Diagram
Diagram
Type restriction of string
Facets
pattern \d:\d{2}-[a-zA-Z]{2}-\d+
Used by
Source
 
<simpleType name="extendedCaseNumber">
  <annotation>
    <documentation>The case number assigned by the court, in the extended form</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="\d:\d{2}-[a-zA-Z]{2}-\d+"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:chapter
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A bankruptcy chapter
Diagram
Diagram
Type restriction of int
Facets
enumeration 7
enumeration 9
enumeration 11
enumeration 12
enumeration 13
enumeration 15
enumeration 304
Used by
Source
 
<simpleType name="chapter">
  <annotation>
    <documentation>A bankruptcy chapter</documentation>
  </annotation>
  <restriction base="xsd:int">
    <enumeration value="7"/>
    <enumeration value="9"/>
    <enumeration value="11"/>
    <enumeration value="12"/>
    <enumeration value="13"/>
    <enumeration value="15"/>
    <enumeration value="304"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:chapterList
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A comma-separated list of bankruptcy chapters
Diagram
Diagram
Type restriction of string
Facets
pattern (7|9|11|12|13|15|304)(,(7|9|11|12|13|15|304))*
Used by
Source
 
<simpleType name="chapterList">
  <annotation>
    <documentation>A comma-separated list of bankruptcy chapters</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="(7|9|11|12|13|15|304)(,(7|9|11|12|13|15|304))*"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:case
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A case in a bankruptcy court
Diagram
Diagram schema_xsd.tmp#case_id schema_xsd.tmp#case_district schema_xsd.tmp#case_division schema_xsd.tmp#case_county schema_xsd.tmp#case_caseNumber schema_xsd.tmp#case_title schema_xsd.tmp#case_chapter schema_xsd.tmp#case_previousChapter schema_xsd.tmp#case_dateClosed schema_xsd.tmp#case_dateConverted schema_xsd.tmp#case_dateDischarged schema_xsd.tmp#case_dateDismissed schema_xsd.tmp#case_dateEntered schema_xsd.tmp#case_dateFiled schema_xsd.tmp#case_dateJointDebtorDischarged schema_xsd.tmp#case_dateJointDebtorDismissed schema_xsd.tmp#case_datePlanConfirmed schema_xsd.tmp#case_dateReopened schema_xsd.tmp#case_dateTerminated schema_xsd.tmp#case_dateTransferred schema_xsd.tmp#case_lastDateToFileClaims schema_xsd.tmp#case_lastDateToFileClaimsGovt schema_xsd.tmp#case_closed schema_xsd.tmp#case_disposition schema_xsd.tmp#case_jointDebtorDisposition schema_xsd.tmp#case_filingFeeStatus schema_xsd.tmp#case_assets schema_xsd.tmp#case_voluntary schema_xsd.tmp#case_debtorType schema_xsd.tmp#case_debtType schema_xsd.tmp#case_parties schema_xsd.tmp#case_claims schema_xsd.tmp#case_creditors schema_xsd.tmp#case_docketItems schema_xsd.tmp#case_data
Used by
Model
Children bkw:assets, bkw:caseNumber, bkw:chapter, bkw:claims, bkw:closed, bkw:county, bkw:creditors, bkw:data, bkw:dateClosed, bkw:dateConverted, bkw:dateDischarged, bkw:dateDismissed, bkw:dateEntered, bkw:dateFiled, bkw:dateJointDebtorDischarged, bkw:dateJointDebtorDismissed, bkw:datePlanConfirmed, bkw:dateReopened, bkw:dateTerminated, bkw:dateTransferred, bkw:debtType, bkw:debtorType, bkw:disposition, bkw:district, bkw:division, bkw:docketItems, bkw:filingFeeStatus, bkw:id, bkw:jointDebtorDisposition, bkw:lastDateToFileClaims, bkw:lastDateToFileClaimsGovt, bkw:parties, bkw:previousChapter, bkw:title, bkw:voluntary
Source
 
<complexType name="case">
  <annotation>
    <documentation>A case in a bankruptcy court</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The ID used to identify the case in calls to webservice operations</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district"/>
    <element name="division" type="bkw:requiredText">
      <annotation>
        <documentation>The division name, as it appears in the Cases Report search form</documentation>
      </annotation>
    </element>
    <element name="county" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The county</documentation>
      </annotation>
    </element>
    <element name="caseNumber" type="bkw:extendedCaseNumber"/>
    <element name="title" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The case title, e.g., "Ernest Singer and Darlene Singer"</documentation>
      </annotation>
    </element>
    <element name="chapter" type="bkw:chapter" minOccurs="0"/>
    <element name="previousChapter" type="bkw:chapter" minOccurs="0">
      <annotation>
        <documentation>The previous chapter, for bankruptcy cases that have been converted</documentation>
      </annotation>
    </element>
    <element name="dateClosed" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date the case was closed</documentation>
      </annotation>
    </element>
    <element name="dateConverted" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date of the last conversion</documentation>
      </annotation>
    </element>
    <element name="dateDischarged" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The discharge date</documentation>
      </annotation>
    </element>
    <element name="dateDismissed" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The dismissal date</documentation>
      </annotation>
    </element>
    <element name="dateEntered" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date the case was entered into CM/ECF</documentation>
      </annotation>
    </element>
    <element name="dateFiled" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The filing date</documentation>
      </annotation>
    </element>
    <element name="dateJointDebtorDischarged" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date joint debtor was discharged</documentation>
      </annotation>
    </element>
    <element name="dateJointDebtorDismissed" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date joint debtor was dismissed</documentation>
      </annotation>
    </element>
    <element name="datePlanConfirmed" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date the chapter 13 plan was confirmed</documentation>
      </annotation>
    </element>
    <element name="dateReopened" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date case was reopened</documentation>
      </annotation>
    </element>
    <element name="dateTerminated" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The termination date</documentation>
      </annotation>
    </element>
    <element name="dateTransferred" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date case was transferred</documentation>
      </annotation>
    </element>
    <element name="lastDateToFileClaims" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The last date to file claims</documentation>
      </annotation>
    </element>
    <element name="lastDateToFileClaimsGovt" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The last date for the government to file claims</documentation>
      </annotation>
    </element>
    <element name="closed" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>True if the case is closed; the availability of this information is independent of the availability of the "dateClosed" property</documentation>
      </annotation>
    </element>
    <element name="disposition" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The case disposition</documentation>
      </annotation>
    </element>
    <element name="jointDebtorDisposition" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The case disposition with respect to the joint debtor in a bankruptcy case</documentation>
      </annotation>
    </element>
    <element name="filingFeeStatus" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The filing fee status</documentation>
      </annotation>
    </element>
    <element name="assets" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether the case involves assets</documentation>
      </annotation>
    </element>
    <element name="voluntary" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether the bankruptcy is voluntary</documentation>
      </annotation>
    </element>
    <element name="debtorType" type="bkw:debtorType" minOccurs="0">
      <annotation>
        <documentation>Type debtor type</documentation>
      </annotation>
    </element>
    <element name="debtType" type="bkw:debtType" minOccurs="0">
      <annotation>
        <documentation>Type debt type</documentation>
      </annotation>
    </element>
    <element name="parties" minOccurs="0">
      <annotation>
        <documentation>The list of parties</documentation>
      </annotation>
      <complexType>
        <choice>
          <element name="party" type="bkw:party" maxOccurs="unbounded"/>
        </choice>
      </complexType>
    </element>
    <element name="claims" minOccurs="0">
      <annotation>
        <documentation>The list of claims</documentation>
      </annotation>
      <complexType>
        <choice>
          <element name="claim" type="bkw:claim" maxOccurs="unbounded"/>
        </choice>
      </complexType>
    </element>
    <element name="creditors" minOccurs="0">
      <annotation>
        <documentation>The list of creditors</documentation>
      </annotation>
      <complexType>
        <choice>
          <element name="creditor" type="bkw:creditor" maxOccurs="unbounded"/>
        </choice>
      </complexType>
    </element>
    <element name="docketItems" minOccurs="0">
      <annotation>
        <documentation>The list of docket items</documentation>
      </annotation>
      <complexType>
        <choice>
          <element name="docketItem" type="bkw:filing" maxOccurs="unbounded"/>
        </choice>
      </complexType>
    </element>
    <element name="data" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The data, in XML format, extracted from documents filed in the case</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:district
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A two- or three-letter US District Court abbreviation. The first
two letters specify the state; third letter, if present, specifies
a region
Diagram
Diagram
Type restriction of string
Facets
enumeration ALM
enumeration ALN
enumeration ALS
enumeration AK
enumeration AZ
enumeration ARE
enumeration ARW
enumeration CAC
enumeration CAE
enumeration CAN
enumeration CAS
enumeration CO
enumeration CT
enumeration DE
enumeration DC
enumeration FLM
enumeration FLN
enumeration FLS
enumeration GAM
enumeration GAN
enumeration GAS
enumeration GU
enumeration HI
enumeration ID
enumeration ILC
enumeration ILN
enumeration ILS
enumeration INN
enumeration INS
enumeration IAN
enumeration IAS
enumeration KS
enumeration KYE
enumeration KYW
enumeration LAE
enumeration LAM
enumeration LAW
enumeration ME
enumeration MD
enumeration MA
enumeration MIE
enumeration MIW
enumeration MN
enumeration MSN
enumeration MSS
enumeration MOE
enumeration MOW
enumeration MT
enumeration NE
enumeration NMI
enumeration NV
enumeration NH
enumeration NJ
enumeration NM
enumeration NYE
enumeration NYN
enumeration NYS
enumeration NYW
enumeration NCE
enumeration NCM
enumeration NCW
enumeration ND
enumeration OHN
enumeration OHS
enumeration OKE
enumeration OKN
enumeration OKW
enumeration OR
enumeration PAE
enumeration PAM
enumeration PAW
enumeration PR
enumeration RI
enumeration SC
enumeration SD
enumeration TNE
enumeration TNM
enumeration TNW
enumeration TXE
enumeration TXN
enumeration TXS
enumeration TXW
enumeration UT
enumeration VT
enumeration VI
enumeration VAE
enumeration VAW
enumeration WAE
enumeration WAW
enumeration WVN
enumeration WVS
enumeration WIE
enumeration WIW
enumeration WY
Used by
Source
 
<simpleType name="district">
  <annotation>
    <documentation>A two- or three-letter US District Court abbreviation. The first two letters specify the state; third letter, if present, specifies a region</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="ALM"/>
    <enumeration value="ALN"/>
    <enumeration value="ALS"/>
    <enumeration value="AK"/>
    <enumeration value="AZ"/>
    <enumeration value="ARE"/>
    <enumeration value="ARW"/>
    <enumeration value="CAC"/>
    <enumeration value="CAE"/>
    <enumeration value="CAN"/>
    <enumeration value="CAS"/>
    <enumeration value="CO"/>
    <enumeration value="CT"/>
    <enumeration value="DE"/>
    <enumeration value="DC"/>
    <enumeration value="FLM"/>
    <enumeration value="FLN"/>
    <enumeration value="FLS"/>
    <enumeration value="GAM"/>
    <enumeration value="GAN"/>
    <enumeration value="GAS"/>
    <enumeration value="GU"/>
    <enumeration value="HI"/>
    <enumeration value="ID"/>
    <enumeration value="ILC"/>
    <enumeration value="ILN"/>
    <enumeration value="ILS"/>
    <enumeration value="INN"/>
    <enumeration value="INS"/>
    <enumeration value="IAN"/>
    <enumeration value="IAS"/>
    <enumeration value="KS"/>
    <enumeration value="KYE"/>
    <enumeration value="KYW"/>
    <enumeration value="LAE"/>
    <enumeration value="LAM"/>
    <enumeration value="LAW"/>
    <enumeration value="ME"/>
    <enumeration value="MD"/>
    <enumeration value="MA"/>
    <enumeration value="MIE"/>
    <enumeration value="MIW"/>
    <enumeration value="MN"/>
    <enumeration value="MSN"/>
    <enumeration value="MSS"/>
    <enumeration value="MOE"/>
    <enumeration value="MOW"/>
    <enumeration value="MT"/>
    <enumeration value="NE"/>
    <enumeration value="NMI"/>
    <enumeration value="NV"/>
    <enumeration value="NH"/>
    <enumeration value="NJ"/>
    <enumeration value="NM"/>
    <enumeration value="NYE"/>
    <enumeration value="NYN"/>
    <enumeration value="NYS"/>
    <enumeration value="NYW"/>
    <enumeration value="NCE"/>
    <enumeration value="NCM"/>
    <enumeration value="NCW"/>
    <enumeration value="ND"/>
    <enumeration value="OHN"/>
    <enumeration value="OHS"/>
    <enumeration value="OKE"/>
    <enumeration value="OKN"/>
    <enumeration value="OKW"/>
    <enumeration value="OR"/>
    <enumeration value="PAE"/>
    <enumeration value="PAM"/>
    <enumeration value="PAW"/>
    <enumeration value="PR"/>
    <enumeration value="RI"/>
    <enumeration value="SC"/>
    <enumeration value="SD"/>
    <enumeration value="TNE"/>
    <enumeration value="TNM"/>
    <enumeration value="TNW"/>
    <enumeration value="TXE"/>
    <enumeration value="TXN"/>
    <enumeration value="TXS"/>
    <enumeration value="TXW"/>
    <enumeration value="UT"/>
    <enumeration value="VT"/>
    <enumeration value="VI"/>
    <enumeration value="VAE"/>
    <enumeration value="VAW"/>
    <enumeration value="WAE"/>
    <enumeration value="WAW"/>
    <enumeration value="WVN"/>
    <enumeration value="WVS"/>
    <enumeration value="WIE"/>
    <enumeration value="WIW"/>
    <enumeration value="WY"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:debtorType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The type of debtor in a bankruptcy case
Diagram
Diagram
Type restriction of string
Facets
enumeration INDIVIDUAL
enumeration PARTNERSHIP
enumeration CORPORATION
enumeration OTHER
Used by
Source
 
<simpleType name="debtorType">
  <annotation>
    <documentation>The type of debtor in a bankruptcy case</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="INDIVIDUAL"/>
    <enumeration value="PARTNERSHIP"/>
    <enumeration value="CORPORATION"/>
    <enumeration value="OTHER"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:debtType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The predominant type of debt in a bankruptcy case
Diagram
Diagram
Type restriction of string
Facets
enumeration CONSUMER
enumeration BUSINESS
enumeration OTHER
Used by
Source
 
<simpleType name="debtType">
  <annotation>
    <documentation>The predominant type of debt in a bankruptcy case</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="CONSUMER"/>
    <enumeration value="BUSINESS"/>
    <enumeration value="OTHER"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:party
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A party to a case
Diagram
Diagram schema_xsd.tmp#party_id schema_xsd.tmp#party_case schema_xsd.tmp#party_role schema_xsd.tmp#party_address schema_xsd.tmp#party_dateAdded schema_xsd.tmp#party_dateTerminated schema_xsd.tmp#party_attorneys
Used by
Model
Children bkw:address, bkw:attorneys, bkw:case, bkw:dateAdded, bkw:dateTerminated, bkw:id, bkw:role
Source
 
<complexType name="party">
  <annotation>
    <documentation>A party to a case</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The ID used to identify the party in calls to webservice operations</documentation>
      </annotation>
    </element>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>The case containing the party; used when the party appears as a standalone object rather than embedded in a case object</documentation>
      </annotation>
    </element>
    <element name="role" type="bkw:partyRole"/>
    <element name="address" type="bkw:address"/>
    <element name="dateAdded" type="xsd:date" minOccurs="0"/>
    <element name="dateTerminated" type="xsd:date" minOccurs="0"/>
    <element name="attorneys" minOccurs="0">
      <annotation>
        <documentation>The list of attorneys</documentation>
      </annotation>
      <complexType>
        <choice>
          <element name="attorney" type="bkw:party" maxOccurs="unbounded"/>
        </choice>
      </complexType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:claim
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A claim in a bankruptcy case
Diagram
Diagram schema_xsd.tmp#claim_id schema_xsd.tmp#claim_case schema_xsd.tmp#claim_claimNumber schema_xsd.tmp#claim_creditor schema_xsd.tmp#claim_dateFiled schema_xsd.tmp#claim_amendedDateFiled schema_xsd.tmp#claim_dateModified schema_xsd.tmp#claim_unsecuredClaimed schema_xsd.tmp#claim_securedClaimed schema_xsd.tmp#claim_priorityClaimed schema_xsd.tmp#claim_unknownClaimed schema_xsd.tmp#claim_administrativeClaimed schema_xsd.tmp#claim_totalClaimed schema_xsd.tmp#claim_unsecuredAllowed schema_xsd.tmp#claim_securedAllowed schema_xsd.tmp#claim_priorityAllowed schema_xsd.tmp#claim_unknownAllowed schema_xsd.tmp#claim_administrativeAllowed schema_xsd.tmp#claim_totalAllowed schema_xsd.tmp#claim_statusText schema_xsd.tmp#claim_filings
Used by
Model
Children bkw:administrativeAllowed, bkw:administrativeClaimed, bkw:amendedDateFiled, bkw:case, bkw:claimNumber, bkw:creditor, bkw:dateFiled, bkw:dateModified, bkw:filings, bkw:id, bkw:priorityAllowed, bkw:priorityClaimed, bkw:securedAllowed, bkw:securedClaimed, bkw:statusText, bkw:totalAllowed, bkw:totalClaimed, bkw:unknownAllowed, bkw:unknownClaimed, bkw:unsecuredAllowed, bkw:unsecuredClaimed
Source
 
<complexType name="claim">
  <annotation>
    <documentation>A claim in a bankruptcy case</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The ID used to identify the claim in calls to webservice operations</documentation>
      </annotation>
    </element>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>The case containing the claim; used when the claim appears as a standalone object rather than embedded in a case object</documentation>
      </annotation>
    </element>
    <element name="claimNumber" type="xsd:positiveInteger">
      <annotation>
        <documentation>The claim number; the claims for a given case are numbered 1, 2, 3, ....</documentation>
      </annotation>
    </element>
    <element name="creditor" type="bkw:creditor" minOccurs="0">
      <annotation>
        <documentation>The creditor</documentation>
      </annotation>
    </element>
    <element name="dateFiled" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>Date claim was filed</documentation>
      </annotation>
    </element>
    <element name="amendedDateFiled" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>Date claim was last ammended</documentation>
      </annotation>
    </element>
    <element name="dateModified" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>Date claim was last modified</documentation>
      </annotation>
    </element>
    <element name="unsecuredClaimed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Unsecured amount claimed</documentation>
      </annotation>
    </element>
    <element name="securedClaimed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Secured amount claimed</documentation>
      </annotation>
    </element>
    <element name="priorityClaimed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Priority amount claimed</documentation>
      </annotation>
    </element>
    <element name="unknownClaimed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Unknown amount claimed</documentation>
      </annotation>
    </element>
    <element name="administrativeClaimed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Administrative amount claimed</documentation>
      </annotation>
    </element>
    <element name="totalClaimed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Total amount claimed</documentation>
      </annotation>
    </element>
    <element name="unsecuredAllowed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Unsecured amount allowed</documentation>
      </annotation>
    </element>
    <element name="securedAllowed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Secured amount allowed</documentation>
      </annotation>
    </element>
    <element name="priorityAllowed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Priority amount allowed</documentation>
      </annotation>
    </element>
    <element name="unknownAllowed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Unknown amount allowed</documentation>
      </annotation>
    </element>
    <element name="administrativeAllowed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Administrative amount allowed</documentation>
      </annotation>
    </element>
    <element name="totalAllowed" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Total amount allowed</documentation>
      </annotation>
    </element>
    <element name="statusText" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Description of claim status</documentation>
      </annotation>
    </element>
    <element name="filings" minOccurs="0">
      <annotation>
        <documentation>List of proofs of claim and docket items relating to the claim</documentation>
      </annotation>
      <complexType>
        <sequence>
          <choice>
            <element name="filing" type="bkw:filing" maxOccurs="unbounded"/>
          </choice>
        </sequence>
      </complexType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:creditor
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A creditor in a bankruptcy case
Diagram
Diagram schema_xsd.tmp#creditor_id schema_xsd.tmp#creditor_case schema_xsd.tmp#creditor_name schema_xsd.tmp#creditor_creditorNumber schema_xsd.tmp#creditor_address
Used by
Model
Children bkw:address, bkw:case, bkw:creditorNumber, bkw:id, bkw:name
Source
 
<complexType name="creditor">
  <annotation>
    <documentation>A creditor in a bankruptcy case</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The ID used to identify the creditor in calls to webservice operations</documentation>
      </annotation>
    </element>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>The case containing the creditor; used when the creditor appears as a standalone object rather than embedded in a case object</documentation>
      </annotation>
    </element>
    <element name="name" type="bkw:requiredText">
      <annotation>
        <documentation>The creditor name</documentation>
      </annotation>
    </element>
    <element name="creditorNumber" type="bkw:creditorNumber" minOccurs="0">
      <annotation>
        <documentation>The creditor number</documentation>
      </annotation>
    </element>
    <element name="address" type="bkw:address"/>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:filing
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A filing in a case
Diagram
Diagram schema_xsd.tmp#filing_id schema_xsd.tmp#filing_case schema_xsd.tmp#filing_type schema_xsd.tmp#filing_dateFiled schema_xsd.tmp#filing_claimNumber schema_xsd.tmp#filing_itemNumber schema_xsd.tmp#filing_title schema_xsd.tmp#filing_text schema_xsd.tmp#filing_url schema_xsd.tmp#filing_documents
Used by
Model
Children bkw:case, bkw:claimNumber, bkw:dateFiled, bkw:documents, bkw:id, bkw:itemNumber, bkw:text, bkw:title, bkw:type, bkw:url
Source
 
<complexType name="filing">
  <annotation>
    <documentation>A filing in a case</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The ID used to identify the filing in calls to webservice operations</documentation>
      </annotation>
    </element>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>The case containing the filing; used when the filing appears as a standalone object rather than embedded in a case object</documentation>
      </annotation>
    </element>
    <element name="type" type="bkw:filingType" minOccurs="0">
      <annotation>
        <documentation>Indicates whether the filing is a docket item or proof of claim. The type must be present unless the filing appears in a case's list of docket items</documentation>
      </annotation>
    </element>
    <element name="dateFiled" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The filing date; may not be the same as the date the docket item was entered into Pacer</documentation>
      </annotation>
    </element>
    <element name="claimNumber" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The number of the claim with which the filing is associated.</documentation>
      </annotation>
    </element>
    <element name="itemNumber" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The offset of the filing within the list of docket items for a case or the list of proofs of claim for a specific claim. In some jurisdictions, docket items that do not represent documents are not assigned a sequence number.</documentation>
      </annotation>
    </element>
    <element name="title" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The docket item title</documentation>
      </annotation>
    </element>
    <element name="text" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The docket item text</documentation>
      </annotation>
    </element>
    <element name="url" type="xsd:anyURI" minOccurs="0">
      <annotation>
        <documentation>The court URL associated with the filing, if the filing has associated documents</documentation>
      </annotation>
    </element>
    <element name="documents" type="bkw:documentList" minOccurs="0">
      <annotation>
        <documentation>The list of documents associated with the docket item. Depending on the operation called, the document list may be absent even though there are documents associated with the filing. Use the operation ViewFiling to view the document list</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:filingType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Indicates whether a filing is a docket item or a proof of claim
Diagram
Diagram
Type restriction of string
Facets
enumeration DOCKET
enumeration PROOF
Used by
Source
 
<simpleType name="filingType">
  <annotation>
    <documentation>Indicates whether a filing is a docket item or a proof of claim</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="DOCKET"/>
    <enumeration value="PROOF"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:documentList
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of documents
Diagram
Diagram schema_xsd.tmp#documentList_document
Used by
Model
Children bkw:document
Source
 
<complexType name="documentList">
  <annotation>
    <documentation>A list of documents</documentation>
  </annotation>
  <sequence>
    <element name="document" type="bkw:document" minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:document
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A PACER document
Diagram
Diagram schema_xsd.tmp#document_id schema_xsd.tmp#document_title schema_xsd.tmp#document_description schema_xsd.tmp#document_created schema_xsd.tmp#document_contentType schema_xsd.tmp#document_charset schema_xsd.tmp#document_language schema_xsd.tmp#document_size schema_xsd.tmp#document_sha1 schema_xsd.tmp#document_metadata schema_xsd.tmp#document_url
Used by
Model
Children bkw:charset, bkw:contentType, bkw:created, bkw:description, bkw:id, bkw:language, bkw:metadata, bkw:sha1, bkw:size, bkw:title, bkw:url
Source
 
<complexType name="document">
  <annotation>
    <documentation>A PACER document</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The ID used to identify the document in calls to webservice operations</documentation>
      </annotation>
    </element>
    <element name="title" type="xsd:string">
      <annotation>
        <documentation>The document title</documentation>
      </annotation>
    </element>
    <element name="description" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The document description</documentation>
      </annotation>
    </element>
    <element name="created" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The document creation date</documentation>
      </annotation>
    </element>
    <element name="contentType" minOccurs="0">
      <annotation>
        <documentation>The MIME media type</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <maxLength value="50"/>
        </restriction>
      </simpleType>
    </element>
    <element name="charset" minOccurs="0">
      <annotation>
        <documentation>The character set</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <maxLength value="20"/>
        </restriction>
      </simpleType>
    </element>
    <element name="language" minOccurs="0">
      <annotation>
        <documentation>An IETF language tag</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <maxLength value="10"/>
        </restriction>
      </simpleType>
    </element>
    <element name="size" type="xsd:unsignedInt" minOccurs="0">
      <annotation>
        <documentation>The size, in byte</documentation>
      </annotation>
    </element>
    <element name="sha1" minOccurs="0">
      <annotation>
        <documentation>The SHA1 hash</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <maxLength value="40"/>
        </restriction>
      </simpleType>
    </element>
    <element name="metadata" minOccurs="0">
      <annotation>
        <documentation>Describes document metadata</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="property" type="bkw:metadataProperty" minOccurs="0" maxOccurs="unbounded"/>
        </sequence>
      </complexType>
    </element>
    <element name="url" type="xsd:anyURI" minOccurs="0">
      <annotation>
        <documentation>A URL for downloading the document, if available</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:metadataProperty
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Used to associate metadata with documents
Diagram
Diagram schema_xsd.tmp#metadataProperty_name schema_xsd.tmp#metadataProperty_value
Used by
Model
Children bkw:name, bkw:value
Source
 
<complexType name="metadataProperty">
  <annotation>
    <documentation>Used to associate metadata with documents</documentation>
  </annotation>
  <sequence>
    <element name="name" type="bkw:requiredText">
      <annotation>
        <documentation>The name of the metadata property, e.g., "us-patent-number"</documentation>
      </annotation>
    </element>
    <element name="value" type="bkw:text">
      <annotation>
        <documentation>The value of the metadata property, e.g., "D621409"</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:creditorNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A creditor number assigned by the court. Creditor numbers are not
shared between cases.
Diagram
Diagram
Type restriction of string
Facets
pattern [0-9]+
Used by
Source
 
<simpleType name="creditorNumber">
  <annotation>
    <documentation>A creditor number assigned by the court. Creditor numbers are not shared between cases.</documentation>
  </annotation>
  <restriction base="xsd:string">
    <pattern value="[0-9]+"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:partyRole
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The role a party plays in a case
Diagram
Diagram
Type restriction of string
Facets
enumeration ATTORNEY
enumeration BANKRUPTCY_ADMINISTRATOR
enumeration CLAIMS_AND_NOTICING_AGENT
enumeration CONSUMER_PRIVACY_OMBUDSMAN
enumeration COUNTER_CLAIMANT
enumeration COUNTER_DEFENDANT
enumeration COUNTER_PLAINTIFF
enumeration CREDITORS_ATTORNEY
enumeration CREDITOR_COMMITTEE
enumeration CREDITOR_COMMITTEE_CHAIR
enumeration CROSS_CLAIMANT
enumeration CROSS_DEFENDANT
enumeration DEBTOR
enumeration DEBTOR_DESIGNEE
enumeration DEBTOR_IN_POSSESSION
enumeration DEFENDANT
enumeration INTERESTED_PARTY
enumeration INTERIM_TRUSTEE
enumeration INTERVENOR
enumeration JNT_ADMIN_DEBTOR
enumeration JOINT_DEBTOR
enumeration JUDGE
enumeration MISCELLANEOUS_PROCEEDING_MOVANT_PLAINTIFF
enumeration NON_FILING_SPOUSE
enumeration PATIENT_CARE_OMBUDSMAN
enumeration PETITIONING_CREDITOR
enumeration PETITION_PREPARER
enumeration PLAINTIFF
enumeration SPECIAL_COUNSEL
enumeration THIRD_PARTY_DEFENDANT
enumeration THIRD_PARTY_PLAINTIFF
enumeration TRUSTEE
enumeration TRUSTEES_ATTORNEY
enumeration US_TRUSTEE
enumeration OTHER
Used by
Source
 
<simpleType name="partyRole">
  <annotation>
    <documentation>The role a party plays in a case</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="ATTORNEY"/>
    <enumeration value="BANKRUPTCY_ADMINISTRATOR"/>
    <enumeration value="CLAIMS_AND_NOTICING_AGENT"/>
    <enumeration value="CONSUMER_PRIVACY_OMBUDSMAN"/>
    <enumeration value="COUNTER_CLAIMANT"/>
    <enumeration value="COUNTER_DEFENDANT"/>
    <enumeration value="COUNTER_PLAINTIFF"/>
    <enumeration value="CREDITORS_ATTORNEY"/>
    <enumeration value="CREDITOR_COMMITTEE"/>
    <enumeration value="CREDITOR_COMMITTEE_CHAIR"/>
    <enumeration value="CROSS_CLAIMANT"/>
    <enumeration value="CROSS_DEFENDANT"/>
    <enumeration value="DEBTOR"/>
    <enumeration value="DEBTOR_DESIGNEE"/>
    <enumeration value="DEBTOR_IN_POSSESSION"/>
    <enumeration value="DEFENDANT"/>
    <enumeration value="INTERESTED_PARTY"/>
    <enumeration value="INTERIM_TRUSTEE"/>
    <enumeration value="INTERVENOR"/>
    <enumeration value="JNT_ADMIN_DEBTOR"/>
    <enumeration value="JOINT_DEBTOR"/>
    <enumeration value="JUDGE"/>
    <enumeration value="MISCELLANEOUS_PROCEEDING_MOVANT_PLAINTIFF"/>
    <enumeration value="NON_FILING_SPOUSE"/>
    <enumeration value="PATIENT_CARE_OMBUDSMAN"/>
    <enumeration value="PETITIONING_CREDITOR"/>
    <enumeration value="PETITION_PREPARER"/>
    <enumeration value="PLAINTIFF"/>
    <enumeration value="SPECIAL_COUNSEL"/>
    <enumeration value="THIRD_PARTY_DEFENDANT"/>
    <enumeration value="THIRD_PARTY_PLAINTIFF"/>
    <enumeration value="TRUSTEE"/>
    <enumeration value="TRUSTEES_ATTORNEY"/>
    <enumeration value="US_TRUSTEE"/>
    <enumeration value="OTHER"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:caseList
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of cases
Diagram
Diagram schema_xsd.tmp#caseList_case
Used by
Model
Children bkw:case
Source
 
<complexType name="caseList">
  <annotation>
    <documentation>A list of cases</documentation>
  </annotation>
  <sequence>
    <element name="case" type="bkw:case" minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:caseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The type of a case in a bankruptcy court
Diagram
Diagram
Type restriction of string
Facets
enumeration ap
enumeration bk
enumeration mp
Source
 
<simpleType name="caseType">
  <annotation>
    <documentation>The type of a case in a bankruptcy court</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="ap"/>
    <enumeration value="bk"/>
    <enumeration value="mp"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:pcl
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The value "PCL", representing the PACER Case Locator
Diagram
Diagram
Type restriction of string
Facets
enumeration PCL
Source
 
<simpleType name="pcl">
  <annotation>
    <documentation>The value "PCL", representing the PACER Case Locator</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="PCL"/>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:districtOrPcl
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A two- or three-letter US District Court abbreviation, or the value
"PCL", representing the PACER Case Locator
Diagram
Diagram schema_xsd.tmp#district schema_xsd.tmp#pcl
Type union of(bkw:district, bkw:pcl)
Source
 
<simpleType name="districtOrPcl">
  <annotation>
    <documentation>A two- or three-letter US District Court abbreviation, or the value "PCL", representing the PACER Case Locator</documentation>
  </annotation>
  <union memberTypes="bkw:district bkw:pcl"/>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:formNumber
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A bankruptcy form number
Diagram
Diagram
Type restriction of string
Facets
enumeration 1 
Voluntary Petition
enumeration 6 
Summary of Schedules
enumeration 6_STAT 
Statistical Summary
enumeration A 
Schedule A
enumeration B 
Schedule B
enumeration 106_A_B 
Schedule A/B
enumeration C 
Schedule C
enumeration D 
Schedule D
enumeration E 
Schedule E
enumeration F 
Schedule F
enumeration 106_E_F 
Schedule E/F
enumeration G 
Schedule G
enumeration H 
Schedule H
enumeration I 
Schedule I
enumeration J 
Schedule J
enumeration 8 
Statement of Intention
enumeration 10S2 
Notice of Postpetition Mortage Fees, Expenses, and Charges
enumeration 203 
Attorney Disclosure
enumeration MATRIX 
Creditor Matrix
Source
 
<simpleType name="formNumber">
  <annotation>
    <documentation>A bankruptcy form number</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="1">
      <annotation>
        <documentation>Voluntary Petition</documentation>
      </annotation>
    </enumeration>
    <enumeration value="6">
      <annotation>
        <documentation>Summary of Schedules</documentation>
      </annotation>
    </enumeration>
    <enumeration value="6_STAT">
      <annotation>
        <documentation>Statistical Summary</documentation>
      </annotation>
    </enumeration>
    <enumeration value="A">
      <annotation>
        <documentation>Schedule A</documentation>
      </annotation>
    </enumeration>
    <enumeration value="B">
      <annotation>
        <documentation>Schedule B</documentation>
      </annotation>
    </enumeration>
    <enumeration value="106_A_B">
      <annotation>
        <documentation>Schedule A/B</documentation>
      </annotation>
    </enumeration>
    <enumeration value="C">
      <annotation>
        <documentation>Schedule C</documentation>
      </annotation>
    </enumeration>
    <enumeration value="D">
      <annotation>
        <documentation>Schedule D</documentation>
      </annotation>
    </enumeration>
    <enumeration value="E">
      <annotation>
        <documentation>Schedule E</documentation>
      </annotation>
    </enumeration>
    <enumeration value="F">
      <annotation>
        <documentation>Schedule F</documentation>
      </annotation>
    </enumeration>
    <enumeration value="106_E_F">
      <annotation>
        <documentation>Schedule E/F</documentation>
      </annotation>
    </enumeration>
    <enumeration value="G">
      <annotation>
        <documentation>Schedule G</documentation>
      </annotation>
    </enumeration>
    <enumeration value="H">
      <annotation>
        <documentation>Schedule H</documentation>
      </annotation>
    </enumeration>
    <enumeration value="I">
      <annotation>
        <documentation>Schedule I</documentation>
      </annotation>
    </enumeration>
    <enumeration value="J">
      <annotation>
        <documentation>Schedule J</documentation>
      </annotation>
    </enumeration>
    <enumeration value="8">
      <annotation>
        <documentation>Statement of Intention</documentation>
      </annotation>
    </enumeration>
    <enumeration value="10S2">
      <annotation>
        <documentation>Notice of Postpetition Mortage Fees, Expenses, and Charges</documentation>
      </annotation>
    </enumeration>
    <enumeration value="203">
      <annotation>
        <documentation>Attorney Disclosure</documentation>
      </annotation>
    </enumeration>
    <enumeration value="MATRIX">
      <annotation>
        <documentation>Creditor Matrix</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:bkmlFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
The BKML format
Diagram
Diagram
Type restriction of string
Facets
enumeration STANDARD 
The standard document-oriented BKML format
enumeration ANALYTICS 
The alternate case-oriented BKML format
enumeration STANDARD_JSON 
The standard document-oriented BKML format rendered in JSON
instead of XML
Used by
Source
 
<simpleType name="bkmlFormat">
  <annotation>
    <documentation>The BKML format</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="STANDARD">
      <annotation>
        <documentation>The standard document-oriented BKML format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="ANALYTICS">
      <annotation>
        <documentation>The alternate case-oriented BKML format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="STANDARD_JSON">
      <annotation>
        <documentation>The standard document-oriented BKML format rendered in JSON instead of XML</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:pacerAccount
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Represents a PACER or current generation CM/ECF account
Diagram
Diagram schema_xsd.tmp#pacerAccount_id schema_xsd.tmp#pacerAccount_username schema_xsd.tmp#pacerAccount_password schema_xsd.tmp#pacerAccount_district schema_xsd.tmp#pacerAccount_description schema_xsd.tmp#pacerAccount_default
Used by
Model
Children bkw:default, bkw:description, bkw:district, bkw:id, bkw:password, bkw:username
Source
 
<complexType name="pacerAccount">
  <annotation>
    <documentation>Represents a PACER or current generation CM/ECF account</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The account ID, of the form pacer-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="username" type="bkw:requiredText">
      <annotation>
        <documentation>The username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district" minOccurs="0">
      <annotation>
        <documentation>The district, for current generation CM/ECF accounts</documentation>
      </annotation>
    </element>
    <element name="description" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Descriptive text associated with the account</documentation>
      </annotation>
    </element>
    <element name="default" type="xsd:boolean">
      <annotation>
        <documentation>true if the PACER account is the default account of the user who owns it</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:pacerTransaction
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Represents a PACER transaction receipt
Diagram
Diagram schema_xsd.tmp#pacerTransaction_id schema_xsd.tmp#pacerTransaction_pacerAccount schema_xsd.tmp#pacerTransaction_user schema_xsd.tmp#pacerTransaction_datetime schema_xsd.tmp#pacerTransaction_description schema_xsd.tmp#pacerTransaction_searchCriteria schema_xsd.tmp#pacerTransaction_billablePages schema_xsd.tmp#pacerTransaction_cost
Used by
Model
Children bkw:billablePages, bkw:cost, bkw:datetime, bkw:description, bkw:id, bkw:pacerAccount, bkw:searchCriteria, bkw:user
Source
 
<complexType name="pacerTransaction">
  <annotation>
    <documentation>Represents a PACER transaction receipt</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The transaction ID, of the form trans-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The ID of the PACER account associated with the transaction, as an identifier of the form pacer-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="user" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The ID of the BankruptcyWatch user responsible for the transaction, as an identifier of the form user-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="datetime" type="xsd:dateTime">
      <annotation>
        <documentation>The transaction timestamp</documentation>
      </annotation>
    </element>
    <element name="description" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A description of the transaction</documentation>
      </annotation>
    </element>
    <element name="searchCriteria" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The search parameters associated with the transaction</documentation>
      </annotation>
    </element>
    <element name="billablePages" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The number of PACER billable pages associated with the transaction</documentation>
      </annotation>
    </element>
    <element name="cost" type="bkw:dollarValue">
      <annotation>
        <documentation>The cost of the transaction</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:pacerReportType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Represents a category of raw search result or document downloaded
from PACER
Diagram
Diagram
Type restriction of string
Facets
enumeration CASE_LOCATOR 
Case Locator output, in XML format
enumeration CASE_NUMBERS 
Case Numbers output, in XML format
enumeration CASES 
Cases Report output, in pipe-separated values format
enumeration CLAIMS_REGISTER 
Claims Register output, in HTML format
enumeration CREDITOR_LIST 
Creditor List output, in CSV format
enumeration DOCKET 
Docket Report output, in HTML format
enumeration DOCUMENT 
Content of a document filed with the court, in PDF format
Used by
Source
 
<simpleType name="pacerReportType">
  <annotation>
    <documentation>Represents a category of raw search result or document downloaded from PACER</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="CASE_LOCATOR">
      <annotation>
        <documentation>Case Locator output, in XML format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_NUMBERS">
      <annotation>
        <documentation>Case Numbers output, in XML format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASES">
      <annotation>
        <documentation>Cases Report output, in pipe-separated values format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CLAIMS_REGISTER">
      <annotation>
        <documentation>Claims Register output, in HTML format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CREDITOR_LIST">
      <annotation>
        <documentation>Creditor List output, in CSV format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="DOCKET">
      <annotation>
        <documentation>Docket Report output, in HTML format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="DOCUMENT">
      <annotation>
        <documentation>Content of a document filed with the court, in PDF format</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:pacerReport
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Represents a raw search result or document downloaded from PACER
Diagram
Diagram schema_xsd.tmp#pacerReport_id schema_xsd.tmp#pacerReport_type schema_xsd.tmp#pacerReport_document schema_xsd.tmp#pacerReport_timestamp schema_xsd.tmp#pacerReport_transaction schema_xsd.tmp#pacerReport_cases
Used by
Model
Children bkw:cases, bkw:document, bkw:id, bkw:timestamp, bkw:transaction, bkw:type
Source
 
<complexType name="pacerReport">
  <annotation>
    <documentation>Represents a raw search result or document downloaded from PACER</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The report ID, of the form report-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="type" type="bkw:pacerReportType">
      <annotation>
        <documentation>The report type</documentation>
      </annotation>
    </element>
    <element name="document" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>A document ID of the form doc-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="timestamp" type="xsd:dateTime">
      <annotation>
        <documentation>The time the report was downloaded from PACER</documentation>
      </annotation>
    </element>
    <element name="transaction" type="bkw:pacerTransaction" minOccurs="0">
      <annotation>
        <documentation>The PACER transaction receipt</documentation>
      </annotation>
    </element>
    <element name="cases" type="bkw:caseList" minOccurs="0">
      <annotation>
        <documentation>The list of cases referenced in the document, ir any</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:subscriptionType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A category of subscrption
Diagram
Diagram
Type restriction of string
Facets
enumeration CONSUMER_PORTFOLIO 
Receive notifications when consumers in a specified collection
file for banrkuptcy
enumeration CASE_PORTFOLIO 
Receive notifications when events occur for cases in a specified
collection
enumeration CASE_LISTS 
Receive notifications when events occur for cases in a specified
geographic area
enumeration CM_ECF 
Receive notifications when emails arrive from the court
(a.k.a. Free Looks)
enumeration PACER_INFO 
Receive notifications of PACER announcements and service status
changes
Used by
Source
 
<simpleType name="subscriptionType">
  <annotation>
    <documentation>A category of subscrption</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="CONSUMER_PORTFOLIO">
      <annotation>
        <documentation>Receive notifications when consumers in a specified collection file for banrkuptcy</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_PORTFOLIO">
      <annotation>
        <documentation>Receive notifications when events occur for cases in a specified collection</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_LISTS">
      <annotation>
        <documentation>Receive notifications when events occur for cases in a specified geographic area</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CM_ECF">
      <annotation>
        <documentation>Receive notifications when emails arrive from the court (a.k.a. Free Looks)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="PACER_INFO">
      <annotation>
        <documentation>Receive notifications of PACER announcements and service status changes</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:eventType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A category of event triggering a notification
Diagram
Diagram
Type restriction of string
Facets
enumeration CASES_FILED 
A list of cases was filed (used by CASE_LISTS subscriptions)
enumeration CASES_DISCHARGED 
A list of cases was discharged (used by CASE_LISTS
subscriptions)
enumeration CASES_DISMISSED 
A list of cases was dismissed (used by CASE_LISTS subscriptions)
enumeration CASES_CLOSED 
A list of cases was closed (used by CASE_LISTS subscriptions)
enumeration CASES_CONVERTED 
A list of cases was conveted (used by CASE_LISTS subscriptions)
enumeration CASES_REOPENED 
A list of cases was reopened  (used by CASE_LISTS subscriptions)
enumeration CASES_TRANSFERRED 
A list of cases was transferred from one division to another
(used by CASE_LISTS subscriptions)
enumeration CASES_SPLIT 
A list of cases was split (used by CASE_LISTS subscriptions)
enumeration CASE_FILED 
A case was filed (used by CASE_PORTFOLIO AND CONSUMER_PORTFOLIO
subscriptions)
enumeration CASE_DISCHARGED 
A case was discharged (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_DISMISSED 
A case was dismissed (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_CLOSED 
A case was closed (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_CONVERTED 
A case was conveted (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_REOPENED 
A case was reopened (used by CASE_PORTFOLIO subscriptions)
subscriptions)
enumeration CASE_TRANSFERRED 
A case was transferred from one division to another (used by
CASE_PORTFOLIO subscriptions)
enumeration CASE_TERMINATED 
A case was terminated (used by CASE_PORTFOLIO subscriptions)
enumeration CASE_SPLIT 
A case was split (used by CASE_PORTFOLIO subscriptions)
enumeration JOINT_DEBTOR_DISCHARGED 
The joint debtor was discharged (used by CASE_PORTFOLIO
subscriptions)
enumeration JOINT_DEBTOR_DISMISSED 
The joint debtor was dismissed (used by CASE_PORTFOLIO
subscriptions)
enumeration PLAN_CONFIRMED 
A chapter 13 plan was confirmed (used by CASE_PORTFOLIO
subscriptions)
enumeration MEETING_OF_CREDITORS_SCHEDULED 
A meeting of creditors was scheduled (used by CASE_PORTFOLIO
subscriptions)
enumeration MEETING_OF_CREDITORS_CANCELED 
A meeting of creditors was canceled (used by CASE_PORTFOLIO
subscriptions)
enumeration MEETING_OF_CREDITORS_OCCURRED 
A meeting of creditors occurred (used by CASE_PORTFOLIO
subscriptions)
enumeration CASE_UPDATED 
An event has occurred that affects a case as a whole (used by
CM_ECF subscriptions)
enumeration DOCKET_ITEM_FILED 
A docket item has been filed (used by CM_ECF subscriptions)
enumeration PROOF_OF_CLAIM_FILED 
A proof of claim has been filed (used by CM_ECF subscriptions)
enumeration DOCKET_ITEM_UPDATED 
A docket item has been updated (used by CM_ECF subscriptions)
enumeration PROOF_OF_CLAIM_UPDATED 
A proof of claim has been updated (used by CM_ECF subscriptions)
enumeration CLAIM_UPDATED 
A claim has been updated (used by CM_ECF subscriptions)
enumeration EMAIL_RECEIVED 
An email not containing any of the other CM_ECF notification
types was received at the address registered with the court
(used by CM_ECF subscriptions)
Used by
Source
 
<simpleType name="eventType">
  <annotation>
    <documentation>A category of event triggering a notification</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="CASES_FILED">
      <annotation>
        <documentation>A list of cases was filed (used by CASE_LISTS subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASES_DISCHARGED">
      <annotation>
        <documentation>A list of cases was discharged (used by CASE_LISTS subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASES_DISMISSED">
      <annotation>
        <documentation>A list of cases was dismissed (used by CASE_LISTS subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASES_CLOSED">
      <annotation>
        <documentation>A list of cases was closed (used by CASE_LISTS subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASES_CONVERTED">
      <annotation>
        <documentation>A list of cases was conveted (used by CASE_LISTS subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASES_REOPENED">
      <annotation>
        <documentation>A list of cases was reopened (used by CASE_LISTS subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASES_TRANSFERRED">
      <annotation>
        <documentation>A list of cases was transferred from one division to another (used by CASE_LISTS subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASES_SPLIT">
      <annotation>
        <documentation>A list of cases was split (used by CASE_LISTS subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_FILED">
      <annotation>
        <documentation>A case was filed (used by CASE_PORTFOLIO AND CONSUMER_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_DISCHARGED">
      <annotation>
        <documentation>A case was discharged (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_DISMISSED">
      <annotation>
        <documentation>A case was dismissed (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_CLOSED">
      <annotation>
        <documentation>A case was closed (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_CONVERTED">
      <annotation>
        <documentation>A case was conveted (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_REOPENED">
      <annotation>
        <documentation>A case was reopened (used by CASE_PORTFOLIO subscriptions) subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_TRANSFERRED">
      <annotation>
        <documentation>A case was transferred from one division to another (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_TERMINATED">
      <annotation>
        <documentation>A case was terminated (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_SPLIT">
      <annotation>
        <documentation>A case was split (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="JOINT_DEBTOR_DISCHARGED">
      <annotation>
        <documentation>The joint debtor was discharged (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="JOINT_DEBTOR_DISMISSED">
      <annotation>
        <documentation>The joint debtor was dismissed (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="PLAN_CONFIRMED">
      <annotation>
        <documentation>A chapter 13 plan was confirmed (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="MEETING_OF_CREDITORS_SCHEDULED">
      <annotation>
        <documentation>A meeting of creditors was scheduled (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="MEETING_OF_CREDITORS_CANCELED">
      <annotation>
        <documentation>A meeting of creditors was canceled (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="MEETING_OF_CREDITORS_OCCURRED">
      <annotation>
        <documentation>A meeting of creditors occurred (used by CASE_PORTFOLIO subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CASE_UPDATED">
      <annotation>
        <documentation>An event has occurred that affects a case as a whole (used by CM_ECF subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="DOCKET_ITEM_FILED">
      <annotation>
        <documentation>A docket item has been filed (used by CM_ECF subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="PROOF_OF_CLAIM_FILED">
      <annotation>
        <documentation>A proof of claim has been filed (used by CM_ECF subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="DOCKET_ITEM_UPDATED">
      <annotation>
        <documentation>A docket item has been updated (used by CM_ECF subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="PROOF_OF_CLAIM_UPDATED">
      <annotation>
        <documentation>A proof of claim has been updated (used by CM_ECF subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CLAIM_UPDATED">
      <annotation>
        <documentation>A claim has been updated (used by CM_ECF subscriptions)</documentation>
      </annotation>
    </enumeration>
    <enumeration value="EMAIL_RECEIVED">
      <annotation>
        <documentation>An email not containing any of the other CM_ECF notification types was received at the address registered with the court (used by CM_ECF subscriptions)</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:messageTransport
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A method for delivering notifications
Diagram
Diagram
Type restriction of string
Facets
enumeration FAX 
Notification by fax
enumeration POSTAL 
Notification by USPS
enumeration SFTP 
Notification by SFTP
enumeration SMTP 
Notification by email
enumeration WEB_PUSH 
Notification by POSTing to a client-provided URL
enumeration WEB_PULL 
Client retrieves notifications by calling ListNotifications
Used by
Source
 
<simpleType name="messageTransport">
  <annotation>
    <documentation>A method for delivering notifications</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="FAX">
      <annotation>
        <documentation>Notification by fax</documentation>
      </annotation>
    </enumeration>
    <enumeration value="POSTAL">
      <annotation>
        <documentation>Notification by USPS</documentation>
      </annotation>
    </enumeration>
    <enumeration value="SFTP">
      <annotation>
        <documentation>Notification by SFTP</documentation>
      </annotation>
    </enumeration>
    <enumeration value="SMTP">
      <annotation>
        <documentation>Notification by email</documentation>
      </annotation>
    </enumeration>
    <enumeration value="WEB_PUSH">
      <annotation>
        <documentation>Notification by POSTing to a client-provided URL</documentation>
      </annotation>
    </enumeration>
    <enumeration value="WEB_PULL">
      <annotation>
        <documentation>Client retrieves notifications by calling ListNotifications</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:messageFormat
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A document format
Diagram
Diagram
Type restriction of string
Facets
enumeration TEXT 
Plain Text
enumeration HTML 
Hypertext Markup Language
enumeration XML 
Extensible Markup Language
enumeration CSV 
Comma-Separated Values
enumeration PDF 
Portable Document Format
enumeration JSON 
JavaScript Object Notation
Used by
Source
 
<simpleType name="messageFormat">
  <annotation>
    <documentation>A document format</documentation>
  </annotation>
  <restriction base="xsd:string">
    <enumeration value="TEXT">
      <annotation>
        <documentation>Plain Text</documentation>
      </annotation>
    </enumeration>
    <enumeration value="HTML">
      <annotation>
        <documentation>Hypertext Markup Language</documentation>
      </annotation>
    </enumeration>
    <enumeration value="XML">
      <annotation>
        <documentation>Extensible Markup Language</documentation>
      </annotation>
    </enumeration>
    <enumeration value="CSV">
      <annotation>
        <documentation>Comma-Separated Values</documentation>
      </annotation>
    </enumeration>
    <enumeration value="PDF">
      <annotation>
        <documentation>Portable Document Format</documentation>
      </annotation>
    </enumeration>
    <enumeration value="JSON">
      <annotation>
        <documentation>JavaScript Object Notation</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:deliveryMethod
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A method for notification delivery
Diagram
Diagram schema_xsd.tmp#deliveryMethod_id schema_xsd.tmp#deliveryMethod_transport schema_xsd.tmp#deliveryMethod_format schema_xsd.tmp#deliveryMethod_batch schema_xsd.tmp#deliveryMethod_address
Used by
Model
Children bkw:address, bkw:batch, bkw:format, bkw:id, bkw:transport
Source
 
<complexType name="deliveryMethod">
  <annotation>
    <documentation>A method for notification delivery</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The delivery method ID, or the form delivery-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="transport" type="bkw:messageTransport"/>
    <element name="format" type="bkw:messageFormat" minOccurs="0">
      <annotation>
        <documentation>Must be XML or unspecified when transport is WEB_PULL</documentation>
      </annotation>
    </element>
    <element name="batch" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>true if notifications should be delivered in batches; must be true or unspecified when transport is WEB_PULL</documentation>
      </annotation>
    </element>
    <element name="address" type="bkw:address" minOccurs="0">
      <annotation>
        <documentation>must be unspecified when transport is WEB_PULL</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:portfolioItem
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
An item in a subscription's portfolio
Diagram
Diagram schema_xsd.tmp#portfolioItem_id schema_xsd.tmp#portfolioItem_properties schema_xsd.tmp#portfolioItem_added schema_xsd.tmp#portfolioItem_removed
Used by
Model
Children bkw:added, bkw:id, bkw:properties, bkw:removed
Source
 
<complexType name="portfolioItem">
  <annotation>
    <documentation>An item in a subscription's portfolio</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:text" minOccurs="0">
      <annotation>
        <documentation>An optional text string selected by the subscriber for internal use; for example, it could be a client identifier</documentation>
      </annotation>
    </element>
    <element name="properties">
      <annotation>
        <documentation>The list of name/value pairs that define the portfolio item; for example, an item in a Case Portfolio has two properties: district and caseNumber</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="property" minOccurs="0" maxOccurs="unbounded">
            <complexType>
              <sequence>
                <element name="name" type="xsd:string"/>
                <element name="value" type="xsd:string"/>
              </sequence>
            </complexType>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="added" type="xsd:dateTime" minOccurs="0">
      <annotation>
        <documentation>The time the item was added to the portfolio</documentation>
      </annotation>
    </element>
    <element name="removed" type="xsd:dateTime" minOccurs="0">
      <annotation>
        <documentation>The time the item was removed from the portfolio</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:parameterList
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
A list of name value pairs used to configure a subscription
Diagram
Diagram schema_xsd.tmp#parameterList_param
Used by
Model
Children bkw:param
Source
 
<complexType name="parameterList">
  <annotation>
    <documentation>A list of name value pairs used to configure a subscription</documentation>
  </annotation>
  <sequence>
    <element name="param" minOccurs="1" maxOccurs="unbounded">
      <complexType>
        <sequence>
          <element name="name" type="xsd:string"/>
          <element name="value" type="xsd:string"/>
        </sequence>
      </complexType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:subscription
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Represents a subscription
Diagram
Diagram schema_xsd.tmp#subscription_id schema_xsd.tmp#subscription_type schema_xsd.tmp#subscription_eventTypes schema_xsd.tmp#subscription_params schema_xsd.tmp#subscription_deliveryMethods
Used by
Model
Children bkw:deliveryMethods, bkw:eventTypes, bkw:id, bkw:params, bkw:type
Source
 
<complexType name="subscription">
  <annotation>
    <documentation>Represents a subscription</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The subscription ID, or the form sub-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="type" type="bkw:subscriptionType">
      <annotation>
        <documentation>The subscription type</documentation>
      </annotation>
    </element>
    <element name="eventTypes" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of notification types; required for CASE_PORTFOLIO and CASE_LISTS subscriptions. For CASE_LISTS subscriptions, exactly one notification type must be specified</documentation>
      </annotation>
    </element>
    <element name="params" type="bkw:parameterList" minOccurs="0"/>
    <element name="deliveryMethods" minOccurs="0">
      <complexType>
        <annotation>
          <documentation>List of delivery methods</documentation>
        </annotation>
        <sequence>
          <element name="deliveryMethod" type="bkw:deliveryMethod" minOccurs="1" maxOccurs="unbounded"/>
        </sequence>
      </complexType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:notification
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Represents a notification
Diagram
Diagram schema_xsd.tmp#notification_id schema_xsd.tmp#notification_subscriptionId schema_xsd.tmp#notification_timestamp schema_xsd.tmp#notification_type schema_xsd.tmp#notification_eventDate schema_xsd.tmp#notification_description schema_xsd.tmp#notification_params schema_xsd.tmp#notification_portfolioItem schema_xsd.tmp#notification_delivered schema_xsd.tmp#notification_cases schema_xsd.tmp#notification_documents
Used by
Model
Children bkw:cases, bkw:delivered, bkw:description, bkw:documents, bkw:eventDate, bkw:id, bkw:params, bkw:portfolioItem, bkw:subscriptionId, bkw:timestamp, bkw:type
Source
 
<complexType name="notification">
  <annotation>
    <documentation>Represents a notification</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The notification ID, or the form not-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="subscriptionId" type="bkw:resourceId">
      <annotation>
        <documentation>The subscription ID</documentation>
      </annotation>
    </element>
    <element name="timestamp" type="xsd:dateTime" minOccurs="0">
      <annotation>
        <documentation>The time at which the notification was generated</documentation>
      </annotation>
    </element>
    <element name="type" type="bkw:eventType">
      <annotation>
        <documentation>The event type</documentation>
      </annotation>
    </element>
    <element name="eventDate" type="xsd:date">
      <annotation>
        <documentation>The event date</documentation>
      </annotation>
    </element>
    <element name="description" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A brief description of the notification</documentation>
      </annotation>
    </element>
    <element name="params" type="bkw:parameterList" minOccurs="0"/>
    <element name="portfolioItem" type="bkw:portfolioItem" minOccurs="0">
      <annotation>
        <documentation>The portfolio item associated with the notification</documentation>
      </annotation>
    </element>
    <element name="delivered" type="xsd:dateTime" minOccurs="0">
      <annotation>
        <documentation>The delivery date, if the notification has been delivered</documentation>
      </annotation>
    </element>
    <element name="cases" type="bkw:caseList" minOccurs="0">
      <annotation>
        <documentation>A list of cases associated with the notification</documentation>
      </annotation>
    </element>
    <element name="documents" type="bkw:documentList" minOccurs="0">
      <annotation>
        <documentation>A list of documents associated with the notification</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:notificationsList
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram schema_xsd.tmp#notificationsList_notification
Used by
Model
Children bkw:notification
Source
 
<complexType name="notificationsList">
  <sequence>
    <element name="notification" type="bkw:notification" minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:trusteeCheck
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Represents a check from a Chapter 13 trustee containing chapter 13
plan payments
Diagram
Diagram schema_xsd.tmp#trusteeCheck_number schema_xsd.tmp#trusteeCheck_date schema_xsd.tmp#trusteeCheck_amount schema_xsd.tmp#trusteeCheck_trusteeAddress schema_xsd.tmp#trusteeCheck_payments
Used by
Model
Children bkw:amount, bkw:date, bkw:number, bkw:payments, bkw:trusteeAddress
Source
 
<complexType name="trusteeCheck">
  <annotation>
    <documentation>Represents a check from a Chapter 13 trustee containing chapter 13 plan payments</documentation>
  </annotation>
  <sequence>
    <element name="number">
      <annotation>
        <documentation>The check number</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <pattern value="[^,*]+"/>
        </restriction>
      </simpleType>
    </element>
    <element name="date" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The check date</documentation>
      </annotation>
    </element>
    <element name="amount" type="bkw:dollarValue">
      <annotation>
        <documentation>The total payment amount</documentation>
      </annotation>
    </element>
    <element name="trusteeAddress" type="bkw:address">
      <annotation>
        <documentation>The trustee address</documentation>
      </annotation>
    </element>
    <element name="payments">
      <annotation>
        <documentation>The list of chapter 13 plan payments covered by the check</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="payment" maxOccurs="unbounded">
            <annotation>
              <documentation>The chapter 13 plan payment covered by the check</documentation>
            </annotation>
            <complexType>
              <sequence>
                <element name="caseNumber" type="bkw:compactCaseNumber">
                  <annotation>
                    <documentation>The seven-digit case number</documentation>
                  </annotation>
                </element>
                <element name="amount" type="bkw:dollarValue">
                  <annotation>
                    <documentation>The payment amount</documentation>
                  </annotation>
                </element>
                <element name="interest" type="bkw:dollarValue" minOccurs="0">
                  <annotation>
                    <documentation>The portion of the payment that represents an interest payment</documentation>
                  </annotation>
                </element>
                <element name="date" type="xsd:date" minOccurs="0">
                  <annotation>
                    <documentation>The check date</documentation>
                  </annotation>
                </element>
                <element name="accountNumber" type="xsd:string" minOccurs="0">
                  <annotation>
                    <documentation>The account number</documentation>
                  </annotation>
                </element>
                <element name="comment" type="xsd:string" minOccurs="0">
                  <annotation>
                    <documentation>A description of the payment added by the trustee</documentation>
                  </annotation>
                </element>
                <element name="debtor1" type="bkw:address">
                  <annotation>
                    <documentation>The address of the debtor</documentation>
                  </annotation>
                </element>
                <element name="debtor2" type="bkw:address" minOccurs="0">
                  <annotation>
                    <documentation>The address of the joint debtor</documentation>
                  </annotation>
                </element>
                <element name="creditor" type="xsd:string">
                  <annotation>
                    <documentation>The creditor name</documentation>
                  </annotation>
                </element>
                <element name="claim">
                  <annotation>
                    <documentation>Information about the claim</documentation>
                  </annotation>
                  <complexType>
                    <sequence>
                      <element name="amount" type="bkw:dollarValue">
                        <annotation>
                          <documentation>The claim amount</documentation>
                        </annotation>
                      </element>
                      <element name="number" type="xsd:nonNegativeInteger">
                        <annotation>
                          <documentation>The claim number</documentation>
                        </annotation>
                      </element>
                      <element name="description" type="xsd:string" minOccurs="0">
                        <annotation>
                          <documentation>The claim description</documentation>
                        </annotation>
                      </element>
                      <element name="interestDue" type="bkw:dollarValue" minOccurs="0">
                        <annotation>
                          <documentation>The interest due</documentation>
                        </annotation>
                      </element>
                      <element name="interestPaid" type="bkw:dollarValue" minOccurs="0">
                        <annotation>
                          <documentation>The interest paid</documentation>
                        </annotation>
                      </element>
                      <element name="interestRate" type="xsd:decimal" minOccurs="0">
                        <annotation>
                          <documentation>The interest rate</documentation>
                        </annotation>
                      </element>
                      <element name="principleDue" type="bkw:dollarValue" minOccurs="0">
                        <annotation>
                          <documentation>The principle due</documentation>
                        </annotation>
                      </element>
                      <element name="principleOwed" type="bkw:dollarValue" minOccurs="0">
                        <annotation>
                          <documentation>The principle owed</documentation>
                        </annotation>
                      </element>
                      <element name="principlePaid" type="bkw:dollarValue" minOccurs="0">
                        <annotation>
                          <documentation>The principle paid</documentation>
                        </annotation>
                      </element>
                      <element name="scheduledAmount" type="bkw:dollarValue" minOccurs="0">
                        <annotation>
                          <documentation>The scheduled amount</documentation>
                        </annotation>
                      </element>
                      <element name="monthlyPayment" type="bkw:dollarValue" minOccurs="0">
                        <annotation>
                          <documentation>The montly payment amount</documentation>
                        </annotation>
                      </element>
                    </sequence>
                  </complexType>
                </element>
              </sequence>
            </complexType>
          </element>
        </sequence>
      </complexType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:trustee
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Represents a bankruptcy trustee
Diagram
Diagram schema_xsd.tmp#trustee_id schema_xsd.tmp#trustee_district schema_xsd.tmp#trustee_chapters schema_xsd.tmp#trustee_address schema_xsd.tmp#trustee_active schema_xsd.tmp#trustee_chapter13Services
Used by
Model
Children bkw:active, bkw:address, bkw:chapter13Services, bkw:chapters, bkw:district, bkw:id
Source
 
<complexType name="trustee">
  <annotation>
    <documentation>Represents a bankruptcy trustee</documentation>
  </annotation>
  <sequence>
    <element name="id" type="bkw:resourceId">
      <annotation>
        <documentation>The trustee ID</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="chapters" type="bkw:chapterList">
      <annotation>
        <documentation>A comma-separated list of chapters</documentation>
      </annotation>
    </element>
    <element name="address" type="bkw:address">
      <annotation>
        <documentation>The trustee address</documentation>
      </annotation>
    </element>
    <element name="active" type="boolean">
      <annotation>
        <documentation>Indicate if trustee is active or inactive</documentation>
      </annotation>
    </element>
    <element name="chapter13Services" minOccurs="0">
      <annotation>
        <documentation>A list of chapter 13 trustee payment services</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="chapter13Service" maxOccurs="unbounded">
            <annotation>
              <documentation>A chapter 13 payment service</documentation>
            </annotation>
            <complexType>
              <sequence>
                <element name="id" type="bkw:resourceId">
                  <annotation>
                    <documentation>The service ID</documentation>
                  </annotation>
                </element>
                <element name="division" type="string" minOccurs="0">
                  <annotation>
                    <documentation>The name of a division within the district, if the service is limited to a specific division</documentation>
                  </annotation>
                </element>
              </sequence>
            </complexType>
          </element>
        </sequence>
      </complexType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CreateAuthTokenRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation CreateAuthToken
Diagram
Diagram schema_xsd.tmp#CreateAuthTokenRequestType_username schema_xsd.tmp#CreateAuthTokenRequestType_password schema_xsd.tmp#CreateAuthTokenRequestType_authtoken schema_xsd.tmp#CreateAuthTokenRequestType_lifetime schema_xsd.tmp#CreateAuthTokenRequestType_label
Used by
Model
Children bkw:authtoken, bkw:label, bkw:lifetime, bkw:password, bkw:username
Source
 
<complexType name="CreateAuthTokenRequestType">
  <annotation>
    <documentation>Request type for operation CreateAuthToken</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="lifetime" type="xsd:positiveInteger">
      <annotation>
        <documentation>The token lifetime, in seconds</documentation>
      </annotation>
    </element>
    <element name="label" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A descriptive label</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CreateAuthTokenResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation CreateAuthToken
Diagram
Diagram schema_xsd.tmp#CreateAuthTokenResponseType_token schema_xsd.tmp#CreateAuthTokenResponseType_status schema_xsd.tmp#CreateAuthTokenResponseType_message
Used by
Model
Children bkw:message, bkw:status, bkw:token
Source
 
<complexType name="CreateAuthTokenResponseType">
  <annotation>
    <documentation>Response type for operation CreateAuthToken</documentation>
  </annotation>
  <sequence>
    <element name="token" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The alphanumeric identifier</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RevokeAuthTokenRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RevokeAuthToken
Diagram
Diagram schema_xsd.tmp#RevokeAuthTokenRequestType_username schema_xsd.tmp#RevokeAuthTokenRequestType_password schema_xsd.tmp#RevokeAuthTokenRequestType_authtoken schema_xsd.tmp#RevokeAuthTokenRequestType_token
Used by
Model
Children bkw:authtoken, bkw:password, bkw:token, bkw:username
Source
 
<complexType name="RevokeAuthTokenRequestType">
  <annotation>
    <documentation>Request type for operation RevokeAuthToken</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="token" type="bkw:requiredText">
      <annotation>
        <documentation>The alphanumeric identifier</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RevokeAuthTokenResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RevokeAuthToken
Diagram
Diagram schema_xsd.tmp#RevokeAuthTokenResponseType_status schema_xsd.tmp#RevokeAuthTokenResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="RevokeAuthTokenResponseType">
  <annotation>
    <documentation>Response type for operation RevokeAuthToken</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListDistrictsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListDistricts
Diagram
Diagram schema_xsd.tmp#ListDistrictsRequestType_username schema_xsd.tmp#ListDistrictsRequestType_password schema_xsd.tmp#ListDistrictsRequestType_authtoken schema_xsd.tmp#ListDistrictsRequestType_from schema_xsd.tmp#ListDistrictsRequestType_to schema_xsd.tmp#ListDistrictsRequestType_filters schema_xsd.tmp#ListDistrictsRequestType_sort
Used by
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Source
 
<complexType name="ListDistrictsRequestType">
  <annotation>
    <documentation>Request type for operation ListDistricts</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first district to be returned, within the collection of all districts matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last district to be returned, within the collection of all districts matching the search criteria; the search may return fewer district than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters. Supported fields are: name (bkw:district) code (xsd:integer)</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListDistrictsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListDistricts
Diagram
Diagram schema_xsd.tmp#ListDistrictsResponseType_results schema_xsd.tmp#ListDistrictsResponseType_status schema_xsd.tmp#ListDistrictsResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListDistrictsResponseType">
  <annotation>
    <documentation>Response type for operation ListDistricts</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" minOccurs="0">
            <annotation>
              <documentation>List of district names and codes</documentation>
            </annotation>
            <complexType>
              <sequence>
                <element name="district" maxOccurs="unbounded">
                  <complexType>
                    <sequence>
                      <element name="name" type="bkw:requiredText"/>
                      <element name="code" type="bkw:district"/>
                    </sequence>
                  </complexType>
                </element>
              </sequence>
            </complexType>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned district, within the collection of all districts matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of districts matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListDivisionsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListDivisions
Diagram
Diagram schema_xsd.tmp#ListDivisionsRequestType_username schema_xsd.tmp#ListDivisionsRequestType_password schema_xsd.tmp#ListDivisionsRequestType_authtoken schema_xsd.tmp#ListDivisionsRequestType_from schema_xsd.tmp#ListDivisionsRequestType_to schema_xsd.tmp#ListDivisionsRequestType_filters schema_xsd.tmp#ListDivisionsRequestType_sort
Used by
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Source
 
<complexType name="ListDivisionsRequestType">
  <annotation>
    <documentation>Request type for operation ListDivisions</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first division to be returned, within the collection of all divisions matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last division to be returned, within the collection of all divisions matching the search criteria; the search may return fewer division than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters. Supported fields are: district (bkw:district) name (xsd:string) officeNumber (xsd:integer)</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListDivisionsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListDivisions
Diagram
Diagram schema_xsd.tmp#ListDivisionsResponseType_results schema_xsd.tmp#ListDivisionsResponseType_status schema_xsd.tmp#ListDivisionsResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListDivisionsResponseType">
  <annotation>
    <documentation>Response type for operation ListDivisions</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" minOccurs="0">
            <complexType>
              <sequence>
                <element name="division" maxOccurs="unbounded">
                  <complexType>
                    <sequence>
                      <element name="district" type="bkw:district">
                        <annotation>
                          <documentation>The district</documentation>
                        </annotation>
                      </element>
                      <element name="name" type="bkw:requiredText">
                        <annotation>
                          <documentation>The division name; typically a city name</documentation>
                        </annotation>
                      </element>
                      <element name="officeNumber" type="xsd:int">
                        <annotation>
                          <documentation>The office number</documentation>
                        </annotation>
                      </element>
                    </sequence>
                  </complexType>
                </element>
              </sequence>
            </complexType>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned division, within the collection of all divisions matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of divisions matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewCaseRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ViewCase
Diagram
Diagram schema_xsd.tmp#ViewCaseRequestType_username schema_xsd.tmp#ViewCaseRequestType_password schema_xsd.tmp#ViewCaseRequestType_authtoken schema_xsd.tmp#ViewCaseRequestType_caseId schema_xsd.tmp#ViewCaseRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:caseId, bkw:outputFormat, bkw:password, bkw:username
Source
 
<complexType name="ViewCaseRequestType">
  <annotation>
    <documentation>Request type for operation ViewCase</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="caseId" type="bkw:resourceId">
      <annotation>
        <documentation>The case ID, of the form case-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>A whitespace-separated list of output format names; supported format names are: claims, creditors, docket, filings, parties</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewCaseResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ViewCase
Diagram
Diagram schema_xsd.tmp#ViewCaseResponseType_case schema_xsd.tmp#ViewCaseResponseType_status schema_xsd.tmp#ViewCaseResponseType_message
Used by
Model
Children bkw:case, bkw:message, bkw:status
Source
 
<complexType name="ViewCaseResponseType">
  <annotation>
    <documentation>Response type for operation ViewCase</documentation>
  </annotation>
  <sequence>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>The case with the specified ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewClaimRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ViewClaim
Diagram
Diagram schema_xsd.tmp#ViewClaimRequestType_username schema_xsd.tmp#ViewClaimRequestType_password schema_xsd.tmp#ViewClaimRequestType_authtoken schema_xsd.tmp#ViewClaimRequestType_claimId schema_xsd.tmp#ViewClaimRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:claimId, bkw:outputFormat, bkw:password, bkw:username
Source
 
<complexType name="ViewClaimRequestType">
  <annotation>
    <documentation>Request type for operation ViewClaim</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="claimId" type="bkw:resourceId">
      <annotation>
        <documentation>The claim ID, of the form claim-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>A whitespace-separated list of output format names; supported format names are: filings, case.summary</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewClaimResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ViewClaim
Diagram
Diagram schema_xsd.tmp#ViewClaimResponseType_claim schema_xsd.tmp#ViewClaimResponseType_status schema_xsd.tmp#ViewClaimResponseType_message
Used by
Model
Children bkw:claim, bkw:message, bkw:status
Source
 
<complexType name="ViewClaimResponseType">
  <annotation>
    <documentation>Response type for operation ViewClaim</documentation>
  </annotation>
  <sequence>
    <element name="claim" type="bkw:claim" minOccurs="0">
      <annotation>
        <documentation>The claim with the specified ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewCreditorRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ViewCreditor
Diagram
Diagram schema_xsd.tmp#ViewCreditorRequestType_username schema_xsd.tmp#ViewCreditorRequestType_password schema_xsd.tmp#ViewCreditorRequestType_authtoken schema_xsd.tmp#ViewCreditorRequestType_creditorId schema_xsd.tmp#ViewCreditorRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:creditorId, bkw:outputFormat, bkw:password, bkw:username
Source
 
<complexType name="ViewCreditorRequestType">
  <annotation>
    <documentation>Request type for operation ViewCreditor</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="creditorId" type="bkw:resourceId">
      <annotation>
        <documentation>The creditor ID, of the form creditor-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>A whitespace-separated list of output format names; supported format names are: case.summary</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewCreditorResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ViewCreditor
Diagram
Diagram schema_xsd.tmp#ViewCreditorResponseType_creditor schema_xsd.tmp#ViewCreditorResponseType_status schema_xsd.tmp#ViewCreditorResponseType_message
Used by
Model
Children bkw:creditor, bkw:message, bkw:status
Source
 
<complexType name="ViewCreditorResponseType">
  <annotation>
    <documentation>Response type for operation ViewCreditor</documentation>
  </annotation>
  <sequence>
    <element name="creditor" type="bkw:creditor" minOccurs="0">
      <annotation>
        <documentation>The creditor with the specified ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewFilingRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ViewFiling
Diagram
Diagram schema_xsd.tmp#ViewFilingRequestType_username schema_xsd.tmp#ViewFilingRequestType_password schema_xsd.tmp#ViewFilingRequestType_authtoken schema_xsd.tmp#ViewFilingRequestType_filingId schema_xsd.tmp#ViewFilingRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:filingId, bkw:outputFormat, bkw:password, bkw:username
Source
 
<complexType name="ViewFilingRequestType">
  <annotation>
    <documentation>Request type for operation ViewFiling</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="filingId" type="bkw:resourceId">
      <annotation>
        <documentation>The filing ID</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>A whitespace-separated list of output format names; supported format names are: documents, case.summary. Defaults to "documents".</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewFilingResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ViewFiling
Diagram
Diagram schema_xsd.tmp#ViewFilingResponseType_filing schema_xsd.tmp#ViewFilingResponseType_status schema_xsd.tmp#ViewFilingResponseType_message
Used by
Model
Children bkw:filing, bkw:message, bkw:status
Source
 
<complexType name="ViewFilingResponseType">
  <annotation>
    <documentation>Response type for operation ViewFiling</documentation>
  </annotation>
  <sequence>
    <element name="filing" type="bkw:filing" minOccurs="0">
      <annotation>
        <documentation>The fililng with the specified ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewPartyRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ViewParty
Diagram
Diagram schema_xsd.tmp#ViewPartyRequestType_username schema_xsd.tmp#ViewPartyRequestType_password schema_xsd.tmp#ViewPartyRequestType_authtoken schema_xsd.tmp#ViewPartyRequestType_partyId schema_xsd.tmp#ViewPartyRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:outputFormat, bkw:partyId, bkw:password, bkw:username
Source
 
<complexType name="ViewPartyRequestType">
  <annotation>
    <documentation>Request type for operation ViewParty</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="partyId" type="bkw:resourceId">
      <annotation>
        <documentation>The party ID, of the form party-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>A whitespace-separated list of output format names; supported format names are: attorneys, case.summary.</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewPartyResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ViewParty
Diagram
Diagram schema_xsd.tmp#ViewPartyResponseType_party schema_xsd.tmp#ViewPartyResponseType_status schema_xsd.tmp#ViewPartyResponseType_message
Used by
Model
Children bkw:message, bkw:party, bkw:status
Source
 
<complexType name="ViewPartyResponseType">
  <annotation>
    <documentation>Response type for operation ViewParty</documentation>
  </annotation>
  <sequence>
    <element name="party" type="bkw:party" minOccurs="0">
      <annotation>
        <documentation>The party with the specified ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListTrusteesRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListTrustees. Exactly one of the
elements "district" and "state" must be present.
Diagram
Diagram schema_xsd.tmp#ListTrusteesRequestType_username schema_xsd.tmp#ListTrusteesRequestType_password schema_xsd.tmp#ListTrusteesRequestType_authtoken schema_xsd.tmp#ListTrusteesRequestType_from schema_xsd.tmp#ListTrusteesRequestType_to schema_xsd.tmp#ListTrusteesRequestType_filters schema_xsd.tmp#ListTrusteesRequestType_sort
Used by
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Source
 
<complexType name="ListTrusteesRequestType">
  <annotation>
    <documentation>Request type for operation ListTrustees. Exactly one of the elements "district" and "state" must be present.</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first trustee to be returned, within the collection of all trustees matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last trustee to be returned, within the collection of all trustees matching the search criteria; the search may return fewer trustees than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters. Supported fields are: id (bkw:resourceId) district (bkw:district) state (bkw:usState) chapter (bkw:chapter) active (xsd:boolean) firstName (xsd:string) lastName (xsd:string)</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListTrusteesResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListTrustees
Diagram
Diagram schema_xsd.tmp#ListTrusteesResponseType_results schema_xsd.tmp#ListTrusteesResponseType_status schema_xsd.tmp#ListTrusteesResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListTrusteesResponseType">
  <annotation>
    <documentation>Response type for operation ListTrustees</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" minOccurs="0">
            <annotation>
              <documentation>The list of trustees</documentation>
            </annotation>
            <complexType>
              <sequence>
                <element name="trustee" type="bkw:trustee" maxOccurs="unbounded">
                  <annotation>
                    <documentation>The trustee</documentation>
                  </annotation>
                </element>
              </sequence>
            </complexType>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned trustee, within the collection of all trustees matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of trustees matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CreatePacerAccountRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation CreatePacerAccount
Diagram
Diagram schema_xsd.tmp#CreatePacerAccountRequestType_username schema_xsd.tmp#CreatePacerAccountRequestType_password schema_xsd.tmp#CreatePacerAccountRequestType_authtoken schema_xsd.tmp#CreatePacerAccountRequestType_accountUsername schema_xsd.tmp#CreatePacerAccountRequestType_accountPassword schema_xsd.tmp#CreatePacerAccountRequestType_district schema_xsd.tmp#CreatePacerAccountRequestType_description
Used by
Model
Children bkw:accountPassword, bkw:accountUsername, bkw:authtoken, bkw:description, bkw:district, bkw:password, bkw:username
Source
 
<complexType name="CreatePacerAccountRequestType">
  <annotation>
    <documentation>Request type for operation CreatePacerAccount</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="accountUsername" type="bkw:requiredText">
      <annotation>
        <documentation>The account username</documentation>
      </annotation>
    </element>
    <element name="accountPassword" type="bkw:requiredText">
      <annotation>
        <documentation>The account password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district" minOccurs="0">
      <annotation>
        <documentation>The district, for current generation CM/ECF accounts</documentation>
      </annotation>
    </element>
    <element name="description" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The account description</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CreatePacerAccountResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation CreatePacerAccount
Diagram
Diagram schema_xsd.tmp#CreatePacerAccountResponseType_accountId schema_xsd.tmp#CreatePacerAccountResponseType_status schema_xsd.tmp#CreatePacerAccountResponseType_message
Used by
Model
Children bkw:accountId, bkw:message, bkw:status
Source
 
<complexType name="CreatePacerAccountResponseType">
  <annotation>
    <documentation>Response type for operation CreatePacerAccount</documentation>
  </annotation>
  <sequence>
    <element name="accountId" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the newly created account, of the form pacer-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:UpdatePacerAccountRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation UpdatePacerAccount
Diagram
Diagram schema_xsd.tmp#UpdatePacerAccountRequestType_username schema_xsd.tmp#UpdatePacerAccountRequestType_password schema_xsd.tmp#UpdatePacerAccountRequestType_authtoken schema_xsd.tmp#UpdatePacerAccountRequestType_accountId schema_xsd.tmp#UpdatePacerAccountRequestType_accountPassword schema_xsd.tmp#UpdatePacerAccountRequestType_description
Used by
Model
Children bkw:accountId, bkw:accountPassword, bkw:authtoken, bkw:description, bkw:password, bkw:username
Source
 
<complexType name="UpdatePacerAccountRequestType">
  <annotation>
    <documentation>Request type for operation UpdatePacerAccount</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="accountId" type="bkw:resourceId">
      <annotation>
        <documentation>Identifier of the account to be updated, of the form pacer-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="accountPassword" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The new account password</documentation>
      </annotation>
    </element>
    <element name="description" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The new account description</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:UpdatePacerAccountResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation UpdatePacerAccount
Diagram
Diagram schema_xsd.tmp#UpdatePacerAccountResponseType_status schema_xsd.tmp#UpdatePacerAccountResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="UpdatePacerAccountResponseType">
  <annotation>
    <documentation>Response type for operation UpdatePacerAccount</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListPacerAccountsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListPacerAccounts
Diagram
Diagram schema_xsd.tmp#ListPacerAccountsRequestType_username schema_xsd.tmp#ListPacerAccountsRequestType_password schema_xsd.tmp#ListPacerAccountsRequestType_authtoken schema_xsd.tmp#ListPacerAccountsRequestType_from schema_xsd.tmp#ListPacerAccountsRequestType_to schema_xsd.tmp#ListPacerAccountsRequestType_filters schema_xsd.tmp#ListPacerAccountsRequestType_sort
Used by
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Source
 
<complexType name="ListPacerAccountsRequestType">
  <annotation>
    <documentation>Request type for operation ListPacerAccounts</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first account to be returned, within the collection of all accounts matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last account to be returned, within the collection of all accounts matching the search criteria; the search may return fewer accounts than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters. Supported fields are: id (bkw:resourceId) description (xsd:string) district (bkw:district)</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListPacerAccountsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListPacerAccounts
Diagram
Diagram schema_xsd.tmp#ListPacerAccountsResponseType_results schema_xsd.tmp#ListPacerAccountsResponseType_status schema_xsd.tmp#ListPacerAccountsResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListPacerAccountsResponseType">
  <annotation>
    <documentation>Response type for operation ListPacerAccounts</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" minOccurs="0">
            <annotation>
              <documentation>List of registered PACER or current generation CM/ECF accounts</documentation>
            </annotation>
            <complexType>
              <sequence>
                <element name="account" type="bkw:pacerAccount" maxOccurs="unbounded"/>
              </sequence>
            </complexType>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned account, within the collection of all accounts matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of accounts matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:DeletePacerAccountRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation DeletePacerAccount
Diagram
Diagram schema_xsd.tmp#DeletePacerAccountRequestType_username schema_xsd.tmp#DeletePacerAccountRequestType_password schema_xsd.tmp#DeletePacerAccountRequestType_authtoken schema_xsd.tmp#DeletePacerAccountRequestType_accountId
Used by
Model
Children bkw:accountId, bkw:authtoken, bkw:password, bkw:username
Source
 
<complexType name="DeletePacerAccountRequestType">
  <annotation>
    <documentation>Request type for operation DeletePacerAccount</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="accountId" type="bkw:resourceId">
      <annotation>
        <documentation>Identifier of the account to be deleted, of the form pacer-xxxxxxxx</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:DeletePacerAccountResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation DeletePacerAccount
Diagram
Diagram schema_xsd.tmp#DeletePacerAccountResponseType_status schema_xsd.tmp#DeletePacerAccountResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="DeletePacerAccountResponseType">
  <annotation>
    <documentation>Response type for operation DeletePacerAccount</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:SetDefaultPacerAccountRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation SetDefaultPacerAccount
Diagram
Diagram schema_xsd.tmp#SetDefaultPacerAccountRequestType_username schema_xsd.tmp#SetDefaultPacerAccountRequestType_password schema_xsd.tmp#SetDefaultPacerAccountRequestType_authtoken schema_xsd.tmp#SetDefaultPacerAccountRequestType_accountId schema_xsd.tmp#SetDefaultPacerAccountRequestType_default
Used by
Model
Children bkw:accountId, bkw:authtoken, bkw:default, bkw:password, bkw:username
Source
 
<complexType name="SetDefaultPacerAccountRequestType">
  <annotation>
    <documentation>Request type for operation SetDefaultPacerAccount</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="accountId" type="bkw:resourceId">
      <annotation>
        <documentation>Identifier of the account to be updated</documentation>
      </annotation>
    </element>
    <element name="default" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>true to set the default status of the account, and false to clear it; defaults to true. If true, the default status of all other registered PACER accounts is cleared.</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:SetDefaultPacerAccountResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation SetDefaultPacerAccount
Diagram
Diagram schema_xsd.tmp#SetDefaultPacerAccountResponseType_status schema_xsd.tmp#SetDefaultPacerAccountResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="SetDefaultPacerAccountResponseType">
  <annotation>
    <documentation>Response type for operation SetDefaultPacerAccount</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewPacerReportRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ViewPacerReport
Diagram
Diagram schema_xsd.tmp#ViewPacerReportRequestType_username schema_xsd.tmp#ViewPacerReportRequestType_password schema_xsd.tmp#ViewPacerReportRequestType_authtoken schema_xsd.tmp#ViewPacerReportRequestType_reportId schema_xsd.tmp#ViewPacerReportRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:outputFormat, bkw:password, bkw:reportId, bkw:username
Source
 
<complexType name="ViewPacerReportRequestType">
  <annotation>
    <documentation>Request type for operation ViewPacerReport</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="reportId" type="bkw:resourceId">
      <annotation>
        <documentation>The report ID, of the form report-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>The output format</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewPacerReportResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ViewPacerReport
Diagram
Diagram schema_xsd.tmp#ViewPacerReportResponseType_report schema_xsd.tmp#ViewPacerReportResponseType_status schema_xsd.tmp#ViewPacerReportResponseType_message
Used by
Model
Children bkw:message, bkw:report, bkw:status
Source
 
<complexType name="ViewPacerReportResponseType">
  <annotation>
    <documentation>Response type for operation ViewPacerReport</documentation>
  </annotation>
  <sequence>
    <element name="report" type="bkw:pacerReport" minOccurs="0">
      <annotation>
        <documentation>The PACER report with the specified ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListPacerReportsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListPacerReports
Diagram
Diagram schema_xsd.tmp#ListPacerReportsRequestType_username schema_xsd.tmp#ListPacerReportsRequestType_password schema_xsd.tmp#ListPacerReportsRequestType_authtoken schema_xsd.tmp#ListPacerReportsRequestType_from schema_xsd.tmp#ListPacerReportsRequestType_to schema_xsd.tmp#ListPacerReportsRequestType_filters schema_xsd.tmp#ListPacerReportsRequestType_sort schema_xsd.tmp#ListPacerReportsRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:outputFormat, bkw:password, bkw:sort, bkw:to, bkw:username
Source
 
<complexType name="ListPacerReportsRequestType">
  <annotation>
    <documentation>Request type for operation ListPacerReports</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first report to be returned, within the collection of all reports matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last report to be returned, within the collection of all reports matching the search criteria; the search may return fewer reports than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>The output format</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListPacerReportsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListPacerReports
Diagram
Diagram schema_xsd.tmp#ListPacerReportsResponseType_results schema_xsd.tmp#ListPacerReportsResponseType_status schema_xsd.tmp#ListPacerReportsResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListPacerReportsResponseType">
  <annotation>
    <documentation>Response type for operation ListPacerReports</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" minOccurs="0">
            <annotation>
              <documentation>The list of reports</documentation>
            </annotation>
            <complexType>
              <choice>
                <element name="report" type="bkw:pacerReport" maxOccurs="unbounded"/>
              </choice>
            </complexType>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned report, within the collection of all reports matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of reports matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewPacerTransactionRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ViewPacerTransaction
Diagram
Diagram schema_xsd.tmp#ViewPacerTransactionRequestType_username schema_xsd.tmp#ViewPacerTransactionRequestType_password schema_xsd.tmp#ViewPacerTransactionRequestType_authtoken schema_xsd.tmp#ViewPacerTransactionRequestType_transactionId schema_xsd.tmp#ViewPacerTransactionRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:outputFormat, bkw:password, bkw:transactionId, bkw:username
Source
 
<complexType name="ViewPacerTransactionRequestType">
  <annotation>
    <documentation>Request type for operation ViewPacerTransaction</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="transactionId" type="bkw:resourceId">
      <annotation>
        <documentation>The transaction ID, of the form trans-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>The output format</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ViewPacerTransactionResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ViewPacerTransaction
Diagram
Diagram schema_xsd.tmp#ViewPacerTransactionResponseType_transaction schema_xsd.tmp#ViewPacerTransactionResponseType_status schema_xsd.tmp#ViewPacerTransactionResponseType_message
Used by
Model
Children bkw:message, bkw:status, bkw:transaction
Source
 
<complexType name="ViewPacerTransactionResponseType">
  <annotation>
    <documentation>Response type for operation ViewPacerTransaction</documentation>
  </annotation>
  <sequence>
    <element name="transaction" type="bkw:pacerTransaction" minOccurs="0">
      <annotation>
        <documentation>The PACER transaction with the specified ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListPacerTransactionsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListPacerTransactions
Diagram
Diagram schema_xsd.tmp#ListPacerTransactionsRequestType_username schema_xsd.tmp#ListPacerTransactionsRequestType_password schema_xsd.tmp#ListPacerTransactionsRequestType_authtoken schema_xsd.tmp#ListPacerTransactionsRequestType_from schema_xsd.tmp#ListPacerTransactionsRequestType_to schema_xsd.tmp#ListPacerTransactionsRequestType_filters schema_xsd.tmp#ListPacerTransactionsRequestType_sort schema_xsd.tmp#ListPacerTransactionsRequestType_outputFormat
Used by
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:outputFormat, bkw:password, bkw:sort, bkw:to, bkw:username
Source
 
<complexType name="ListPacerTransactionsRequestType">
  <annotation>
    <documentation>Request type for operation ListPacerTransactions</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first transaction to be returned, within the collection of all transactions matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last transaction to be returned, within the collection of all transactions matching the search criteria; the search may return fewer transactions than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
    <element name="outputFormat" type="bkw:outputFormat" minOccurs="0">
      <annotation>
        <documentation>The output format</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListPacerTransactionsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation PacerTransactions
Diagram
Diagram schema_xsd.tmp#ListPacerTransactionsResponseType_results schema_xsd.tmp#ListPacerTransactionsResponseType_status schema_xsd.tmp#ListPacerTransactionsResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListPacerTransactionsResponseType">
  <annotation>
    <documentation>Response type for operation PacerTransactions</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" minOccurs="0">
            <annotation>
              <documentation>The list of transactions</documentation>
            </annotation>
            <complexType>
              <choice>
                <element name="transaction" type="bkw:pacerTransaction" maxOccurs="unbounded"/>
              </choice>
            </complexType>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned transaction, within the collection of all transactions matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of transactions matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunCaseLocatorRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RunCaseLocator
Diagram
Diagram schema_xsd.tmp#RunCaseLocatorRequestType_username schema_xsd.tmp#RunCaseLocatorRequestType_password schema_xsd.tmp#RunCaseLocatorRequestType_authtoken schema_xsd.tmp#RunCaseLocatorRequestType_district schema_xsd.tmp#RunCaseLocatorRequestType_caseNumber schema_xsd.tmp#RunCaseLocatorRequestType_chapter schema_xsd.tmp#RunCaseLocatorRequestType_party schema_xsd.tmp#RunCaseLocatorRequestType_partyExact schema_xsd.tmp#RunCaseLocatorRequestType_ssn schema_xsd.tmp#RunCaseLocatorRequestType_ssn4 schema_xsd.tmp#RunCaseLocatorRequestType_cache schema_xsd.tmp#RunCaseLocatorRequestType_pacerAccount
Used by
Model
Children bkw:authtoken, bkw:cache, bkw:caseNumber, bkw:chapter, bkw:district, bkw:pacerAccount, bkw:party, bkw:partyExact, bkw:password, bkw:ssn, bkw:ssn4, bkw:username
Source
 
<complexType name="RunCaseLocatorRequestType">
  <annotation>
    <documentation>Request type for operation RunCaseLocator</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district" minOccurs="0">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="caseNumber" type="bkw:caseNumber" minOccurs="0">
      <annotation>
        <documentation>The case number</documentation>
      </annotation>
    </element>
    <element name="chapter" type="bkw:chapter" minOccurs="0">
      <annotation>
        <documentation>The chapter</documentation>
      </annotation>
    </element>
    <element name="party" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The party name, in the format "last, first"</documentation>
      </annotation>
    </element>
    <element name="partyExact" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Enables exact party name matching; defaults to false</documentation>
      </annotation>
    </element>
    <element name="ssn" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The party Social Security or Tax ID number</documentation>
      </annotation>
    </element>
    <element name="ssn4" type="bkw:ssn4" minOccurs="0">
      <annotation>
        <documentation>The last four digits of the the party Social Security or Tax ID number</documentation>
      </annotation>
    </element>
    <element name="cache" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
      </annotation>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunCaseLocatorResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RunCaseLocator
Diagram
Diagram schema_xsd.tmp#RunCaseLocatorResponseType_cases schema_xsd.tmp#RunCaseLocatorResponseType_status schema_xsd.tmp#RunCaseLocatorResponseType_message
Used by
Model
Children bkw:cases, bkw:message, bkw:status
Source
 
<complexType name="RunCaseLocatorResponseType">
  <annotation>
    <documentation>Response type for operation RunCaseLocator</documentation>
  </annotation>
  <sequence>
    <element name="cases" type="bkw:caseList" minOccurs="0">
      <annotation>
        <documentation>The list of cases matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunCaseNumbersRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RunCaseNumbers
Diagram
Diagram schema_xsd.tmp#RunCaseNumbersRequestType_username schema_xsd.tmp#RunCaseNumbersRequestType_password schema_xsd.tmp#RunCaseNumbersRequestType_authtoken schema_xsd.tmp#RunCaseNumbersRequestType_district schema_xsd.tmp#RunCaseNumbersRequestType_caseNumber
Used by
Model
Children bkw:authtoken, bkw:caseNumber, bkw:district, bkw:password, bkw:username
Source
 
<complexType name="RunCaseNumbersRequestType">
  <annotation>
    <documentation>Request type for operation RunCaseNumbers</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="caseNumber" type="bkw:requiredText">
      <annotation>
        <documentation>A free-form case number</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunCaseNumbersResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RunCaseNumbers
Diagram
Diagram schema_xsd.tmp#RunCaseNumbersResponseType_cases schema_xsd.tmp#RunCaseNumbersResponseType_status schema_xsd.tmp#RunCaseNumbersResponseType_message
Used by
Model
Children bkw:cases, bkw:message, bkw:status
Source
 
<complexType name="RunCaseNumbersResponseType">
  <annotation>
    <documentation>Response type for operation RunCaseNumbers</documentation>
  </annotation>
  <sequence>
    <element name="cases" type="bkw:caseList" minOccurs="0">
      <annotation>
        <documentation>The list of matching cases</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunCasesRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RunCases
Diagram
Diagram schema_xsd.tmp#RunCasesRequestType_username schema_xsd.tmp#RunCasesRequestType_password schema_xsd.tmp#RunCasesRequestType_authtoken schema_xsd.tmp#RunCasesRequestType_district schema_xsd.tmp#RunCasesRequestType_division schema_xsd.tmp#RunCasesRequestType_caseTypes schema_xsd.tmp#RunCasesRequestType_chapters schema_xsd.tmp#RunCasesRequestType_status schema_xsd.tmp#RunCasesRequestType_includeParties schema_xsd.tmp#RunCasesRequestType_proSeOnly schema_xsd.tmp#RunCasesRequestType_counties schema_xsd.tmp#RunCasesRequestType_trustee schema_xsd.tmp#RunCasesRequestType_debtorType schema_xsd.tmp#RunCasesRequestType_debtType schema_xsd.tmp#RunCasesRequestType_dateType schema_xsd.tmp#RunCasesRequestType_from schema_xsd.tmp#RunCasesRequestType_to schema_xsd.tmp#RunCasesRequestType_cache schema_xsd.tmp#RunCasesRequestType_pacerAccount
Used by
Model
Children bkw:authtoken, bkw:cache, bkw:caseTypes, bkw:chapters, bkw:counties, bkw:dateType, bkw:debtType, bkw:debtorType, bkw:district, bkw:division, bkw:from, bkw:includeParties, bkw:pacerAccount, bkw:password, bkw:proSeOnly, bkw:status, bkw:to, bkw:trustee, bkw:username
Source
 
<complexType name="RunCasesRequestType">
  <annotation>
    <documentation>Request type for operation RunCases</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="division" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The division name or office number</documentation>
      </annotation>
    </element>
    <element name="caseTypes" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of case types; by default cases of any type are returned</documentation>
      </annotation>
    </element>
    <element name="chapters" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of chapters; by default cases are not filtered by chapter</documentation>
      </annotation>
    </element>
    <element name="status" minOccurs="0">
      <annotation>
        <documentation>The current case status; defaults to "all"</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <enumeration value="open"/>
          <enumeration value="closed"/>
          <enumeration value="all"/>
        </restriction>
      </simpleType>
    </element>
    <element name="includeParties" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>True if party information should be included in the output; defaults to false</documentation>
      </annotation>
    </element>
    <element name="proSeOnly" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>True to include only pre se cases; defaults to false</documentation>
      </annotation>
    </element>
    <element name="counties" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of county names</documentation>
      </annotation>
    </element>
    <element name="trustee" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A comma-sperated list of trustee IDs of form trustee-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="debtorType" type="bkw:debtorType" minOccurs="0">
      <annotation>
        <documentation>The debtor type</documentation>
      </annotation>
    </element>
    <element name="debtType" type="bkw:debtType" minOccurs="0">
      <annotation>
        <documentation>The debt type</documentation>
      </annotation>
    </element>
    <element name="dateType">
      <annotation>
        <documentation>The type of case event to which the "from" and "to" options apply</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <enumeration value="filed"/>
          <enumeration value="entered"/>
          <enumeration value="discharged"/>
          <enumeration value="dismissed"/>
          <enumeration value="closed"/>
          <enumeration value="converted"/>
        </restriction>
      </simpleType>
    </element>
    <element name="from" type="xsd:date">
      <annotation>
        <documentation>The beginning of the date range of cases to be returned</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:date">
      <annotation>
        <documentation>The end of the date range of cases to be returned</documentation>
      </annotation>
    </element>
    <element name="cache" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
      </annotation>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunCasesResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RunCases
Diagram
Diagram schema_xsd.tmp#RunCasesResponseType_cases schema_xsd.tmp#RunCasesResponseType_status schema_xsd.tmp#RunCasesResponseType_message
Used by
Model
Children bkw:cases, bkw:message, bkw:status
Source
 
<complexType name="RunCasesResponseType">
  <annotation>
    <documentation>Response type for operation RunCases</documentation>
  </annotation>
  <sequence>
    <element name="cases" type="bkw:caseList" minOccurs="0">
      <annotation>
        <documentation>A list of cases</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunClaimsRegisterRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RunClaimsRegister
Diagram
Diagram schema_xsd.tmp#RunClaimsRegisterRequestType_username schema_xsd.tmp#RunClaimsRegisterRequestType_password schema_xsd.tmp#RunClaimsRegisterRequestType_authtoken schema_xsd.tmp#RunClaimsRegisterRequestType_district schema_xsd.tmp#RunClaimsRegisterRequestType_extendedCaseNumber schema_xsd.tmp#RunClaimsRegisterRequestType_fromDate schema_xsd.tmp#RunClaimsRegisterRequestType_toDate schema_xsd.tmp#RunClaimsRegisterRequestType_fromClaim schema_xsd.tmp#RunClaimsRegisterRequestType_toClaim schema_xsd.tmp#RunClaimsRegisterRequestType_cache schema_xsd.tmp#RunClaimsRegisterRequestType_pacerAccount
Used by
Model
Children bkw:authtoken, bkw:cache, bkw:district, bkw:extendedCaseNumber, bkw:fromClaim, bkw:fromDate, bkw:pacerAccount, bkw:password, bkw:toClaim, bkw:toDate, bkw:username
Source
 
<complexType name="RunClaimsRegisterRequestType">
  <annotation>
    <documentation>Request type for operation RunClaimsRegister</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
      <annotation>
        <documentation>The extended case number</documentation>
      </annotation>
    </element>
    <element name="fromDate" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The beginning of the range of filing dates of claims to be included in the result</documentation>
      </annotation>
    </element>
    <element name="toDate" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The end of the range of filing dates of claims to be included in the result</documentation>
      </annotation>
    </element>
    <element name="fromClaim" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The beginning of the range of claim numbers of claims to be included in the result</documentation>
      </annotation>
    </element>
    <element name="toClaim" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The end of the range of claim numbers of claims to be included in the result</documentation>
      </annotation>
    </element>
    <element name="cache" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
      </annotation>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunClaimsRegisterResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RunClaimsRegister
Diagram
Diagram schema_xsd.tmp#RunClaimsRegisterResponseType_case schema_xsd.tmp#RunClaimsRegisterResponseType_status schema_xsd.tmp#RunClaimsRegisterResponseType_message
Used by
Model
Children bkw:case, bkw:message, bkw:status
Source
 
<complexType name="RunClaimsRegisterResponseType">
  <annotation>
    <documentation>Response type for operation RunClaimsRegister</documentation>
  </annotation>
  <sequence>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>A case containing a list of claims</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunCreditorListRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RunCreditorList
Diagram
Diagram schema_xsd.tmp#RunCreditorListRequestType_username schema_xsd.tmp#RunCreditorListRequestType_password schema_xsd.tmp#RunCreditorListRequestType_authtoken schema_xsd.tmp#RunCreditorListRequestType_district schema_xsd.tmp#RunCreditorListRequestType_extendedCaseNumber schema_xsd.tmp#RunCreditorListRequestType_cache schema_xsd.tmp#RunCreditorListRequestType_pacerAccount
Used by
Model
Children bkw:authtoken, bkw:cache, bkw:district, bkw:extendedCaseNumber, bkw:pacerAccount, bkw:password, bkw:username
Source
 
<complexType name="RunCreditorListRequestType">
  <annotation>
    <documentation>Request type for operation RunCreditorList</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
      <annotation>
        <documentation>The extended case number</documentation>
      </annotation>
    </element>
    <element name="cache" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
      </annotation>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunCreditorListResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RunCreditorList
Diagram
Diagram schema_xsd.tmp#RunCreditorListResponseType_case schema_xsd.tmp#RunCreditorListResponseType_status schema_xsd.tmp#RunCreditorListResponseType_message
Used by
Model
Children bkw:case, bkw:message, bkw:status
Source
 
<complexType name="RunCreditorListResponseType">
  <annotation>
    <documentation>Response type for operation RunCreditorList</documentation>
  </annotation>
  <sequence>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>A case containing a list of creditors</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunDocketRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RunDocket
Diagram
Diagram schema_xsd.tmp#RunDocketRequestType_username schema_xsd.tmp#RunDocketRequestType_password schema_xsd.tmp#RunDocketRequestType_authtoken schema_xsd.tmp#RunDocketRequestType_district schema_xsd.tmp#RunDocketRequestType_extendedCaseNumber schema_xsd.tmp#RunDocketRequestType_fromDate schema_xsd.tmp#RunDocketRequestType_toDate schema_xsd.tmp#RunDocketRequestType_fromItem schema_xsd.tmp#RunDocketRequestType_toItem schema_xsd.tmp#RunDocketRequestType_cache schema_xsd.tmp#RunDocketRequestType_pacerAccount
Used by
Model
Children bkw:authtoken, bkw:cache, bkw:district, bkw:extendedCaseNumber, bkw:fromDate, bkw:fromItem, bkw:pacerAccount, bkw:password, bkw:toDate, bkw:toItem, bkw:username
Source
 
<complexType name="RunDocketRequestType">
  <annotation>
    <documentation>Request type for operation RunDocket</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
      <annotation>
        <documentation>The extended case number</documentation>
      </annotation>
    </element>
    <element name="fromDate" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The beginning of the range of filing dates of docket items to be included in the result</documentation>
      </annotation>
    </element>
    <element name="toDate" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The end of the range of filing dates of docket items to be included in the result</documentation>
      </annotation>
    </element>
    <element name="fromItem" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The beginning of the range of item numbers of docket items to be included in the result. The voluntary petition in bankruptcy cases is usually the first or second docket item.</documentation>
      </annotation>
    </element>
    <element name="toItem" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The end of the range of item numbers of docket items to be included in the result. The voluntary petition in bankruptcy cases is usually the first or second docket item.</documentation>
      </annotation>
    </element>
    <element name="cache" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
      </annotation>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunDocketResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RunDocket
Diagram
Diagram schema_xsd.tmp#RunDocketResponseType_case schema_xsd.tmp#RunDocketResponseType_status schema_xsd.tmp#RunDocketResponseType_message
Used by
Model
Children bkw:case, bkw:message, bkw:status
Source
 
<complexType name="RunDocketResponseType">
  <annotation>
    <documentation>Response type for operation RunDocket</documentation>
  </annotation>
  <sequence>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>A case containing a list of docket items</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:GenerateUrlRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation GenerateUrl
Diagram
Diagram schema_xsd.tmp#GenerateUrlRequestType_username schema_xsd.tmp#GenerateUrlRequestType_password schema_xsd.tmp#GenerateUrlRequestType_authtoken schema_xsd.tmp#GenerateUrlRequestType_documentId schema_xsd.tmp#GenerateUrlRequestType_lifetime schema_xsd.tmp#GenerateUrlRequestType_pacerAccount schema_xsd.tmp#GenerateUrlRequestType_acceptCharges
Used by
Model
Children bkw:acceptCharges, bkw:authtoken, bkw:documentId, bkw:lifetime, bkw:pacerAccount, bkw:password, bkw:username
Source
 
<complexType name="GenerateUrlRequestType">
  <annotation>
    <documentation>Request type for operation GenerateUrl</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="documentId" type="bkw:requiredText">
      <annotation>
        <documentation>The document IDs</documentation>
      </annotation>
    </element>
    <element name="lifetime" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The number of seconds that the URL will be valid; the maximum allowed value is 2592000; defaults to one week</documentation>
      </annotation>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used; if the user does not have a default PACER account, the operation will fail unless the parameter "acceptCharges" is set to false</documentation>
      </annotation>
    </element>
    <element name="acceptCharges" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether a document should be puchased if it is not free; defaults to true; if a pacer account is not specified, may not be set to false</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:GenerateUrlResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation GenerateUrl
Diagram
Diagram schema_xsd.tmp#GenerateUrlResponseType_url schema_xsd.tmp#GenerateUrlResponseType_status schema_xsd.tmp#GenerateUrlResponseType_message
Used by
Model
Children bkw:message, bkw:status, bkw:url
Source
 
<complexType name="GenerateUrlResponseType">
  <annotation>
    <documentation>Response type for operation GenerateUrl</documentation>
  </annotation>
  <sequence>
    <element name="url" type="xsd:anyURI" minOccurs="0">
      <annotation>
        <documentation>The URL</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CreateDocumentRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation CreateDocument
Diagram
Diagram schema_xsd.tmp#CreateDocumentRequestType_username schema_xsd.tmp#CreateDocumentRequestType_password schema_xsd.tmp#CreateDocumentRequestType_authtoken schema_xsd.tmp#CreateDocumentRequestType_title schema_xsd.tmp#CreateDocumentRequestType_description schema_xsd.tmp#CreateDocumentRequestType_contentType schema_xsd.tmp#CreateDocumentRequestType_charset schema_xsd.tmp#CreateDocumentRequestType_language schema_xsd.tmp#CreateDocumentRequestType_data
Used by
Model
Children bkw:authtoken, bkw:charset, bkw:contentType, bkw:data, bkw:description, bkw:language, bkw:password, bkw:title, bkw:username
Source
 
<complexType name="CreateDocumentRequestType">
  <annotation>
    <documentation>Request type for operation CreateDocument</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="title" type="bkw:requiredText">
      <annotation>
        <documentation>The document title</documentation>
      </annotation>
    </element>
    <element name="description" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The document description</documentation>
      </annotation>
    </element>
    <element name="contentType" type="bkw:requiredText">
      <annotation>
        <documentation>The MIME media type</documentation>
      </annotation>
    </element>
    <element name="charset" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The character set identifier</documentation>
      </annotation>
    </element>
    <element name="language" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>An IETF language tag</documentation>
      </annotation>
    </element>
    <element name="data" type="bkw:requiredText">
      <annotation>
        <documentation>The base64-encoded document data</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CreateDocumentResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation CreateDocument
Diagram
Diagram schema_xsd.tmp#CreateDocumentResponseType_documentId schema_xsd.tmp#CreateDocumentResponseType_status schema_xsd.tmp#CreateDocumentResponseType_message
Used by
Model
Children bkw:documentId, bkw:message, bkw:status
Source
 
<complexType name="CreateDocumentResponseType">
  <annotation>
    <documentation>Response type for operation CreateDocument</documentation>
  </annotation>
  <sequence>
    <element name="documentId" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The document ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Simple Type bkw:caseInfoOutputType
Namespace http://www.bkwservice.com/api/2020-07-01
Diagram
Diagram
Type restriction of string
Facets
enumeration CASE_SUMMARY 
Indicates that all the returned cases will include only scalar-
valued properties; no parties, filings, creditors, claims, or
parsed data will be included.
enumeration DOCKET 
Indicates that the most recently filed case will include its
collections of parties and filings; no creditors, claims, or
parsed data will be included. Cases filed earlier, if any, will
include only scalar-valued properties.
enumeration DATA 
Indicates that the most recently filed case will include its
collections of parties and filings, as well as the data
extracted from the documents filed in the case; no creditors or
claims will be included. Cases filed earlier, if any, will
include only scalar-valued properties.
Used by
Source
 
<simpleType name="caseInfoOutputType">
  <restriction base="xsd:string">
    <enumeration value="CASE_SUMMARY">
      <annotation>
        <documentation>Indicates that all the returned cases will include only scalar- valued properties; no parties, filings, creditors, claims, or parsed data will be included.</documentation>
      </annotation>
    </enumeration>
    <enumeration value="DOCKET">
      <annotation>
        <documentation>Indicates that the most recently filed case will include its collections of parties and filings; no creditors, claims, or parsed data will be included. Cases filed earlier, if any, will include only scalar-valued properties.</documentation>
      </annotation>
    </enumeration>
    <enumeration value="DATA">
      <annotation>
        <documentation>Indicates that the most recently filed case will include its collections of parties and filings, as well as the data extracted from the documents filed in the case; no creditors or claims will be included. Cases filed earlier, if any, will include only scalar-valued properties.</documentation>
      </annotation>
    </enumeration>
  </restriction>
</simpleType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CaseInfoRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation CaseInfo
Diagram
Diagram schema_xsd.tmp#CaseInfoRequestType_username schema_xsd.tmp#CaseInfoRequestType_password schema_xsd.tmp#CaseInfoRequestType_authtoken schema_xsd.tmp#CaseInfoRequestType_chapter schema_xsd.tmp#CaseInfoRequestType_party schema_xsd.tmp#CaseInfoRequestType_ssn schema_xsd.tmp#CaseInfoRequestType_ssn4 schema_xsd.tmp#CaseInfoRequestType_outputType schema_xsd.tmp#CaseInfoRequestType_cache schema_xsd.tmp#CaseInfoRequestType_formNumbers schema_xsd.tmp#CaseInfoRequestType_bkmlFormat schema_xsd.tmp#CaseInfoRequestType_pacerAccount
Used by
Model
Children bkw:authtoken, bkw:bkmlFormat, bkw:cache, bkw:chapter, bkw:formNumbers, bkw:outputType, bkw:pacerAccount, bkw:party, bkw:password, bkw:ssn, bkw:ssn4, bkw:username
Source
 
<complexType name="CaseInfoRequestType">
  <annotation>
    <documentation>Request type for operation CaseInfo</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="chapter" type="bkw:chapter" minOccurs="0">
      <annotation>
        <documentation>The bankruptcy chapter</documentation>
      </annotation>
    </element>
    <element name="party" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The party name, in the format "last, first"</documentation>
      </annotation>
    </element>
    <element name="ssn" type="bkw:ssn" minOccurs="0">
      <annotation>
        <documentation>The party Social Security number or Tax ID number</documentation>
      </annotation>
    </element>
    <element name="ssn4" type="bkw:ssn4" minOccurs="0">
      <annotation>
        <documentation>The last four digits of the party Social Security number or Tax ID number</documentation>
      </annotation>
    </element>
    <element name="outputType" type="bkw:caseInfoOutputType">
      <annotation>
        <documentation>The type of information to return</documentation>
      </annotation>
    </element>
    <element name="cache" minOccurs="0">
      <annotation>
        <documentation>Indicates which parts of the returned information should be retrieved from the cache, if available, without accessing PACER</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <enumeration value="NONE">
            <annotation>
              <documentation>Indicates that no cached information should be returned</documentation>
            </annotation>
          </enumeration>
          <enumeration value="CASE_LIST">
            <annotation>
              <documentation>Indicates that a cached case list should returned, if available</documentation>
            </annotation>
          </enumeration>
          <enumeration value="DOCKET">
            <annotation>
              <documentation>Indicates that a cached docket should be returned, if available; if this option is specified case, parsed data, if any, will also be retrieved from the cache</documentation>
            </annotation>
          </enumeration>
        </restriction>
      </simpleType>
    </element>
    <element name="formNumbers" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of form numbers, indicating the type of forms to parse; by default, all supported forms are parsed. This parameter may not be specified if the output format is CASE_SUMMARY or DOCKET.</documentation>
      </annotation>
    </element>
    <element name="bkmlFormat" minOccurs="0">
      <annotation>
        <documentation>Indicates the format of the data that will be returned; defaults to STANDARD. This parameter may not be specified if the output format is CASE_SUMMARY or DOCKET.</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <enumeration value="STANDARD">
            <annotation>
              <documentation>Indicates that the parsed data will be returned in BKML format</documentation>
            </annotation>
          </enumeration>
          <enumeration value="ANALYTICS">
            <annotation>
              <documentation>Indicates that the parsed data will be returned in analytics format</documentation>
            </annotation>
          </enumeration>
        </restriction>
      </simpleType>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CaseInfoResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation CaseInfo
Diagram
Diagram schema_xsd.tmp#CaseInfoResponseType_cases schema_xsd.tmp#CaseInfoResponseType_status schema_xsd.tmp#CaseInfoResponseType_message
Used by
Model
Children bkw:cases, bkw:message, bkw:status
Source
 
<complexType name="CaseInfoResponseType">
  <annotation>
    <documentation>Response type for operation CaseInfo</documentation>
  </annotation>
  <sequence>
    <element name="cases" type="bkw:caseList" minOccurs="0">
      <annotation>
        <documentation>The list of cases matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ParseDocumentsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ParseDocuments; the documents to parse
may be specified either as a comma-separated list of document IDs
or as a district and case number
Diagram
Diagram schema_xsd.tmp#ParseDocumentsRequestType_username schema_xsd.tmp#ParseDocumentsRequestType_password schema_xsd.tmp#ParseDocumentsRequestType_authtoken schema_xsd.tmp#ParseDocumentsRequestType_district schema_xsd.tmp#ParseDocumentsRequestType_extendedCaseNumber schema_xsd.tmp#ParseDocumentsRequestType_documentIds schema_xsd.tmp#ParseDocumentsRequestType_formNumbers schema_xsd.tmp#ParseDocumentsRequestType_bkmlFormat schema_xsd.tmp#ParseDocumentsRequestType_cache schema_xsd.tmp#ParseDocumentsRequestType_pacerAccount
Used by
Model
Children bkw:authtoken, bkw:bkmlFormat, bkw:cache, bkw:district, bkw:documentIds, bkw:extendedCaseNumber, bkw:formNumbers, bkw:pacerAccount, bkw:password, bkw:username
Source
 
<complexType name="ParseDocumentsRequestType">
  <annotation>
    <documentation>Request type for operation ParseDocuments; the documents to parse may be specified either as a comma-separated list of document IDs or as a district and case number</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district" minOccurs="0">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="extendedCaseNumber" type="bkw:extendedCaseNumber" minOccurs="0">
      <annotation>
        <documentation>The extended case number</documentation>
      </annotation>
    </element>
    <element name="documentIds" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of document IDs</documentation>
      </annotation>
    </element>
    <element name="formNumbers" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of elements of the enumeration bkw:formNumber</documentation>
      </annotation>
    </element>
    <element name="bkmlFormat" type="bkw:bkmlFormat" minOccurs="0">
      <annotation>
        <documentation>The BKML format; defaults to STANDARD</documentation>
      </annotation>
    </element>
    <element name="cache" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>Indicates whether cached data should returned, if available, without accessing PACER; defaults to false</documentation>
      </annotation>
    </element>
    <element name="pacerAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>Identifier of the PACER account to be used, of the form pacer-xxxxxxxx; if not specified, the user's default PACER account will be used</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ParseDocumentsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ParseDocuments
Diagram
Diagram schema_xsd.tmp#ParseDocumentsResponseType_case schema_xsd.tmp#ParseDocumentsResponseType_documents schema_xsd.tmp#ParseDocumentsResponseType_data schema_xsd.tmp#ParseDocumentsResponseType_status schema_xsd.tmp#ParseDocumentsResponseType_message
Used by
Model
Children bkw:case, bkw:data, bkw:documents, bkw:message, bkw:status
Source
 
<complexType name="ParseDocumentsResponseType">
  <annotation>
    <documentation>Response type for operation ParseDocuments</documentation>
  </annotation>
  <sequence>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>The case, if a district and case number were specified</documentation>
      </annotation>
    </element>
    <element name="documents" type="bkw:documentList" minOccurs="0">
      <annotation>
        <documentation>The list of parsed documents</documentation>
      </annotation>
    </element>
    <element name="data" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The data, in XML format</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CreateSubscriptionRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation CreateSubscription
Diagram
Diagram schema_xsd.tmp#CreateSubscriptionRequestType_username schema_xsd.tmp#CreateSubscriptionRequestType_password schema_xsd.tmp#CreateSubscriptionRequestType_authtoken schema_xsd.tmp#CreateSubscriptionRequestType_type schema_xsd.tmp#CreateSubscriptionRequestType_eventTypes schema_xsd.tmp#CreateSubscriptionRequestType_params
Used by
Model
Children bkw:authtoken, bkw:eventTypes, bkw:params, bkw:password, bkw:type, bkw:username
Source
 
<complexType name="CreateSubscriptionRequestType">
  <annotation>
    <documentation>Request type for operation CreateSubscription</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="type" type="bkw:subscriptionType">
      <annotation>
        <documentation>The subscription type</documentation>
      </annotation>
    </element>
    <element name="eventTypes" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of event types; required for CASE_PORTFOLIO and CASE_LISTS subscriptions. For CASE_LISTS subscriptions, exactly one notification type must be specified</documentation>
      </annotation>
    </element>
    <element name="params" type="bkw:parameterList" minOccurs="0"/>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CreateSubscriptionResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation CreateSubscription
Diagram
Diagram schema_xsd.tmp#CreateSubscriptionResponseType_subscriptionId schema_xsd.tmp#CreateSubscriptionResponseType_status schema_xsd.tmp#CreateSubscriptionResponseType_message
Used by
Model
Children bkw:message, bkw:status, bkw:subscriptionId
Source
 
<complexType name="CreateSubscriptionResponseType">
  <annotation>
    <documentation>Response type for operation CreateSubscription</documentation>
  </annotation>
  <sequence>
    <element name="subscriptionId" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The subscription ID</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:DeleteSubscriptionRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation DeleteSubscription
Diagram
Diagram schema_xsd.tmp#DeleteSubscriptionRequestType_username schema_xsd.tmp#DeleteSubscriptionRequestType_password schema_xsd.tmp#DeleteSubscriptionRequestType_authtoken schema_xsd.tmp#DeleteSubscriptionRequestType_subscriptionId
Used by
Model
Children bkw:authtoken, bkw:password, bkw:subscriptionId, bkw:username
Source
 
<complexType name="DeleteSubscriptionRequestType">
  <annotation>
    <documentation>Request type for operation DeleteSubscription</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="subscriptionId" type="bkw:resourceId">
      <annotation>
        <documentation>The subscription ID</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:DeleteSubscriptionResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation DeleteSubscription
Diagram
Diagram schema_xsd.tmp#DeleteSubscriptionResponseType_status schema_xsd.tmp#DeleteSubscriptionResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="DeleteSubscriptionResponseType">
  <annotation>
    <documentation>Response type for operation DeleteSubscription</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListSubscriptionsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListSubscriptions
Diagram
Diagram schema_xsd.tmp#ListSubscriptionsRequestType_username schema_xsd.tmp#ListSubscriptionsRequestType_password schema_xsd.tmp#ListSubscriptionsRequestType_authtoken schema_xsd.tmp#ListSubscriptionsRequestType_from schema_xsd.tmp#ListSubscriptionsRequestType_to schema_xsd.tmp#ListSubscriptionsRequestType_filters schema_xsd.tmp#ListSubscriptionsRequestType_sort
Used by
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:to, bkw:username
Source
 
<complexType name="ListSubscriptionsRequestType">
  <annotation>
    <documentation>Request type for operation ListSubscriptions</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first subscription to be returned, within the collection of all subscriptions matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last subscription to be returned, within the collection of all subscriptions matching the search criteria; the search may return fewer subscriptions than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters. Supported fields are: id (bkw:resourceId) type (bkw:subscriptionType)</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListSubscriptionsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListSubscriptions
Diagram
Diagram schema_xsd.tmp#ListSubscriptionsResponseType_results schema_xsd.tmp#ListSubscriptionsResponseType_status schema_xsd.tmp#ListSubscriptionsResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListSubscriptionsResponseType">
  <annotation>
    <documentation>Response type for operation ListSubscriptions</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" minOccurs="0">
            <annotation>
              <documentation>The list of creditors</documentation>
            </annotation>
            <complexType>
              <choice>
                <element name="subscription" type="bkw:subscription" maxOccurs="unbounded"/>
              </choice>
            </complexType>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned subscription, within the collection of all subscriptions matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of subscriptions matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:AddDeliveryMethodRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation AddDeliveryMethod
Diagram
Diagram schema_xsd.tmp#AddDeliveryMethodRequestType_username schema_xsd.tmp#AddDeliveryMethodRequestType_password schema_xsd.tmp#AddDeliveryMethodRequestType_authtoken schema_xsd.tmp#AddDeliveryMethodRequestType_subscriptionId schema_xsd.tmp#AddDeliveryMethodRequestType_transport schema_xsd.tmp#AddDeliveryMethodRequestType_format schema_xsd.tmp#AddDeliveryMethodRequestType_batch schema_xsd.tmp#AddDeliveryMethodRequestType_address
Used by
Model
Children bkw:address, bkw:authtoken, bkw:batch, bkw:format, bkw:password, bkw:subscriptionId, bkw:transport, bkw:username
Source
 
<complexType name="AddDeliveryMethodRequestType">
  <annotation>
    <documentation>Request type for operation AddDeliveryMethod</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="subscriptionId" type="bkw:resourceId">
      <annotation>
        <documentation>The subscription ID</documentation>
      </annotation>
    </element>
    <element name="transport" type="bkw:messageTransport"/>
    <element name="format" type="bkw:messageFormat" minOccurs="0">
      <annotation>
        <documentation>The message format. The value depends on the transport, as follows EMAIL - defauls to HTML FAX - must be unspecified or equal to TEXT; defaults to TEXT POSTAL - must be unspecified or equal to TEXT; defaults to TEXT WEB_PUSH - must be unspecified or equal to XML; defaults to XML WEB_PULL - must be unspecified or equal to XML; defaults to XML</documentation>
      </annotation>
    </element>
    <element name="batch" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>true if notifications should be delivered in batches. Must be absent when transport is WEB_PULL. The value depends on the transport, as follows EMAIL - defaults to false FAX - defaults to false POSTAL - must be unspecified or true; defaults to true WEB_PUSH - defaults to false WEB_PULL - must be unspecified or true; defaults to true</documentation>
      </annotation>
    </element>
    <element name="address" type="bkw:address" minOccurs="0">
      <annotation>
        <documentation>An address indicating where the notification should be sent. Must be present unless transport is WEB_PULL, in which case it must be absent.</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:AddDeliveryMethodResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation AddDeliveryMethod
Diagram
Diagram schema_xsd.tmp#AddDeliveryMethodResponseType_status schema_xsd.tmp#AddDeliveryMethodResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="AddDeliveryMethodResponseType">
  <annotation>
    <documentation>Response type for operation AddDeliveryMethod</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RemoveDeliveryMethodRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RemoveDeliveryMethod
Diagram
Diagram schema_xsd.tmp#RemoveDeliveryMethodRequestType_username schema_xsd.tmp#RemoveDeliveryMethodRequestType_password schema_xsd.tmp#RemoveDeliveryMethodRequestType_authtoken schema_xsd.tmp#RemoveDeliveryMethodRequestType_subscriptionId schema_xsd.tmp#RemoveDeliveryMethodRequestType_transport schema_xsd.tmp#RemoveDeliveryMethodRequestType_address
Used by
Model
Children bkw:address, bkw:authtoken, bkw:password, bkw:subscriptionId, bkw:transport, bkw:username
Source
 
<complexType name="RemoveDeliveryMethodRequestType">
  <annotation>
    <documentation>Request type for operation RemoveDeliveryMethod</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="subscriptionId" type="bkw:resourceId">
      <annotation>
        <documentation>The subscription ID</documentation>
      </annotation>
    </element>
    <element name="transport" type="bkw:messageTransport">
      <annotation>
        <documentation>The type of delivery method</documentation>
      </annotation>
    </element>
    <element name="address" type="bkw:address" minOccurs="0">
      <annotation>
        <documentation>The address</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RemoveDeliveryMethodResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RemoveDeliveryMethod
Diagram
Diagram schema_xsd.tmp#RemoveDeliveryMethodResponseType_status schema_xsd.tmp#RemoveDeliveryMethodResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="RemoveDeliveryMethodResponseType">
  <annotation>
    <documentation>Response type for operation RemoveDeliveryMethod</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListNotificationsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListNotifications
Diagram
Diagram schema_xsd.tmp#ListNotificationsRequestType_username schema_xsd.tmp#ListNotificationsRequestType_password schema_xsd.tmp#ListNotificationsRequestType_authtoken schema_xsd.tmp#ListNotificationsRequestType_subscriptionId schema_xsd.tmp#ListNotificationsRequestType_deliveryMethodId schema_xsd.tmp#ListNotificationsRequestType_from schema_xsd.tmp#ListNotificationsRequestType_to schema_xsd.tmp#ListNotificationsRequestType_filters schema_xsd.tmp#ListNotificationsRequestType_sort
Used by
Model
Children bkw:authtoken, bkw:deliveryMethodId, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:subscriptionId, bkw:to, bkw:username
Source
 
<complexType name="ListNotificationsRequestType">
  <annotation>
    <documentation>Request type for operation ListNotifications</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="subscriptionId" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The ID of a subscription with a delivery method with transport WEB_PULL; excatly one of "subscriptionId" and "deliveryMethodId" must be supplied</documentation>
      </annotation>
    </element>
    <element name="deliveryMethodId" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The delivery method ID; excatly one of "subscriptionId" and "deliveryMethodId" must be supplied</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first notification to be returned, within the collection of all notifications matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last notification to be returned, within the collection of all notifications matching the search criteria; the search may return fewer notifications than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters. All subscription types support the following fields: id (bkw:resourceId) timestamp (bkw:dateTime) eventType (xsd:eventType) eventDate (xsd:date) description (xsd:string) delivered (bkw:dateTime) In addition, subscriptions of type CONSUMER_PORTFOLIO support the following fields: item.id (xsd:string) item.firstName (xsd:string) item.middleName (xsd:string) item.lastName (xsd:string) item.ssn4 (xsd:string) Subscriptions of type CASE_PORTFOLIO support the following fields item.id (xsd:string) item.district (xsd:string) item.caseNumber (xsd:string)</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListNotificationsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListNotifications
Diagram
Diagram schema_xsd.tmp#ListNotificationsResponseType_results schema_xsd.tmp#ListNotificationsResponseType_status schema_xsd.tmp#ListNotificationsResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListNotificationsResponseType">
  <annotation>
    <documentation>Response type for operation ListNotifications</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" type="bkw:notificationsList" minOccurs="0">
            <annotation>
              <documentation>The list of notifications</documentation>
            </annotation>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned notification, within the collection of all notifications matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of notifications matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:AddPortfolioItemsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation AddPortfolioItems
Diagram
Diagram schema_xsd.tmp#AddPortfolioItemsRequestType_username schema_xsd.tmp#AddPortfolioItemsRequestType_password schema_xsd.tmp#AddPortfolioItemsRequestType_authtoken schema_xsd.tmp#AddPortfolioItemsRequestType_subscriptionId schema_xsd.tmp#AddPortfolioItemsRequestType_items
Used by
Model
Children bkw:authtoken, bkw:items, bkw:password, bkw:subscriptionId, bkw:username
Source
 
<complexType name="AddPortfolioItemsRequestType">
  <annotation>
    <documentation>Request type for operation AddPortfolioItems</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="subscriptionId" type="bkw:resourceId">
      <annotation>
        <documentation>The subscription ID</documentation>
      </annotation>
    </element>
    <element name="items">
      <annotation>
        <documentation>A list of portfolio items</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="item" type="bkw:portfolioItem" minOccurs="1" maxOccurs="unbounded"/>
        </sequence>
      </complexType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:AddPortfolioItemsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation AddPortfolioItems
Diagram
Diagram schema_xsd.tmp#AddPortfolioItemsResponseType_status schema_xsd.tmp#AddPortfolioItemsResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="AddPortfolioItemsResponseType">
  <annotation>
    <documentation>Response type for operation AddPortfolioItems</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RemovePortfolioItemsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RemovePortfolioItems
Diagram
Diagram schema_xsd.tmp#RemovePortfolioItemsRequestType_username schema_xsd.tmp#RemovePortfolioItemsRequestType_password schema_xsd.tmp#RemovePortfolioItemsRequestType_authtoken schema_xsd.tmp#RemovePortfolioItemsRequestType_subscriptionId schema_xsd.tmp#RemovePortfolioItemsRequestType_items
Used by
Model
Children bkw:authtoken, bkw:items, bkw:password, bkw:subscriptionId, bkw:username
Source
 
<complexType name="RemovePortfolioItemsRequestType">
  <annotation>
    <documentation>Request type for operation RemovePortfolioItems</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="subscriptionId" type="bkw:resourceId">
      <annotation>
        <documentation>The subscription ID</documentation>
      </annotation>
    </element>
    <element name="items">
      <annotation>
        <documentation>A list of portfolio items</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="item" type="bkw:portfolioItem" minOccurs="1" maxOccurs="unbounded"/>
        </sequence>
      </complexType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RemovePortfolioItemsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RemovePortfolioItems
Diagram
Diagram schema_xsd.tmp#RemovePortfolioItemsResponseType_status schema_xsd.tmp#RemovePortfolioItemsResponseType_message
Used by
Model
Children bkw:message, bkw:status
Source
 
<complexType name="RemovePortfolioItemsResponseType">
  <annotation>
    <documentation>Response type for operation RemovePortfolioItems</documentation>
  </annotation>
  <sequence>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListPortfolioItemsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListPortfolioItems
Diagram
Diagram schema_xsd.tmp#ListPortfolioItemsRequestType_username schema_xsd.tmp#ListPortfolioItemsRequestType_password schema_xsd.tmp#ListPortfolioItemsRequestType_authtoken schema_xsd.tmp#ListPortfolioItemsRequestType_subscriptionId schema_xsd.tmp#ListPortfolioItemsRequestType_from schema_xsd.tmp#ListPortfolioItemsRequestType_to schema_xsd.tmp#ListPortfolioItemsRequestType_filters schema_xsd.tmp#ListPortfolioItemsRequestType_sort
Used by
Model
Children bkw:authtoken, bkw:filters, bkw:from, bkw:password, bkw:sort, bkw:subscriptionId, bkw:to, bkw:username
Source
 
<complexType name="ListPortfolioItemsRequestType">
  <annotation>
    <documentation>Request type for operation ListPortfolioItems</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token; used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="subscriptionId" type="bkw:requiredText">
      <annotation>
        <documentation>The subscription ID, of the form sub-xxxxxxxx password</documentation>
      </annotation>
    </element>
    <element name="from" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the first portfolio item to be returned, within the collection of all portfolio items matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="to" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The 1-based offset of the last portfolio item to be returned, within the collection of all portfolio items matching the search criteria; the search may return fewer portfolio items than requested</documentation>
      </annotation>
    </element>
    <element name="filters" type="bkw:searchFilterList" minOccurs="0">
      <annotation>
        <documentation>A list of search filters</documentation>
      </annotation>
    </element>
    <element name="sort" type="bkw:sortCriteria" minOccurs="0">
      <annotation>
        <documentation>The sort criteria</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListPortfolioItemsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListPortfolioItems
Diagram
Diagram schema_xsd.tmp#ListPortfolioItemsResponseType_results schema_xsd.tmp#ListPortfolioItemsResponseType_status schema_xsd.tmp#ListPortfolioItemsResponseType_message
Used by
Model
Children bkw:message, bkw:results, bkw:status
Source
 
<complexType name="ListPortfolioItemsResponseType">
  <annotation>
    <documentation>Response type for operation ListPortfolioItems</documentation>
  </annotation>
  <sequence>
    <element name="results" minOccurs="0">
      <annotation>
        <documentation>The search results</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="items" minOccurs="0">
            <annotation>
              <documentation>The list of portfolio items</documentation>
            </annotation>
            <complexType>
              <choice>
                <element name="item" type="bkw:portfolioItem" maxOccurs="unbounded"/>
              </choice>
            </complexType>
          </element>
          <element name="offset" type="xsd:positiveInteger" minOccurs="0">
            <annotation>
              <documentation>The 1-based offset of the first returned case, within the collection of all creditors matching the search criteria</documentation>
            </annotation>
          </element>
          <element name="total" type="xsd:nonNegativeInteger">
            <annotation>
              <documentation>The total number of creditors matching the search criteria</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CaseSummaryRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation CaseSummary
Diagram
Diagram schema_xsd.tmp#CaseSummaryRequestType_username schema_xsd.tmp#CaseSummaryRequestType_password schema_xsd.tmp#CaseSummaryRequestType_authtoken schema_xsd.tmp#CaseSummaryRequestType_district schema_xsd.tmp#CaseSummaryRequestType_extendedCaseNumber
Used by
Model
Children bkw:authtoken, bkw:district, bkw:extendedCaseNumber, bkw:password, bkw:username
Source
 
<complexType name="CaseSummaryRequestType">
  <annotation>
    <documentation>Request type for operation CaseSummary</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
      <annotation>
        <documentation>The extended case number</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:CaseSummaryResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation CaseSummary
Diagram
Diagram schema_xsd.tmp#CaseSummaryResponseType_case schema_xsd.tmp#CaseSummaryResponseType_status schema_xsd.tmp#CaseSummaryResponseType_message
Used by
Model
Children bkw:case, bkw:message, bkw:status
Source
 
<complexType name="CaseSummaryResponseType">
  <annotation>
    <documentation>Response type for operation CaseSummary</documentation>
  </annotation>
  <sequence>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>The case matching the search criteria</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListTrusteeCheckPaymentsRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation ListTrusteeCheckPayments
Diagram
Diagram schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_username schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_password schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_authtoken schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_serviceId schema_xsd.tmp#ListTrusteeCheckPaymentsRequestType_checkNumbers
Used by
Model
Children bkw:authtoken, bkw:checkNumbers, bkw:password, bkw:serviceId, bkw:username
Source
 
<complexType name="ListTrusteeCheckPaymentsRequestType">
  <annotation>
    <documentation>Request type for operation ListTrusteeCheckPayments</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="serviceId" type="bkw:requiredText">
      <annotation>
        <documentation>The trustee payment service ID, of the form ch13-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="checkNumbers">
      <annotation>
        <documentation>A comma-separated list of check numbers</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <pattern value="[a-zA-Z0-9]+(,[a-zA-Z0-9]+)*"/>
        </restriction>
      </simpleType>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:ListTrusteeCheckPaymentsResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation ListTrusteeCheckPayments
Diagram
Diagram schema_xsd.tmp#ListTrusteeCheckPaymentsResponseType_checks schema_xsd.tmp#ListTrusteeCheckPaymentsResponseType_status schema_xsd.tmp#ListTrusteeCheckPaymentsResponseType_message
Used by
Model
Children bkw:checks, bkw:message, bkw:status
Source
 
<complexType name="ListTrusteeCheckPaymentsResponseType">
  <annotation>
    <documentation>Response type for operation ListTrusteeCheckPayments</documentation>
  </annotation>
  <sequence>
    <element name="checks" minOccurs="0">
      <annotation>
        <documentation>A list of trustee checks</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="check" type="bkw:trusteeCheck" minOccurs="0" maxOccurs="unbounded"/>
        </sequence>
      </complexType>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunEcfCreditorListRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation RunEcfCreditorList
Diagram
Diagram schema_xsd.tmp#RunEcfCreditorListRequestType_username schema_xsd.tmp#RunEcfCreditorListRequestType_password schema_xsd.tmp#RunEcfCreditorListRequestType_authtoken schema_xsd.tmp#RunEcfCreditorListRequestType_district schema_xsd.tmp#RunEcfCreditorListRequestType_extendedCaseNumber schema_xsd.tmp#RunEcfCreditorListRequestType_ecfAccount
Used by
Model
Children bkw:authtoken, bkw:district, bkw:ecfAccount, bkw:extendedCaseNumber, bkw:password, bkw:username
Source
 
<complexType name="RunEcfCreditorListRequestType">
  <annotation>
    <documentation>Request type for operation RunEcfCreditorList</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
      <annotation>
        <documentation>The extended case number</documentation>
      </annotation>
    </element>
    <element name="ecfAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>A CM/ECF account id of a form pacer-xxxxxxxx</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:RunEcfCreditorListResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation RunEcfCreditorList
Diagram
Diagram schema_xsd.tmp#RunEcfCreditorListResponseType_case schema_xsd.tmp#RunEcfCreditorListResponseType_status schema_xsd.tmp#RunEcfCreditorListResponseType_message
Used by
Model
Children bkw:case, bkw:message, bkw:status
Source
 
<complexType name="RunEcfCreditorListResponseType">
  <annotation>
    <documentation>Response type for operation RunEcfCreditorList</documentation>
  </annotation>
  <sequence>
    <element name="case" type="bkw:case" minOccurs="0">
      <annotation>
        <documentation>A case containing a list of creditors with creditor numbers</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:AddCreditorRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation AddCreditor
Diagram
Diagram schema_xsd.tmp#AddCreditorRequestType_username schema_xsd.tmp#AddCreditorRequestType_password schema_xsd.tmp#AddCreditorRequestType_authtoken schema_xsd.tmp#AddCreditorRequestType_district schema_xsd.tmp#AddCreditorRequestType_extendedCaseNumber schema_xsd.tmp#AddCreditorRequestType_address schema_xsd.tmp#AddCreditorRequestType_ecfAccount
Used by
Model
Children bkw:address, bkw:authtoken, bkw:district, bkw:ecfAccount, bkw:extendedCaseNumber, bkw:password, bkw:username
Source
 
<complexType name="AddCreditorRequestType">
  <annotation>
    <documentation>Request type for operation AddCreditor</documentation>
  </annotation>
  <sequence>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
      <annotation>
        <documentation>The extended case number</documentation>
      </annotation>
    </element>
    <element name="address" type="bkw:requiredText">
      <annotation>
        <documentation>The creditor address</documentation>
      </annotation>
    </element>
    <element name="ecfAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>A CM/ECF account id of a form pacer-xxxxxxxx</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:AddCreditorResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation AddCreditor
Diagram
Diagram schema_xsd.tmp#AddCreditorResponseType_documents schema_xsd.tmp#AddCreditorResponseType_status schema_xsd.tmp#AddCreditorResponseType_message
Used by
Model
Children bkw:documents, bkw:message, bkw:status
Source
 
<complexType name="AddCreditorResponseType">
  <annotation>
    <documentation>Response type for operation AddCreditor</documentation>
  </annotation>
  <sequence>
    <element name="documents" type="bkw:documentList" minOccurs="0">
      <annotation>
        <documentation>A list of CM/ECF filing confirmations in HTML format</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:FileClaimRequestType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Request type for operation FileClaim
Diagram
Diagram schema_xsd.tmp#FileClaimRequestType_username schema_xsd.tmp#FileClaimRequestType_password schema_xsd.tmp#FileClaimRequestType_authtoken schema_xsd.tmp#FileClaimRequestType_district schema_xsd.tmp#FileClaimRequestType_extendedCaseNumber schema_xsd.tmp#FileClaimRequestType_creditorNumber schema_xsd.tmp#FileClaimRequestType_creditorAddress schema_xsd.tmp#FileClaimRequestType_paymentAddress schema_xsd.tmp#FileClaimRequestType_otherNames schema_xsd.tmp#FileClaimRequestType_previousCreditor schema_xsd.tmp#FileClaimRequestType_uci schema_xsd.tmp#FileClaimRequestType_claimNumber schema_xsd.tmp#FileClaimRequestType_claimDate schema_xsd.tmp#FileClaimRequestType_previousFiler schema_xsd.tmp#FileClaimRequestType_accountNumber schema_xsd.tmp#FileClaimRequestType_claimAmount schema_xsd.tmp#FileClaimRequestType_includesInterest schema_xsd.tmp#FileClaimRequestType_basisOfClaim schema_xsd.tmp#FileClaimRequestType_securedByRealEstate schema_xsd.tmp#FileClaimRequestType_securedByMotorVehicle schema_xsd.tmp#FileClaimRequestType_securedByOther schema_xsd.tmp#FileClaimRequestType_securedByDescription schema_xsd.tmp#FileClaimRequestType_basisForPerfection schema_xsd.tmp#FileClaimRequestType_propertyValue schema_xsd.tmp#FileClaimRequestType_securedAmount schema_xsd.tmp#FileClaimRequestType_unsecuredAmount schema_xsd.tmp#FileClaimRequestType_amountToCureDefault schema_xsd.tmp#FileClaimRequestType_interestRate schema_xsd.tmp#FileClaimRequestType_interestRateType schema_xsd.tmp#FileClaimRequestType_lease schema_xsd.tmp#FileClaimRequestType_amountToCureLeaseDefault schema_xsd.tmp#FileClaimRequestType_rightOfSetoff schema_xsd.tmp#FileClaimRequestType_domesticSupportObligationsAmount schema_xsd.tmp#FileClaimRequestType_depositsAmount schema_xsd.tmp#FileClaimRequestType_wagesSalariesCommissionAmount schema_xsd.tmp#FileClaimRequestType_taxesOrPenaltiesAmount schema_xsd.tmp#FileClaimRequestType_contributionsAmount schema_xsd.tmp#FileClaimRequestType_otherPriorityAmount schema_xsd.tmp#FileClaimRequestType_otherPrioritySubsection schema_xsd.tmp#FileClaimRequestType_attachments schema_xsd.tmp#FileClaimRequestType_signatureType schema_xsd.tmp#FileClaimRequestType_signatureAddress schema_xsd.tmp#FileClaimRequestType_mainDocument schema_xsd.tmp#FileClaimRequestType_ecfAccount
Used by
Model
Children bkw:accountNumber, bkw:amountToCureDefault, bkw:amountToCureLeaseDefault, bkw:attachments, bkw:authtoken, bkw:basisForPerfection, bkw:basisOfClaim, bkw:claimAmount, bkw:claimDate, bkw:claimNumber, bkw:contributionsAmount, bkw:creditorAddress, bkw:creditorNumber, bkw:depositsAmount, bkw:district, bkw:domesticSupportObligationsAmount, bkw:ecfAccount, bkw:extendedCaseNumber, bkw:includesInterest, bkw:interestRate, bkw:interestRateType, bkw:lease, bkw:mainDocument, bkw:otherNames, bkw:otherPriorityAmount, bkw:otherPrioritySubsection, bkw:password, bkw:paymentAddress, bkw:previousCreditor, bkw:previousFiler, bkw:propertyValue, bkw:rightOfSetoff, bkw:securedAmount, bkw:securedByDescription, bkw:securedByMotorVehicle, bkw:securedByOther, bkw:securedByRealEstate, bkw:signatureAddress, bkw:signatureType, bkw:taxesOrPenaltiesAmount, bkw:uci, bkw:unsecuredAmount, bkw:username, bkw:wagesSalariesCommissionAmount
Source
 
<complexType name="FileClaimRequestType">
  <annotation>
    <documentation>Request type for operation FileClaim</documentation>
  </annotation>
  <all>
    <element name="username" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch username</documentation>
      </annotation>
    </element>
    <element name="password" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The BankruptcyWatch password</documentation>
      </annotation>
    </element>
    <element name="authtoken" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The authentication token, used in place of a username and password</documentation>
      </annotation>
    </element>
    <element name="district" type="bkw:district">
      <annotation>
        <documentation>The district</documentation>
      </annotation>
    </element>
    <element name="extendedCaseNumber" type="bkw:extendedCaseNumber">
      <annotation>
        <documentation>The extended case number</documentation>
      </annotation>
    </element>
    <element name="creditorNumber" type="bkw:creditorNumber" minOccurs="0">
      <annotation>
        <documentation>The creditor number, if the creditor has already been added to the case. Exactly one of the elements "creditorNumber" and "creditorName" must be provided.</documentation>
      </annotation>
    </element>
    <element name="creditorAddress" type="bkw:address" minOccurs="0">
      <annotation>
        <documentation>The creditor address. If the element "creditorNumber", is present, the address must consist of just "phone1" and "email" address elements. Otherwise, the two elements must be present together with a complete street address and personal name or organization.</documentation>
      </annotation>
    </element>
    <element name="paymentAddress" type="bkw:address" minOccurs="0">
      <annotation>
        <documentation>The address to which payments should be sent, if different from the address to which notices should be sent</documentation>
      </annotation>
    </element>
    <element name="otherNames" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Other names the creditor used with the debtor</documentation>
      </annotation>
    </element>
    <element name="previousCreditor" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The entity from whom claim has been acquired, if applicable</documentation>
      </annotation>
    </element>
    <element name="uci" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Te uiform claim identifier for electronic payments in chapter 13</documentation>
      </annotation>
    </element>
    <element name="claimNumber" type="xsd:positiveInteger" minOccurs="0">
      <annotation>
        <documentation>The claim number of original claim, if the claim being filed is an amendment</documentation>
      </annotation>
    </element>
    <element name="claimDate" type="xsd:date" minOccurs="0">
      <annotation>
        <documentation>The date on which original claim was filed, if the claim being filed is an amendment</documentation>
      </annotation>
    </element>
    <element name="previousFiler" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>The person or entity that previously filed a proof of claim for the claim, if applicable</documentation>
      </annotation>
    </element>
    <element name="accountNumber" minOccurs="0">
      <annotation>
        <documentation>The last 4 digits of the account number used to identify the debtor, if any</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <pattern value="[0-9a-zA-Z]{4}"/>
        </restriction>
      </simpleType>
    </element>
    <element name="claimAmount" type="bkw:dollarValue">
      <annotation>
        <documentation>The amount of the claim</documentation>
      </annotation>
    </element>
    <element name="includesInterest" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>true if claim amount includes interest or other charges</documentation>
      </annotation>
    </element>
    <element name="basisOfClaim" minOccurs="0">
      <annotation>
        <documentation>The basis of the claim</documentation>
      </annotation>
    </element>
    <element name="securedByRealEstate" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>True if the claim is secured by real estate</documentation>
      </annotation>
    </element>
    <element name="securedByMotorVehicle" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>True if the claim is secured by one or more motor vehicles</documentation>
      </annotation>
    </element>
    <element name="securedByOther" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>True if the claim is secured by property other than real estate or motor vehicles</documentation>
      </annotation>
    </element>
    <element name="securedByDescription" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Description of property other than real estate or motor vehicles securing claim</documentation>
      </annotation>
    </element>
    <element name="basisForPerfection" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Basis for perfection of claim, if claim is secured</documentation>
      </annotation>
    </element>
    <element name="propertyValue" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>The value of the property securing the claim, if claim is secured</documentation>
      </annotation>
    </element>
    <element name="securedAmount" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Amount of the claim that is secured, if claim is secured</documentation>
      </annotation>
    </element>
    <element name="unsecuredAmount" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Amount of the claim that is unsecured, if claim is secured</documentation>
      </annotation>
    </element>
    <element name="amountToCureDefault" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Amount necessary to cure any default as of the date of the petition, if claim is secured</documentation>
      </annotation>
    </element>
    <element name="interestRate" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>Annual interest rate, if claim is secured</documentation>
      </annotation>
    </element>
    <element name="interestRateType" minOccurs="0">
      <annotation>
        <documentation>Type of interest rate, if claim is secured</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <enumeration value="FIXED">
            <annotation>
              <documentation>Fixed</documentation>
            </annotation>
          </enumeration>
          <enumeration value="VARIABLE">
            <annotation>
              <documentation>Variable</documentation>
            </annotation>
          </enumeration>
        </restriction>
      </simpleType>
    </element>
    <element name="lease" type="xsd:boolean" minOccurs="0">
      <annotation>
        <documentation>true if claim is based on lease</documentation>
      </annotation>
    </element>
    <element name="amountToCureLeaseDefault" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>Amount necessary to cure any default as of the date of the petition</documentation>
      </annotation>
    </element>
    <element name="rightOfSetoff" type="bkw:requiredText" minOccurs="0">
      <annotation>
        <documentation>Description of the property associated with the right of setoff, if applicable</documentation>
      </annotation>
    </element>
    <element name="domesticSupportObligationsAmount" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(1)(A) or (a)(1)(B), if any</documentation>
      </annotation>
    </element>
    <element name="depositsAmount" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(7), if any</documentation>
      </annotation>
    </element>
    <element name="wagesSalariesCommissionAmount" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(4), if any</documentation>
      </annotation>
    </element>
    <element name="taxesOrPenaltiesAmount" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(8), if any</documentation>
      </annotation>
    </element>
    <element name="contributionsAmount" type="bkw:dollarValue" minOccurs="0">
      <annotation>
        <documentation>The amount of the claim that is entitled to priority under 11 U.S.C.&#xA7;507(a)(5), if any</documentation>
      </annotation>
    </element>
    <element name="otherPriorityAmount" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The amount of the claim that is entitled to priority under a subsection of 11 U.S.C.&#xA7;507(a) not specified above, if any</documentation>
      </annotation>
    </element>
    <element name="otherPrioritySubsection" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>The subsection of 11 U.S.C.&#xA7;507(a) not specified above under which all or part of the claim is entitled to priority, if any</documentation>
      </annotation>
    </element>
    <element name="attachments" type="xsd:string" minOccurs="0">
      <annotation>
        <documentation>A comma-separated list of document IDs</documentation>
      </annotation>
    </element>
    <element name="signatureType" minOccurs="0">
      <annotation>
        <documentation>The role of the person signing the form</documentation>
      </annotation>
      <simpleType>
        <restriction base="xsd:string">
          <enumeration value="CREDITOR">
            <annotation>
              <documentation>Signer is the creditor</documentation>
            </annotation>
          </enumeration>
          <enumeration value="CREDITOR_ATTORNEY">
            <annotation>
              <documentation>Signer is the creditor's attorney or authorized agent</documentation>
            </annotation>
          </enumeration>
          <enumeration value="GUARANTOR">
            <annotation>
              <documentation>Signer is a guarantor, surety, endorser, or other codebtor</documentation>
            </annotation>
          </enumeration>
        </restriction>
      </simpleType>
    </element>
    <element name="signatureAddress" type="bkw:address" minOccurs="0">
      <annotation>
        <documentation>The address of the person signing the form. Personal name, street address, email, and phone1 are required.</documentation>
      </annotation>
    </element>
    <element name="mainDocument" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>The proof of claim form to be filed with the court, if any, as an identifier of the form doc-xxxxxxxx</documentation>
      </annotation>
    </element>
    <element name="ecfAccount" type="bkw:resourceId" minOccurs="0">
      <annotation>
        <documentation>A CM/ECF account id of a form pacer-xxxxxxxx</documentation>
      </annotation>
    </element>
  </all>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
Complex Type bkw:FileClaimResponseType
Namespace http://www.bkwservice.com/api/2020-07-01
Annotations
 
Response type for operation FileClaim
Diagram
Diagram schema_xsd.tmp#FileClaimResponseType_documents schema_xsd.tmp#FileClaimResponseType_status schema_xsd.tmp#FileClaimResponseType_message
Used by
Model
Children bkw:documents, bkw:message, bkw:status
Source
 
<complexType name="FileClaimResponseType">
  <annotation>
    <documentation>Response type for operation FileClaim</documentation>
  </annotation>
  <sequence>
    <element name="documents" type="bkw:documentList" minOccurs="0">
      <annotation>
        <documentation>A list of filed documents in PDF format and CM/ECF filing confirmations in HTML format</documentation>
      </annotation>
    </element>
    <element name="status" type="bkw:statusCode">
      <annotation>
        <documentation>Status of the operation</documentation>
      </annotation>
    </element>
    <element name="message" type="xsd:string">
      <annotation>
        <documentation>Brief message explaining the status</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>
Schema location file:/www/devdocs.bk.watch/www/api/2020-07-01/schema/schema.xsd
XML Schema documentation generated by ® XML Editor.