{"components":{"schemas":{"class_browsing_request_derwent_api":{"properties":{"params":{"items":{"properties":{"class-levels":{"description":"Requested classification level","example":"1","type":"string"},"classes":{"description":"Requested class code to be browsed","example":"A01","type":"string"},"type":{"description":"Requested classification type","example":"ipc8","type":"string"}},"required":["class-levels","classes","type"],"type":"object"},"type":"array"}},"type":"object"},"class_search_request_derwent_api":{"properties":{"params":{"items":{"properties":{"query":{"description":"Requested classification level","example":"ti=neem","type":"string"},"type":{"description":"Requested classification type","example":"ipc8","type":"string"}},"required":["query","type"],"type":"object"},"type":"array"}},"type":"object"},"combined_search_request_derwent_api":{"properties":{"params":{"items":{"properties":{"collections1":{"description":"Requested Collection(s) number 1","example":"usapps,usgrants,woapps","type":"string"},"collections2":{"description":"Requested Collection(s) number 2","example":"epapps,epgrants","type":"string"},"collections3":{"description":"Requested Collection(s) number 3","example":"usapps","type":"string"},"combination":{"description":"Combination of all the requested query using boolean operators","example":"($1 AND $2 OR S3)","type":"string"},"offset":{"description":"Starting range of the documents to be fetched","example":0,"type":"number"},"query1":{"description":"Requested query number 1","example":"pd>=(20180101)","type":"string"},"query2":{"description":"Requested query number 2","example":"pac=IN","type":"string"},"query3":{"description":"Requested query number 3","example":"pa=*US","type":"string"},"return-fields":{"description":"Requested resultset field(s)","example":"pn,pd","type":"string"},"search-on-datatype1":{"description":"Requested search-on-datatype number 1","example":"fld","type":"string"},"search-on-datatype2":{"description":"Requested search-on-datatype number 2","example":"fld","type":"string"},"search-on-datatype3":{"description":"Requested search-on-datatype number 3","example":"fld_dwpi","type":"string"},"size":{"description":"Number of the documents to be fetched","example":3,"type":"number"}},"required":["collections1","query1","collections2","query2"],"type":"object"},"type":"array"}},"type":"object"},"corporate_tree_request_derwent_api":{"properties":{"params":{"items":{"properties":{"code":{"description":"Requested corporate code","example":"ARCO","type":"string"},"terms":{"description":"Requested corporate terms","example":"Microsoft","type":"string"}},"required":["code","terms"],"type":"object"},"type":"array"}},"type":"object"},"derwent_images_request":{"properties":{"drawings":{"description":"Alias for fponly.","example":1,"type":"integer"},"dwpi":{"description":"0 for front page DWPI image, 1 for all DWPI images.","example":1,"type":"integer"},"format":{"default":"gif","description":"Image format requested from CLIPS.","example":"gif","type":"string"},"fponly":{"description":"Front-page image flag.","example":1,"type":"integer"},"params":{"items":{"properties":{"ids":{"description":"Requested document ids. Provide either ids or pn, not both.","example":"EP4451620A120241023","type":"string"},"pn":{"description":"Requested patent numbers. Provide either pn or ids, not both.","example":"EP4451620A1","type":"string"}},"type":"object"},"type":"array"},"size":{"default":380,"description":"Requested image size.","type":"integer"},"type":{"description":"Image type. Use 'normal' or 'inline'.","example":"inline","type":"string"},"wrap":{"default":true,"description":"Return IP API wrapper URLs when true.","type":"boolean"}},"required":["params"],"type":"object"},"doc_idmapping_request_derwent_api":{"properties":{"params":{"items":{"properties":{"collections":{"description":"Requested Collection(s)","example":"arapps, arutils, apgrants, amgrants, auapps, augrants, auinnov, atapps, atgrants, atutils, bygrants, byutils, beapps, begrants, brapps, brgrants, brutils, bgapps, bggrants, bgutils, caapps, cagrants, cnapps, cngrants, cnutils, coapps, crapps, crutils, hrapps, hrgrants, hrutils, cuapps, cugrants, czapps, czgrants, czutils, csgrants, dkapps, dkgrants, dkutils, epapps, epgrants, eeapps, eegrants, eeutils, eagrants, fiapps, figrants, frapps, frgrants, gegrants, ddapps, ddgrants, deapps, degrants, deutils, gbapps, gbgrants, grapps, grgrants, gcgrants, hkapps, hkgrants, hkutils, hugrants, isgrants, inapps, ingrants, idapps, idsimple, ieapps, iegrants, ieutils, ilgrants, itgrants, jpapps, jpgrants, jputils, krapps, krgrants, krutils, lvgrants, ltgrants, luapps, lugrants, myapps, mygrants, mxapps, mxgrants, mdgrants, mdutils, mcgrants, mngrants, mnutils, maapps, magrants, nlapps, nlgrants, nzgrants, noapps, nogrants, oagrants, phapps, phgrants, phutils, plgrants, plutils, ptapps, ptgrants, ptutils, roapps, rogrants, routils, ruapps, rugrants, ruutils, saapps, sagrants, rsapps, rsgrants, rsutils, sgapps, sggrants, skapps, skgrants, skutils, sigrants, siutils, zaapps, sugrants, esapps, esgrants, esutils, seapps, segrants, chapps, chgrants, twapps, twgrants, twutils, thapps, thgrants, thutils, tnapps, trapps, trgrants, trutils, uagrants, uautils, usapps, usgrants, uyapps, vnapps, vngrants, vnutils, woapps, derwent, inpadoc","type":"string"},"pns":{"description":"Requested patent numbers","example":"EP4451620A1","type":"string"}},"required":["collections","pns"],"type":"object"},"type":"array"}},"type":"object"},"document_availability_request_caselaw":{"properties":{"GUIDS":{"description":"Documents to check","items":{"description":"Unique ID of caselaw document","example":"2706413","type":"string"},"type":"array"},"SINCE_LAST_UPDATED":{"description":"Show only documents updated since this date","example":"2023-07-23","format":"date","type":"string"}},"type":"object"},"document_availability_request_patent":{"properties":{"collection":{"description":"Requested Collection","items":{"description":"Derwent Abstract Journal(DAJ)|Patent abstract Journal(PAJ)","example":"DAJ|PAJ","type":"string"},"type":"array"},"input_type":{"description":"Type of input patents list","items":{"description":"Type of patents - Publication Number( default patent) or Accession Number (dwpan)","example":"patent|dwpan","type":"string"},"type":"array"},"patents":{"description":"Patents to check","example":["JP51021981B(197002753R)","US3201444A(196617885F)"],"items":{"description":"List of Publication numbers or Accession numbers for patent","example":"JP51021981B(197002753R)","type":"string"},"type":"array"}},"type":"object"},"document_by_ids_request_derwent_api":{"properties":{"params":{"items":{"properties":{"collections":{"description":"Requested Collection(s)","example":"arapps, arutils, apgrants, amgrants, auapps, augrants, auinnov, atapps, atgrants, atutils, bygrants, byutils, beapps, begrants, brapps, brgrants, brutils, bgapps, bggrants, bgutils, caapps, cagrants, cnapps, cngrants, cnutils, coapps, crapps, crutils, hrapps, hrgrants, hrutils, cuapps, cugrants, czapps, czgrants, czutils, csgrants, dkapps, dkgrants, dkutils, epapps, epgrants, eeapps, eegrants, eeutils, eagrants, fiapps, figrants, frapps, frgrants, gegrants, ddapps, ddgrants, deapps, degrants, deutils, gbapps, gbgrants, grapps, grgrants, gcgrants, hkapps, hkgrants, hkutils, hugrants, isgrants, inapps, ingrants, idapps, idsimple, ieapps, iegrants, ieutils, ilgrants, itgrants, jpapps, jpgrants, jputils, krapps, krgrants, krutils, lvgrants, ltgrants, luapps, lugrants, myapps, mygrants, mxapps, mxgrants, mdgrants, mdutils, mcgrants, mngrants, mnutils, maapps, magrants, nlapps, nlgrants, nzgrants, noapps, nogrants, oagrants, phapps, phgrants, phutils, plgrants, plutils, ptapps, ptgrants, ptutils, roapps, rogrants, routils, ruapps, rugrants, ruutils, saapps, sagrants, rsapps, rsgrants, rsutils, sgapps, sggrants, skapps, skgrants, skutils, sigrants, siutils, zaapps, sugrants, esapps, esgrants, esutils, seapps, segrants, chapps, chgrants, twapps, twgrants, twutils, thapps, thgrants, thutils, tnapps, trapps, trgrants, trutils, uagrants, uautils, usapps, usgrants, uyapps, vnapps, vngrants, vnutils, woapps, derwent, inpadoc","type":"string"},"ids":{"description":"Requested document ids","example":"EP4451620A120241023","type":"string"},"return-fields":{"description":"Requested retrieve-field(s)","example":"pn,pd","type":"string"}},"required":["collections","ids"],"type":"object"},"type":"array"}},"type":"object"},"document_by_listref_request_derwent_api":{"properties":{"params":{"items":{"properties":{"collections":{"description":"Requested Collection(s)","example":"usapps,usgrants,epapps,epgrants,woapps","type":"string"},"listref":{"description":"Reference of a resultset","example":"1770538450897-bi9q63lce0N","type":"string"},"offset":{"description":"Starting range of the documents to be fetched","example":0,"type":"number"},"return-fields":{"description":"Requested resultset field(s)","example":"pn,pd","type":"string"},"size":{"description":"Number of the documents to be fetched","example":3,"type":"number"}},"required":["collections","listref"],"type":"object"},"type":"array"}},"type":"object"},"document_by_pns_request_derwent_api":{"properties":{"params":{"items":{"properties":{"collections":{"description":"Requested Collection(s)","example":"arapps, arutils, apgrants, amgrants, auapps, augrants, auinnov, atapps, atgrants, atutils, bygrants, byutils, beapps, begrants, brapps, brgrants, brutils, bgapps, bggrants, bgutils, caapps, cagrants, cnapps, cngrants, cnutils, coapps, crapps, crutils, hrapps, hrgrants, hrutils, cuapps, cugrants, czapps, czgrants, czutils, csgrants, dkapps, dkgrants, dkutils, epapps, epgrants, eeapps, eegrants, eeutils, eagrants, fiapps, figrants, frapps, frgrants, gegrants, ddapps, ddgrants, deapps, degrants, deutils, gbapps, gbgrants, grapps, grgrants, gcgrants, hkapps, hkgrants, hkutils, hugrants, isgrants, inapps, ingrants, idapps, idsimple, ieapps, iegrants, ieutils, ilgrants, itgrants, jpapps, jpgrants, jputils, krapps, krgrants, krutils, lvgrants, ltgrants, luapps, lugrants, myapps, mygrants, mxapps, mxgrants, mdgrants, mdutils, mcgrants, mngrants, mnutils, maapps, magrants, nlapps, nlgrants, nzgrants, noapps, nogrants, oagrants, phapps, phgrants, phutils, plgrants, plutils, ptapps, ptgrants, ptutils, roapps, rogrants, routils, ruapps, rugrants, ruutils, saapps, sagrants, rsapps, rsgrants, rsutils, sgapps, sggrants, skapps, skgrants, skutils, sigrants, siutils, zaapps, sugrants, esapps, esgrants, esutils, seapps, segrants, chapps, chgrants, twapps, twgrants, twutils, thapps, thgrants, thutils, tnapps, trapps, trgrants, trutils, uagrants, uautils, usapps, usgrants, uyapps, vnapps, vngrants, vnutils, woapps, derwent, inpadoc","type":"string"},"pns":{"description":"Requested patent numbers","example":"EP4451620A1","type":"string"},"return-fields":{"description":"Requested retrieve-field(s)","example":"pn,pd","type":"string"}},"required":["collections","pns"],"type":"object"},"type":"array"}},"type":"object"},"document_pdf_request_derwent_api_post":{"properties":{"params":{"description":"PDF request parameters","items":{"properties":{"pns":{"description":"Requested patent numbers. Accepts a comma-separated string or list.","example":"US20110094542A1,US12368967B2","type":"string"}},"required":["pns"],"type":"object"},"type":"array"},"wrap":{"description":"When true, return wrapped IP-API URLs instead of direct DocDel URLs.","example":"true","type":"string"}},"required":["params"],"type":"object"},"document_pdf_response_derwent_api_post":{"properties":{"available":{"description":"Available PDF URLs","items":{"properties":{"pn":{"description":"Requested patent number","example":"US12368967B2","type":"string"},"url":{"description":"Returned PDF URL.","example":"https://api.clarivate.com/patents/derwent/document/pdf/file?patent=US12368967B2&token=example-token","type":"string"}},"required":["pn","url"],"type":"object"},"type":"array"},"unavailable":{"description":"Requested patent numbers that are unavailable","items":{"description":"Requested patent numbers that are unavailable","example":"BADPN123","type":"string"},"type":"array"}},"required":["available"],"type":"object"},"field_aliases_caselaw":{"properties":{"AREA":{"description":"Alias for AREA","example":"AREA_ALIAS","type":"string"},"BINDER_ID":{"description":"Alias for BINDER_ID","example":"BINDER_ID_ALIAS","type":"string"},"CASE_DOMAIN":{"description":"Alias for CASE_DOMAIN","example":"CASE_DOMAIN_ALIAS","type":"string"},"CASE_NAME":{"description":"Alias for CASE_NAME","example":"CASE_NAME_ALIAS","type":"string"},"CASE_RESOLUTION":{"description":"Alias for CASE_RESOLUTION","example":"CASE_RESOLUTION_ALIAS","type":"string"},"CASE_STAGE":{"description":"Alias for CASE_STAGE","example":"CASE_STAGE_ALIAS","type":"string"},"CASE_STATUS":{"description":"Alias for CASE_STATUS","example":"CASE_STATUS_ALIAS","type":"string"},"CLAIM_CONSTRUCTION_AGREED":{"description":"Alias for CLAIM_CONSTRUCTION_AGREED","example":"CLAIM_CONSTRUCTION_AGREED_ALIAS","type":"string"},"CLAIM_CONSTRUCTION_DEFINITION":{"description":"Alias for CLAIM_CONSTRUCTION_DEFINITION","example":"CLAIM_CONSTRUCTION_DEFINITION_ALIAS","type":"string"},"CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION":{"description":"Alias for CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION","example":"CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION_ALIAS","type":"string"},"CLAIM_CONSTRUCTION_NOT_NECESSARY":{"description":"Alias for CLAIM_CONSTRUCTION_NOT_NECESSARY","example":"CLAIM_CONSTRUCTION_NOT_NECESSARY_ALIAS","type":"string"},"CLAIM_CONSTRUCTION_TERM":{"description":"Alias for CLAIM_CONSTRUCTION_TERM","example":"CLAIM_CONSTRUCTION_TERM_ALIAS","type":"string"},"CLOSED":{"description":"Alias for CLOSED","example":"CLOSED_ALIAS","type":"string"},"COPYRIGHT_ANONYMOUS":{"description":"Alias for COPYRIGHT_ANONYMOUS","example":"COPYRIGHT_ANONYMOUS_ALIAS","type":"string"},"COPYRIGHT_DESCRIPTION":{"description":"Alias for COPYRIGHT_DESCRIPTION","example":"COPYRIGHT_DESCRIPTION_ALIAS","type":"string"},"COPYRIGHT_ROLE":{"description":"Alias for COPYRIGHT_ROLE","example":"COPYRIGHT_ROLE_ALIAS","type":"string"},"COPYRIGHT_TITLE":{"description":"Alias for COPYRIGHT_TITLE","example":"COPYRIGHT_TITLE_ALIAS","type":"string"},"COPYRIGHT_TYPE":{"description":"Alias for COPYRIGHT_TYPE","example":"COPYRIGHT_TYPE_ALIAS","type":"string"},"DAMAGE_AMOUNT":{"description":"Alias for DAMAGE_AMOUNT","example":"DAMAGE_AMOUNT_ALIAS","type":"string"},"DAMAGE_CALCULATION_METHOD":{"description":"Alias for DAMAGE_CALCULATION_METHOD","example":"DAMAGE_CALCULATION_METHOD_ALIAS","type":"string"},"DAMAGE_CURRENCY":{"description":"Alias for DAMAGE_CURRENCY","example":"DAMAGE_CURRENCY_ALIAS","type":"string"},"DAMAGE_CURRENT_CNY_EQUIVALENT":{"description":"Alias for DAMAGE_CURRENT_CNY_EQUIVALENT","example":"DAMAGE_CURRENT_CNY_EQUIVALENT_ALIAS","type":"string"},"DAMAGE_CURRENT_EUR_EQUIVALENT":{"description":"Alias for DAMAGE_CURRENT_EUR_EQUIVALENT","example":"DAMAGE_CURRENT_EUR_EQUIVALENT_ALIAS","type":"string"},"DAMAGE_CURRENT_USD_EQUIVALENT":{"description":"Alias for DAMAGE_CURRENT_USD_EQUIVALENT","example":"DAMAGE_CURRENT_USD_EQUIVALENT_ALIAS","type":"string"},"DAMAGE_LATER":{"description":"Alias for DAMAGE_LATER","example":"DAMAGE_LATER_ALIAS","type":"string"},"DAMAGE_NATURE":{"description":"Alias for DAMAGE_NATURE","example":"DAMAGE_NATURE_ALIAS","type":"string"},"DAMAGE_PARTIAL":{"description":"Alias for DAMAGE_PARTIAL","example":"DAMAGE_PARTIAL_ALIAS","type":"string"},"DAMAGE_REQUESTED":{"description":"Alias for DAMAGE_REQUESTED","example":"DAMAGE_REQUESTED_ALIAS","type":"string"},"DESIGN_ANONYMOUS":{"description":"Alias for DESIGN_ANONYMOUS","example":"DESIGN_ANONYMOUS_ALIAS","type":"string"},"DESIGN_LOCARNO_CLASS":{"description":"Alias for DESIGN_LOCARNO_CLASS","example":"DESIGN_LOCARNO_CLASS_ALIAS","type":"string"},"DESIGN_PRODUCT":{"description":"Alias for DESIGN_PRODUCT","example":"DESIGN_PRODUCT_ALIAS","type":"string"},"DESIGN_PRODUCT_LANGUAGE":{"description":"Alias for DESIGN_PRODUCT_LANGUAGE","example":"DESIGN_PRODUCT_LANGUAGE_ALIAS","type":"string"},"DESIGN_REGISTRATION_NUMBER":{"description":"Alias for DESIGN_REGISTRATION_NUMBER","example":"DESIGN_REGISTRATION_NUMBER_ALIAS","type":"string"},"DESIGN_REGISTRATION_OFFICE":{"description":"Alias for DESIGN_REGISTRATION_OFFICE","example":"DESIGN_REGISTRATION_OFFICE_ALIAS","type":"string"},"DESIGN_REGISTRATION_STATUS":{"description":"Alias for DESIGN_REGISTRATION_STATUS","example":"DESIGN_REGISTRATION_STATUS_ALIAS","type":"string"},"DESIGN_ROLE":{"description":"Alias for DESIGN_ROLE","example":"DESIGN_ROLE_ALIAS","type":"string"},"DESIGN_VERBAL_ELEMENT":{"description":"Alias for DESIGN_VERBAL_ELEMENT","example":"DESIGN_VERBAL_ELEMENT_ALIAS","type":"string"},"DESIGN_VIENNA_CLASS":{"description":"Alias for DESIGN_VIENNA_CLASS","example":"DESIGN_VIENNA_CLASS_ALIAS","type":"string"},"DOCKET_COURT_AREA":{"description":"Alias for DOCKET_COURT_AREA","example":"DOCKET_COURT_AREA_ALIAS","type":"string"},"DOCKET_COURT_COUNTRY":{"description":"Alias for DOCKET_COURT_COUNTRY","example":"DOCKET_COURT_COUNTRY_ALIAS","type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2":{"description":"Alias for DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","example":"DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2_ALIAS","type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3":{"description":"Alias for DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","example":"DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3_ALIAS","type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_TEXT":{"description":"Alias for DOCKET_COURT_COUNTRY_DERIVED_TEXT","example":"DOCKET_COURT_COUNTRY_DERIVED_TEXT_ALIAS","type":"string"},"DOCKET_COURT_COUNTRY_TEXT":{"description":"Alias for DOCKET_COURT_COUNTRY_TEXT","example":"DOCKET_COURT_COUNTRY_TEXT_ALIAS","type":"string"},"DOCKET_COURT_NAME":{"description":"Alias for DOCKET_COURT_NAME","example":"DOCKET_COURT_NAME_ALIAS","type":"string"},"DOCKET_COURT_PATH":{"description":"Alias for DOCKET_COURT_PATH","example":"DOCKET_COURT_PATH_ALIAS","type":"string"},"DOCKET_COURT_TYPE_ADMINISTRATIVE":{"description":"Alias for DOCKET_COURT_TYPE_ADMINISTRATIVE","example":"DOCKET_COURT_TYPE_ADMINISTRATIVE_ALIAS","type":"string"},"DOCKET_COURT_TYPE_ARBITRATION":{"description":"Alias for DOCKET_COURT_TYPE_ARBITRATION","example":"DOCKET_COURT_TYPE_ARBITRATION_ALIAS","type":"string"},"DOCKET_COURT_TYPE_JUDICIAL":{"description":"Alias for DOCKET_COURT_TYPE_JUDICIAL","example":"DOCKET_COURT_TYPE_JUDICIAL_ALIAS","type":"string"},"DOCKET_REFERENCE":{"description":"Alias for DOCKET_REFERENCE","example":"DOCKET_REFERENCE_ALIAS","type":"string"},"DOCUMENT_CITABLE":{"description":"Alias for DOCUMENT_CITABLE","example":"DOCUMENT_CITABLE_ALIAS","type":"string"},"DOCUMENT_CITATION_REFERENCE":{"description":"Alias for DOCUMENT_CITATION_REFERENCE","example":"DOCUMENT_CITATION_REFERENCE_ALIAS","type":"string"},"DOCUMENT_DATE":{"description":"Alias for DOCUMENT_DATE","example":"DOCUMENT_DATE_ALIAS","type":"string"},"DOCUMENT_DECLARATORY":{"description":"Alias for DOCUMENT_DECLARATORY","example":"DOCUMENT_DECLARATORY_ALIAS","type":"string"},"DOCUMENT_DEFAULT_JUDGEMENT":{"description":"Alias for DOCUMENT_DEFAULT_JUDGEMENT","example":"DOCUMENT_DEFAULT_JUDGEMENT_ALIAS","type":"string"},"DOCUMENT_LEVEL":{"description":"Alias for DOCUMENT_LEVEL","example":"DOCUMENT_LEVEL_ALIAS","type":"string"},"DOCUMENT_REFUSAL":{"description":"Alias for DOCUMENT_REFUSAL","example":"DOCUMENT_REFUSAL_ALIAS","type":"string"},"DOCUMENT_STATE":{"description":"Alias for DOCUMENT_STATE","example":"DOCUMENT_STATE_ALIAS","type":"string"},"DOCUMENT_SUBTYPE":{"description":"Alias for DOCUMENT_SUBTYPE","example":"DOCUMENT_SUBTYPE_ALIAS","type":"string"},"DOCUMENT_TRADEMARK_REPUTATION":{"description":"Alias for DOCUMENT_TRADEMARK_REPUTATION","example":"DOCUMENT_TRADEMARK_REPUTATION_ALIAS","type":"string"},"DOCUMENT_TYPE":{"description":"Alias for DOCUMENT_TYPE","example":"DOCUMENT_TYPE_ALIAS","type":"string"},"DOCUMENT_WINNER":{"description":"Alias for DOCUMENT_WINNER","example":"DOCUMENT_WINNER_ALIAS","type":"string"},"DOMAIN_IS_COPYRIGHT":{"description":"Alias for DOMAIN_IS_COPYRIGHT","example":"DOMAIN_IS_COPYRIGHT_ALIAS","type":"string"},"DOMAIN_IS_DESIGN_MODEL":{"description":"Alias for DOMAIN_IS_DESIGN_MODEL","example":"DOMAIN_IS_DESIGN_MODEL_ALIAS","type":"string"},"DOMAIN_IS_DOMAIN_NAME":{"description":"Alias for DOMAIN_IS_DOMAIN_NAME","example":"DOMAIN_IS_DOMAIN_NAME_ALIAS","type":"string"},"DOMAIN_IS_OTHER":{"description":"Alias for DOMAIN_IS_OTHER","example":"DOMAIN_IS_OTHER_ALIAS","type":"string"},"DOMAIN_IS_PATENT":{"description":"Alias for DOMAIN_IS_PATENT","example":"DOMAIN_IS_PATENT_ALIAS","type":"string"},"DOMAIN_IS_TRADEMARK":{"description":"Alias for DOMAIN_IS_TRADEMARK","example":"DOMAIN_IS_TRADEMARK_ALIAS","type":"string"},"DOMAIN_IS_UNFAIR_COMPETITION":{"description":"Alias for DOMAIN_IS_UNFAIR_COMPETITION","example":"DOMAIN_IS_UNFAIR_COMPETITION_ALIAS","type":"string"},"DOMAIN_NAME":{"description":"Alias for DOMAIN_NAME","example":"DOMAIN_NAME_ALIAS","type":"string"},"DOMAIN_NAME_ANONYMOUS":{"description":"Alias for DOMAIN_NAME_ANONYMOUS","example":"DOMAIN_NAME_ANONYMOUS_ALIAS","type":"string"},"DOMAIN_NAME_ROLE":{"description":"Alias for DOMAIN_NAME_ROLE","example":"DOMAIN_NAME_ROLE_ALIAS","type":"string"},"DOMAIN_NAME_TLD":{"description":"Alias for DOMAIN_NAME_TLD","example":"DOMAIN_NAME_TLD_ALIAS","type":"string"},"EARLIEST_EVENT_DATE":{"description":"Alias for EARLIEST_EVENT_DATE","example":"EARLIEST_EVENT_DATE_ALIAS","type":"string"},"EU_TRADEMARK":{"description":"Alias for EU_TRADEMARK","example":"EU_TRADEMARK_ALIAS","type":"string"},"EX_OFFICIO":{"description":"Alias for EX_OFFICIO","example":"EX_OFFICIO_ALIAS","type":"string"},"FIRST_ACTION_DATE":{"description":"Alias for FIRST_ACTION_DATE","example":"FIRST_ACTION_DATE_ALIAS","type":"string"},"FIRST_ACTION_TYPE":{"description":"Alias for FIRST_ACTION_TYPE","example":"FIRST_ACTION_TYPE_ALIAS","type":"string"},"GUID":{"description":"Alias for GUID","example":"GUID_ALIAS","type":"string"},"IPC_CLASS_CODE":{"description":"Alias for IPC_CLASS_CODE","example":"IPC_CLASS_CODE_ALIAS","type":"string"},"IPC_CLASS_INDUSTRY_AREA":{"description":"Alias for IPC_CLASS_INDUSTRY_AREA","example":"IPC_CLASS_INDUSTRY_AREA_ALIAS","type":"string"},"IPC_CLASS_INDUSTRY_FIELD":{"description":"Alias for IPC_CLASS_INDUSTRY_FIELD","example":"IPC_CLASS_INDUSTRY_FIELD_ALIAS","type":"string"},"LAST_EVENT_DATE":{"description":"Alias for LAST_EVENT_DATE","example":"LAST_EVENT_DATE_ALIAS","type":"string"},"LAST_UPDATED_DATE":{"description":"Alias for LAST_UPDATED_DATE","example":"LAST_UPDATED_DATE_ALIAS","type":"string"},"NUMBER_DEFENDANTS":{"description":"Alias for NUMBER_DEFENDANTS","example":"NUMBER_DEFENDANTS_ALIAS","type":"string"},"NUMBER_PLAINTIFFS":{"description":"Alias for NUMBER_PLAINTIFFS","example":"NUMBER_PLAINTIFFS_ALIAS","type":"string"},"NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO":{"description":"Alias for NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","example":"NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO_ALIAS","type":"string"},"PARTY_ALTERNATIVE_ULTIMATE_PARENT":{"description":"Alias for PARTY_ALTERNATIVE_ULTIMATE_PARENT","example":"PARTY_ALTERNATIVE_ULTIMATE_PARENT_ALIAS","type":"string"},"PARTY_COUNTRY":{"description":"Alias for PARTY_COUNTRY","example":"PARTY_COUNTRY_ALIAS","type":"string"},"PARTY_DEFENDANT_NAME":{"description":"Alias for PARTY_DEFENDANT_NAME","example":"PARTY_DEFENDANT_NAME_ALIAS","type":"string"},"PARTY_DEFENDANT_ULTIMATE_PARENT":{"description":"Alias for PARTY_DEFENDANT_ULTIMATE_PARENT","example":"PARTY_DEFENDANT_ULTIMATE_PARENT_ALIAS","type":"string"},"PARTY_IS_ANONYMOUS":{"description":"Alias for PARTY_IS_ANONYMOUS","example":"PARTY_IS_ANONYMOUS_ALIAS","type":"string"},"PARTY_IS_EX_OFFICIO":{"description":"Alias for PARTY_IS_EX_OFFICIO","example":"PARTY_IS_EX_OFFICIO_ALIAS","type":"string"},"PARTY_LEGAL_FORM":{"description":"Alias for PARTY_LEGAL_FORM","example":"PARTY_LEGAL_FORM_ALIAS","type":"string"},"PARTY_OPTIMIZED_NAME":{"description":"Alias for PARTY_OPTIMIZED_NAME","example":"PARTY_OPTIMIZED_NAME_ALIAS","type":"string"},"PARTY_OPTIMIZED_NAMES":{"description":"Alias for PARTY_OPTIMIZED_NAMES","example":"PARTY_OPTIMIZED_NAMES_ALIAS","type":"string"},"PARTY_PLAINTIFF_NAME":{"description":"Alias for PARTY_PLAINTIFF_NAME","example":"PARTY_PLAINTIFF_NAME_ALIAS","type":"string"},"PARTY_PLAINTIFF_ULTIMATE_PARENT":{"description":"Alias for PARTY_PLAINTIFF_ULTIMATE_PARENT","example":"PARTY_PLAINTIFF_ULTIMATE_PARENT_ALIAS","type":"string"},"PARTY_ROLE":{"description":"Alias for PARTY_ROLE","example":"PARTY_ROLE_ALIAS","type":"string"},"PARTY_TYPE":{"description":"Alias for PARTY_TYPE","example":"PARTY_TYPE_ALIAS","type":"string"},"PARTY_ULTIMATE_PARENT":{"description":"Alias for PARTY_ULTIMATE_PARENT","example":"PARTY_ULTIMATE_PARENT_ALIAS","type":"string"},"PATENT_ANONYMOUS":{"description":"Alias for PATENT_ANONYMOUS","example":"PATENT_ANONYMOUS_ALIAS","type":"string"},"PATENT_APPLICATION_ID":{"description":"Alias for PATENT_APPLICATION_ID","example":"PATENT_APPLICATION_ID_ALIAS","type":"string"},"PATENT_APPLICATION_NUMBER":{"description":"Alias for PATENT_APPLICATION_NUMBER","example":"PATENT_APPLICATION_NUMBER_ALIAS","type":"string"},"PATENT_ASSERTIONS":{"description":"Alias for PATENT_ASSERTIONS","example":"PATENT_ASSERTIONS_ALIAS","type":"string"},"PATENT_DAMAGES_ASSIGNED":{"description":"Alias for PATENT_DAMAGES_ASSIGNED","example":"PATENT_DAMAGES_ASSIGNED_ALIAS","type":"string"},"PATENT_DOCDB_FAMILY_ID":{"description":"Alias for PATENT_DOCDB_FAMILY_ID","example":"PATENT_DOCDB_FAMILY_ID_ALIAS","type":"string"},"PATENT_DWPI_APPLICATION_NUMBER":{"description":"Alias for PATENT_DWPI_APPLICATION_NUMBER","example":"PATENT_DWPI_APPLICATION_NUMBER_ALIAS","type":"string"},"PATENT_INDEX":{"description":"Alias for PATENT_INDEX","example":"PATENT_INDEX_ALIAS","type":"string"},"PATENT_INFRINGEMENT":{"description":"Alias for PATENT_INFRINGEMENT","example":"PATENT_INFRINGEMENT_ALIAS","type":"string"},"PATENT_INPADOC_FAMILY_ID":{"description":"Alias for PATENT_INPADOC_FAMILY_ID","example":"PATENT_INPADOC_FAMILY_ID_ALIAS","type":"string"},"PATENT_INVENTION_ID":{"description":"Alias for PATENT_INVENTION_ID","example":"PATENT_INVENTION_ID_ALIAS","type":"string"},"PATENT_OPTIMIZED_TITLE":{"description":"Alias for PATENT_OPTIMIZED_TITLE","example":"PATENT_OPTIMIZED_TITLE_ALIAS","type":"string"},"PATENT_PUBLICATION_NUMBER":{"description":"Alias for PATENT_PUBLICATION_NUMBER","example":"PATENT_PUBLICATION_NUMBER_ALIAS","type":"string"},"PATENT_REFERENCE_AUTHORITY":{"description":"Alias for PATENT_REFERENCE_AUTHORITY","example":"PATENT_REFERENCE_AUTHORITY_ALIAS","type":"string"},"PATENT_REFERENCE_KIND":{"description":"Alias for PATENT_REFERENCE_KIND","example":"PATENT_REFERENCE_KIND_ALIAS","type":"string"},"PATENT_REFERENCE_NUMBER":{"description":"Alias for PATENT_REFERENCE_NUMBER","example":"PATENT_REFERENCE_NUMBER_ALIAS","type":"string"},"PATENT_REFERENCE_ORIGINAL":{"description":"Alias for PATENT_REFERENCE_ORIGINAL","example":"PATENT_REFERENCE_ORIGINAL_ALIAS","type":"string"},"PATENT_REFERENCE_TYPE":{"description":"Alias for PATENT_REFERENCE_TYPE","example":"PATENT_REFERENCE_TYPE_ALIAS","type":"string"},"PATENT_ROLE":{"description":"Alias for PATENT_ROLE","example":"PATENT_ROLE_ALIAS","type":"string"},"PATENT_SOURCE":{"description":"Alias for PATENT_SOURCE","example":"PATENT_SOURCE_ALIAS","type":"string"},"PATENT_TITLE":{"description":"Alias for PATENT_TITLE","example":"PATENT_TITLE_ALIAS","type":"string"},"PATENT_TITLE_LANGUAGE":{"description":"Alias for PATENT_TITLE_LANGUAGE","example":"PATENT_TITLE_LANGUAGE_ALIAS","type":"string"},"PATENT_TYPE":{"description":"Alias for PATENT_TYPE","example":"PATENT_TYPE_ALIAS","type":"string"},"PATENT_VALIDITY":{"description":"Alias for PATENT_VALIDITY","example":"PATENT_VALIDITY_ALIAS","type":"string"},"PATENT_VALIDITY_CHALLENGES":{"description":"Alias for PATENT_VALIDITY_CHALLENGES","example":"PATENT_VALIDITY_CHALLENGES_ALIAS","type":"string"},"POINT_OF_LAW_CONFIDENCE_LEVEL":{"description":"Alias for POINT_OF_LAW_CONFIDENCE_LEVEL","example":"POINT_OF_LAW_CONFIDENCE_LEVEL_ALIAS","type":"string"},"POINT_OF_LAW_NAME":{"description":"Alias for POINT_OF_LAW_NAME","example":"POINT_OF_LAW_NAME_ALIAS","type":"string"},"POINT_OF_LAW_OUTCOME":{"description":"Alias for POINT_OF_LAW_OUTCOME","example":"POINT_OF_LAW_OUTCOME_ALIAS","type":"string"},"POINT_OF_LAW_OUTCOME_NEGATIVE":{"description":"Alias for POINT_OF_LAW_OUTCOME_NEGATIVE","example":"POINT_OF_LAW_OUTCOME_NEGATIVE_ALIAS","type":"string"},"POINT_OF_LAW_OUTCOME_POSITIVE":{"description":"Alias for POINT_OF_LAW_OUTCOME_POSITIVE","example":"POINT_OF_LAW_OUTCOME_POSITIVE_ALIAS","type":"string"},"POINT_OF_LAW_PARENT_PATH":{"description":"Alias for POINT_OF_LAW_PARENT_PATH","example":"POINT_OF_LAW_PARENT_PATH_ALIAS","type":"string"},"POINT_OF_LAW_PREFIX":{"description":"Alias for POINT_OF_LAW_PREFIX","example":"POINT_OF_LAW_PREFIX_ALIAS","type":"string"},"PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION":{"description":"Alias for PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION","example":"PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION_ALIAS","type":"string"},"PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS":{"description":"Alias for PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS","example":"PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS_ALIAS","type":"string"},"PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION":{"description":"Alias for PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION","example":"PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION_ALIAS","type":"string"},"PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS":{"description":"Alias for PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS","example":"PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS_ALIAS","type":"string"},"PRODUCT_COMPARISON_SIMILAR":{"description":"Alias for PRODUCT_COMPARISON_SIMILAR","example":"PRODUCT_COMPARISON_SIMILAR_ALIAS","type":"string"},"RELATION_RATING":{"description":"Alias for RELATION_RATING","example":"RELATION_RATING_ALIAS","type":"string"},"RELATION_RELATION":{"description":"Alias for RELATION_RELATION","example":"RELATION_RELATION_ALIAS","type":"string"},"RELATION_TARGET_DECISION":{"description":"Alias for RELATION_TARGET_DECISION","example":"RELATION_TARGET_DECISION_ALIAS","type":"string"},"RELATION_TARGET_REFERENCE":{"description":"Alias for RELATION_TARGET_REFERENCE","example":"RELATION_TARGET_REFERENCE_ALIAS","type":"string"},"RELEVANT_PUBLIC_AVERAGE_CONSUMER":{"description":"Alias for RELEVANT_PUBLIC_AVERAGE_CONSUMER","example":"RELEVANT_PUBLIC_AVERAGE_CONSUMER_ALIAS","type":"string"},"RELEVANT_PUBLIC_AWARENESS":{"description":"Alias for RELEVANT_PUBLIC_AWARENESS","example":"RELEVANT_PUBLIC_AWARENESS_ALIAS","type":"string"},"RELEVANT_PUBLIC_NICE_CLASS":{"description":"Alias for RELEVANT_PUBLIC_NICE_CLASS","example":"RELEVANT_PUBLIC_NICE_CLASS_ALIAS","type":"string"},"RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER":{"description":"Alias for RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER","example":"RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER_ALIAS","type":"string"},"REMEDY":{"description":"Alias for REMEDY","example":"REMEDY_ALIAS","type":"string"},"REPRESENTATIVE_COUNTRY":{"description":"Alias for REPRESENTATIVE_COUNTRY","example":"REPRESENTATIVE_COUNTRY_ALIAS","type":"string"},"REPRESENTATIVE_LEGAL_FORM":{"description":"Alias for REPRESENTATIVE_LEGAL_FORM","example":"REPRESENTATIVE_LEGAL_FORM_ALIAS","type":"string"},"REPRESENTATIVE_OPTIMIZED_NAME":{"description":"Alias for REPRESENTATIVE_OPTIMIZED_NAME","example":"REPRESENTATIVE_OPTIMIZED_NAME_ALIAS","type":"string"},"REPRESENTATIVE_TYPE":{"description":"Alias for REPRESENTATIVE_TYPE","example":"REPRESENTATIVE_TYPE_ALIAS","type":"string"},"RIGHT_ASSESSMENT_AMENDED_CLAIMS":{"description":"Alias for RIGHT_ASSESSMENT_AMENDED_CLAIMS","example":"RIGHT_ASSESSMENT_AMENDED_CLAIMS_ALIAS","type":"string"},"RIGHT_ASSESSMENT_INFRINGEMENT":{"description":"Alias for RIGHT_ASSESSMENT_INFRINGEMENT","example":"RIGHT_ASSESSMENT_INFRINGEMENT_ALIAS","type":"string"},"RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX":{"description":"Alias for RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX","example":"RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX_ALIAS","type":"string"},"RIGHT_ASSESSMENT_VALIDITY":{"description":"Alias for RIGHT_ASSESSMENT_VALIDITY","example":"RIGHT_ASSESSMENT_VALIDITY_ALIAS","type":"string"},"SETTLED":{"description":"Alias for SETTLED","example":"SETTLED_ALIAS","type":"string"},"TOTAL_DAMAGE_AMOUNT":{"description":"Alias for TOTAL_DAMAGE_AMOUNT","example":"TOTAL_DAMAGE_AMOUNT_ALIAS","type":"string"},"TOTAL_DAMAGE_CURRENCY":{"description":"Alias for TOTAL_DAMAGE_CURRENCY","example":"TOTAL_DAMAGE_CURRENCY_ALIAS","type":"string"},"TOTAL_DAMAGE_TYPE":{"description":"Alias for TOTAL_DAMAGE_TYPE","example":"TOTAL_DAMAGE_TYPE_ALIAS","type":"string"},"TRADEMARK_ANONYMOUS":{"description":"Alias for TRADEMARK_ANONYMOUS","example":"TRADEMARK_ANONYMOUS_ALIAS","type":"string"},"TRADEMARK_ID":{"description":"Alias for TRADEMARK_ID","example":"TRADEMARK_ID_ALIAS","type":"string"},"TRADEMARK_LOCARNO_CLASS":{"description":"Alias for TRADEMARK_LOCARNO_CLASS","example":"TRADEMARK_LOCARNO_CLASS_ALIAS","type":"string"},"TRADEMARK_NICE_CLASS":{"description":"Alias for TRADEMARK_NICE_CLASS","example":"TRADEMARK_NICE_CLASS_ALIAS","type":"string"},"TRADEMARK_REGISTRATION_NUMBER":{"description":"Alias for TRADEMARK_REGISTRATION_NUMBER","example":"TRADEMARK_REGISTRATION_NUMBER_ALIAS","type":"string"},"TRADEMARK_REGISTRATION_OFFICE":{"description":"Alias for TRADEMARK_REGISTRATION_OFFICE","example":"TRADEMARK_REGISTRATION_OFFICE_ALIAS","type":"string"},"TRADEMARK_ROLE":{"description":"Alias for TRADEMARK_ROLE","example":"TRADEMARK_ROLE_ALIAS","type":"string"},"TRADEMARK_TYPE":{"description":"Alias for TRADEMARK_TYPE","example":"TRADEMARK_TYPE_ALIAS","type":"string"},"TRADEMARK_VERBAL_ELEMENT":{"description":"Alias for TRADEMARK_VERBAL_ELEMENT","example":"TRADEMARK_VERBAL_ELEMENT_ALIAS","type":"string"},"TRADEMARK_VIENNA_CLASS":{"description":"Alias for TRADEMARK_VIENNA_CLASS","example":"TRADEMARK_VIENNA_CLASS_ALIAS","type":"string"},"WITHDRAWN":{"description":"Alias for WITHDRAWN","example":"WITHDRAWN_ALIAS","type":"string"}},"type":"object"},"field_aliases_patent":{"properties":{"AGENT_ADDRESS":{"description":"Alias for AGENT_ADDRESS","example":"AGENT_ADDRESS_ALIAS","type":"string"},"AGENT_CITY":{"description":"Alias for AGENT_CITY","example":"AGENT_CITY_ALIAS","type":"string"},"AGENT_COUNTRY":{"description":"Alias for AGENT_COUNTRY","example":"AGENT_COUNTRY_ALIAS","type":"string"},"AGENT_INID":{"description":"Alias for AGENT_INID","example":"AGENT_INID_ALIAS","type":"string"},"AGENT_NAME":{"description":"Alias for AGENT_NAME","example":"AGENT_NAME_ALIAS","type":"string"},"AGENT_STATE":{"description":"Alias for AGENT_STATE","example":"AGENT_STATE_ALIAS","type":"string"},"AGENT_ZIP_CODE":{"description":"Alias for AGENT_ZIP_CODE","example":"AGENT_ZIP_CODE_ALIAS","type":"string"},"APPLICATION_DATE":{"description":"Alias for APPLICATION_DATE","example":"APPLICATION_DATE_ALIAS","type":"string"},"APPLICATION_NUMBER":{"description":"Alias for APPLICATION_NUMBER","example":"APPLICATION_NUMBER_ALIAS","type":"string"},"APPLICATION_REGISTRATION_OFFICE":{"description":"Alias for APPLICATION_REGISTRATION_OFFICE","example":"APPLICATION_REGISTRATION_OFFICE_ALIAS","type":"string"},"ASSIGNEE_CURRENT_US":{"description":"Alias for ASSIGNEE_CURRENT_US","example":"ASSIGNEE_CURRENT_US_ALIAS","type":"string"},"ASSIGNEE_NAME":{"description":"Alias for ASSIGNEE_NAME","example":"ASSIGNEE_NAME_ALIAS","type":"string"},"ASSIGNEE_ORIGINAL_ADDRESS":{"description":"Alias for ASSIGNEE_ORIGINAL_ADDRESS","example":"ASSIGNEE_ORIGINAL_ADDRESS_ALIAS","type":"string"},"ASSIGNEE_ORIGINAL_CITY":{"description":"Alias for ASSIGNEE_ORIGINAL_CITY","example":"ASSIGNEE_ORIGINAL_CITY_ALIAS","type":"string"},"ASSIGNEE_ORIGINAL_COUNTRY":{"description":"Alias for ASSIGNEE_ORIGINAL_COUNTRY","example":"ASSIGNEE_ORIGINAL_COUNTRY_ALIAS","type":"string"},"ASSIGNEE_ORIGINAL_INID":{"description":"Alias for ASSIGNEE_ORIGINAL_INID","example":"ASSIGNEE_ORIGINAL_INID_ALIAS","type":"string"},"ASSIGNEE_ORIGINAL_NAME":{"description":"Alias for ASSIGNEE_ORIGINAL_NAME","example":"ASSIGNEE_ORIGINAL_NAME_ALIAS","type":"string"},"ASSIGNEE_ORIGINAL_NATIONALITY":{"description":"Alias for ASSIGNEE_ORIGINAL_NATIONALITY","example":"ASSIGNEE_ORIGINAL_NATIONALITY_ALIAS","type":"string"},"ASSIGNEE_ORIGINAL_STATE":{"description":"Alias for ASSIGNEE_ORIGINAL_STATE","example":"ASSIGNEE_ORIGINAL_STATE_ALIAS","type":"string"},"ASSIGNEE_ORIGINAL_ZIP_CODE":{"description":"Alias for ASSIGNEE_ORIGINAL_ZIP_CODE","example":"ASSIGNEE_ORIGINAL_ZIP_CODE_ALIAS","type":"string"},"CITATION_WOS_CLUSTERKEY":{"description":"Alias for CITATION_WOS_CLUSTERKEY","example":"CITATION_WOS_CLUSTERKEY_ALIAS","type":"string"},"CITATION_WOS_SCORE":{"description":"Alias for CITATION_WOS_SCORE","example":"CITATION_WOS_SCORE_ALIAS","type":"string"},"CORRESPONDENT_ADDRESS":{"description":"Alias for CORRESPONDENT_ADDRESS","example":"CORRESPONDENT_ADDRESS_ALIAS","type":"string"},"CORRESPONDENT_CITY":{"description":"Alias for CORRESPONDENT_CITY","example":"CORRESPONDENT_CITY_ALIAS","type":"string"},"CORRESPONDENT_COUNTRY":{"description":"Alias for CORRESPONDENT_COUNTRY","example":"CORRESPONDENT_COUNTRY_ALIAS","type":"string"},"CORRESPONDENT_NAME":{"description":"Alias for CORRESPONDENT_NAME","example":"CORRESPONDENT_NAME_ALIAS","type":"string"},"CORRESPONDENT_STATE":{"description":"Alias for CORRESPONDENT_STATE","example":"CORRESPONDENT_STATE_ALIAS","type":"string"},"CORRESPONDENT_ZIP_CODE":{"description":"Alias for CORRESPONDENT_ZIP_CODE","example":"CORRESPONDENT_ZIP_CODE_ALIAS","type":"string"},"CPC_4":{"description":"Alias for CPC_4","example":"CPC_4_ALIAS","type":"string"},"CPC_CURRENT":{"description":"Alias for CPC_CURRENT","example":"CPC_CURRENT_ALIAS","type":"string"},"CPC_SYMBOL":{"description":"Alias for CPC_SYMBOL","example":"CPC_SYMBOL_ALIAS","type":"string"},"CPC_TYPE":{"description":"Alias for CPC_TYPE","example":"CPC_TYPE_ALIAS","type":"string"},"DEAD_ALIVE_STATUS":{"description":"Alias for DEAD_ALIVE_STATUS","example":"DEAD_ALIVE_STATUS_ALIAS","type":"string"},"DERWENT_BACKWARD_CITATION_COUNT":{"description":"Alias for DERWENT_BACKWARD_CITATION_COUNT","example":"DERWENT_BACKWARD_CITATION_COUNT_ALIAS","type":"string"},"DERWENT_FORWARD_CITATION_COUNT":{"description":"Alias for DERWENT_FORWARD_CITATION_COUNT","example":"DERWENT_FORWARD_CITATION_COUNT_ALIAS","type":"string"},"DOCDB_SIMPLE_FAMILY_ID":{"description":"Alias for DOCDB_SIMPLE_FAMILY_ID","example":"DOCDB_SIMPLE_FAMILY_ID_ALIAS","type":"string"},"DOCUMENT_GUID":{"description":"Alias for DOCUMENT_GUID","example":"DOCUMENT_GUID_ALIAS","type":"string"},"DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL":{"description":"Alias for DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL","example":"DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL_ALIAS","type":"string"},"DPCI_CITED_COUNTS_AUTHORITIES_TOTAL":{"description":"Alias for DPCI_CITED_COUNTS_AUTHORITIES_TOTAL","example":"DPCI_CITED_COUNTS_AUTHORITIES_TOTAL_ALIAS","type":"string"},"DPCI_CITED_COUNTS_NON_PATENTS_TOTAL":{"description":"Alias for DPCI_CITED_COUNTS_NON_PATENTS_TOTAL","example":"DPCI_CITED_COUNTS_NON_PATENTS_TOTAL_ALIAS","type":"string"},"DPCI_CITED_COUNTS_PATENTS_TOTAL":{"description":"Alias for DPCI_CITED_COUNTS_PATENTS_TOTAL","example":"DPCI_CITED_COUNTS_PATENTS_TOTAL_ALIAS","type":"string"},"DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL":{"description":"Alias for DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL","example":"DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL_ALIAS","type":"string"},"DPCI_CITING_COUNTS_AUTHORITIES_TOTAL":{"description":"Alias for DPCI_CITING_COUNTS_AUTHORITIES_TOTAL","example":"DPCI_CITING_COUNTS_AUTHORITIES_TOTAL_ALIAS","type":"string"},"DPCI_CITING_COUNTS_PATENTS_TOTAL":{"description":"Alias for DPCI_CITING_COUNTS_PATENTS_TOTAL","example":"DPCI_CITING_COUNTS_PATENTS_TOTAL_ALIAS","type":"string"},"DSI_AGE_DISCOUNT":{"description":"Alias for DSI_AGE_DISCOUNT","example":"DSI_AGE_DISCOUNT_ALIAS","type":"string"},"DSI_AVERAGE_SCORE":{"description":"Alias for DSI_AVERAGE_SCORE","example":"DSI_AVERAGE_SCORE_ALIAS","type":"string"},"DSI_INVENTION_GLOBALIZATION_SCORE":{"description":"Alias for DSI_INVENTION_GLOBALIZATION_SCORE","example":"DSI_INVENTION_GLOBALIZATION_SCORE_ALIAS","type":"string"},"DSI_INVENTION_INFLUENCE_SCORE":{"description":"Alias for DSI_INVENTION_INFLUENCE_SCORE","example":"DSI_INVENTION_INFLUENCE_SCORE_ALIAS","type":"string"},"DSI_INVENTION_SUCCESS_SCORE":{"description":"Alias for DSI_INVENTION_SUCCESS_SCORE","example":"DSI_INVENTION_SUCCESS_SCORE_ALIAS","type":"string"},"DSI_STRENGTH_INDEX":{"description":"Alias for DSI_STRENGTH_INDEX","example":"DSI_STRENGTH_INDEX_ALIAS","type":"string"},"DSI_TECHNICAL_DISTINCTIVENESS_SCORE":{"description":"Alias for DSI_TECHNICAL_DISTINCTIVENESS_SCORE","example":"DSI_TECHNICAL_DISTINCTIVENESS_SCORE_ALIAS","type":"string"},"DSI_YEARS_REMAINING":{"description":"Alias for DSI_YEARS_REMAINING","example":"DSI_YEARS_REMAINING_ALIAS","type":"string"},"DWPI_ACCESSION_NUMBER":{"description":"Alias for DWPI_ACCESSION_NUMBER","example":"DWPI_ACCESSION_NUMBER_ALIAS","type":"string"},"DWPI_APPLICATION_NUMBER_BASIC":{"description":"Alias for DWPI_APPLICATION_NUMBER_BASIC","example":"DWPI_APPLICATION_NUMBER_BASIC_ALIAS","type":"string"},"DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC":{"description":"Alias for DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","example":"DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC_ALIAS","type":"string"},"DWPI_ASSIGNEE_CODE":{"description":"Alias for DWPI_ASSIGNEE_CODE","example":"DWPI_ASSIGNEE_CODE_ALIAS","type":"string"},"DWPI_ASSIGNEE_CODE_TYPE":{"description":"Alias for DWPI_ASSIGNEE_CODE_TYPE","example":"DWPI_ASSIGNEE_CODE_TYPE_ALIAS","type":"string"},"DWPI_ASSIGNEE_NAME":{"description":"Alias for DWPI_ASSIGNEE_NAME","example":"DWPI_ASSIGNEE_NAME_ALIAS","type":"string"},"DWPI_CLASS":{"description":"Alias for DWPI_CLASS","example":"DWPI_CLASS_ALIAS","type":"string"},"DWPI_CLASS_DESCRIPTION":{"description":"Alias for DWPI_CLASS_DESCRIPTION","example":"DWPI_CLASS_DESCRIPTION_ALIAS","type":"string"},"DWPI_CLASS_SECTION":{"description":"Alias for DWPI_CLASS_SECTION","example":"DWPI_CLASS_SECTION_ALIAS","type":"string"},"DWPI_CLASS_SECTION_DESCRIPTION":{"description":"Alias for DWPI_CLASS_SECTION_DESCRIPTION","example":"DWPI_CLASS_SECTION_DESCRIPTION_ALIAS","type":"string"},"DWPI_DESIGNATED_OFFICE_COUNT":{"description":"Alias for DWPI_DESIGNATED_OFFICE_COUNT","example":"DWPI_DESIGNATED_OFFICE_COUNT_ALIAS","type":"string"},"DWPI_EARLIEST_PRIORITY_DATE":{"description":"Alias for DWPI_EARLIEST_PRIORITY_DATE","example":"DWPI_EARLIEST_PRIORITY_DATE_ALIAS","type":"string"},"DWPI_EARLIEST_PRIORITY_YEAR":{"description":"Alias for DWPI_EARLIEST_PRIORITY_YEAR","example":"DWPI_EARLIEST_PRIORITY_YEAR_ALIAS","type":"string"},"DWPI_FAMILY_MEMBER_COUNT":{"description":"Alias for DWPI_FAMILY_MEMBER_COUNT","example":"DWPI_FAMILY_MEMBER_COUNT_ALIAS","type":"string"},"DWPI_FAMILY_STATUS":{"description":"Alias for DWPI_FAMILY_STATUS","example":"DWPI_FAMILY_STATUS_ALIAS","type":"string"},"DWPI_INVENTOR_NAME":{"description":"Alias for DWPI_INVENTOR_NAME","example":"DWPI_INVENTOR_NAME_ALIAS","type":"string"},"DWPI_KIND_CODE_BASIC":{"description":"Alias for DWPI_KIND_CODE_BASIC","example":"DWPI_KIND_CODE_BASIC_ALIAS","type":"string"},"DWPI_MANUAL_CODE":{"description":"Alias for DWPI_MANUAL_CODE","example":"DWPI_MANUAL_CODE_ALIAS","type":"string"},"DWPI_MANUAL_CODE_4":{"description":"Alias for DWPI_MANUAL_CODE_4","example":"DWPI_MANUAL_CODE_4_ALIAS","type":"string"},"DWPI_MANUAL_CODE_CLASS":{"description":"Alias for DWPI_MANUAL_CODE_CLASS","example":"DWPI_MANUAL_CODE_CLASS_ALIAS","type":"string"},"DWPI_MANUAL_CODE_CLASS_DESCRIPTION":{"description":"Alias for DWPI_MANUAL_CODE_CLASS_DESCRIPTION","example":"DWPI_MANUAL_CODE_CLASS_DESCRIPTION_ALIAS","type":"string"},"DWPI_MANUAL_CODE_DESCRIPTION":{"description":"Alias for DWPI_MANUAL_CODE_DESCRIPTION","example":"DWPI_MANUAL_CODE_DESCRIPTION_ALIAS","type":"string"},"DWPI_MANUAL_CODE_SECTION":{"description":"Alias for DWPI_MANUAL_CODE_SECTION","example":"DWPI_MANUAL_CODE_SECTION_ALIAS","type":"string"},"DWPI_MANUAL_CODE_SECTION_DESCRIPTION":{"description":"Alias for DWPI_MANUAL_CODE_SECTION_DESCRIPTION","example":"DWPI_MANUAL_CODE_SECTION_DESCRIPTION_ALIAS","type":"string"},"DWPI_PUBLICATION_NUMBER_BASIC":{"description":"Alias for DWPI_PUBLICATION_NUMBER_BASIC","example":"DWPI_PUBLICATION_NUMBER_BASIC_ALIAS","type":"string"},"DWPI_REGISTRATION_OFFICE_BASIC":{"description":"Alias for DWPI_REGISTRATION_OFFICE_BASIC","example":"DWPI_REGISTRATION_OFFICE_BASIC_ALIAS","type":"string"},"DWPI_TITLE":{"description":"Alias for DWPI_TITLE","example":"DWPI_TITLE_ALIAS","type":"string"},"DWPI_UPDATE":{"description":"Alias for DWPI_UPDATE","example":"DWPI_UPDATE_ALIAS","type":"string"},"DWPI_UPDATE_BASIC":{"description":"Alias for DWPI_UPDATE_BASIC","example":"DWPI_UPDATE_BASIC_ALIAS","type":"string"},"EARLIEST_PRIORITY_COUNTRY":{"description":"Alias for EARLIEST_PRIORITY_COUNTRY","example":"EARLIEST_PRIORITY_COUNTRY_ALIAS","type":"string"},"EARLIEST_PRIORITY_DATE":{"description":"Alias for EARLIEST_PRIORITY_DATE","example":"EARLIEST_PRIORITY_DATE_ALIAS","type":"string"},"EARLIEST_PRIORITY_NUMBER":{"description":"Alias for EARLIEST_PRIORITY_NUMBER","example":"EARLIEST_PRIORITY_NUMBER_ALIAS","type":"string"},"EARLIEST_PRIORITY_YEAR":{"description":"Alias for EARLIEST_PRIORITY_YEAR","example":"EARLIEST_PRIORITY_YEAR_ALIAS","type":"string"},"ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR":{"description":"Alias for ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR","example":"ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR_ALIAS","type":"string"},"ESTIMATED_EXPIRATION_DATE":{"description":"Alias for ESTIMATED_EXPIRATION_DATE","example":"ESTIMATED_EXPIRATION_DATE_ALIAS","type":"string"},"ESTIMATED_EXPIRATION_DISCLAIMER_FLAG":{"description":"Alias for ESTIMATED_EXPIRATION_DISCLAIMER_FLAG","example":"ESTIMATED_EXPIRATION_DISCLAIMER_FLAG_ALIAS","type":"string"},"ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM":{"description":"Alias for ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM","example":"ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM_ALIAS","type":"string"},"ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE":{"description":"Alias for ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE","example":"ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE_ALIAS","type":"string"},"ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT":{"description":"Alias for ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT","example":"ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT_ALIAS","type":"string"},"ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE":{"description":"Alias for ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE","example":"ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE_ALIAS","type":"string"},"EXAMINER_MAIN":{"description":"Alias for EXAMINER_MAIN","example":"EXAMINER_MAIN_ALIAS","type":"string"},"EXAMINER_SECONDARY":{"description":"Alias for EXAMINER_SECONDARY","example":"EXAMINER_SECONDARY_ALIAS","type":"string"},"GRANTED":{"description":"Alias for GRANTED","example":"GRANTED_ALIAS","type":"string"},"GRANT_DATE":{"description":"Alias for GRANT_DATE","example":"GRANT_DATE_ALIAS","type":"string"},"GREEN_DATA_CATEGORY":{"description":"Alias for GREEN_DATA_CATEGORY","example":"GREEN_DATA_CATEGORY_ALIAS","type":"string"},"GUID":{"description":"Alias for GUID","example":"GUID_ALIAS","type":"string"},"INPADOC_FAMILY_STATUS":{"description":"Alias for INPADOC_FAMILY_STATUS","example":"INPADOC_FAMILY_STATUS_ALIAS","type":"string"},"INVENTOR_ADDRESS":{"description":"Alias for INVENTOR_ADDRESS","example":"INVENTOR_ADDRESS_ALIAS","type":"string"},"INVENTOR_CITY":{"description":"Alias for INVENTOR_CITY","example":"INVENTOR_CITY_ALIAS","type":"string"},"INVENTOR_COUNTRY":{"description":"Alias for INVENTOR_COUNTRY","example":"INVENTOR_COUNTRY_ALIAS","type":"string"},"INVENTOR_NAME":{"description":"Alias for INVENTOR_NAME","example":"INVENTOR_NAME_ALIAS","type":"string"},"INVENTOR_NATIONALITY":{"description":"Alias for INVENTOR_NATIONALITY","example":"INVENTOR_NATIONALITY_ALIAS","type":"string"},"INVENTOR_STATE":{"description":"Alias for INVENTOR_STATE","example":"INVENTOR_STATE_ALIAS","type":"string"},"INVENTOR_ZIP_CODE":{"description":"Alias for INVENTOR_ZIP_CODE","example":"INVENTOR_ZIP_CODE_ALIAS","type":"string"},"IPC_4":{"description":"Alias for IPC_4","example":"IPC_4_ALIAS","type":"string"},"IPC_CLASS":{"description":"Alias for IPC_CLASS","example":"IPC_CLASS_ALIAS","type":"string"},"IPC_CLASS_DESCRIPTION":{"description":"Alias for IPC_CLASS_DESCRIPTION","example":"IPC_CLASS_DESCRIPTION_ALIAS","type":"string"},"IPC_CURRENT":{"description":"Alias for IPC_CURRENT","example":"IPC_CURRENT_ALIAS","type":"string"},"IPC_DESCRIPTION":{"description":"Alias for IPC_DESCRIPTION","example":"IPC_DESCRIPTION_ALIAS","type":"string"},"IPC_SECTION":{"description":"Alias for IPC_SECTION","example":"IPC_SECTION_ALIAS","type":"string"},"IPC_SECTION_DESCRIPTION":{"description":"Alias for IPC_SECTION_DESCRIPTION","example":"IPC_SECTION_DESCRIPTION_ALIAS","type":"string"},"IPC_SUBCLASS":{"description":"Alias for IPC_SUBCLASS","example":"IPC_SUBCLASS_ALIAS","type":"string"},"IPC_SUBCLASS_DESCRIPTION":{"description":"Alias for IPC_SUBCLASS_DESCRIPTION","example":"IPC_SUBCLASS_DESCRIPTION_ALIAS","type":"string"},"IPC_SYMBOL":{"description":"Alias for IPC_SYMBOL","example":"IPC_SYMBOL_ALIAS","type":"string"},"IPC_TYPE":{"description":"Alias for IPC_TYPE","example":"IPC_TYPE_ALIAS","type":"string"},"JP_CLASS_FI_CODE":{"description":"Alias for JP_CLASS_FI_CODE","example":"JP_CLASS_FI_CODE_ALIAS","type":"string"},"JP_CLASS_F_TERM":{"description":"Alias for JP_CLASS_F_TERM","example":"JP_CLASS_F_TERM_ALIAS","type":"string"},"KIND_CODE":{"description":"Alias for KIND_CODE","example":"KIND_CODE_ALIAS","type":"string"},"LAST_UPDATED_DATE":{"description":"Alias for LAST_UPDATED_DATE","example":"LAST_UPDATED_DATE_ALIAS","type":"string"},"OPTIMIZED_ASSIGNEES":{"description":"Alias for OPTIMIZED_ASSIGNEES","example":"OPTIMIZED_ASSIGNEES_ALIAS","type":"string"},"PATENT_TYPE":{"description":"Alias for PATENT_TYPE","example":"PATENT_TYPE_ALIAS","type":"string"},"PUBLICATION_DATE":{"description":"Alias for PUBLICATION_DATE","example":"PUBLICATION_DATE_ALIAS","type":"string"},"PUBLICATION_LANGUAGE":{"description":"Alias for PUBLICATION_LANGUAGE","example":"PUBLICATION_LANGUAGE_ALIAS","type":"string"},"PUBLICATION_NUMBER":{"description":"Alias for PUBLICATION_NUMBER","example":"PUBLICATION_NUMBER_ALIAS","type":"string"},"PUBLICATION_TYPE":{"description":"Alias for PUBLICATION_TYPE","example":"PUBLICATION_TYPE_ALIAS","type":"string"},"PUBLICATION_YEAR":{"description":"Alias for PUBLICATION_YEAR","example":"PUBLICATION_YEAR_ALIAS","type":"string"},"REGISTRATION_OFFICE":{"description":"Alias for REGISTRATION_OFFICE","example":"REGISTRATION_OFFICE_ALIAS","type":"string"},"REPRESENTATIVE_NAME":{"description":"Alias for REPRESENTATIVE_NAME","example":"REPRESENTATIVE_NAME_ALIAS","type":"string"},"SERIAL_NUMBER":{"description":"Alias for SERIAL_NUMBER","example":"SERIAL_NUMBER_ALIAS","type":"string"},"ULTIMATE_PARENT":{"description":"Alias for ULTIMATE_PARENT","example":"ULTIMATE_PARENT_ALIAS","type":"string"}},"type":"object"},"field_aliases_trademark":{"properties":{"APPLICANT_ADDRESS_COUNTRY_CODE":{"description":"Alias for APPLICANT_ADDRESS_COUNTRY_CODE","example":"APPLICANT_ADDRESS_COUNTRY_CODE_ALIAS","type":"string"},"APPLICANT_ADDRESS_LINE_TEXT":{"description":"Alias for APPLICANT_ADDRESS_LINE_TEXT","example":"APPLICANT_ADDRESS_LINE_TEXT_ALIAS","type":"string"},"APPLICANT_ADDRESS_NATIVE_LINE_TEXT":{"description":"Alias for APPLICANT_ADDRESS_NATIVE_LINE_TEXT","example":"APPLICANT_ADDRESS_NATIVE_LINE_TEXT_ALIAS","type":"string"},"APPLICANT_NAME":{"description":"Alias for APPLICANT_NAME","example":"APPLICANT_NAME_ALIAS","type":"string"},"APPLICANT_NAME_NATIVE":{"description":"Alias for APPLICANT_NAME_NATIVE","example":"APPLICANT_NAME_NATIVE_ALIAS","type":"string"},"APPLICATION_ABANDONED_DATE":{"description":"Alias for APPLICATION_ABANDONED_DATE","example":"APPLICATION_ABANDONED_DATE_ALIAS","type":"string"},"APPLICATION_DATE":{"description":"Alias for APPLICATION_DATE","example":"APPLICATION_DATE_ALIAS","type":"string"},"APPLICATION_LANGUAGE_CODE":{"description":"Alias for APPLICATION_LANGUAGE_CODE","example":"APPLICATION_LANGUAGE_CODE_ALIAS","type":"string"},"APPLICATION_NUMBER_TEXT":{"description":"Alias for APPLICATION_NUMBER_TEXT","example":"APPLICATION_NUMBER_TEXT_ALIAS","type":"string"},"CANCELLATION_DATE":{"description":"Alias for CANCELLATION_DATE","example":"CANCELLATION_DATE_ALIAS","type":"string"},"CLASSIFICATION":{"description":"Alias for CLASSIFICATION","example":"CLASSIFICATION_ALIAS","type":"string"},"CLASSIFICATION_CODE_ENRICHED":{"description":"Alias for CLASSIFICATION_CODE_ENRICHED","example":"CLASSIFICATION_CODE_ENRICHED_ALIAS","type":"string"},"COUNTRY_ISO_3166_ALPHA2":{"description":"Alias for COUNTRY_ISO_3166_ALPHA2","example":"COUNTRY_ISO_3166_ALPHA2_ALIAS","type":"string"},"COUNTRY_ISO_3166_ALPHA3":{"description":"Alias for COUNTRY_ISO_3166_ALPHA3","example":"COUNTRY_ISO_3166_ALPHA3_ALIAS","type":"string"},"COUNTRY_TEXT":{"description":"Alias for COUNTRY_TEXT","example":"COUNTRY_TEXT_ALIAS","type":"string"},"CURRENT_STATUS":{"description":"Alias for CURRENT_STATUS","example":"CURRENT_STATUS_ALIAS","type":"string"},"CURRENT_STATUS_DERIVED":{"description":"Alias for CURRENT_STATUS_DERIVED","example":"CURRENT_STATUS_DERIVED_ALIAS","type":"string"},"DESIGNATED_COUNTRY_CODE":{"description":"Alias for DESIGNATED_COUNTRY_CODE","example":"DESIGNATED_COUNTRY_CODE_ALIAS","type":"string"},"DESIGNATION_BASIS":{"description":"Alias for DESIGNATION_BASIS","example":"DESIGNATION_BASIS_ALIAS","type":"string"},"DISCLAIMERS":{"description":"Alias for DISCLAIMERS","example":"DISCLAIMERS_ALIAS","type":"string"},"EXPIRY_DATE":{"description":"Alias for EXPIRY_DATE","example":"EXPIRY_DATE_ALIAS","type":"string"},"FILING_DATE_DERIVED":{"description":"Alias for FILING_DATE_DERIVED","example":"FILING_DATE_DERIVED_ALIAS","type":"string"},"GUID":{"description":"Alias for GUID","example":"GUID_ALIAS","type":"string"},"GUID_DERIVED":{"description":"Alias for GUID_DERIVED","example":"GUID_DERIVED_ALIAS","type":"string"},"ID":{"description":"Alias for ID","example":"ID_ALIAS","type":"string"},"ID_DERIVED":{"description":"Alias for ID_DERIVED","example":"ID_DERIVED_ALIAS","type":"string"},"IMAGES_TOTAL_QUANTITY":{"description":"Alias for IMAGES_TOTAL_QUANTITY","example":"IMAGES_TOTAL_QUANTITY_ALIAS","type":"string"},"IMAGE_KIND":{"description":"Alias for IMAGE_KIND","example":"IMAGE_KIND_ALIAS","type":"string"},"INITIAL_APPLICATION_DATE":{"description":"Alias for INITIAL_APPLICATION_DATE","example":"INITIAL_APPLICATION_DATE_ALIAS","type":"string"},"INITIAL_REGISTRATION_DATE":{"description":"Alias for INITIAL_REGISTRATION_DATE","example":"INITIAL_REGISTRATION_DATE_ALIAS","type":"string"},"INT_CLASS_HEADING_DERIVED":{"description":"Alias for INT_CLASS_HEADING_DERIVED","example":"INT_CLASS_HEADING_DERIVED_ALIAS","type":"string"},"INT_CLASS_NUMBER":{"description":"Alias for INT_CLASS_NUMBER","example":"INT_CLASS_NUMBER_ALIAS","type":"string"},"INT_CLASS_TYPE_DERIVED":{"description":"Alias for INT_CLASS_TYPE_DERIVED","example":"INT_CLASS_TYPE_DERIVED_ALIAS","type":"string"},"INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION":{"description":"Alias for INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION","example":"INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION_ALIAS","type":"string"},"INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE":{"description":"Alias for INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE","example":"INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE_ALIAS","type":"string"},"INT_GOODS_SERVICES_DESCRIPTION":{"description":"Alias for INT_GOODS_SERVICES_DESCRIPTION","example":"INT_GOODS_SERVICES_DESCRIPTION_ALIAS","type":"string"},"INT_GOODS_SERVICES_LANGUAGE_CODE":{"description":"Alias for INT_GOODS_SERVICES_LANGUAGE_CODE","example":"INT_GOODS_SERVICES_LANGUAGE_CODE_ALIAS","type":"string"},"LAST_PUBLICATION_DATE":{"description":"Alias for LAST_PUBLICATION_DATE","example":"LAST_PUBLICATION_DATE_ALIAS","type":"string"},"LAST_UPDATED_DATE":{"description":"Alias for LAST_UPDATED_DATE","example":"LAST_UPDATED_DATE_ALIAS","type":"string"},"MARK_FEATURE":{"description":"Alias for MARK_FEATURE","example":"MARK_FEATURE_ALIAS","type":"string"},"MARK_TRANSLATION_TEXT":{"description":"Alias for MARK_TRANSLATION_TEXT","example":"MARK_TRANSLATION_TEXT_ALIAS","type":"string"},"MARK_TRANSLITERATION_TEXT":{"description":"Alias for MARK_TRANSLITERATION_TEXT","example":"MARK_TRANSLITERATION_TEXT_ALIAS","type":"string"},"MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED":{"description":"Alias for MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED","example":"MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED_ALIAS","type":"string"},"MARK_VERBAL_ELEMENT_TEXT":{"description":"Alias for MARK_VERBAL_ELEMENT_TEXT","example":"MARK_VERBAL_ELEMENT_TEXT_ALIAS","type":"string"},"NAT_CLASS_NUMBER":{"description":"Alias for NAT_CLASS_NUMBER","example":"NAT_CLASS_NUMBER_ALIAS","type":"string"},"NAT_GOODS_SERVICES_DESCRIPTION":{"description":"Alias for NAT_GOODS_SERVICES_DESCRIPTION","example":"NAT_GOODS_SERVICES_DESCRIPTION_ALIAS","type":"string"},"NAT_GOODS_SERVICES_LANGUAGE_CODE":{"description":"Alias for NAT_GOODS_SERVICES_LANGUAGE_CODE","example":"NAT_GOODS_SERVICES_LANGUAGE_CODE_ALIAS","type":"string"},"PRIORITY_COUNTRY_CODE":{"description":"Alias for PRIORITY_COUNTRY_CODE","example":"PRIORITY_COUNTRY_CODE_ALIAS","type":"string"},"PRIORITY_DATE":{"description":"Alias for PRIORITY_DATE","example":"PRIORITY_DATE_ALIAS","type":"string"},"PRIORITY_NUMBER_TEXT":{"description":"Alias for PRIORITY_NUMBER_TEXT","example":"PRIORITY_NUMBER_TEXT_ALIAS","type":"string"},"PUBLICATION_DATE":{"description":"Alias for PUBLICATION_DATE","example":"PUBLICATION_DATE_ALIAS","type":"string"},"PUBLICATION_YEAR":{"description":"Alias for PUBLICATION_YEAR","example":"PUBLICATION_YEAR_ALIAS","type":"string"},"REGISTRATION_DATE":{"description":"Alias for REGISTRATION_DATE","example":"REGISTRATION_DATE_ALIAS","type":"string"},"REGISTRATION_NUMBER_TEXT":{"description":"Alias for REGISTRATION_NUMBER_TEXT","example":"REGISTRATION_NUMBER_TEXT_ALIAS","type":"string"},"REGISTRATION_OFFICE_CODE":{"description":"Alias for REGISTRATION_OFFICE_CODE","example":"REGISTRATION_OFFICE_CODE_ALIAS","type":"string"},"REGISTRATION_OFFICE_CODE_DERIVED":{"description":"Alias for REGISTRATION_OFFICE_CODE_DERIVED","example":"REGISTRATION_OFFICE_CODE_DERIVED_ALIAS","type":"string"},"RENEWAL_DATE":{"description":"Alias for RENEWAL_DATE","example":"RENEWAL_DATE_ALIAS","type":"string"},"RENEWAL_PUBLISHED_DATE":{"description":"Alias for RENEWAL_PUBLISHED_DATE","example":"RENEWAL_PUBLISHED_DATE_ALIAS","type":"string"},"REPRESENTATIVE_ADDRESS_COUNTRY_CODE":{"description":"Alias for REPRESENTATIVE_ADDRESS_COUNTRY_CODE","example":"REPRESENTATIVE_ADDRESS_COUNTRY_CODE_ALIAS","type":"string"},"REPRESENTATIVE_ADDRESS_LINE_TEXT":{"description":"Alias for REPRESENTATIVE_ADDRESS_LINE_TEXT","example":"REPRESENTATIVE_ADDRESS_LINE_TEXT_ALIAS","type":"string"},"REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT":{"description":"Alias for REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT","example":"REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT_ALIAS","type":"string"},"REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE":{"description":"Alias for REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE","example":"REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE_ALIAS","type":"string"},"REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT":{"description":"Alias for REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT","example":"REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT_ALIAS","type":"string"},"REPRESENTATIVE_CORRESPONDENT_NAME":{"description":"Alias for REPRESENTATIVE_CORRESPONDENT_NAME","example":"REPRESENTATIVE_CORRESPONDENT_NAME_ALIAS","type":"string"},"REPRESENTATIVE_NAME":{"description":"Alias for REPRESENTATIVE_NAME","example":"REPRESENTATIVE_NAME_ALIAS","type":"string"},"REPRESENTATIVE_NAME_NATIVE":{"description":"Alias for REPRESENTATIVE_NAME_NATIVE","example":"REPRESENTATIVE_NAME_NATIVE_ALIAS","type":"string"},"SECOND_LANGUAGE_CODE":{"description":"Alias for SECOND_LANGUAGE_CODE","example":"SECOND_LANGUAGE_CODE_ALIAS","type":"string"}},"type":"object"},"image_url_list_derwent_api":{"properties":{"image_urls":{"description":"URL for an image","items":{"description":"URL for an image","example":"https://","type":"string"},"type":"array"},"inline_image_urls":{"description":"URL result for inline Derwent images when type=inline","items":{"description":"URL result for inline Derwent images when type=inline","example":"https://localhost/patents/derwent/document/images/file?patent=EP4451620A1&image_type=inline&token=...","type":"string"},"type":"array"},"missing_patent_numbers":{"description":"Patent numbers where no image was found","items":{"description":"Patent numbers where no image was found","example":"EP0000000A1","type":"string"},"type":"array"}},"type":"object"},"image_url_list_patent":{"properties":{"image_urls":{"description":"URL for an image","items":{"description":"URL for an image","example":"https://","type":"string"},"type":"array"}},"type":"object"},"match_patent":{"properties":{"MATCH":{"properties":{"ALG":{"description":"Matching algorithm (currently only \"DEFAULT\")","example":"DEFAULT","type":"string"},"MATCH_FIELDS":{"description":"Fields to match. Must be one of ('assignee', 'parent_assignee')","items":{"description":"Fields to match. Must be one of ('assignee', 'parent_assignee')","example":"assignee","type":"string"},"type":"array"},"THRESHOLD":{"description":"Minimum match score","example":0,"type":"number"},"TOPN":{"default":10,"description":"Maximum number of matches to return","example":2,"type":"number"},"VALUE":{"description":"A field value to attempt to match","example":"Microsoft","type":"string"}},"type":"object"}},"type":"object"},"match_response_patent":{"properties":{"assignee":{"items":{"properties":{"count":{"description":"Number of documents with this value","type":"number"},"name":{"description":"Value of field assignee","type":"string"},"score":{"description":"Match score","type":"number"}},"type":"object"},"type":"array"},"parent_assignee":{"items":{"properties":{"count":{"description":"Number of documents with this value","type":"number"},"name":{"description":"Value of field parent_assignee","type":"string"},"score":{"description":"Match score","type":"number"}},"type":"object"},"type":"array"}},"type":"object"},"query_body_caselaw":{"description":"Query objects of this type may be freely interleaved with boolean operators, as strings. Available boolean operators are AND and OR","properties":{"ALG":{"description":"Algorithm to use.","enum":["BASIC"],"type":"string"},"FIELD":{"description":"Field to query","enum":["NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS","DOMAIN_NAME_ANONYMOUS","FIRST_ACTION_DATE","DOCUMENT_CITABLE","DOMAIN_IS_DOMAIN_NAME","DESIGN_LOCARNO_CLASS","PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION","TRADEMARK_NICE_CLASS","DOMAIN_IS_UNFAIR_COMPETITION","PATENT_PUBLICATION_NUMBER","CLAIM_CONSTRUCTION_AGREED","RIGHT_ASSESSMENT_INFRINGEMENT","PATENT_ROLE","PATENT_INPADOC_FAMILY_ID","PATENT_INDEX","SETTLED","DOCKET_COURT_COUNTRY_DERIVED_TEXT","LAST_UPDATED_DATE","DOMAIN_NAME","DESIGN_REGISTRATION_STATUS","DOCUMENT_WINNER","PATENT_INVENTION_ID","REMEDY","POINT_OF_LAW_OUTCOME_POSITIVE","CASE_DOMAIN","POINT_OF_LAW_OUTCOME","DOCUMENT_DEFAULT_JUDGEMENT","DESIGN_REGISTRATION_OFFICE","DESIGN_VIENNA_CLASS","PATENT_DWPI_APPLICATION_NUMBER","PARTY_LEGAL_FORM","EU_TRADEMARK","CASE_STATUS","DESIGN_PRODUCT","RIGHT_ASSESSMENT_AMENDED_CLAIMS","DAMAGE_PARTIAL","PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION","BINDER_ID","PATENT_REFERENCE_NUMBER","COPYRIGHT_ROLE","DAMAGE_CURRENT_USD_EQUIVALENT","POINT_OF_LAW_PARENT_PATH","CLOSED","POINT_OF_LAW_OUTCOME_NEGATIVE","PATENT_INFRINGEMENT","PATENT_APPLICATION_NUMBER","DAMAGE_AMOUNT","DOCUMENT_LEVEL","DOMAIN_IS_PATENT","FIRST_ACTION_TYPE","RELATION_TARGET_REFERENCE","DOCUMENT_TRADEMARK_REPUTATION","DAMAGE_REQUESTED","POINT_OF_LAW_NAME","PATENT_DOCDB_FAMILY_ID","CLAIM_CONSTRUCTION_DEFINITION","DAMAGE_NATURE","PATENT_REFERENCE_ORIGINAL","PATENT_VALIDITY_CHALLENGES","TRADEMARK_VERBAL_ELEMENT","DOMAIN_NAME_TLD","PARTY_PLAINTIFF_NAME","DOCKET_COURT_TYPE_JUDICIAL","DOCUMENT_STATE","PATENT_TITLE_LANGUAGE","DOCKET_COURT_COUNTRY","PATENT_TITLE","TRADEMARK_VIENNA_CLASS","DESIGN_REGISTRATION_NUMBER","EARLIEST_EVENT_DATE","DOCKET_COURT_TYPE_ARBITRATION","PRODUCT_COMPARISON_SIMILAR","PATENT_VALIDITY","DOCKET_REFERENCE","DOMAIN_IS_COPYRIGHT","PARTY_OPTIMIZED_NAMES","DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","PATENT_DAMAGES_ASSIGNED","DESIGN_VERBAL_ELEMENT","PATENT_APPLICATION_ID","TRADEMARK_ID","NUMBER_PLAINTIFFS","DOMAIN_IS_TRADEMARK","DOCUMENT_SUBTYPE","PARTY_ALTERNATIVE_ULTIMATE_PARENT","RELEVANT_PUBLIC_AVERAGE_CONSUMER","TRADEMARK_ROLE","RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX","PARTY_COUNTRY","CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION","PATENT_ASSERTIONS","IPC_CLASS_INDUSTRY_AREA","TOTAL_DAMAGE_CURRENCY","DOMAIN_NAME_ROLE","DOCUMENT_TYPE","RIGHT_ASSESSMENT_VALIDITY","PARTY_IS_ANONYMOUS","IPC_CLASS_INDUSTRY_FIELD","TRADEMARK_LOCARNO_CLASS","WITHDRAWN","PATENT_TYPE","NUMBER_DEFENDANTS","RELEVANT_PUBLIC_NICE_CLASS","TRADEMARK_REGISTRATION_NUMBER","TRADEMARK_REGISTRATION_OFFICE","PATENT_REFERENCE_AUTHORITY","TRADEMARK_ANONYMOUS","PARTY_ULTIMATE_PARENT","PATENT_OPTIMIZED_TITLE","COPYRIGHT_TYPE","DOCKET_COURT_NAME","CLAIM_CONSTRUCTION_NOT_NECESSARY","DOCKET_COURT_PATH","PARTY_ROLE","RELATION_RELATION","LAST_EVENT_DATE","REPRESENTATIVE_LEGAL_FORM","PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS","PARTY_PLAINTIFF_ULTIMATE_PARENT","DAMAGE_CURRENCY","DAMAGE_CURRENT_CNY_EQUIVALENT","PATENT_REFERENCE_KIND","DOCKET_COURT_TYPE_ADMINISTRATIVE","PARTY_TYPE","AREA","DESIGN_ROLE","REPRESENTATIVE_OPTIMIZED_NAME","COPYRIGHT_ANONYMOUS","PARTY_OPTIMIZED_NAME","GUID","DAMAGE_CURRENT_EUR_EQUIVALENT","DOCUMENT_REFUSAL","PARTY_DEFENDANT_ULTIMATE_PARENT","POINT_OF_LAW_PREFIX","PATENT_REFERENCE_TYPE","CASE_NAME","RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER","CASE_RESOLUTION","RELEVANT_PUBLIC_AWARENESS","REPRESENTATIVE_TYPE","CASE_STAGE","PATENT_ANONYMOUS","CLAIM_CONSTRUCTION_TERM","DAMAGE_LATER","REPRESENTATIVE_COUNTRY","DESIGN_PRODUCT_LANGUAGE","RELATION_TARGET_DECISION","TRADEMARK_TYPE","DOMAIN_IS_OTHER","PARTY_DEFENDANT_NAME","DOCUMENT_CITATION_REFERENCE","DESIGN_ANONYMOUS","TOTAL_DAMAGE_TYPE","DAMAGE_CALCULATION_METHOD","POINT_OF_LAW_CONFIDENCE_LEVEL","DOCKET_COURT_COUNTRY_TEXT","COPYRIGHT_TITLE","DOCKET_COURT_AREA","PATENT_SOURCE","PARTY_IS_EX_OFFICIO","EX_OFFICIO","TOTAL_DAMAGE_AMOUNT","DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","DOCUMENT_DATE","IPC_CLASS_CODE","RELATION_RATING","DOMAIN_IS_DESIGN_MODEL","DOCUMENT_DECLARATORY","COPYRIGHT_DESCRIPTION"],"example":"GUID","type":"string"},"OP":{"description":"Operator","enum":["NE","EQ","IS","GT","LE","LT","IN","GE"],"type":"string"},"VALUE":{"description":"Field value to match (based on operator)","example":"2706413","type":"string"}},"required":["OP","VALUE"],"type":"object"},"query_body_patent":{"description":"Query objects of this type may be freely interleaved with boolean operators, as strings. Available boolean operators are AND and OR","properties":{"ALG":{"description":"Algorithm to use.","enum":["BASIC"],"type":"string"},"FIELD":{"description":"Field to query","enum":["DWPI_MANUAL_CODE_CLASS","APPLICATION_NUMBER","DEAD_ALIVE_STATUS","ESTIMATED_EXPIRATION_DISCLAIMER_FLAG","EARLIEST_PRIORITY_COUNTRY","IPC_SUBCLASS_DESCRIPTION","DWPI_MANUAL_CODE_SECTION","ASSIGNEE_CURRENT_US","GRANTED","APPLICATION_DATE","EXAMINER_MAIN","CITATION_WOS_CLUSTERKEY","LAST_UPDATED_DATE","AGENT_COUNTRY","DWPI_KIND_CODE_BASIC","DPCI_CITED_COUNTS_AUTHORITIES_TOTAL","INVENTOR_ADDRESS","SERIAL_NUMBER","EARLIEST_PRIORITY_NUMBER","IPC_SECTION","CPC_TYPE","IPC_SUBCLASS","DERWENT_BACKWARD_CITATION_COUNT","DOCDB_SIMPLE_FAMILY_ID","DSI_INVENTION_SUCCESS_SCORE","EARLIEST_PRIORITY_YEAR","CORRESPONDENT_ZIP_CODE","CORRESPONDENT_NAME","DWPI_MANUAL_CODE_DESCRIPTION","IPC_TYPE","ASSIGNEE_ORIGINAL_NAME","OPTIMIZED_ASSIGNEES","DERWENT_FORWARD_CITATION_COUNT","EXAMINER_SECONDARY","DSI_INVENTION_INFLUENCE_SCORE","DPCI_CITING_COUNTS_PATENTS_TOTAL","CITATION_WOS_SCORE","DWPI_APPLICATION_NUMBER_BASIC","DWPI_ACCESSION_NUMBER","DWPI_ASSIGNEE_NAME","ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE","DWPI_ASSIGNEE_CODE_TYPE","DWPI_CLASS","ASSIGNEE_ORIGINAL_NATIONALITY","ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE","ESTIMATED_EXPIRATION_DATE","IPC_4","REGISTRATION_OFFICE","INVENTOR_NAME","PUBLICATION_YEAR","PUBLICATION_LANGUAGE","APPLICATION_REGISTRATION_OFFICE","CORRESPONDENT_CITY","CPC_SYMBOL","DSI_TECHNICAL_DISTINCTIVENESS_SCORE","DWPI_MANUAL_CODE_4","ASSIGNEE_ORIGINAL_ZIP_CODE","CORRESPONDENT_STATE","DPCI_CITED_COUNTS_NON_PATENTS_TOTAL","DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL","ULTIMATE_PARENT","AGENT_ZIP_CODE","AGENT_INID","ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR","DWPI_FAMILY_MEMBER_COUNT","DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL","INVENTOR_ZIP_CODE","REPRESENTATIVE_NAME","GRANT_DATE","DWPI_CLASS_DESCRIPTION","DWPI_EARLIEST_PRIORITY_DATE","GREEN_DATA_CATEGORY","EARLIEST_PRIORITY_DATE","IPC_SECTION_DESCRIPTION","AGENT_STATE","ASSIGNEE_ORIGINAL_CITY","IPC_SYMBOL","DSI_INVENTION_GLOBALIZATION_SCORE","DWPI_MANUAL_CODE","DSI_STRENGTH_INDEX","KIND_CODE","ASSIGNEE_ORIGINAL_INID","DWPI_DESIGNATED_OFFICE_COUNT","IPC_CURRENT","PUBLICATION_NUMBER","ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT","IPC_CLASS","PATENT_TYPE","CPC_CURRENT","DPCI_CITED_COUNTS_PATENTS_TOTAL","JP_CLASS_FI_CODE","DOCUMENT_GUID","INVENTOR_COUNTRY","ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM","PUBLICATION_DATE","JP_CLASS_F_TERM","DWPI_REGISTRATION_OFFICE_BASIC","CPC_4","DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","DWPI_CLASS_SECTION","DWPI_PUBLICATION_NUMBER_BASIC","DWPI_MANUAL_CODE_CLASS_DESCRIPTION","DWPI_EARLIEST_PRIORITY_YEAR","DWPI_CLASS_SECTION_DESCRIPTION","DPCI_CITING_COUNTS_AUTHORITIES_TOTAL","DWPI_INVENTOR_NAME","ASSIGNEE_ORIGINAL_COUNTRY","GUID","CORRESPONDENT_COUNTRY","AGENT_CITY","DWPI_FAMILY_STATUS","DSI_AVERAGE_SCORE","DSI_YEARS_REMAINING","CORRESPONDENT_ADDRESS","DWPI_MANUAL_CODE_SECTION_DESCRIPTION","INVENTOR_STATE","AGENT_NAME","DSI_AGE_DISCOUNT","PUBLICATION_TYPE","INVENTOR_NATIONALITY","ASSIGNEE_ORIGINAL_ADDRESS","INVENTOR_CITY","INPADOC_FAMILY_STATUS","ASSIGNEE_NAME","IPC_DESCRIPTION","IPC_CLASS_DESCRIPTION","AGENT_ADDRESS","DWPI_ASSIGNEE_CODE","DWPI_TITLE","ASSIGNEE_ORIGINAL_STATE"],"example":"GUID","type":"string"},"OP":{"description":"Operator","enum":["NE","EQ","IS","GT","LE","LT","IN","GE"],"type":"string"},"VALUE":{"description":"Field value to match (based on operator)","example":"WO2021243294A120211202","type":"string"}},"required":["OP","VALUE"],"type":"object"},"query_body_trademark":{"description":"Query objects of this type may be freely interleaved with boolean operators, as strings. Available boolean operators are AND and OR","properties":{"ALG":{"description":"Algorithm to use.","enum":["BASIC"],"type":"string"},"FIELD":{"description":"Field to query","enum":["REGISTRATION_NUMBER_TEXT","INITIAL_REGISTRATION_DATE","ID","COUNTRY_ISO_3166_ALPHA2","MARK_VERBAL_ELEMENT_TEXT","REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT","REPRESENTATIVE_CORRESPONDENT_NAME","MARK_FEATURE","CURRENT_STATUS_DERIVED","FILING_DATE_DERIVED","APPLICANT_NAME_NATIVE","NAT_GOODS_SERVICES_DESCRIPTION","REPRESENTATIVE_ADDRESS_LINE_TEXT","CANCELLATION_DATE","REPRESENTATIVE_NAME_NATIVE","IMAGE_KIND","MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED","APPLICANT_ADDRESS_COUNTRY_CODE","APPLICANT_ADDRESS_NATIVE_LINE_TEXT","DESIGNATION_BASIS","RENEWAL_PUBLISHED_DATE","INT_GOODS_SERVICES_LANGUAGE_CODE","GUID","REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT","PRIORITY_COUNTRY_CODE","REGISTRATION_DATE","APPLICATION_NUMBER_TEXT","REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE","LAST_PUBLICATION_DATE","REGISTRATION_OFFICE_CODE_DERIVED","APPLICATION_DATE","MARK_TRANSLATION_TEXT","INT_CLASS_HEADING_DERIVED","CURRENT_STATUS","COUNTRY_ISO_3166_ALPHA3","DESIGNATED_COUNTRY_CODE","EXPIRY_DATE","PRIORITY_DATE","INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE","INT_CLASS_NUMBER","RENEWAL_DATE","LAST_UPDATED_DATE","INITIAL_APPLICATION_DATE","PUBLICATION_YEAR","APPLICANT_ADDRESS_LINE_TEXT","CLASSIFICATION","APPLICANT_NAME","INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION","IMAGES_TOTAL_QUANTITY","APPLICATION_LANGUAGE_CODE","ID_DERIVED","GUID_DERIVED","MARK_TRANSLITERATION_TEXT","NAT_GOODS_SERVICES_LANGUAGE_CODE","INT_CLASS_TYPE_DERIVED","REGISTRATION_OFFICE_CODE","DISCLAIMERS","COUNTRY_TEXT","INT_GOODS_SERVICES_DESCRIPTION","CLASSIFICATION_CODE_ENRICHED","REPRESENTATIVE_ADDRESS_COUNTRY_CODE","PUBLICATION_DATE","APPLICATION_ABANDONED_DATE","NAT_CLASS_NUMBER","SECOND_LANGUAGE_CODE","REPRESENTATIVE_NAME","PRIORITY_NUMBER_TEXT"],"example":"GUID","type":"string"},"OP":{"description":"Operator","enum":["NE","EQ","IS","GT","LE","LT","IN","GE"],"type":"string"},"VALUE":{"description":"Field value to match (based on operator)","example":"USAFI65E053B1C87611DEB9C6000D609921FB","type":"string"}},"required":["OP","VALUE"],"type":"object"},"records_request_caselaw":{"properties":{"FIELDS":{"description":"Fields to fetch","items":{"description":"Fields to fetch","enum":["BINDER.RIGHTS.PATENTS.OPTIMIZED_TITLE","BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_B.DESCRIPTION","BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.REQUESTED","BINDER.PARTIES_DEFENDANT.TYPE","BINDER.PARTIES.EX_OFFICIO","BINDER.RIGHTS.PATENTS.INDEX","BINDER.DOCKET_COURT_COUNTRIES","BINDER.DOCKETS.COURT.AREA","BINDER.PARTIES.TYPE","BINDER.RIGHTS.PATENTS.INFRINGEMENT","BINDER.PARTIES_PLAINTIFF.NAME","BINDER.RIGHTS.PATENTS.DWPI_APPLICATION_NUMBER","BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_B.NICE_CLASSES","BINDER.SETTLED","BINDER.EARLIEST_EVENT_DATE","BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","BINDER.CASE_RESOLUTION","BINDER.AREA","BINDER.PARTIES_DEFENDANT.NAME","BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.NICE_CLASSES","BINDER.PARTIES_PLAINTIFF.NATIONALITY","BINDER.WITHDRAWN","BINDER.REMEDY","BINDER.TOTAL_DAMAGES.AMOUNT","BINDER.RIGHTS.TRADEMARKS.LOCARNO_CLASSES","BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.AMENDED_CLAIMS","BINDER.PARTIES_DEFENDANT","BINDER.DOCKETS.DOCUMENTS.LEVEL","BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.POSITIVE","BINDER.RIGHTS.PATENTS.AMENDED_CLAIMS","BINDER.PARTIES.REPRESENTATIVES.OPTIMIZED_NAME","BINDER.CASE_STAGE","BINDER.RIGHTS.TRADEMARKS.VIENNA_CLASSES","BINDER.RIGHTS.COPYRIGHTS.ANONYMOUS","BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.DESCRIPTION","BINDER.RIGHTS.DESIGNS.PRODUCT","BINDER.RIGHTS.COPYRIGHTS.DESCRIPTION","BINDER.RIGHTS.PATENTS.APPLICATION_NUMBER","BINDER.RIGHTS.PATENTS.NATURE","BINDER.CASE_DOMAINS","BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.MEANS_PLUS_FUNCTION","BINDER.RIGHTS.PATENTS.REFERENCES.TYPE","BINDER.PARTIES.ACTOR_ID","BINDER.RIGHTS.DESIGNS.ROLE","BINDER.DOCKETS.DOCUMENTS.RELATIONS.RATING","BINDER.PARTIES_DEFENDANT.NATIONALITY","BINDER.RIGHTS.DESIGNS.ANONYMOUS","BINDER.RIGHTS.COPYRIGHTS.TYPE","BINDER.PARTIES.REPRESENTATIVES.TYPE","BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.NOT_NECESSARY","BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.INFRINGEMENT","BINDER.CASE_NAME","BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.DEFINITION","BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.OUTCOME","BINDER.TOTAL_DAMAGES","BINDER.PARTIES.OPTIMIZED_NAME","BINDER.RIGHTS.TRADEMARKS.VERBAL_ELEMENT","BINDER.RIGHTS.PATENTS.SOURCE","BINDER.EU_TRADEMARK","BINDER.RIGHTS.PATENTS.TITLES.TITLE","BINDER.PATENT_DAMAGES_ASSIGNED","BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PREFIX","BINDER.RIGHTS.DOMAIN_NAMES.TLD","BINDER.PARTIES_PLAINTIFF","BINDER.CASE_STATUS","BINDER.DOCKETS.COURT.COURT_COUNTRY","BINDER.DOCKETS.COURT.NAME","BINDER.CASE_REFERENCES","BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_EUR_EQUIVALENT","BINDER.LAST_EVENT_DATE","BINDER.RIGHTS.TRADEMARKS.ROLE","BINDER.RIGHTS.PATENTS.VALIDITY","BINDER.RIGHTS.PATENTS.REFERENCES.NUMBER","BINDER.RIGHTS.DESIGNS.REGISTRATION_NUMBER","BINDER.RIGHTS.DOMAIN_NAMES.ROLE","BINDER.PARTIES.ULTIMATE_PARENT","BINDER.DOCKET_COURT_NAMES","BINDER.RIGHTS.TRADEMARKS.REGISTRATION_OFFICE","BINDER.DOCKETS.COURT.COURT_COUNTRY_TEXT","BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.LATER","BINDER.PARTIES_PLAINTIFF.LEGAL_FORM","BINDER.DOCKETS.DOCUMENTS.DECLARATORY","BINDER.PARTIES_PLAINTIFF.TYPE","BINDER.RIGHTS.DESIGNS.PRODUCT_LANGUAGE","BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.NEGATIVE","BINDER.NUMBER_PLAINTIFFS","BINDER.RIGHTS.DESIGNS.REGISTRATION_OFFICE","BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.AVERAGE_CONSUMER","BINDER.RIGHTS.PATENTS.APPLICATION_ID","BINDER.DOCKETS.DOCUMENTS.WINNER","BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.AGREED","BINDER.DOCKETS.DOCUMENTS.CITATION_REFERENCE","BINDER.RIGHTS.PATENTS.PUBLICATION_NUMBER","BINDER.PARTIES.LEGAL_FORM","BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENCY","BINDER.RIGHTS.TRADEMARKS.NICE_CLASSES","BINDER.RIGHTS.COPYRIGHTS.ROLE","BINDER.RIGHTS.DESIGNS.VIENNA_CLASSES","BINDER.NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","BINDER.DOCKETS.DOCUMENTS.STATE","BINDER.RIGHTS.PATENTS.ROLE","BINDER.RIGHTS.PATENTS.REFERENCES.KIND","BINDER.TOTAL_DAMAGES.TYPE","BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_CNY_EQUIVALENT","BINDER.PARTIES.ROLE","BINDER.PARTIES.ANONYMOUS","BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.VALIDITY","BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.PARTIAL","BINDER.RIGHTS.DESIGNS.REGISTRATION_STATUS","BINDER.PARTIES.REPRESENTATIVES.LEGAL_FORM","BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.TERM","BINDER.DOCKETS.DOCUMENTS.REFUSAL","BINDER.PARTIES_DEFENDANT.LEGAL_FORM","BINDER.RIGHTS.PATENTS.EXTENDED_FAMILY_ID","BINDER.DOCKETS.DOCUMENTS.DAMAGES.CALCULATION_METHOD","BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_TEXT","BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.SIMILAR","BINDER.RIGHTS.PATENTS.REFERENCES.ORIGINAL","BINDER.PARTIES.REPRESENTATIVES.COUNTRY","BINDER.RIGHTS.DOMAIN_NAMES.DOMAIN_NAME","BINDER.DOCKETS.DOCUMENTS.RELATIONS.TARGET_DECISION","BINDER.DOCKETS.DOCUMENTS.DAMAGES.NATURE","BINDER.DOCKETS.DOCUMENTS.RELATIONS.RELATION","BINDER.PATENT_VALIDITY_CHALLENGES","BINDER.DOCKETS.COURT.TYPES","BINDER.RIGHTS.PATENTS.IPC_CLASSES","BINDER.PARTIES_PLAINTIFF.ACTOR_ID","BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PARENT_PATH","BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.NICE_CLASSES","BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.NAME","BINDER.DOCKETS.DOCUMENTS.DOCUMENT_DATE","BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.PROFESSIONAL_CONSUMER","BINDER.NUMBER_DEFENDANTS","BINDER.FIRST_ACTION_TYPE","BINDER.DOCKETS.DOCUMENTS.DEFAULT_JUDGEMENT","BINDER.DOCKETS.DOCUMENTS.RELATIONS.TARGET_REFERENCE","BINDER.PARTIES_DEFENDANT.ACTOR_ID","BINDER.RIGHTS.PATENTS.SIMPLE_FAMILY_ID","BINDER.RIGHTS.PATENTS.ANONYMOUS","BINDER.TOTAL_DAMAGES.CURRENCY","BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_USD_EQUIVALENT","BINDER.PARTIES.ALTERNATIVE_ULTIMATE_PARENT","BINDER.RIGHTS.DOMAIN_NAMES.ANONYMOUS","BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.RIGHT_ASSESSMENT_INDEX","BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.CONFIDENCE_LEVEL","BINDER.FIRST_ACTION_DATE","BINDER.EX_OFFICIO","BINDER.RIGHTS.TRADEMARKS.REGISTRATION_NUMBER","BINDER.RIGHTS.COPYRIGHTS.TITLE","GUID","BINDER.RIGHTS.PATENTS.REFERENCES.AUTHORITY","BINDER.CLOSED","BINDER.PARTIES.COUNTRY","BINDER.RIGHTS.PATENTS.TITLES.LANGUAGE","BINDER.RIGHTS.TRADEMARKS.COMPUMARK_GUID","BINDER.RIGHTS.PATENTS.INVENTION_ID","BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.AWARENESS","EXPORT_TIMESTAMP","BINDER.DOCKETS.DOCUMENTS.DOCUMENT_TYPE","BINDER.DOCKETS.DOCUMENTS.DAMAGES.AMOUNT","BINDER.DOCKETS.DOCUMENTS.SUBTYPE","BINDER.RIGHTS.TRADEMARKS.ANONYMOUS","BINDER.RIGHTS.DESIGNS.LOCARNO_CLASSES","BINDER.DOCKETS.REFERENCE","BINDER.RIGHTS.DESIGNS.VERBAL_ELEMENT","BINDER.DOCKETS.DOCUMENTS.CITABLE","BINDER.DOCKETS.DOCUMENTS.TRADEMARK_REPUTATION","BINDER.DOCKETS.COURT.PATH","BINDER.PATENT_ASSERTIONS","BINDER.LAST_UPDATED_DATE","BINDER.RIGHTS.TRADEMARKS.TYPE"],"type":"string"},"type":"array"},"GUIDS":{"description":"Document(s) to retrieve","items":{"description":"Unique ID of caselaw document","example":"2706413","type":"string"},"type":"array"}},"required":["GUIDS"],"type":"object"},"records_request_patent":{"properties":{"FIELDS":{"description":"Fields to fetch","items":{"description":"Fields to fetch","enum":["BACKWARD_CITATION.MEMBERS.SOURCE","AUTHOR_ABSTRACTS.LANGUAGE","APPLICATION_NUMBER","INPADOC_FAMILY.PUBLICATION_DATE","PRIORITIES.DATE","DEAD_ALIVE_STATUS","CPCS_CURRENT","BACKWARD_CITATION.DWPI_ASSIGNEES.NAME","FORWARD_CITATION.ASSIGNEE","EARLIEST_PRIORITY_COUNTRY","DWPI_CLASSES","FORWARD_CITATION.APPLICATION_DATE","DPCI_CITING_PATENTS.MEMBERS.FAMILY_MEMBER","US_REASSIGNMENTS.CORRESPONDENT_NAME","INPADOC_FAMILY.DERWENT_TITLE","DPCI_CITING_PATENTS.DWPI_ACCESSION_NUMBER","GRANTED","APPLICATION_DATE","INVENTORS.COUNTRY","INVENTORS.NAME","PREDICTIVE.DOMAIN_INFLUENCE","BACKWARD_CITATION.GUID","DPCI_CITED_PATENTS.MEMBERS.SOURCE","DESCRIPTIONS","JP_CLASSES","BACKWARD_CITATION.PUBLICATION_DATE","TITLES.SOURCE","DPCI_CITING_PATENTS.DWPI_ASSIGNEES.NAME","LAST_UPDATED_DATE","DWPI_ABSTRACT.USE","CORRESPONDENTS.COUNTRY","DPCI_CITED_COUNTS.NON_PATENTS_TOTAL","DWPI_KIND_CODE_BASIC","ASSIGNEES_ORIGINAL.ZIP_CODE","FORWARD_CITATION.DWPI_ACCESSION_NUMBER","CPCS.ASSIGNING_OFFICE","DPCI_CITED_PATENTS.APPLICATION_DATE","DWPI_ASSIGNEES.NAME","DESIGNATED_OFFICES.FILING_REGION","DPCI_CITING_PATENTS.GUID","DPCI_CITING_PATENTS.EARLIEST_PRIORITY_DATE","FORWARD_CITATION.PUBLICATION_NUMBER","BACKWARD_CITATION.KIND_CODE","TITLES.LANGUAGE","SERIAL_NUMBER","ULTIMATE_PARENTS","INPADOC_LEGAL_STATUS_EVENTS.IMPACT","DPCI_CITED_PATENTS.DWPI_INVENTOR_NAMES","IPCS.SYMBOL","INPADOC_FAMILY.TITLES.TITLE_ENGLISH","EARLIEST_PRIORITY_NUMBER","DPCI_CITING_PATENTS.MEMBERS","DERWENT_BACKWARD_CITATION_COUNT","FORWARD_CITATION.COUNTRY_CODE","DOCDB_SIMPLE_FAMILY_ID","REPRESENTATIVES.ADDRESS","AUTHOR_ABSTRACTS.XML","EARLIEST_PRIORITY_YEAR","CORRESPONDENTS.ADDRESS","REPRESENTATIVES.CITY","ASSIGNEES_ORIGINAL","JP_CLASSES.F_TERMS","BACKWARD_CITATION.DWPI_ASSIGNEES","FORWARD_CITATION.EARLIEST_PRIORITY_DATE","DWPI_ABSTRACT.TECHNOLOGY_FOCUSES","DWPI_UPDATE_BASIC","INPADOC_FAMILY.TITLES.TITLE_FRENCH","DERWENT_FORWARD_CITATION_COUNT","DPCI_CITED_PATENTS.EARLIEST_PRIORITY_DATE","TITLES","INPADOC_FAMILY.TITLES.TITLE_GERMAN","DWPI_ABSTRACT_EXT.WIDER_DISCLOSURE","DPCI_CITING_PATENTS.DWPI_INVENTOR_NAMES","FORWARD_CITATIONS.MEMBERS.SOURCE","DESCRIPTIONS.XML","FORWARD_CITATION.DWPI_ASSIGNEES.NAME","INPADOC_FAMILY.ASSIGNEE","DWPI_APPLICATION_NUMBER_BASIC","CPCS","DWPI_ACCESSION_NUMBER","DPCI_CITING_PATENTS.MEMBERS.RELEVANCE_CATEGORY","ASSIGNEES_ORIGINAL.ADDRESS","LEGAL_STATUS_FACTOR","INPADOC_FAMILY.DEAD_ALIVE_STATUS","INPADOC_LEGAL_STATUS_EVENTS.CODE","DPCI_CITING_PATENTS.DWPI_TITLE","US_REASSIGNMENTS.ASSIGNEES.STATE","INVENTORS.ADDRESS","PREDICTIVE.PATENT_STRENGTH","DWPI_INVENTORS","PREDICTIVE.GRANT_PROBABILITY","BACKWARD_CITATION.DWPI_ASSIGNEES.CODE","ASSIGNEES_ORIGINAL.STATE","DPCI_CITED_PATENTS.MEMBERS.RELEVANCE_CATEGORY","INVENTORS.ZIP_CODE","US_REASSIGNMENTS.ASSIGNORS.NAME","DPCI_CITING_COUNTS.PATENTS_TOTAL","DWPI_ASSIGNEES.CODE","CPCS.COMBINATION_LINKING","DESCRIPTIONS.SOURCE","DPCI_CITED_PATENTS.PUBLICATION_DATE","US_REASSIGNMENTS.ASSIGNORS.DATE_SIGNED","REPRESENTATIVES.COUNTRY","BACKWARD_CITATION.DWPI_TITLE","DPCI_CITING_PATENTS.DWPI_ASSIGNEES.CODE","REGISTRATION_OFFICE","DWPI_INVENTORS.NAME","CLAIMS.LANGUAGE","INPADOC_FAMILY.INVENTOR","PUBLICATION_YEAR","BACKWARD_CITATION.DWPI_ACCESSION_NUMBER","DWPI_ASSIGNEES","INPADOC_FAMILY.GUID","FORWARD_CITATION.MEMBERS.RELEVANCE_CATEGORY","APPLICATION_REGISTRATION_OFFICE","INPADOC_FAMILY_ID","DPCI_CITED_PATENTS.MEMBERS.FAMILY_MEMBER","US_REASSIGNMENTS.ASSIGNORS.ORDINAL","DPCI_CITED_NON_PATENTS.TEXT","AUTHOR_ABSTRACTS.SOURCE","BACKWARD_CITATION.PUBLICATION_NUMBER","DWPI_ABSTRACT_EXT.EXAMPLE","INPADOC_FAMILY.TITLES.TITLE_SPANISH","JP_CLASSES.FI_CODES","ASSIGNEES_ORIGINAL.NAME","DWPI_MANUAL_CODES.CODE","DWPI_ABSTRACT_EXT","DPCI_CITED_PATENTS.DWPI_ACCESSION_NUMBER","CPCS.VERSION","DPCI_CITED_PATENTS.DWPI_ASSIGNEES","CORRESPONDENTS.CITY","DW_KEYWORDS","FORWARD_CITATION.DWPI_ASSIGNEES.CODE","DPCI_CITED_PATENTS.GUID","PRIORITIES.COUNTRY","ASSIGNEES_ORIGINAL.CITY","DWPI_FAMILY_MEMBER_COUNT","FORWARD_CITATION.DWPI_INVENTOR_NAMES","DESCRIPTIONS.LANGUAGE","IPCS.VERSION","US_REASSIGNMENTS.ASSIGNEES.ADDRESS","GRANT_DATE","INPADOC_FAMILY.DERWENT_INVENTOR","US_REASSIGNMENTS.CORRESPONDENT_ADDRESS","FORWARD_CITATION.KIND_CODE","DWPI_EARLIEST_PRIORITY_DATE","LEGAL_STATUS_FACTOR.CODE","EARLIEST_PRIORITY_DATE","CORRESPONDENTS","BACKWARD_CITATION.DWPI_INVENTOR_NAMES","DWPI_TITLE","INPADOC_LEGAL_STATUS_EVENTS.DESCRIPTION","DPCI_CITED_PATENTS.MEMBERS","DPCI_CITED_NON_PATENTS.MEMBERS","CLAIMS","FORWARD_CITATION.PUBLICATION_DATE","DPCI_CITING_PATENTS","ESTIMATED_EXPIRATION.FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT","DPCI_CITED_NON_PATENTS.DOC_ID","DPCI_CITING_COUNTS.ACCESSION_NUMBERS_TOTAL","ASSIGNEES_ORIGINAL.NATIONALITY","DWPI_ABSTRACT.ADVANTAGE","KIND_CODE","DWPI_ABSTRACT.NOVELTY","INPADOC_FAMILY.TITLES","IPCS.SOURCE","DWPI_CLASSES.DESCRIPTION","DWPI_DESIGNATED_OFFICE_COUNT","IPCS_CURRENT","DWPI_ABSTRACT_EXT.PRIOR_ART","US_REASSIGNMENTS.ASSIGNEES.ORDINAL","INPADOC_FAMILY","INPADOC_FAMILY.PUBLICATION_NUMBER","INPADOC_LEGAL_STATUS_EVENTS","PUBLICATION_NUMBER","DPCI_CITED_COUNTS.PATENTS_TOTAL","US_REASSIGNMENTS.ASSIGNEES.ZIP_CODE","FORWARD_CITATION","INVENTORS","DWPI_MANUAL_CODES","APPLICATION_NUMBER_ORIGINAL","CLAIMS.XML","BACKWARD_CITATION","DPCI_CITING_COUNTS.AUTHORITIES_TOTAL","US_REASSIGNMENTS.ASSIGNEES.NAME","DPCI_CITED_COUNTS.ACCESSION_NUMBERS_TOTAL","PATENT_TYPE","INPADOC_LEGAL_STATUS_EVENTS.GAZETTE_DATE","DPCI_CITING_PATENTS.PUBLICATION_DATE","DPCI_CITING_PATENTS.PUBLICATION_NUMBER","ASSIGNEE_NAMES","INPADOC_FAMILY.DERWENT_ASSIGNEES.NAME","CPCS.SYMBOL","CPCS.ACTION_DATE","AUTHOR_ABSTRACTS","LEGAL_STATUS_FACTOR.DESCRIPTION","DPCI_CITED_PATENTS.DWPI_TITLE","INPADOC_FAMILY.TITLES.TITLE_OTHERS","PRIORITIES","DPCI_CITING_PATENTS.MEMBERS.SOURCE","INDEPENDENT_CLAIMS.SOURCE","INPADOC_FAMILY.APPLICATION_NUMBER","DPCI_CITED_NON_PATENTS.MEMBERS.SOURCE","DPCI_CITED_PATENTS.PUBLICATION_NUMBER","ESTIMATED_EXPIRATION.CONFIRMATION_INDICATOR","DESIGNATED_OFFICES.STATES","DWPI_ABSTRACT","DWPI_ABSTRACT_EXT.DOCUMENTATION","BACKWARD_CITATION.COUNTRY_CODE","PUBLICATION_DATE","INPADOC_FAMILY.KIND_CODE","LEGAL_STATUS_FACTOR.COUNTRY","INPADOC_FAMILY.DERWENT_ASSIGNEES.CODE","INVENTORS.CITY","ASSIGNEES_ORIGINAL.COUNTRY","BACKWARD_CITATION.MEMBERS","INVENTORS.STATE","DWPI_UPDATE","INDEPENDENT_CLAIMS","DWPI_REGISTRATION_OFFICE_BASIC","DWPI_ABSTRACT.DRAWING_DESCRIPTION","DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","BACKWARD_CITATION.APPLICATION_DATE","ASSIGNEES_ORIGINAL.TYPE","BACKWARD_CITATION.ASSIGNEE","ESTIMATED_EXPIRATION.FACTOR_DESIGN_TERM","IPCS.TYPE","DWPI_MANUAL_CODES.DESCRIPTION","DWPI_PUBLICATION_NUMBER_BASIC","DPCI_CITED_PATENTS","BACKWARD_CITATION.EARLIEST_PRIORITY_DATE","FORWARD_CITATION.INVENTOR","US_REASSIGNMENTS.ASSIGNEES.COUNTRY","CPCS.TYPE","DWPI_ABSTRACT.MECHANISM","DPCI_CITED_NON_PATENTS","FORWARD_CITATION.DWPI_TITLE","DWPI_ABSTRACT_EXT.ADMINISTRATION","US_REASSIGNMENTS.PATENT_ORDINAL","IPCS","DPCI_CITED_PATENTS.DWPI_ASSIGNEES.CODE","REPRESENTATIVES","BACKWARD_CITATION.INVENTOR","DPCI_CITING_PATENTS.APPLICATION_DATE","GUID","EXAMINERS.MAIN","US_REASSIGNMENTS.REEL_FRAME","INPADOC_FAMILY.IPC","PREDICTIVE","DWPI_FAMILY_STATUS","DWPI_ABSTRACT_EXT.SPECIFIC_COMPOUND","PREDICTIVE.STRATEGIC_IMPORTANCE","FIRST_CLAIM","INDEPENDENT_CLAIMS.INDEX","FORWARD_CITATION.DWPI_ASSIGNEES","ESTIMATED_EXPIRATION","DWPI_ABSTRACT.DETAILED_DESCRIPTION","INPADOC_FAMILY.TITLES.TITLE_PORTUGUESSE","ESTIMATED_EXPIRATION.DATE","FORWARD_CITATION.MEMBERS","ESTIMATED_EXPIRATION.FACTOR_EARLIEST_EFFECTIVE_FILING_DATE","US_REASSIGNMENTS.ASSIGNEES.CITY","CLAIMS.SOURCE","DPCI_CITED_COUNTS.AUTHORITIES_TOTAL","PUBLICATION_TYPE","TITLES.TEXT","INDEPENDENT_CLAIMS.XML","PRIORITIES.NUMBER","BACKWARD_CITATION.MEMBERS.RELEVANCE_CATEGORY","FORWARD_CITATION.GUID","DWPI_ABSTRACT.ACTIVITY","DWPI_ABSTRACT_EXT.DEFINITION","DWPI_CLASSES.CLASS","INPADOC_FAMILY_STATUS","ESTIMATED_EXPIRATION.FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE","EXAMINERS.SECONDARIES","INPADOC_FAMILY.DERWENT_ASSIGNEES","INDEPENDENT_CLAIMS.LANGUAGE","DPCI_CITING_PATENTS.DWPI_ASSIGNEES","REPRESENTATIVES.NAME","US_REASSIGNMENTS.DATE_RECORDED","DESIGNATED_OFFICES","INPADOC_FAMILY.COUNTRY_CODE","ASSIGNEES_CURRENT_US","DPCI_CITED_NON_PATENTS.MEMBERS.FAMILY_MEMBER","US_REASSIGNMENTS.CONVEYANCE","DPCI_CITED_PATENTS.DWPI_ASSIGNEES.NAME","CORRESPONDENTS.NAME","EXAMINERS","CLAIMS.INDEX","IPCS.DESCRIPTION","PUBLICATION_LANGUAGE","DPCI_CITED_NON_PATENTS.MEMBERS.RELEVANCE_CATEGORY","ESTIMATED_EXPIRATION.DISCLAIMER_FLAG"],"type":"string"},"type":"array"},"GUIDS":{"description":"Document(s) to retrieve","items":{"description":"Unique ID of patent document","example":"WO2021243294A120211202","type":"string"},"type":"array"}},"required":["GUIDS"],"type":"object"},"records_request_trademark":{"properties":{"FIELDS":{"description":"Fields to fetch","items":{"description":"Fields to fetch","enum":["STATUS.EXPIRY_DATE","STATUS.CANCELLATION_DATE","APPLICANTS","ID","GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_CLASS_NUMBER","FIGURATIVE_ELEMENTS.CLASSIFICATION_CODES_ENRICHED","STATUS.INITIAL_APPLICATION_DATE","REPRESENTATIVES.NAME_NATIVE","APPLICANTS.NAME_NATIVE","FIGURATIVE_ELEMENTS.CLASSIFICATION","STATUS.CURRENT_STATUS_DERIVED","WORD_MARK_SPECIFICATION.MARK_TRANSLITERATION_TEXT","REPRESENTATIVES.ADDRESS_NATIVE_LINE_TEXT","STATUS.LAST_PUBLICATION_DATE","MARK_FEATURE","STATUS.REGISTRATION_NUMBER_TEXT","REPRESENTATIVE_CORRESPONDENTS.NAME","IMAGE_KIND","STATUS.APPLICATION_DATE","WORD_MARK_SPECIFICATION.MARK_TRANSLATION_TEXT","GOODS_SERVICES.INT_CLASS_DESCRIPTIONS","STATUS.REGISTRATION_DATE","DESIGNATION_BASIS","REPRESENTATIVES","APPLICANTS.ADDRESS_COUNTRY_CODE","STATUS.APPLICATION_NUMBER_TEXT","STATUS.PUBLICATION_YEAR","GUID","REPRESENTATIVE_CORRESPONDENTS","STATUS.CURRENT_STATUS","WORD_MARK_SPECIFICATION.MARK_VERBAL_ELEMENT_TEXT","STATUS","PRIORITIES.PRIORITY_DATE","PRIORITIES.COUNTRY_CODE","GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION","DESIGNATED_COUNTRY_CODE","STATUS.RENEWAL_DATE","REPRESENTATIVE_CORRESPONDENTS.ADDRESS_LINE_TEXT","LAST_UPDATED_DATE","APPLICANTS.ADDRESS_NATIVE_LINE_TEXT","GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_GOODS_SERVICES_LANGUAGE_CODE","STATUS.RENEWAL_PUBLISHED_DATE","STATUS.PUBLICATION_DATE","WORD_MARK_SPECIFICATION.MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED","IMAGES_TOTAL_QUANTITY","APPLICATION_LANGUAGE_CODE","APPLICANTS.ADDRESS_LINE_TEXT","APPLICANTS.NAME","REPRESENTATIVES.ADDRESS_COUNTRY_CODE","PRIORITIES.NUMBER_TEXT","STATUS.APPLICATION_ABANDONED_DATE","GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS.NAT_GOODS_SERVICES_DESCRIPTION","GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS","REGISTRATION_OFFICE_CODE","GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_GOODS_SERVICES_DESCRIPTION","GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE","GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS.NAT_GOODS_SERVICES_LANGUAGE_CODE","REPRESENTATIVES.NAME","DISCLAIMERS","STATUS.FILING_DATE_DERIVED","PRIORITIES","GOODS_SERVICES","WORD_MARK_SPECIFICATION","REPRESENTATIVE_CORRESPONDENTS.ADDRESS_COUNTRY_CODE","SECOND_LANGUAGE_CODE","STATUS.INITIAL_REGISTRATION_DATE","FIGURATIVE_ELEMENTS","GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS.NAT_CLASS_NUMBER","REPRESENTATIVES.ADDRESS_LINE_TEXT"],"type":"string"},"type":"array"},"GUIDS":{"description":"Document(s) to retrieve","items":{"description":"Unique ID of trademark document","example":"USAFI65E053B1C87611DEB9C6000D609921FB","type":"string"},"type":"array"}},"required":["GUIDS"],"type":"object"},"search_by_ids_request_derwent_api":{"properties":{"params":{"items":{"properties":{"collections":{"description":"Requested Collection(s)","example":"arapps, arutils, apgrants, amgrants, auapps, augrants, auinnov, atapps, atgrants, atutils, bygrants, byutils, beapps, begrants, brapps, brgrants, brutils, bgapps, bggrants, bgutils, caapps, cagrants, cnapps, cngrants, cnutils, coapps, crapps, crutils, hrapps, hrgrants, hrutils, cuapps, cugrants, czapps, czgrants, czutils, csgrants, dkapps, dkgrants, dkutils, epapps, epgrants, eeapps, eegrants, eeutils, eagrants, fiapps, figrants, frapps, frgrants, gegrants, ddapps, ddgrants, deapps, degrants, deutils, gbapps, gbgrants, grapps, grgrants, gcgrants, hkapps, hkgrants, hkutils, hugrants, isgrants, inapps, ingrants, idapps, idsimple, ieapps, iegrants, ieutils, ilgrants, itgrants, jpapps, jpgrants, jputils, krapps, krgrants, krutils, lvgrants, ltgrants, luapps, lugrants, myapps, mygrants, mxapps, mxgrants, mdgrants, mdutils, mcgrants, mngrants, mnutils, maapps, magrants, nlapps, nlgrants, nzgrants, noapps, nogrants, oagrants, phapps, phgrants, phutils, plgrants, plutils, ptapps, ptgrants, ptutils, roapps, rogrants, routils, ruapps, rugrants, ruutils, saapps, sagrants, rsapps, rsgrants, rsutils, sgapps, sggrants, skapps, skgrants, skutils, sigrants, siutils, zaapps, sugrants, esapps, esgrants, esutils, seapps, segrants, chapps, chgrants, twapps, twgrants, twutils, thapps, thgrants, thutils, tnapps, trapps, trgrants, trutils, uagrants, uautils, usapps, usgrants, uyapps, vnapps, vngrants, vnutils, woapps, derwent, inpadoc","type":"string"},"ids":{"description":"Requested document ids","example":"EP4451620A120241023","type":"string"},"return-fields":{"description":"Requested resultset field(s)","example":"pn,pd","type":"string"}},"required":["collections","ids"],"type":"object"},"type":"array"}},"type":"object"},"search_by_pns_request_derwent_api":{"properties":{"params":{"items":{"properties":{"collections":{"description":"Requested Collection(s)","example":"arapps, arutils, apgrants, amgrants, auapps, augrants, auinnov, atapps, atgrants, atutils, bygrants, byutils, beapps, begrants, brapps, brgrants, brutils, bgapps, bggrants, bgutils, caapps, cagrants, cnapps, cngrants, cnutils, coapps, crapps, crutils, hrapps, hrgrants, hrutils, cuapps, cugrants, czapps, czgrants, czutils, csgrants, dkapps, dkgrants, dkutils, epapps, epgrants, eeapps, eegrants, eeutils, eagrants, fiapps, figrants, frapps, frgrants, gegrants, ddapps, ddgrants, deapps, degrants, deutils, gbapps, gbgrants, grapps, grgrants, gcgrants, hkapps, hkgrants, hkutils, hugrants, isgrants, inapps, ingrants, idapps, idsimple, ieapps, iegrants, ieutils, ilgrants, itgrants, jpapps, jpgrants, jputils, krapps, krgrants, krutils, lvgrants, ltgrants, luapps, lugrants, myapps, mygrants, mxapps, mxgrants, mdgrants, mdutils, mcgrants, mngrants, mnutils, maapps, magrants, nlapps, nlgrants, nzgrants, noapps, nogrants, oagrants, phapps, phgrants, phutils, plgrants, plutils, ptapps, ptgrants, ptutils, roapps, rogrants, routils, ruapps, rugrants, ruutils, saapps, sagrants, rsapps, rsgrants, rsutils, sgapps, sggrants, skapps, skgrants, skutils, sigrants, siutils, zaapps, sugrants, esapps, esgrants, esutils, seapps, segrants, chapps, chgrants, twapps, twgrants, twutils, thapps, thgrants, thutils, tnapps, trapps, trgrants, trutils, uagrants, uautils, usapps, usgrants, uyapps, vnapps, vngrants, vnutils, woapps, derwent, inpadoc","type":"string"},"pns":{"description":"Requested patent numbers","example":"EP4451620A1","type":"string"},"return-fields":{"description":"Requested resultset field(s)","example":"pn,pd","type":"string"}},"required":["collections","pns"],"type":"object"},"type":"array"}},"type":"object"},"search_by_query_request_derwent_api":{"properties":{"params":{"items":{"properties":{"collections":{"description":"Requested Collection(s)","example":"usapps,usgrants,epapps,epgrants,woapps","type":"string"},"offset":{"description":"Starting range of the documents to be fetched","example":0,"type":"number"},"query":{"description":"Requested query","example":"pd>=(20180101)","type":"string"},"return-fields":{"description":"Requested resultset field(s)","example":"pn,pd","type":"string"},"size":{"description":"Number of the documents to be fetched","example":3,"type":"number"}},"required":["collections","query"],"type":"object"},"type":"array"}},"type":"object"},"search_request_caselaw":{"properties":{"AGG":{"description":"A list of aggregations","items":{"properties":{"ALIAS":{"description":"Field name alias","example":"NUM_GUIDS","type":"string"},"FIELD":{"description":"Field to query","enum":["NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS","DOMAIN_NAME_ANONYMOUS","FIRST_ACTION_DATE","DOCUMENT_CITABLE","DOMAIN_IS_DOMAIN_NAME","DESIGN_LOCARNO_CLASS","PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION","TRADEMARK_NICE_CLASS","DOMAIN_IS_UNFAIR_COMPETITION","PATENT_PUBLICATION_NUMBER","CLAIM_CONSTRUCTION_AGREED","RIGHT_ASSESSMENT_INFRINGEMENT","PATENT_ROLE","PATENT_INPADOC_FAMILY_ID","PATENT_INDEX","SETTLED","DOCKET_COURT_COUNTRY_DERIVED_TEXT","LAST_UPDATED_DATE","DOMAIN_NAME","DESIGN_REGISTRATION_STATUS","DOCUMENT_WINNER","PATENT_INVENTION_ID","REMEDY","POINT_OF_LAW_OUTCOME_POSITIVE","CASE_DOMAIN","POINT_OF_LAW_OUTCOME","DOCUMENT_DEFAULT_JUDGEMENT","DESIGN_REGISTRATION_OFFICE","DESIGN_VIENNA_CLASS","PATENT_DWPI_APPLICATION_NUMBER","PARTY_LEGAL_FORM","EU_TRADEMARK","CASE_STATUS","DESIGN_PRODUCT","RIGHT_ASSESSMENT_AMENDED_CLAIMS","DAMAGE_PARTIAL","PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION","BINDER_ID","PATENT_REFERENCE_NUMBER","COPYRIGHT_ROLE","DAMAGE_CURRENT_USD_EQUIVALENT","POINT_OF_LAW_PARENT_PATH","CLOSED","POINT_OF_LAW_OUTCOME_NEGATIVE","PATENT_INFRINGEMENT","PATENT_APPLICATION_NUMBER","DAMAGE_AMOUNT","DOCUMENT_LEVEL","DOMAIN_IS_PATENT","FIRST_ACTION_TYPE","RELATION_TARGET_REFERENCE","DOCUMENT_TRADEMARK_REPUTATION","DAMAGE_REQUESTED","POINT_OF_LAW_NAME","PATENT_DOCDB_FAMILY_ID","CLAIM_CONSTRUCTION_DEFINITION","DAMAGE_NATURE","PATENT_REFERENCE_ORIGINAL","PATENT_VALIDITY_CHALLENGES","TRADEMARK_VERBAL_ELEMENT","DOMAIN_NAME_TLD","PARTY_PLAINTIFF_NAME","DOCKET_COURT_TYPE_JUDICIAL","DOCUMENT_STATE","PATENT_TITLE_LANGUAGE","DOCKET_COURT_COUNTRY","PATENT_TITLE","TRADEMARK_VIENNA_CLASS","DESIGN_REGISTRATION_NUMBER","EARLIEST_EVENT_DATE","DOCKET_COURT_TYPE_ARBITRATION","PRODUCT_COMPARISON_SIMILAR","PATENT_VALIDITY","DOCKET_REFERENCE","DOMAIN_IS_COPYRIGHT","PARTY_OPTIMIZED_NAMES","DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","PATENT_DAMAGES_ASSIGNED","DESIGN_VERBAL_ELEMENT","PATENT_APPLICATION_ID","TRADEMARK_ID","NUMBER_PLAINTIFFS","DOMAIN_IS_TRADEMARK","DOCUMENT_SUBTYPE","PARTY_ALTERNATIVE_ULTIMATE_PARENT","RELEVANT_PUBLIC_AVERAGE_CONSUMER","TRADEMARK_ROLE","RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX","PARTY_COUNTRY","CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION","PATENT_ASSERTIONS","IPC_CLASS_INDUSTRY_AREA","TOTAL_DAMAGE_CURRENCY","DOMAIN_NAME_ROLE","DOCUMENT_TYPE","RIGHT_ASSESSMENT_VALIDITY","PARTY_IS_ANONYMOUS","IPC_CLASS_INDUSTRY_FIELD","TRADEMARK_LOCARNO_CLASS","WITHDRAWN","PATENT_TYPE","NUMBER_DEFENDANTS","RELEVANT_PUBLIC_NICE_CLASS","TRADEMARK_REGISTRATION_NUMBER","TRADEMARK_REGISTRATION_OFFICE","PATENT_REFERENCE_AUTHORITY","TRADEMARK_ANONYMOUS","PARTY_ULTIMATE_PARENT","PATENT_OPTIMIZED_TITLE","COPYRIGHT_TYPE","DOCKET_COURT_NAME","CLAIM_CONSTRUCTION_NOT_NECESSARY","DOCKET_COURT_PATH","PARTY_ROLE","RELATION_RELATION","LAST_EVENT_DATE","REPRESENTATIVE_LEGAL_FORM","PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS","PARTY_PLAINTIFF_ULTIMATE_PARENT","DAMAGE_CURRENCY","DAMAGE_CURRENT_CNY_EQUIVALENT","PATENT_REFERENCE_KIND","DOCKET_COURT_TYPE_ADMINISTRATIVE","PARTY_TYPE","AREA","DESIGN_ROLE","REPRESENTATIVE_OPTIMIZED_NAME","COPYRIGHT_ANONYMOUS","PARTY_OPTIMIZED_NAME","GUID","DAMAGE_CURRENT_EUR_EQUIVALENT","DOCUMENT_REFUSAL","PARTY_DEFENDANT_ULTIMATE_PARENT","POINT_OF_LAW_PREFIX","PATENT_REFERENCE_TYPE","CASE_NAME","RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER","CASE_RESOLUTION","RELEVANT_PUBLIC_AWARENESS","REPRESENTATIVE_TYPE","CASE_STAGE","PATENT_ANONYMOUS","CLAIM_CONSTRUCTION_TERM","DAMAGE_LATER","REPRESENTATIVE_COUNTRY","DESIGN_PRODUCT_LANGUAGE","RELATION_TARGET_DECISION","TRADEMARK_TYPE","DOMAIN_IS_OTHER","PARTY_DEFENDANT_NAME","DOCUMENT_CITATION_REFERENCE","DESIGN_ANONYMOUS","TOTAL_DAMAGE_TYPE","DAMAGE_CALCULATION_METHOD","POINT_OF_LAW_CONFIDENCE_LEVEL","DOCKET_COURT_COUNTRY_TEXT","COPYRIGHT_TITLE","DOCKET_COURT_AREA","PATENT_SOURCE","PARTY_IS_EX_OFFICIO","EX_OFFICIO","TOTAL_DAMAGE_AMOUNT","DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","DOCUMENT_DATE","IPC_CLASS_CODE","RELATION_RATING","DOMAIN_IS_DESIGN_MODEL","DOCUMENT_DECLARATORY","COPYRIGHT_DESCRIPTION"],"example":"GUID","type":"string"},"FUNC":{"description":"Aggregation function","example":"COUNT","type":"string"}},"required":["FIELD","FUNC"],"type":"object"},"type":"array"},"FIELDS":{"oneOf":[{"description":"Fields to fetch. This may also be a structure of type field_aliases_caselaw, rather than an array, in which case the fields will be renamed.","items":{"default":"GUID","description":"Fields to fetch. This may also be a structure of type field_aliases_caselaw, rather than an array, in which case the fields will be renamed.","enum":["NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS","DOMAIN_NAME_ANONYMOUS","FIRST_ACTION_DATE","DOCUMENT_CITABLE","DOMAIN_IS_DOMAIN_NAME","DESIGN_LOCARNO_CLASS","PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION","TRADEMARK_NICE_CLASS","DOMAIN_IS_UNFAIR_COMPETITION","PATENT_PUBLICATION_NUMBER","CLAIM_CONSTRUCTION_AGREED","RIGHT_ASSESSMENT_INFRINGEMENT","PATENT_ROLE","PATENT_INPADOC_FAMILY_ID","PATENT_INDEX","SETTLED","DOCKET_COURT_COUNTRY_DERIVED_TEXT","LAST_UPDATED_DATE","DOMAIN_NAME","DESIGN_REGISTRATION_STATUS","DOCUMENT_WINNER","PATENT_INVENTION_ID","REMEDY","POINT_OF_LAW_OUTCOME_POSITIVE","CASE_DOMAIN","POINT_OF_LAW_OUTCOME","DOCUMENT_DEFAULT_JUDGEMENT","DESIGN_REGISTRATION_OFFICE","DESIGN_VIENNA_CLASS","PATENT_DWPI_APPLICATION_NUMBER","PARTY_LEGAL_FORM","EU_TRADEMARK","CASE_STATUS","DESIGN_PRODUCT","RIGHT_ASSESSMENT_AMENDED_CLAIMS","DAMAGE_PARTIAL","PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION","BINDER_ID","PATENT_REFERENCE_NUMBER","COPYRIGHT_ROLE","DAMAGE_CURRENT_USD_EQUIVALENT","POINT_OF_LAW_PARENT_PATH","CLOSED","POINT_OF_LAW_OUTCOME_NEGATIVE","PATENT_INFRINGEMENT","PATENT_APPLICATION_NUMBER","DAMAGE_AMOUNT","DOCUMENT_LEVEL","DOMAIN_IS_PATENT","FIRST_ACTION_TYPE","RELATION_TARGET_REFERENCE","DOCUMENT_TRADEMARK_REPUTATION","DAMAGE_REQUESTED","POINT_OF_LAW_NAME","PATENT_DOCDB_FAMILY_ID","CLAIM_CONSTRUCTION_DEFINITION","DAMAGE_NATURE","PATENT_REFERENCE_ORIGINAL","PATENT_VALIDITY_CHALLENGES","TRADEMARK_VERBAL_ELEMENT","DOMAIN_NAME_TLD","PARTY_PLAINTIFF_NAME","DOCKET_COURT_TYPE_JUDICIAL","DOCUMENT_STATE","PATENT_TITLE_LANGUAGE","DOCKET_COURT_COUNTRY","PATENT_TITLE","TRADEMARK_VIENNA_CLASS","DESIGN_REGISTRATION_NUMBER","EARLIEST_EVENT_DATE","DOCKET_COURT_TYPE_ARBITRATION","PRODUCT_COMPARISON_SIMILAR","PATENT_VALIDITY","DOCKET_REFERENCE","DOMAIN_IS_COPYRIGHT","PARTY_OPTIMIZED_NAMES","DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","PATENT_DAMAGES_ASSIGNED","DESIGN_VERBAL_ELEMENT","PATENT_APPLICATION_ID","TRADEMARK_ID","NUMBER_PLAINTIFFS","DOMAIN_IS_TRADEMARK","DOCUMENT_SUBTYPE","PARTY_ALTERNATIVE_ULTIMATE_PARENT","RELEVANT_PUBLIC_AVERAGE_CONSUMER","TRADEMARK_ROLE","RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX","PARTY_COUNTRY","CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION","PATENT_ASSERTIONS","IPC_CLASS_INDUSTRY_AREA","TOTAL_DAMAGE_CURRENCY","DOMAIN_NAME_ROLE","DOCUMENT_TYPE","RIGHT_ASSESSMENT_VALIDITY","PARTY_IS_ANONYMOUS","IPC_CLASS_INDUSTRY_FIELD","TRADEMARK_LOCARNO_CLASS","WITHDRAWN","PATENT_TYPE","NUMBER_DEFENDANTS","RELEVANT_PUBLIC_NICE_CLASS","TRADEMARK_REGISTRATION_NUMBER","TRADEMARK_REGISTRATION_OFFICE","PATENT_REFERENCE_AUTHORITY","TRADEMARK_ANONYMOUS","PARTY_ULTIMATE_PARENT","PATENT_OPTIMIZED_TITLE","COPYRIGHT_TYPE","DOCKET_COURT_NAME","CLAIM_CONSTRUCTION_NOT_NECESSARY","DOCKET_COURT_PATH","PARTY_ROLE","RELATION_RELATION","LAST_EVENT_DATE","REPRESENTATIVE_LEGAL_FORM","PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS","PARTY_PLAINTIFF_ULTIMATE_PARENT","DAMAGE_CURRENCY","DAMAGE_CURRENT_CNY_EQUIVALENT","PATENT_REFERENCE_KIND","DOCKET_COURT_TYPE_ADMINISTRATIVE","PARTY_TYPE","AREA","DESIGN_ROLE","REPRESENTATIVE_OPTIMIZED_NAME","COPYRIGHT_ANONYMOUS","PARTY_OPTIMIZED_NAME","GUID","DAMAGE_CURRENT_EUR_EQUIVALENT","DOCUMENT_REFUSAL","PARTY_DEFENDANT_ULTIMATE_PARENT","POINT_OF_LAW_PREFIX","PATENT_REFERENCE_TYPE","CASE_NAME","RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER","CASE_RESOLUTION","RELEVANT_PUBLIC_AWARENESS","REPRESENTATIVE_TYPE","CASE_STAGE","PATENT_ANONYMOUS","CLAIM_CONSTRUCTION_TERM","DAMAGE_LATER","REPRESENTATIVE_COUNTRY","DESIGN_PRODUCT_LANGUAGE","RELATION_TARGET_DECISION","TRADEMARK_TYPE","DOMAIN_IS_OTHER","PARTY_DEFENDANT_NAME","DOCUMENT_CITATION_REFERENCE","DESIGN_ANONYMOUS","TOTAL_DAMAGE_TYPE","DAMAGE_CALCULATION_METHOD","POINT_OF_LAW_CONFIDENCE_LEVEL","DOCKET_COURT_COUNTRY_TEXT","COPYRIGHT_TITLE","DOCKET_COURT_AREA","PATENT_SOURCE","PARTY_IS_EX_OFFICIO","EX_OFFICIO","TOTAL_DAMAGE_AMOUNT","DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","DOCUMENT_DATE","IPC_CLASS_CODE","RELATION_RATING","DOMAIN_IS_DESIGN_MODEL","DOCUMENT_DECLARATORY","COPYRIGHT_DESCRIPTION"],"example":"GUID","type":"string"},"type":"array"},{"$ref":"#/components/schemas/field_aliases_caselaw"}]},"GROUPBY":{"description":"Group by fields (for aggregation)","items":{"description":"Group by fields (for aggregation)","enum":["NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS","DOMAIN_NAME_ANONYMOUS","FIRST_ACTION_DATE","DOCUMENT_CITABLE","DOMAIN_IS_DOMAIN_NAME","DESIGN_LOCARNO_CLASS","PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION","TRADEMARK_NICE_CLASS","DOMAIN_IS_UNFAIR_COMPETITION","PATENT_PUBLICATION_NUMBER","CLAIM_CONSTRUCTION_AGREED","RIGHT_ASSESSMENT_INFRINGEMENT","PATENT_ROLE","PATENT_INPADOC_FAMILY_ID","PATENT_INDEX","SETTLED","DOCKET_COURT_COUNTRY_DERIVED_TEXT","LAST_UPDATED_DATE","DOMAIN_NAME","DESIGN_REGISTRATION_STATUS","DOCUMENT_WINNER","PATENT_INVENTION_ID","REMEDY","POINT_OF_LAW_OUTCOME_POSITIVE","CASE_DOMAIN","POINT_OF_LAW_OUTCOME","DOCUMENT_DEFAULT_JUDGEMENT","DESIGN_REGISTRATION_OFFICE","DESIGN_VIENNA_CLASS","PATENT_DWPI_APPLICATION_NUMBER","PARTY_LEGAL_FORM","EU_TRADEMARK","CASE_STATUS","DESIGN_PRODUCT","RIGHT_ASSESSMENT_AMENDED_CLAIMS","DAMAGE_PARTIAL","PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION","BINDER_ID","PATENT_REFERENCE_NUMBER","COPYRIGHT_ROLE","DAMAGE_CURRENT_USD_EQUIVALENT","POINT_OF_LAW_PARENT_PATH","CLOSED","POINT_OF_LAW_OUTCOME_NEGATIVE","PATENT_INFRINGEMENT","PATENT_APPLICATION_NUMBER","DAMAGE_AMOUNT","DOCUMENT_LEVEL","DOMAIN_IS_PATENT","FIRST_ACTION_TYPE","RELATION_TARGET_REFERENCE","DOCUMENT_TRADEMARK_REPUTATION","DAMAGE_REQUESTED","POINT_OF_LAW_NAME","PATENT_DOCDB_FAMILY_ID","CLAIM_CONSTRUCTION_DEFINITION","DAMAGE_NATURE","PATENT_REFERENCE_ORIGINAL","PATENT_VALIDITY_CHALLENGES","TRADEMARK_VERBAL_ELEMENT","DOMAIN_NAME_TLD","PARTY_PLAINTIFF_NAME","DOCKET_COURT_TYPE_JUDICIAL","DOCUMENT_STATE","PATENT_TITLE_LANGUAGE","DOCKET_COURT_COUNTRY","PATENT_TITLE","TRADEMARK_VIENNA_CLASS","DESIGN_REGISTRATION_NUMBER","EARLIEST_EVENT_DATE","DOCKET_COURT_TYPE_ARBITRATION","PRODUCT_COMPARISON_SIMILAR","PATENT_VALIDITY","DOCKET_REFERENCE","DOMAIN_IS_COPYRIGHT","PARTY_OPTIMIZED_NAMES","DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","PATENT_DAMAGES_ASSIGNED","DESIGN_VERBAL_ELEMENT","PATENT_APPLICATION_ID","TRADEMARK_ID","NUMBER_PLAINTIFFS","DOMAIN_IS_TRADEMARK","DOCUMENT_SUBTYPE","RELEVANT_PUBLIC_AVERAGE_CONSUMER","TRADEMARK_ROLE","RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX","PARTY_COUNTRY","CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION","PATENT_ASSERTIONS","IPC_CLASS_INDUSTRY_AREA","TOTAL_DAMAGE_CURRENCY","DOMAIN_NAME_ROLE","DOCUMENT_TYPE","RIGHT_ASSESSMENT_VALIDITY","PARTY_IS_ANONYMOUS","IPC_CLASS_INDUSTRY_FIELD","TRADEMARK_LOCARNO_CLASS","WITHDRAWN","PATENT_TYPE","NUMBER_DEFENDANTS","TRADEMARK_REGISTRATION_NUMBER","TRADEMARK_REGISTRATION_OFFICE","PATENT_REFERENCE_AUTHORITY","TRADEMARK_ANONYMOUS","PARTY_ULTIMATE_PARENT","PATENT_OPTIMIZED_TITLE","COPYRIGHT_TYPE","DOCKET_COURT_NAME","CLAIM_CONSTRUCTION_NOT_NECESSARY","DOCKET_COURT_PATH","PARTY_ROLE","RELATION_RELATION","LAST_EVENT_DATE","REPRESENTATIVE_LEGAL_FORM","PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS","PARTY_PLAINTIFF_ULTIMATE_PARENT","DAMAGE_CURRENCY","DAMAGE_CURRENT_CNY_EQUIVALENT","PATENT_REFERENCE_KIND","DOCKET_COURT_TYPE_ADMINISTRATIVE","PARTY_TYPE","AREA","DESIGN_ROLE","REPRESENTATIVE_OPTIMIZED_NAME","COPYRIGHT_ANONYMOUS","PARTY_OPTIMIZED_NAME","GUID","DAMAGE_CURRENT_EUR_EQUIVALENT","DOCUMENT_REFUSAL","PARTY_DEFENDANT_ULTIMATE_PARENT","POINT_OF_LAW_PREFIX","PATENT_REFERENCE_TYPE","CASE_NAME","RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER","CASE_RESOLUTION","RELEVANT_PUBLIC_AWARENESS","REPRESENTATIVE_TYPE","CASE_STAGE","PATENT_ANONYMOUS","CLAIM_CONSTRUCTION_TERM","DAMAGE_LATER","REPRESENTATIVE_COUNTRY","DESIGN_PRODUCT_LANGUAGE","RELATION_TARGET_DECISION","TRADEMARK_TYPE","DOMAIN_IS_OTHER","PARTY_DEFENDANT_NAME","DOCUMENT_CITATION_REFERENCE","DESIGN_ANONYMOUS","TOTAL_DAMAGE_TYPE","DAMAGE_CALCULATION_METHOD","POINT_OF_LAW_CONFIDENCE_LEVEL","DOCKET_COURT_COUNTRY_TEXT","COPYRIGHT_TITLE","DOCKET_COURT_AREA","PATENT_SOURCE","PARTY_IS_EX_OFFICIO","EX_OFFICIO","TOTAL_DAMAGE_AMOUNT","DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","DOCUMENT_DATE","IPC_CLASS_CODE","RELATION_RATING","DOMAIN_IS_DESIGN_MODEL","DOCUMENT_DECLARATORY","COPYRIGHT_DESCRIPTION"],"example":"GUID","type":"string"},"type":"array"},"LIMIT":{"default":10,"description":"Maximum documents to retrieve","example":10,"type":"number"},"OFFSET":{"default":0,"description":"How many items to skip at the beginning (for pagination)","example":0,"type":"number"},"ORDERBY":{"description":"Order by fields (for aggregation)","items":{"example":{"GUID":"ASC"},"properties":{"AREA":{"enum":["DESC","ASC"],"type":"string"},"BINDER_ID":{"enum":["DESC","ASC"],"type":"string"},"CASE_DOMAIN":{"enum":["DESC","ASC"],"type":"string"},"CASE_NAME":{"enum":["DESC","ASC"],"type":"string"},"CASE_RESOLUTION":{"enum":["DESC","ASC"],"type":"string"},"CASE_STAGE":{"enum":["DESC","ASC"],"type":"string"},"CASE_STATUS":{"enum":["DESC","ASC"],"type":"string"},"CLAIM_CONSTRUCTION_AGREED":{"enum":["DESC","ASC"],"type":"string"},"CLAIM_CONSTRUCTION_DEFINITION":{"enum":["DESC","ASC"],"type":"string"},"CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION":{"enum":["DESC","ASC"],"type":"string"},"CLAIM_CONSTRUCTION_NOT_NECESSARY":{"enum":["DESC","ASC"],"type":"string"},"CLAIM_CONSTRUCTION_TERM":{"enum":["DESC","ASC"],"type":"string"},"CLOSED":{"enum":["DESC","ASC"],"type":"string"},"COPYRIGHT_ANONYMOUS":{"enum":["DESC","ASC"],"type":"string"},"COPYRIGHT_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"COPYRIGHT_ROLE":{"enum":["DESC","ASC"],"type":"string"},"COPYRIGHT_TITLE":{"enum":["DESC","ASC"],"type":"string"},"COPYRIGHT_TYPE":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_AMOUNT":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_CALCULATION_METHOD":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_CURRENCY":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_CURRENT_CNY_EQUIVALENT":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_CURRENT_EUR_EQUIVALENT":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_CURRENT_USD_EQUIVALENT":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_LATER":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_NATURE":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_PARTIAL":{"enum":["DESC","ASC"],"type":"string"},"DAMAGE_REQUESTED":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_ANONYMOUS":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_LOCARNO_CLASS":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_PRODUCT":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_PRODUCT_LANGUAGE":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_REGISTRATION_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_REGISTRATION_OFFICE":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_REGISTRATION_STATUS":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_ROLE":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_VERBAL_ELEMENT":{"enum":["DESC","ASC"],"type":"string"},"DESIGN_VIENNA_CLASS":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_AREA":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_COUNTRY":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_TEXT":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_COUNTRY_TEXT":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_NAME":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_PATH":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_TYPE_ADMINISTRATIVE":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_TYPE_ARBITRATION":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_COURT_TYPE_JUDICIAL":{"enum":["DESC","ASC"],"type":"string"},"DOCKET_REFERENCE":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_CITABLE":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_CITATION_REFERENCE":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"DOCUMENT_DECLARATORY":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_DEFAULT_JUDGEMENT":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_LEVEL":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_REFUSAL":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_STATE":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_SUBTYPE":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_TRADEMARK_REPUTATION":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_TYPE":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_WINNER":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_IS_COPYRIGHT":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_IS_DESIGN_MODEL":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_IS_DOMAIN_NAME":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_IS_OTHER":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_IS_PATENT":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_IS_TRADEMARK":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_IS_UNFAIR_COMPETITION":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_NAME":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_NAME_ANONYMOUS":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_NAME_ROLE":{"enum":["DESC","ASC"],"type":"string"},"DOMAIN_NAME_TLD":{"enum":["DESC","ASC"],"type":"string"},"EARLIEST_EVENT_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"EU_TRADEMARK":{"enum":["DESC","ASC"],"type":"string"},"EX_OFFICIO":{"enum":["DESC","ASC"],"type":"string"},"FIRST_ACTION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"FIRST_ACTION_TYPE":{"enum":["DESC","ASC"],"type":"string"},"GUID":{"enum":["DESC","ASC"],"type":"string"},"IPC_CLASS_CODE":{"enum":["DESC","ASC"],"type":"string"},"IPC_CLASS_INDUSTRY_AREA":{"enum":["DESC","ASC"],"type":"string"},"IPC_CLASS_INDUSTRY_FIELD":{"enum":["DESC","ASC"],"type":"string"},"LAST_EVENT_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"LAST_UPDATED_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"NUMBER_DEFENDANTS":{"enum":["DESC","ASC"],"type":"string"},"NUMBER_PLAINTIFFS":{"enum":["DESC","ASC"],"type":"string"},"NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO":{"enum":["DESC","ASC"],"type":"string"},"PARTY_ALTERNATIVE_ULTIMATE_PARENT":{"enum":["DESC","ASC"],"type":"string"},"PARTY_COUNTRY":{"enum":["DESC","ASC"],"type":"string"},"PARTY_DEFENDANT_NAME":{"enum":["DESC","ASC"],"type":"string"},"PARTY_DEFENDANT_ULTIMATE_PARENT":{"enum":["DESC","ASC"],"type":"string"},"PARTY_IS_ANONYMOUS":{"enum":["DESC","ASC"],"type":"string"},"PARTY_IS_EX_OFFICIO":{"enum":["DESC","ASC"],"type":"string"},"PARTY_LEGAL_FORM":{"enum":["DESC","ASC"],"type":"string"},"PARTY_OPTIMIZED_NAME":{"enum":["DESC","ASC"],"type":"string"},"PARTY_OPTIMIZED_NAMES":{"enum":["DESC","ASC"],"type":"string"},"PARTY_PLAINTIFF_NAME":{"enum":["DESC","ASC"],"type":"string"},"PARTY_PLAINTIFF_ULTIMATE_PARENT":{"enum":["DESC","ASC"],"type":"string"},"PARTY_ROLE":{"enum":["DESC","ASC"],"type":"string"},"PARTY_TYPE":{"enum":["DESC","ASC"],"type":"string"},"PARTY_ULTIMATE_PARENT":{"enum":["DESC","ASC"],"type":"string"},"PATENT_ANONYMOUS":{"enum":["DESC","ASC"],"type":"string"},"PATENT_APPLICATION_ID":{"enum":["DESC","ASC"],"type":"string"},"PATENT_APPLICATION_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"PATENT_ASSERTIONS":{"enum":["DESC","ASC"],"type":"string"},"PATENT_DAMAGES_ASSIGNED":{"enum":["DESC","ASC"],"type":"string"},"PATENT_DOCDB_FAMILY_ID":{"enum":["DESC","ASC"],"type":"string"},"PATENT_DWPI_APPLICATION_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"PATENT_INDEX":{"enum":["DESC","ASC"],"type":"string"},"PATENT_INFRINGEMENT":{"enum":["DESC","ASC"],"type":"string"},"PATENT_INPADOC_FAMILY_ID":{"enum":["DESC","ASC"],"type":"string"},"PATENT_INVENTION_ID":{"enum":["DESC","ASC"],"type":"string"},"PATENT_OPTIMIZED_TITLE":{"enum":["DESC","ASC"],"type":"string"},"PATENT_PUBLICATION_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"PATENT_REFERENCE_AUTHORITY":{"enum":["DESC","ASC"],"type":"string"},"PATENT_REFERENCE_KIND":{"enum":["DESC","ASC"],"type":"string"},"PATENT_REFERENCE_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"PATENT_REFERENCE_ORIGINAL":{"enum":["DESC","ASC"],"type":"string"},"PATENT_REFERENCE_TYPE":{"enum":["DESC","ASC"],"type":"string"},"PATENT_ROLE":{"enum":["DESC","ASC"],"type":"string"},"PATENT_SOURCE":{"enum":["DESC","ASC"],"type":"string"},"PATENT_TITLE":{"enum":["DESC","ASC"],"type":"string"},"PATENT_TITLE_LANGUAGE":{"enum":["DESC","ASC"],"type":"string"},"PATENT_TYPE":{"enum":["DESC","ASC"],"type":"string"},"PATENT_VALIDITY":{"enum":["DESC","ASC"],"type":"string"},"PATENT_VALIDITY_CHALLENGES":{"enum":["DESC","ASC"],"type":"string"},"POINT_OF_LAW_CONFIDENCE_LEVEL":{"enum":["DESC","ASC"],"type":"string"},"POINT_OF_LAW_NAME":{"enum":["DESC","ASC"],"type":"string"},"POINT_OF_LAW_OUTCOME":{"enum":["DESC","ASC"],"type":"string"},"POINT_OF_LAW_OUTCOME_NEGATIVE":{"enum":["DESC","ASC"],"type":"string"},"POINT_OF_LAW_OUTCOME_POSITIVE":{"enum":["DESC","ASC"],"type":"string"},"POINT_OF_LAW_PARENT_PATH":{"enum":["DESC","ASC"],"type":"string"},"POINT_OF_LAW_PREFIX":{"enum":["DESC","ASC"],"type":"string"},"PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS":{"enum":["DESC","ASC"],"type":"string"},"PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS":{"enum":["DESC","ASC"],"type":"string"},"PRODUCT_COMPARISON_SIMILAR":{"enum":["DESC","ASC"],"type":"string"},"RELATION_RATING":{"enum":["DESC","ASC"],"type":"string"},"RELATION_RELATION":{"enum":["DESC","ASC"],"type":"string"},"RELATION_TARGET_DECISION":{"enum":["DESC","ASC"],"type":"string"},"RELATION_TARGET_REFERENCE":{"enum":["DESC","ASC"],"type":"string"},"RELEVANT_PUBLIC_AVERAGE_CONSUMER":{"enum":["DESC","ASC"],"type":"string"},"RELEVANT_PUBLIC_AWARENESS":{"enum":["DESC","ASC"],"type":"string"},"RELEVANT_PUBLIC_NICE_CLASS":{"enum":["DESC","ASC"],"type":"string"},"RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER":{"enum":["DESC","ASC"],"type":"string"},"REMEDY":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_COUNTRY":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_LEGAL_FORM":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_OPTIMIZED_NAME":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_TYPE":{"enum":["DESC","ASC"],"type":"string"},"RIGHT_ASSESSMENT_AMENDED_CLAIMS":{"enum":["DESC","ASC"],"type":"string"},"RIGHT_ASSESSMENT_INFRINGEMENT":{"enum":["DESC","ASC"],"type":"string"},"RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX":{"enum":["DESC","ASC"],"type":"string"},"RIGHT_ASSESSMENT_VALIDITY":{"enum":["DESC","ASC"],"type":"string"},"SETTLED":{"enum":["DESC","ASC"],"type":"string"},"TOTAL_DAMAGE_AMOUNT":{"enum":["DESC","ASC"],"type":"string"},"TOTAL_DAMAGE_CURRENCY":{"enum":["DESC","ASC"],"type":"string"},"TOTAL_DAMAGE_TYPE":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_ANONYMOUS":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_ID":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_LOCARNO_CLASS":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_NICE_CLASS":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_REGISTRATION_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_REGISTRATION_OFFICE":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_ROLE":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_TYPE":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_VERBAL_ELEMENT":{"enum":["DESC","ASC"],"type":"string"},"TRADEMARK_VIENNA_CLASS":{"enum":["DESC","ASC"],"type":"string"},"WITHDRAWN":{"enum":["DESC","ASC"],"type":"string"}},"type":"object"},"type":"array"},"QUERY":{"description":"Either a query_body_caselaw object or an array of one or more query_body_caselaw objects separated by strings consisting of boolean operators.","oneOf":[{"items":{"anyOf":[{"description":"boolean operator","type":"string"},{"$ref":"#/components/schemas/query_body_caselaw"}]},"type":"array"},{"$ref":"#/components/schemas/query_body_caselaw"}]}},"type":"object"},"search_request_patent":{"properties":{"AGG":{"description":"A list of aggregations","items":{"properties":{"ALIAS":{"description":"Field name alias","example":"NUM_GUIDS","type":"string"},"FIELD":{"description":"Field to query","enum":["DWPI_MANUAL_CODE_CLASS","APPLICATION_NUMBER","DEAD_ALIVE_STATUS","ESTIMATED_EXPIRATION_DISCLAIMER_FLAG","EARLIEST_PRIORITY_COUNTRY","IPC_SUBCLASS_DESCRIPTION","DWPI_MANUAL_CODE_SECTION","ASSIGNEE_CURRENT_US","GRANTED","APPLICATION_DATE","EXAMINER_MAIN","CITATION_WOS_CLUSTERKEY","LAST_UPDATED_DATE","AGENT_COUNTRY","DWPI_KIND_CODE_BASIC","DPCI_CITED_COUNTS_AUTHORITIES_TOTAL","INVENTOR_ADDRESS","SERIAL_NUMBER","EARLIEST_PRIORITY_NUMBER","IPC_SECTION","CPC_TYPE","IPC_SUBCLASS","DERWENT_BACKWARD_CITATION_COUNT","DOCDB_SIMPLE_FAMILY_ID","DSI_INVENTION_SUCCESS_SCORE","EARLIEST_PRIORITY_YEAR","CORRESPONDENT_ZIP_CODE","CORRESPONDENT_NAME","DWPI_MANUAL_CODE_DESCRIPTION","IPC_TYPE","ASSIGNEE_ORIGINAL_NAME","OPTIMIZED_ASSIGNEES","DERWENT_FORWARD_CITATION_COUNT","EXAMINER_SECONDARY","DSI_INVENTION_INFLUENCE_SCORE","DPCI_CITING_COUNTS_PATENTS_TOTAL","CITATION_WOS_SCORE","DWPI_APPLICATION_NUMBER_BASIC","DWPI_ACCESSION_NUMBER","DWPI_ASSIGNEE_NAME","ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE","DWPI_ASSIGNEE_CODE_TYPE","DWPI_CLASS","ASSIGNEE_ORIGINAL_NATIONALITY","ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE","ESTIMATED_EXPIRATION_DATE","IPC_4","REGISTRATION_OFFICE","INVENTOR_NAME","PUBLICATION_YEAR","PUBLICATION_LANGUAGE","APPLICATION_REGISTRATION_OFFICE","CORRESPONDENT_CITY","CPC_SYMBOL","DSI_TECHNICAL_DISTINCTIVENESS_SCORE","DWPI_MANUAL_CODE_4","ASSIGNEE_ORIGINAL_ZIP_CODE","CORRESPONDENT_STATE","DPCI_CITED_COUNTS_NON_PATENTS_TOTAL","DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL","ULTIMATE_PARENT","AGENT_ZIP_CODE","AGENT_INID","ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR","DWPI_FAMILY_MEMBER_COUNT","DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL","INVENTOR_ZIP_CODE","REPRESENTATIVE_NAME","GRANT_DATE","DWPI_CLASS_DESCRIPTION","DWPI_EARLIEST_PRIORITY_DATE","GREEN_DATA_CATEGORY","EARLIEST_PRIORITY_DATE","IPC_SECTION_DESCRIPTION","AGENT_STATE","ASSIGNEE_ORIGINAL_CITY","IPC_SYMBOL","DSI_INVENTION_GLOBALIZATION_SCORE","DWPI_MANUAL_CODE","DSI_STRENGTH_INDEX","KIND_CODE","ASSIGNEE_ORIGINAL_INID","DWPI_DESIGNATED_OFFICE_COUNT","IPC_CURRENT","PUBLICATION_NUMBER","ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT","IPC_CLASS","PATENT_TYPE","CPC_CURRENT","DPCI_CITED_COUNTS_PATENTS_TOTAL","JP_CLASS_FI_CODE","DOCUMENT_GUID","INVENTOR_COUNTRY","ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM","PUBLICATION_DATE","JP_CLASS_F_TERM","DWPI_REGISTRATION_OFFICE_BASIC","CPC_4","DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","DWPI_CLASS_SECTION","DWPI_PUBLICATION_NUMBER_BASIC","DWPI_MANUAL_CODE_CLASS_DESCRIPTION","DWPI_EARLIEST_PRIORITY_YEAR","DWPI_CLASS_SECTION_DESCRIPTION","DPCI_CITING_COUNTS_AUTHORITIES_TOTAL","DWPI_INVENTOR_NAME","ASSIGNEE_ORIGINAL_COUNTRY","GUID","CORRESPONDENT_COUNTRY","AGENT_CITY","DWPI_FAMILY_STATUS","DSI_AVERAGE_SCORE","DSI_YEARS_REMAINING","CORRESPONDENT_ADDRESS","DWPI_MANUAL_CODE_SECTION_DESCRIPTION","INVENTOR_STATE","AGENT_NAME","DSI_AGE_DISCOUNT","PUBLICATION_TYPE","INVENTOR_NATIONALITY","ASSIGNEE_ORIGINAL_ADDRESS","INVENTOR_CITY","INPADOC_FAMILY_STATUS","ASSIGNEE_NAME","IPC_DESCRIPTION","IPC_CLASS_DESCRIPTION","AGENT_ADDRESS","DWPI_ASSIGNEE_CODE","DWPI_TITLE","ASSIGNEE_ORIGINAL_STATE"],"example":"GUID","type":"string"},"FUNC":{"description":"Aggregation function","example":"COUNT","type":"string"}},"required":["FIELD","FUNC"],"type":"object"},"type":"array"},"FIELDS":{"oneOf":[{"description":"Fields to fetch. This may also be a structure of type field_aliases_patent, rather than an array, in which case the fields will be renamed.","items":{"default":"GUID","description":"Fields to fetch. This may also be a structure of type field_aliases_patent, rather than an array, in which case the fields will be renamed.","enum":["DWPI_MANUAL_CODE_CLASS","APPLICATION_NUMBER","DEAD_ALIVE_STATUS","ESTIMATED_EXPIRATION_DISCLAIMER_FLAG","EARLIEST_PRIORITY_COUNTRY","IPC_SUBCLASS_DESCRIPTION","DWPI_MANUAL_CODE_SECTION","ASSIGNEE_CURRENT_US","GRANTED","APPLICATION_DATE","EXAMINER_MAIN","CITATION_WOS_CLUSTERKEY","LAST_UPDATED_DATE","AGENT_COUNTRY","DWPI_KIND_CODE_BASIC","DPCI_CITED_COUNTS_AUTHORITIES_TOTAL","INVENTOR_ADDRESS","SERIAL_NUMBER","EARLIEST_PRIORITY_NUMBER","IPC_SECTION","CPC_TYPE","IPC_SUBCLASS","DERWENT_BACKWARD_CITATION_COUNT","DOCDB_SIMPLE_FAMILY_ID","DSI_INVENTION_SUCCESS_SCORE","EARLIEST_PRIORITY_YEAR","CORRESPONDENT_ZIP_CODE","CORRESPONDENT_NAME","DWPI_MANUAL_CODE_DESCRIPTION","IPC_TYPE","ASSIGNEE_ORIGINAL_NAME","DWPI_UPDATE_BASIC","OPTIMIZED_ASSIGNEES","DERWENT_FORWARD_CITATION_COUNT","EXAMINER_SECONDARY","DSI_INVENTION_INFLUENCE_SCORE","DPCI_CITING_COUNTS_PATENTS_TOTAL","CITATION_WOS_SCORE","DWPI_APPLICATION_NUMBER_BASIC","DWPI_ACCESSION_NUMBER","DWPI_ASSIGNEE_NAME","ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE","DWPI_ASSIGNEE_CODE_TYPE","DWPI_CLASS","ASSIGNEE_ORIGINAL_NATIONALITY","ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE","ESTIMATED_EXPIRATION_DATE","IPC_4","REGISTRATION_OFFICE","INVENTOR_NAME","PUBLICATION_YEAR","PUBLICATION_LANGUAGE","APPLICATION_REGISTRATION_OFFICE","CORRESPONDENT_CITY","CPC_SYMBOL","DSI_TECHNICAL_DISTINCTIVENESS_SCORE","DWPI_MANUAL_CODE_4","ASSIGNEE_ORIGINAL_ZIP_CODE","CORRESPONDENT_STATE","DPCI_CITED_COUNTS_NON_PATENTS_TOTAL","DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL","ULTIMATE_PARENT","AGENT_ZIP_CODE","AGENT_INID","ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR","DWPI_FAMILY_MEMBER_COUNT","DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL","INVENTOR_ZIP_CODE","REPRESENTATIVE_NAME","GRANT_DATE","DWPI_CLASS_DESCRIPTION","DWPI_EARLIEST_PRIORITY_DATE","GREEN_DATA_CATEGORY","EARLIEST_PRIORITY_DATE","IPC_SECTION_DESCRIPTION","AGENT_STATE","ASSIGNEE_ORIGINAL_CITY","IPC_SYMBOL","DSI_INVENTION_GLOBALIZATION_SCORE","DWPI_MANUAL_CODE","DSI_STRENGTH_INDEX","KIND_CODE","ASSIGNEE_ORIGINAL_INID","DWPI_DESIGNATED_OFFICE_COUNT","IPC_CURRENT","PUBLICATION_NUMBER","ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT","IPC_CLASS","PATENT_TYPE","CPC_CURRENT","DPCI_CITED_COUNTS_PATENTS_TOTAL","JP_CLASS_FI_CODE","DOCUMENT_GUID","INVENTOR_COUNTRY","ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM","PUBLICATION_DATE","JP_CLASS_F_TERM","DWPI_UPDATE","DWPI_REGISTRATION_OFFICE_BASIC","CPC_4","DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","DWPI_CLASS_SECTION","DWPI_PUBLICATION_NUMBER_BASIC","DWPI_MANUAL_CODE_CLASS_DESCRIPTION","DWPI_EARLIEST_PRIORITY_YEAR","DWPI_CLASS_SECTION_DESCRIPTION","DPCI_CITING_COUNTS_AUTHORITIES_TOTAL","DWPI_INVENTOR_NAME","ASSIGNEE_ORIGINAL_COUNTRY","GUID","CORRESPONDENT_COUNTRY","AGENT_CITY","DWPI_FAMILY_STATUS","DSI_AVERAGE_SCORE","DSI_YEARS_REMAINING","CORRESPONDENT_ADDRESS","DWPI_MANUAL_CODE_SECTION_DESCRIPTION","INVENTOR_STATE","AGENT_NAME","DSI_AGE_DISCOUNT","PUBLICATION_TYPE","INVENTOR_NATIONALITY","ASSIGNEE_ORIGINAL_ADDRESS","INVENTOR_CITY","INPADOC_FAMILY_STATUS","ASSIGNEE_NAME","IPC_DESCRIPTION","IPC_CLASS_DESCRIPTION","AGENT_ADDRESS","DWPI_ASSIGNEE_CODE","DWPI_TITLE","ASSIGNEE_ORIGINAL_STATE"],"example":"GUID","type":"string"},"type":"array"},{"$ref":"#/components/schemas/field_aliases_patent"}]},"GROUPBY":{"description":"Group by fields (for aggregation)","items":{"description":"Group by fields (for aggregation)","enum":["DWPI_MANUAL_CODE_CLASS","APPLICATION_NUMBER","DEAD_ALIVE_STATUS","ESTIMATED_EXPIRATION_DISCLAIMER_FLAG","EARLIEST_PRIORITY_COUNTRY","IPC_SUBCLASS_DESCRIPTION","DWPI_MANUAL_CODE_SECTION","ASSIGNEE_CURRENT_US","GRANTED","APPLICATION_DATE","EXAMINER_MAIN","CITATION_WOS_CLUSTERKEY","LAST_UPDATED_DATE","AGENT_COUNTRY","DWPI_KIND_CODE_BASIC","DPCI_CITED_COUNTS_AUTHORITIES_TOTAL","INVENTOR_ADDRESS","SERIAL_NUMBER","EARLIEST_PRIORITY_NUMBER","IPC_SECTION","CPC_TYPE","IPC_SUBCLASS","DERWENT_BACKWARD_CITATION_COUNT","DOCDB_SIMPLE_FAMILY_ID","DSI_INVENTION_SUCCESS_SCORE","EARLIEST_PRIORITY_YEAR","CORRESPONDENT_ZIP_CODE","CORRESPONDENT_NAME","DWPI_MANUAL_CODE_DESCRIPTION","IPC_TYPE","ASSIGNEE_ORIGINAL_NAME","OPTIMIZED_ASSIGNEES","DERWENT_FORWARD_CITATION_COUNT","EXAMINER_SECONDARY","DSI_INVENTION_INFLUENCE_SCORE","DPCI_CITING_COUNTS_PATENTS_TOTAL","CITATION_WOS_SCORE","DWPI_APPLICATION_NUMBER_BASIC","DWPI_ACCESSION_NUMBER","DWPI_ASSIGNEE_NAME","ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE","DWPI_ASSIGNEE_CODE_TYPE","DWPI_CLASS","ASSIGNEE_ORIGINAL_NATIONALITY","ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE","ESTIMATED_EXPIRATION_DATE","IPC_4","REGISTRATION_OFFICE","INVENTOR_NAME","PUBLICATION_YEAR","PUBLICATION_LANGUAGE","APPLICATION_REGISTRATION_OFFICE","CORRESPONDENT_CITY","CPC_SYMBOL","DSI_TECHNICAL_DISTINCTIVENESS_SCORE","DWPI_MANUAL_CODE_4","ASSIGNEE_ORIGINAL_ZIP_CODE","CORRESPONDENT_STATE","DPCI_CITED_COUNTS_NON_PATENTS_TOTAL","DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL","ULTIMATE_PARENT","AGENT_ZIP_CODE","AGENT_INID","ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR","DWPI_FAMILY_MEMBER_COUNT","DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL","INVENTOR_ZIP_CODE","REPRESENTATIVE_NAME","GRANT_DATE","DWPI_CLASS_DESCRIPTION","DWPI_EARLIEST_PRIORITY_DATE","GREEN_DATA_CATEGORY","EARLIEST_PRIORITY_DATE","IPC_SECTION_DESCRIPTION","AGENT_STATE","ASSIGNEE_ORIGINAL_CITY","IPC_SYMBOL","DSI_INVENTION_GLOBALIZATION_SCORE","DWPI_MANUAL_CODE","DSI_STRENGTH_INDEX","KIND_CODE","ASSIGNEE_ORIGINAL_INID","DWPI_DESIGNATED_OFFICE_COUNT","IPC_CURRENT","PUBLICATION_NUMBER","ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT","IPC_CLASS","PATENT_TYPE","CPC_CURRENT","DPCI_CITED_COUNTS_PATENTS_TOTAL","JP_CLASS_FI_CODE","DOCUMENT_GUID","INVENTOR_COUNTRY","ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM","PUBLICATION_DATE","JP_CLASS_F_TERM","DWPI_REGISTRATION_OFFICE_BASIC","CPC_4","DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","DWPI_CLASS_SECTION","DWPI_PUBLICATION_NUMBER_BASIC","DWPI_MANUAL_CODE_CLASS_DESCRIPTION","DWPI_EARLIEST_PRIORITY_YEAR","DWPI_CLASS_SECTION_DESCRIPTION","DPCI_CITING_COUNTS_AUTHORITIES_TOTAL","DWPI_INVENTOR_NAME","ASSIGNEE_ORIGINAL_COUNTRY","GUID","CORRESPONDENT_COUNTRY","AGENT_CITY","DWPI_FAMILY_STATUS","DSI_AVERAGE_SCORE","DSI_YEARS_REMAINING","CORRESPONDENT_ADDRESS","DWPI_MANUAL_CODE_SECTION_DESCRIPTION","INVENTOR_STATE","AGENT_NAME","DSI_AGE_DISCOUNT","PUBLICATION_TYPE","INVENTOR_NATIONALITY","ASSIGNEE_ORIGINAL_ADDRESS","INVENTOR_CITY","INPADOC_FAMILY_STATUS","ASSIGNEE_NAME","IPC_DESCRIPTION","IPC_CLASS_DESCRIPTION","AGENT_ADDRESS","DWPI_ASSIGNEE_CODE","DWPI_TITLE","ASSIGNEE_ORIGINAL_STATE"],"example":"GUID","type":"string"},"type":"array"},"LIMIT":{"default":10,"description":"Maximum documents to retrieve","example":10,"type":"number"},"OFFSET":{"default":0,"description":"How many items to skip at the beginning (for pagination)","example":0,"type":"number"},"ORDERBY":{"description":"Order by fields (for aggregation)","items":{"example":{"GUID":"ASC"},"properties":{"AGENT_ADDRESS":{"enum":["DESC","ASC"],"type":"string"},"AGENT_CITY":{"enum":["DESC","ASC"],"type":"string"},"AGENT_COUNTRY":{"enum":["DESC","ASC"],"type":"string"},"AGENT_INID":{"enum":["DESC","ASC"],"type":"string"},"AGENT_NAME":{"enum":["DESC","ASC"],"type":"string"},"AGENT_STATE":{"enum":["DESC","ASC"],"type":"string"},"AGENT_ZIP_CODE":{"enum":["DESC","ASC"],"type":"string"},"APPLICATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"APPLICATION_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"APPLICATION_REGISTRATION_OFFICE":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_CURRENT_US":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_NAME":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_ORIGINAL_ADDRESS":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_ORIGINAL_CITY":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_ORIGINAL_COUNTRY":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_ORIGINAL_INID":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_ORIGINAL_NAME":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_ORIGINAL_NATIONALITY":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_ORIGINAL_STATE":{"enum":["DESC","ASC"],"type":"string"},"ASSIGNEE_ORIGINAL_ZIP_CODE":{"enum":["DESC","ASC"],"type":"string"},"CITATION_WOS_CLUSTERKEY":{"enum":["DESC","ASC"],"type":"string"},"CITATION_WOS_SCORE":{"enum":["DESC","ASC"],"type":"string"},"CORRESPONDENT_ADDRESS":{"enum":["DESC","ASC"],"type":"string"},"CORRESPONDENT_CITY":{"enum":["DESC","ASC"],"type":"string"},"CORRESPONDENT_COUNTRY":{"enum":["DESC","ASC"],"type":"string"},"CORRESPONDENT_NAME":{"enum":["DESC","ASC"],"type":"string"},"CORRESPONDENT_STATE":{"enum":["DESC","ASC"],"type":"string"},"CORRESPONDENT_ZIP_CODE":{"enum":["DESC","ASC"],"type":"string"},"CPC_4":{"enum":["DESC","ASC"],"type":"string"},"CPC_CURRENT":{"enum":["DESC","ASC"],"type":"string"},"CPC_SYMBOL":{"enum":["DESC","ASC"],"type":"string"},"CPC_TYPE":{"enum":["DESC","ASC"],"type":"string"},"DEAD_ALIVE_STATUS":{"enum":["DESC","ASC"],"type":"string"},"DERWENT_BACKWARD_CITATION_COUNT":{"enum":["DESC","ASC"],"type":"string"},"DERWENT_FORWARD_CITATION_COUNT":{"enum":["DESC","ASC"],"type":"string"},"DOCDB_SIMPLE_FAMILY_ID":{"enum":["DESC","ASC"],"type":"string"},"DOCUMENT_GUID":{"enum":["DESC","ASC"],"type":"string"},"DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL":{"enum":["DESC","ASC"],"type":"string"},"DPCI_CITED_COUNTS_AUTHORITIES_TOTAL":{"enum":["DESC","ASC"],"type":"string"},"DPCI_CITED_COUNTS_NON_PATENTS_TOTAL":{"enum":["DESC","ASC"],"type":"string"},"DPCI_CITED_COUNTS_PATENTS_TOTAL":{"enum":["DESC","ASC"],"type":"string"},"DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL":{"enum":["DESC","ASC"],"type":"string"},"DPCI_CITING_COUNTS_AUTHORITIES_TOTAL":{"enum":["DESC","ASC"],"type":"string"},"DPCI_CITING_COUNTS_PATENTS_TOTAL":{"enum":["DESC","ASC"],"type":"string"},"DSI_AGE_DISCOUNT":{"enum":["DESC","ASC"],"type":"string"},"DSI_AVERAGE_SCORE":{"enum":["DESC","ASC"],"type":"string"},"DSI_INVENTION_GLOBALIZATION_SCORE":{"enum":["DESC","ASC"],"type":"string"},"DSI_INVENTION_INFLUENCE_SCORE":{"enum":["DESC","ASC"],"type":"string"},"DSI_INVENTION_SUCCESS_SCORE":{"enum":["DESC","ASC"],"type":"string"},"DSI_STRENGTH_INDEX":{"enum":["DESC","ASC"],"type":"string"},"DSI_TECHNICAL_DISTINCTIVENESS_SCORE":{"enum":["DESC","ASC"],"type":"string"},"DSI_YEARS_REMAINING":{"enum":["DESC","ASC"],"type":"string"},"DWPI_ACCESSION_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"DWPI_APPLICATION_NUMBER_BASIC":{"enum":["DESC","ASC"],"type":"string"},"DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC":{"enum":["DESC","ASC"],"type":"string"},"DWPI_ASSIGNEE_CODE":{"enum":["DESC","ASC"],"type":"string"},"DWPI_ASSIGNEE_CODE_TYPE":{"enum":["DESC","ASC"],"type":"string"},"DWPI_ASSIGNEE_NAME":{"enum":["DESC","ASC"],"type":"string"},"DWPI_CLASS":{"enum":["DESC","ASC"],"type":"string"},"DWPI_CLASS_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"DWPI_CLASS_SECTION":{"enum":["DESC","ASC"],"type":"string"},"DWPI_CLASS_SECTION_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"DWPI_DESIGNATED_OFFICE_COUNT":{"enum":["DESC","ASC"],"type":"string"},"DWPI_EARLIEST_PRIORITY_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"DWPI_EARLIEST_PRIORITY_YEAR":{"enum":["DESC","ASC"],"type":"string"},"DWPI_FAMILY_MEMBER_COUNT":{"enum":["DESC","ASC"],"type":"string"},"DWPI_FAMILY_STATUS":{"enum":["DESC","ASC"],"type":"string"},"DWPI_INVENTOR_NAME":{"enum":["DESC","ASC"],"type":"string"},"DWPI_KIND_CODE_BASIC":{"enum":["DESC","ASC"],"type":"string"},"DWPI_MANUAL_CODE":{"enum":["DESC","ASC"],"type":"string"},"DWPI_MANUAL_CODE_4":{"enum":["DESC","ASC"],"type":"string"},"DWPI_MANUAL_CODE_CLASS":{"enum":["DESC","ASC"],"type":"string"},"DWPI_MANUAL_CODE_CLASS_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"DWPI_MANUAL_CODE_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"DWPI_MANUAL_CODE_SECTION":{"enum":["DESC","ASC"],"type":"string"},"DWPI_MANUAL_CODE_SECTION_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"DWPI_PUBLICATION_NUMBER_BASIC":{"enum":["DESC","ASC"],"type":"string"},"DWPI_REGISTRATION_OFFICE_BASIC":{"enum":["DESC","ASC"],"type":"string"},"DWPI_TITLE":{"enum":["DESC","ASC"],"type":"string"},"DWPI_UPDATE":{"enum":["DESC","ASC"],"type":"string"},"DWPI_UPDATE_BASIC":{"enum":["DESC","ASC"],"type":"string"},"EARLIEST_PRIORITY_COUNTRY":{"enum":["DESC","ASC"],"type":"string"},"EARLIEST_PRIORITY_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"EARLIEST_PRIORITY_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"EARLIEST_PRIORITY_YEAR":{"enum":["DESC","ASC"],"type":"string"},"ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR":{"enum":["DESC","ASC"],"type":"string"},"ESTIMATED_EXPIRATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"ESTIMATED_EXPIRATION_DISCLAIMER_FLAG":{"enum":["DESC","ASC"],"type":"string"},"ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM":{"enum":["DESC","ASC"],"type":"string"},"ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT":{"enum":["DESC","ASC"],"type":"string"},"ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"EXAMINER_MAIN":{"enum":["DESC","ASC"],"type":"string"},"EXAMINER_SECONDARY":{"enum":["DESC","ASC"],"type":"string"},"GRANTED":{"enum":["DESC","ASC"],"type":"string"},"GRANT_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"GREEN_DATA_CATEGORY":{"enum":["DESC","ASC"],"type":"string"},"GUID":{"enum":["DESC","ASC"],"type":"string"},"INPADOC_FAMILY_STATUS":{"enum":["DESC","ASC"],"type":"string"},"INVENTOR_ADDRESS":{"enum":["DESC","ASC"],"type":"string"},"INVENTOR_CITY":{"enum":["DESC","ASC"],"type":"string"},"INVENTOR_COUNTRY":{"enum":["DESC","ASC"],"type":"string"},"INVENTOR_NAME":{"enum":["DESC","ASC"],"type":"string"},"INVENTOR_NATIONALITY":{"enum":["DESC","ASC"],"type":"string"},"INVENTOR_STATE":{"enum":["DESC","ASC"],"type":"string"},"INVENTOR_ZIP_CODE":{"enum":["DESC","ASC"],"type":"string"},"IPC_4":{"enum":["DESC","ASC"],"type":"string"},"IPC_CLASS":{"enum":["DESC","ASC"],"type":"string"},"IPC_CLASS_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"IPC_CURRENT":{"enum":["DESC","ASC"],"type":"string"},"IPC_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"IPC_SECTION":{"enum":["DESC","ASC"],"type":"string"},"IPC_SECTION_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"IPC_SUBCLASS":{"enum":["DESC","ASC"],"type":"string"},"IPC_SUBCLASS_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"IPC_SYMBOL":{"enum":["DESC","ASC"],"type":"string"},"IPC_TYPE":{"enum":["DESC","ASC"],"type":"string"},"JP_CLASS_FI_CODE":{"enum":["DESC","ASC"],"type":"string"},"JP_CLASS_F_TERM":{"enum":["DESC","ASC"],"type":"string"},"KIND_CODE":{"enum":["DESC","ASC"],"type":"string"},"LAST_UPDATED_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"OPTIMIZED_ASSIGNEES":{"enum":["DESC","ASC"],"type":"string"},"PATENT_TYPE":{"enum":["DESC","ASC"],"type":"string"},"PUBLICATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"PUBLICATION_LANGUAGE":{"enum":["DESC","ASC"],"type":"string"},"PUBLICATION_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"PUBLICATION_TYPE":{"enum":["DESC","ASC"],"type":"string"},"PUBLICATION_YEAR":{"enum":["DESC","ASC"],"type":"string"},"REGISTRATION_OFFICE":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_NAME":{"enum":["DESC","ASC"],"type":"string"},"SERIAL_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"ULTIMATE_PARENT":{"enum":["DESC","ASC"],"type":"string"}},"type":"object"},"type":"array"},"QUERY":{"description":"Either a query_body_patent object or an array of one or more query_body_patent objects separated by strings consisting of boolean operators.","oneOf":[{"items":{"anyOf":[{"description":"boolean operator","type":"string"},{"$ref":"#/components/schemas/query_body_patent"}]},"type":"array"},{"$ref":"#/components/schemas/query_body_patent"}]}},"type":"object"},"search_request_trademark":{"properties":{"AGG":{"description":"A list of aggregations","items":{"properties":{"ALIAS":{"description":"Field name alias","example":"NUM_GUIDS","type":"string"},"FIELD":{"description":"Field to query","enum":["REGISTRATION_NUMBER_TEXT","INITIAL_REGISTRATION_DATE","ID","COUNTRY_ISO_3166_ALPHA2","MARK_VERBAL_ELEMENT_TEXT","REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT","REPRESENTATIVE_CORRESPONDENT_NAME","MARK_FEATURE","CURRENT_STATUS_DERIVED","FILING_DATE_DERIVED","APPLICANT_NAME_NATIVE","NAT_GOODS_SERVICES_DESCRIPTION","REPRESENTATIVE_ADDRESS_LINE_TEXT","CANCELLATION_DATE","REPRESENTATIVE_NAME_NATIVE","IMAGE_KIND","MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED","APPLICANT_ADDRESS_COUNTRY_CODE","APPLICANT_ADDRESS_NATIVE_LINE_TEXT","DESIGNATION_BASIS","RENEWAL_PUBLISHED_DATE","INT_GOODS_SERVICES_LANGUAGE_CODE","GUID","REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT","PRIORITY_COUNTRY_CODE","REGISTRATION_DATE","APPLICATION_NUMBER_TEXT","REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE","LAST_PUBLICATION_DATE","REGISTRATION_OFFICE_CODE_DERIVED","APPLICATION_DATE","MARK_TRANSLATION_TEXT","INT_CLASS_HEADING_DERIVED","CURRENT_STATUS","COUNTRY_ISO_3166_ALPHA3","DESIGNATED_COUNTRY_CODE","EXPIRY_DATE","PRIORITY_DATE","INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE","INT_CLASS_NUMBER","RENEWAL_DATE","LAST_UPDATED_DATE","INITIAL_APPLICATION_DATE","PUBLICATION_YEAR","APPLICANT_ADDRESS_LINE_TEXT","CLASSIFICATION","APPLICANT_NAME","INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION","IMAGES_TOTAL_QUANTITY","APPLICATION_LANGUAGE_CODE","ID_DERIVED","GUID_DERIVED","MARK_TRANSLITERATION_TEXT","NAT_GOODS_SERVICES_LANGUAGE_CODE","INT_CLASS_TYPE_DERIVED","REGISTRATION_OFFICE_CODE","DISCLAIMERS","COUNTRY_TEXT","INT_GOODS_SERVICES_DESCRIPTION","CLASSIFICATION_CODE_ENRICHED","REPRESENTATIVE_ADDRESS_COUNTRY_CODE","PUBLICATION_DATE","APPLICATION_ABANDONED_DATE","NAT_CLASS_NUMBER","SECOND_LANGUAGE_CODE","REPRESENTATIVE_NAME","PRIORITY_NUMBER_TEXT"],"example":"GUID","type":"string"},"FUNC":{"description":"Aggregation function","example":"COUNT","type":"string"}},"required":["FIELD","FUNC"],"type":"object"},"type":"array"},"FIELDS":{"oneOf":[{"description":"Fields to fetch. This may also be a structure of type field_aliases_trademark, rather than an array, in which case the fields will be renamed.","items":{"default":"GUID","description":"Fields to fetch. This may also be a structure of type field_aliases_trademark, rather than an array, in which case the fields will be renamed.","enum":["REGISTRATION_NUMBER_TEXT","INITIAL_REGISTRATION_DATE","ID","COUNTRY_ISO_3166_ALPHA2","MARK_VERBAL_ELEMENT_TEXT","REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT","REPRESENTATIVE_CORRESPONDENT_NAME","MARK_FEATURE","CURRENT_STATUS_DERIVED","FILING_DATE_DERIVED","APPLICANT_NAME_NATIVE","NAT_GOODS_SERVICES_DESCRIPTION","REPRESENTATIVE_ADDRESS_LINE_TEXT","CANCELLATION_DATE","REPRESENTATIVE_NAME_NATIVE","IMAGE_KIND","MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED","APPLICANT_ADDRESS_COUNTRY_CODE","APPLICANT_ADDRESS_NATIVE_LINE_TEXT","DESIGNATION_BASIS","RENEWAL_PUBLISHED_DATE","INT_GOODS_SERVICES_LANGUAGE_CODE","GUID","REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT","PRIORITY_COUNTRY_CODE","REGISTRATION_DATE","APPLICATION_NUMBER_TEXT","REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE","LAST_PUBLICATION_DATE","REGISTRATION_OFFICE_CODE_DERIVED","APPLICATION_DATE","MARK_TRANSLATION_TEXT","INT_CLASS_HEADING_DERIVED","CURRENT_STATUS","COUNTRY_ISO_3166_ALPHA3","DESIGNATED_COUNTRY_CODE","EXPIRY_DATE","PRIORITY_DATE","INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE","INT_CLASS_NUMBER","RENEWAL_DATE","LAST_UPDATED_DATE","INITIAL_APPLICATION_DATE","PUBLICATION_YEAR","APPLICANT_ADDRESS_LINE_TEXT","CLASSIFICATION","APPLICANT_NAME","INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION","IMAGES_TOTAL_QUANTITY","APPLICATION_LANGUAGE_CODE","ID_DERIVED","GUID_DERIVED","MARK_TRANSLITERATION_TEXT","NAT_GOODS_SERVICES_LANGUAGE_CODE","INT_CLASS_TYPE_DERIVED","REGISTRATION_OFFICE_CODE","DISCLAIMERS","COUNTRY_TEXT","INT_GOODS_SERVICES_DESCRIPTION","CLASSIFICATION_CODE_ENRICHED","REPRESENTATIVE_ADDRESS_COUNTRY_CODE","PUBLICATION_DATE","APPLICATION_ABANDONED_DATE","NAT_CLASS_NUMBER","SECOND_LANGUAGE_CODE","REPRESENTATIVE_NAME","PRIORITY_NUMBER_TEXT"],"example":"GUID","type":"string"},"type":"array"},{"$ref":"#/components/schemas/field_aliases_trademark"}]},"GROUPBY":{"description":"Group by fields (for aggregation)","items":{"description":"Group by fields (for aggregation)","enum":["REGISTRATION_NUMBER_TEXT","INITIAL_REGISTRATION_DATE","ID","COUNTRY_ISO_3166_ALPHA2","MARK_VERBAL_ELEMENT_TEXT","REPRESENTATIVE_CORRESPONDENT_NAME","MARK_FEATURE","CURRENT_STATUS_DERIVED","FILING_DATE_DERIVED","APPLICANT_NAME_NATIVE","IMAGE_KIND","CANCELLATION_DATE","REPRESENTATIVE_NAME_NATIVE","MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED","APPLICANT_ADDRESS_COUNTRY_CODE","RENEWAL_PUBLISHED_DATE","DESIGNATION_BASIS","INT_GOODS_SERVICES_LANGUAGE_CODE","GUID","APPLICATION_NUMBER_TEXT","PRIORITY_COUNTRY_CODE","REGISTRATION_DATE","LAST_PUBLICATION_DATE","REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE","APPLICATION_DATE","REGISTRATION_OFFICE_CODE_DERIVED","MARK_TRANSLATION_TEXT","INT_CLASS_HEADING_DERIVED","CURRENT_STATUS","COUNTRY_ISO_3166_ALPHA3","DESIGNATED_COUNTRY_CODE","EXPIRY_DATE","PRIORITY_DATE","INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE","INT_CLASS_NUMBER","RENEWAL_DATE","LAST_UPDATED_DATE","INITIAL_APPLICATION_DATE","PUBLICATION_YEAR","CLASSIFICATION","APPLICANT_NAME","IMAGES_TOTAL_QUANTITY","APPLICATION_LANGUAGE_CODE","ID_DERIVED","GUID_DERIVED","MARK_TRANSLITERATION_TEXT","NAT_GOODS_SERVICES_LANGUAGE_CODE","INT_CLASS_TYPE_DERIVED","REGISTRATION_OFFICE_CODE","COUNTRY_TEXT","INT_GOODS_SERVICES_DESCRIPTION","CLASSIFICATION_CODE_ENRICHED","REPRESENTATIVE_ADDRESS_COUNTRY_CODE","PUBLICATION_DATE","APPLICATION_ABANDONED_DATE","NAT_CLASS_NUMBER","SECOND_LANGUAGE_CODE","REPRESENTATIVE_NAME","PRIORITY_NUMBER_TEXT"],"example":"GUID","type":"string"},"type":"array"},"LIMIT":{"default":10,"description":"Maximum documents to retrieve","example":10,"type":"number"},"OFFSET":{"default":0,"description":"How many items to skip at the beginning (for pagination)","example":0,"type":"number"},"ORDERBY":{"description":"Order by fields (for aggregation)","items":{"example":{"GUID":"ASC"},"properties":{"APPLICANT_ADDRESS_COUNTRY_CODE":{"enum":["DESC","ASC"],"type":"string"},"APPLICANT_ADDRESS_LINE_TEXT":{"enum":["DESC","ASC"],"type":"string"},"APPLICANT_ADDRESS_NATIVE_LINE_TEXT":{"enum":["DESC","ASC"],"type":"string"},"APPLICANT_NAME":{"enum":["DESC","ASC"],"type":"string"},"APPLICANT_NAME_NATIVE":{"enum":["DESC","ASC"],"type":"string"},"APPLICATION_ABANDONED_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"APPLICATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"APPLICATION_LANGUAGE_CODE":{"enum":["DESC","ASC"],"type":"string"},"APPLICATION_NUMBER_TEXT":{"enum":["DESC","ASC"],"type":"string"},"CANCELLATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"CLASSIFICATION":{"enum":["DESC","ASC"],"type":"string"},"CLASSIFICATION_CODE_ENRICHED":{"enum":["DESC","ASC"],"type":"string"},"COUNTRY_ISO_3166_ALPHA2":{"enum":["DESC","ASC"],"type":"string"},"COUNTRY_ISO_3166_ALPHA3":{"enum":["DESC","ASC"],"type":"string"},"COUNTRY_TEXT":{"enum":["DESC","ASC"],"type":"string"},"CURRENT_STATUS":{"enum":["DESC","ASC"],"type":"string"},"CURRENT_STATUS_DERIVED":{"enum":["DESC","ASC"],"type":"string"},"DESIGNATED_COUNTRY_CODE":{"enum":["DESC","ASC"],"type":"string"},"DESIGNATION_BASIS":{"enum":["DESC","ASC"],"type":"string"},"DISCLAIMERS":{"enum":["DESC","ASC"],"type":"string"},"EXPIRY_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"FILING_DATE_DERIVED":{"enum":["DESC","ASC"],"format":"date","type":"string"},"GUID":{"enum":["DESC","ASC"],"type":"string"},"GUID_DERIVED":{"enum":["DESC","ASC"],"type":"string"},"ID":{"enum":["DESC","ASC"],"type":"string"},"ID_DERIVED":{"enum":["DESC","ASC"],"type":"string"},"IMAGES_TOTAL_QUANTITY":{"enum":["DESC","ASC"],"type":"string"},"IMAGE_KIND":{"enum":["DESC","ASC"],"type":"string"},"INITIAL_APPLICATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"INITIAL_REGISTRATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"INT_CLASS_HEADING_DERIVED":{"enum":["DESC","ASC"],"type":"string"},"INT_CLASS_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"INT_CLASS_TYPE_DERIVED":{"enum":["DESC","ASC"],"type":"string"},"INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE":{"enum":["DESC","ASC"],"type":"string"},"INT_GOODS_SERVICES_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"INT_GOODS_SERVICES_LANGUAGE_CODE":{"enum":["DESC","ASC"],"type":"string"},"LAST_PUBLICATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"LAST_UPDATED_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"MARK_FEATURE":{"enum":["DESC","ASC"],"type":"string"},"MARK_TRANSLATION_TEXT":{"enum":["DESC","ASC"],"type":"string"},"MARK_TRANSLITERATION_TEXT":{"enum":["DESC","ASC"],"type":"string"},"MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED":{"enum":["DESC","ASC"],"type":"string"},"MARK_VERBAL_ELEMENT_TEXT":{"enum":["DESC","ASC"],"type":"string"},"NAT_CLASS_NUMBER":{"enum":["DESC","ASC"],"type":"string"},"NAT_GOODS_SERVICES_DESCRIPTION":{"enum":["DESC","ASC"],"type":"string"},"NAT_GOODS_SERVICES_LANGUAGE_CODE":{"enum":["DESC","ASC"],"type":"string"},"PRIORITY_COUNTRY_CODE":{"enum":["DESC","ASC"],"type":"string"},"PRIORITY_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"PRIORITY_NUMBER_TEXT":{"enum":["DESC","ASC"],"type":"string"},"PUBLICATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"PUBLICATION_YEAR":{"enum":["DESC","ASC"],"type":"string"},"REGISTRATION_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"REGISTRATION_NUMBER_TEXT":{"enum":["DESC","ASC"],"type":"string"},"REGISTRATION_OFFICE_CODE":{"enum":["DESC","ASC"],"type":"string"},"REGISTRATION_OFFICE_CODE_DERIVED":{"enum":["DESC","ASC"],"type":"string"},"RENEWAL_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"RENEWAL_PUBLISHED_DATE":{"enum":["DESC","ASC"],"format":"date","type":"string"},"REPRESENTATIVE_ADDRESS_COUNTRY_CODE":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_ADDRESS_LINE_TEXT":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_CORRESPONDENT_NAME":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_NAME":{"enum":["DESC","ASC"],"type":"string"},"REPRESENTATIVE_NAME_NATIVE":{"enum":["DESC","ASC"],"type":"string"},"SECOND_LANGUAGE_CODE":{"enum":["DESC","ASC"],"type":"string"}},"type":"object"},"type":"array"},"QUERY":{"description":"Either a query_body_trademark object or an array of one or more query_body_trademark objects separated by strings consisting of boolean operators.","oneOf":[{"items":{"anyOf":[{"description":"boolean operator","type":"string"},{"$ref":"#/components/schemas/query_body_trademark"}]},"type":"array"},{"$ref":"#/components/schemas/query_body_trademark"}]}},"type":"object"}},"securitySchemes":{"key":{"type":"apiKey","in":"header","name":"X-ApiKey"}}},"info":{"contact":{"email":"Derwent.support@clarivate.com","name":"Derwent API"},"description":"Derwent APIs provide seamless access to enriched patent data, enabling users to enhance their research capabilities and make faster, more informed decisions.\n\nWith user-friendly API endpoints, users can easily integrate reliable patent data into their existing systems, saving time and resources and streamline patent and innovation workflows.\n\nAccess a vast database of global patent information, including titles and abstracts for 65m+ inventions, optimized assignee data, and corrected priority data errors for more reliable insights.","termsOfService":"https://clarivate.com/legal-center/terms-of-business/product-service-terms/","title":"Intellectual Property (IP) Data API","version":"1.0.7"},"openapi":"3.0.3","paths":{"/caselaw/document/availability":{"post":{"description":"Query the availability and update date of documents","operationId":"checkCaselawDocumentAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_availability_request_caselaw"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"result_count":6,"results":{"2706413":{"availability":"valid","last_updated":"2023-06-15 04:48:10.244000000"},"10043066":{"availability":"deleted","last_updated":"2023-03-22 23:05:32.841943000"},"10157664":{"availability":"deleted","last_updated":"2023-04-26 23:14:36.608294000"},"10282480":{"availability":"deleted","last_updated":"2023-04-20 23:05:59.493840000"},"11021977":{"availability":"valid","last_updated":"2023-06-21 15:08:19.928657000"},"9999999999":{"availability":"invalid"}}},"properties":{"result_count":{"description":"Total number of results","type":"number"},"results":{"description":"Page of results","items":{"properties":{"GUID":{"description":"GUID","example":"2706413","type":"string"},"availability":{"enum":["invalid","deleted","valid"],"example":"valid","type":"string"},"last_updated":{"description":"Date of last update","example":"2023-06-15","format":"date","type":"string"}},"required":["GUID","availability"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Caselaw document availability check","tags":["IP Cases"]}},"/caselaw/document/json":{"post":{"description":"Call to fetch one or more full caselaw documents by GUID, with possibile filters.","operationId":"getCaselawDocuments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/records_request_caselaw"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Page of results","items":{"properties":{"BINDER":{"properties":{"AREA":{"description":"Represents the legal area where the case takes place as defined by Darts-ip (i.e. countries grouped together under harmonized legal provisions).\n\nFlat name: AREA\nHierarchical name: BINDER.AREA","example":"JAPAN","type":"string"},"CASE_DOMAINS":{"items":{"description":"The IP right types that the case pertains to. Possible values are: copyright, design_model, domain_name, patent, trademark, unfair_competition or other\n\nFlat name: CASE_DOMAIN\nHierarchical name: BINDER.CASE_DOMAINS","example":"[\"PATENT\", \"DOMAIN_NAME\", \"TRADEMARK\"]","type":"string"},"type":"array"},"CASE_NAME":{"description":"The name of the Binder, about 4% of our Binders have a case name.\n\nFlat name: CASE_NAME\nHierarchical name: BINDER.CASE_NAME","example":"EX PARTE SAGHEER AHMAD","type":"string"},"CASE_REFERENCES":{"items":{"description":"The docket references for this specific case.\n\nFlat name: _BINDER.CASE_REFERENCES\nHierarchical name: BINDER.CASE_REFERENCES","example":"81 O 25/99\", \"6 U 179/99","type":"string"},"type":"array"},"CASE_RESOLUTION":{"description":"The outcome of the case according to the information collected. Possible values are: claimant wins, defendant wins, split win, settled, withdrawn or unknown (null value).\n\nFlat name: CASE_RESOLUTION\nHierarchical name: BINDER.CASE_RESOLUTION","example":"SETTLED","type":"string"},"CASE_STAGE":{"description":"The current stage of the case according to the information collected\n\nFlat name: CASE_STAGE\nHierarchical name: BINDER.CASE_STAGE","example":"HEARING","type":"string"},"CASE_STATUS":{"description":"The current status of an IP Case. Possible values are open, closed or inactive.\n\nFlat name: CASE_STATUS\nHierarchical name: BINDER.CASE_STATUS","example":"CLOSED","type":"string"},"CLOSED":{"description":"Whether the binder has been closed. (US Only)\n\nFlat name: CLOSED\nHierarchical name: BINDER.CLOSED","example":false,"type":"boolean"},"DOCKETS":{"properties":{"COURT":{"properties":{"AREA":{"description":"The legal area this court is part of.\n\nFlat name: DOCKET_COURT_AREA\nHierarchical name: BINDER.DOCKETS.COURT.AREA","example":"EUROPE","type":"string"},"COURT_COUNTRY":{"description":"A two-character WIPO ST.3 code representing the country or the international organization the court is part of.\n\nFlat name: DOCKET_COURT_COUNTRY\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY","example":"RU","type":"string"},"COURT_COUNTRY_DERIVED":{"properties":{"COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2":{"description":"A two-character code mapping from the court country code to the countries belonging to the court country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","example":"AD","type":"string"},"COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3":{"description":"A three-character code mapping from the court country code to the countries belonging to the court country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","example":"AND","type":"string"},"COURT_COUNTRY_DERIVED_TEXT":{"description":"The country name mapping from the court country code to the countries belonging to the country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_TEXT\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_TEXT","example":"ALBANIA","type":"string"}},"type":"object"},"COURT_COUNTRY_TEXT":{"description":"The country or the international organization the court is part of.\n\nFlat name: DOCKET_COURT_COUNTRY_TEXT\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_TEXT","example":"AFRICAN INTELLECTUAL PROPERTY ORGANIZATION","type":"string"},"NAME":{"description":"The English name of the Court.\n\nFlat name: DOCKET_COURT_NAME\nHierarchical name: BINDER.DOCKETS.COURT.NAME","example":"FEDERAL SERVICE FOR IP - WIPO","type":"string"},"PATH":{"description":"Information about the Court in which this Docket was handled.\n\nFlat name: DOCKET_COURT_PATH\nHierarchical name: BINDER.DOCKETS.COURT.PATH","example":"COMMONW. OF INDEP. STATES/RUSSIAN FEDERATION/FEDERAL SERVICE FOR IP - WIPO","type":"string"},"TYPES":{"items":{"description":"Domain Types such as wethere a document is Administrative, Judical, or Arbitration.\n\nFlat name: _BINDER.DOCKETS.COURT.TYPES\nHierarchical name: BINDER.DOCKETS.COURT.TYPES","example":"ADMINISTRATIVE","type":"string"},"type":"array"}},"type":"object"},"DOCUMENTS":{"properties":{"CITABLE":{"description":"Whether the decision has a reporter citation.\n\nFlat name: DOCUMENT_CITABLE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CITABLE","example":false,"type":"boolean"},"CITATION_REFERENCE":{"description":"An unique internal reference in the format 'darts-000-000-A'.\n\nFlat name: DOCUMENT_CITATION_REFERENCE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CITATION_REFERENCE","example":"\"DARTS-998-200-L\",","type":"string"},"CLAIM_CONSTRUCTIONS":{"properties":{"AGREED":{"description":"Whether both the plaintiff(s) and defendant(s) agreed with the definition put forward by the judge.\n\nFlat name: CLAIM_CONSTRUCTION_AGREED\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.AGREED","example":false,"type":"boolean"},"DEFINITION":{"description":"The definition that was given for the term in this decision.\n\nFlat name: CLAIM_CONSTRUCTION_DEFINITION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.DEFINITION","example":"NICHT GLEICHZEITIG","type":"string"},"MEANS_PLUS_FUNCTION":{"description":"Whether the term was considered as describing a function the technology performs, rather than the structure of the technology.(US Only)\n\nFlat name: CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.MEANS_PLUS_FUNCTION","example":"NOT_DISCUSSED","type":"string"},"NOT_NECESSARY":{"description":"Whether the judge deemed a definition of the term to unnecessary for a variety of reasons.\n\nFlat name: CLAIM_CONSTRUCTION_NOT_NECESSARY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.NOT_NECESSARY","example":false,"type":"boolean"},"TERM":{"description":"The term for which a definition or interpretation was given by the judge in this decision.\n\nFlat name: CLAIM_CONSTRUCTION_TERM\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.TERM","example":"ASYNCHROM","type":"string"}},"type":"object"},"DAMAGES":{"properties":{"AMOUNT":{"description":"The amount of damages that needs to be paid.\n\nFlat name: DAMAGE_AMOUNT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.AMOUNT","example":137240,"type":"number"},"CALCULATION_METHOD":{"description":"How the damages have been calculated.\n\nFlat name: DAMAGE_CALCULATION_METHOD\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CALCULATION_METHOD","example":"LOSS_OF_PROFITS","type":"string"},"CURRENCY":{"description":"A 3-character ISO currency code for the main currency of the damage.\n\nFlat name: DAMAGE_CURRENCY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENCY","example":"EUR","type":"string"},"CURRENT_CNY_EQUIVALENT":{"description":"The amount converted to Chinese Yuan.\n\nFlat name: DAMAGE_CURRENT_CNY_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_CNY_EQUIVALENT","example":1454475,"type":"number"},"CURRENT_EUR_EQUIVALENT":{"description":"The amount converted to Euro.\n\nFlat name: DAMAGE_CURRENT_EUR_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_EUR_EQUIVALENT","example":186335,"type":"number"},"CURRENT_USD_EQUIVALENT":{"description":"The amount converted to US Dollars.\n\nFlat name: DAMAGE_CURRENT_USD_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_USD_EQUIVALENT","example":224108,"type":"number"},"NATURE":{"description":"The nature of the damages mentioned in the decision document.\n\nFlat name: DAMAGE_NATURE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.NATURE","example":"INFRINGEMENT","type":"string"},"TYPES":{"properties":{"LATER":{"description":"Indicates that damages have been assigned, but the amount has not been specified in this decision.\n\nFlat name: DAMAGE_LATER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.LATER","example":false,"type":"boolean"},"PARTIAL":{"description":"Indicates whether the damage amount is potentially incomplete and might be amended in a future decision.\n\nFlat name: DAMAGE_PARTIAL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.PARTIAL","example":false,"type":"boolean"},"REQUESTED":{"description":"Indicates that the damage was requested by the plaintiff, but not necessarily granted.\n\nFlat name: DAMAGE_REQUESTED\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.REQUESTED","example":false,"type":"boolean"}},"type":"object"}},"type":"object"},"DECLARATORY":{"description":"Whether the decision addresses a motion for declaratory judgment(US Only).\n\nFlat name: DOCUMENT_DECLARATORY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DECLARATORY","example":false,"type":"boolean"},"DEFAULT_JUDGEMENT":{"description":"Whether the decision is granting a default judgment (US Only).\n\nFlat name: DOCUMENT_DEFAULT_JUDGEMENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DEFAULT_JUDGEMENT","example":false,"type":"boolean"},"DOCUMENT_DATE":{"description":"Judgment Date: The date of this Document.\nThis field is of type date but will be serialized to type string.\n\nFlat name: DOCUMENT_DATE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DOCUMENT_DATE","example":"2021-10-04","format":"date","type":"string"},"DOCUMENT_TYPE":{"description":"The type of the document. Possible values are: decisions_and_orders, prelude, process_procedure_information, settlement_information, briefs_and_memorandums, motions, evidence and conclusions_of_advocate_generale\n\nFlat name: DOCUMENT_TYPE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DOCUMENT_TYPE","example":"DECISIONS_AND_ORDERS","type":"string"},"LEVEL":{"description":"The level of the document. Possible values are first_instance, appeal, judicial_review and preliminary_ruling\n\nFlat name: DOCUMENT_LEVEL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.LEVEL","example":"FIRST_INSTANCE","type":"string"},"POINT_OF_LAWS":{"properties":{"CONFIDENCE_LEVEL":{"description":"Whether the point of law was suggested by AI or was manually encoded.\n\nFlat name: POINT_OF_LAW_CONFIDENCE_LEVEL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.CONFIDENCE_LEVEL","example":"CONFIDENT","type":"string"},"NAME":{"description":"The name of this Point of Law.\n\nFlat name: POINT_OF_LAW_NAME\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.NAME","example":"BETWEEN GOODS IN DIFFERENT CLASSES","type":"string"},"OUTCOMES":{"properties":{"NEGATIVE":{"description":"The name of the negative outcome (if applicable).\n\nFlat name: POINT_OF_LAW_OUTCOME_NEGATIVE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.NEGATIVE","example":"DIFFERENT","type":"string"},"OUTCOME":{"description":"The outcome either positive, negative or both for this Point of Law.\n\nFlat name: POINT_OF_LAW_OUTCOME\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.OUTCOME","example":"NEGATIVE","type":"string"},"POSITIVE":{"description":"The name of the positive outcome (if applicable).\n\nFlat name: POINT_OF_LAW_OUTCOME_POSITIVE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.POSITIVE","example":"DIFFERENT","type":"string"}},"type":"object"},"PARENT_PATH":{"description":"The parent of this Point of Law in the Point of Law tree.\n\nFlat name: POINT_OF_LAW_PARENT_PATH\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PARENT_PATH","example":"CONFLICT BETWEEN TRADE MARKS/LIKELIHOOD OF CONFUSION (IDENTICAL/SIMILAR TRADE MARKS FOR IDENTICAL/SIMILAR GOODS OR SERVICES)/SIMILARITY BETWEEN THE GOODS/SERVICES/BETWEEN GOODS IN DIFFERENT CLASSES","type":"string"},"PREFIX":{"description":"The parent of this Point of Law in the Point of Law tree.\n\nFlat name: POINT_OF_LAW_PREFIX\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PREFIX","example":"EUR-06.2.2.4","type":"string"}},"type":"object"},"PRODUCT_COMPARISONS":{"properties":{"PRODUCT_A":{"properties":{"DESCRIPTION":{"description":"Description of the first product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.DESCRIPTION","example":"DEBIT CARD SERVICES; PROCESSING OF PAYMENTS IN RELATION TO CHARGE CARDS; PROCESSING PAYMENTS MADE BY CHARGE CARDS; CHEQUE GUARANTEE CARD PROCESSING; ISSUING OF CREDIT AND DEBIT CARDS; FINANCIAL TRANSACTIONS; ELECTRONIC FUNDS TRANSFER; PAYMENT SETTLEMENT, BANKING OPERATIONS; BANKS (BANKING); BANKING; FINANCIAL CONSULTANCY; CREDIT CONSULTANCY; BUDGET ACCOUNT SERVICES; BANK ACCOUNT AND SAVINGS ACCOUNT SERVICES; FINANCIAL SERVICES IN THE FIELD OF BANK CARDS; BANK ACCOUNT INFORMATION SERVICES; PROVIDING OF BANKING SERVICES; MONEY TRANSFER SERVICES BY ELECTRONIC MEANS; ELECTRONIC FUND TRANSFER FOR OTHERS; PROVIDING MULTIPLE PAYMENT OPTIONS BY MEANS OF CUSTOMER-OPERATED ELECTRONIC TERMINALS AVAILABLE ON-SITE IN RETAIL STORES","type":"string"},"NICE_CLASSES":{"description":"The Nice Classes of the first product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.NICE_CLASSES","example":"36.\",\"36.13\",\"36.41","type":"string"}},"type":"object"},"PRODUCT_B":{"properties":{"DESCRIPTION":{"description":"Description of the second product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_B.DESCRIPTION","example":"FARE CARD FOR ACCESSING FARE COLLECTION EQUIPMENT FOR MASS TRANSPORTATION","type":"string"},"NICE_CLASSES":{"description":"The Nice Classes of the second product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_B.NICE_CLASSES","example":"\"41.H2.\",\"35.2\",\"25.45\",","type":"string"}},"type":"object"},"SIMILAR":{"description":"Whether both products being compared where deemed similar or not by the judge.\n\nFlat name: PRODUCT_COMPARISON_SIMILAR\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.SIMILAR","example":false,"type":"boolean"}},"type":"object"},"REFUSAL":{"description":"For Trademark cases. True for any first instance document issued by an IP office of type ADMINISTRATIVE_HEARING.\n\nFlat name: DOCUMENT_REFUSAL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.REFUSAL","example":false,"type":"boolean"},"RELATIONS":{"properties":{"RATING":{"description":"Describes to what length the current decision follows the reasoning presented in the target decision.\n\nFlat name: RELATION_RATING\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.RATING","example":"UPHELD","type":"string"},"RELATION":{"description":"The type of relation. The current decision either follows up on another decision or refers to another decision.\n\nFlat name: RELATION_RELATION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.RELATION","example":"INSTANCE_FOLLOWS","type":"string"},"TARGET_DECISION":{"description":"The citation reference of the decision that the current decision relates to (e.g. darts-000-000-A).\n\nFlat name: RELATION_TARGET_DECISION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.TARGET_DECISION","example":"DARTS-404-771-D","type":"string"},"TARGET_REFERENCE":{"description":"The reference/description of the decision that the current decision relates to.\n\nFlat name: RELATION_TARGET_REFERENCE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.TARGET_REFERENCE","example":"FR-2004038828_20070323","type":"string"}},"type":"object"},"RELEVANT_PUBLIC":{"properties":{"AVERAGE_CONSUMER":{"description":"Whether average consumer attention was considered in the decision when discussing the relevant public.\n\nFlat name: RELEVANT_PUBLIC_AVERAGE_CONSUMER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.AVERAGE_CONSUMER","example":true,"type":"boolean"},"AWARENESS":{"description":"The level of awareness that the consumer has of the product.\n\nFlat name: RELEVANT_PUBLIC_AWARENESS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.AWARENESS","example":"AWARE","type":"string"},"NICE_CLASSES":{"items":{"description":"The Nice Classes of the product being discussed.\n\nFlat name: RELEVANT_PUBLIC_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.NICE_CLASSES","example":"18\",\"14\",\"34","type":"string"},"type":"array"},"PROFESSIONAL_CONSUMER":{"description":"Whether professional consumer attention was considered in the decision when discussing the relevant public\n\nFlat name: RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.PROFESSIONAL_CONSUMER","example":true,"type":"boolean"}},"type":"object"},"RIGHT_ASSESSMENTS":{"properties":{"AMENDED_CLAIMS":{"description":"Whether amendments to the patent claims were made in this decision.\n\nFlat name: RIGHT_ASSESSMENT_AMENDED_CLAIMS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.AMENDED_CLAIMS","example":false,"type":"boolean"},"INFRINGEMENT":{"description":"Indicates whether infringement of the patent was discussed in this decision and, if so, whether the patent was considered to be infringed or not.\n\nFlat name: RIGHT_ASSESSMENT_INFRINGEMENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.INFRINGEMENT","example":"INFRINGED","type":"string"},"RIGHT_ASSESSMENT_INDEX":{"description":"An index identifying to which patent right in this legal case the right assessment relates.\n\nFlat name: RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.RIGHT_ASSESSMENT_INDEX","example":1,"type":"number"},"VALIDITY":{"description":"Indicates whether validity of the patent was discussed in this decision and, if so, whether the patent claims were considered to be valid or not.\n\nFlat name: RIGHT_ASSESSMENT_VALIDITY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.VALIDITY","example":"UNDECIDED","type":"string"}},"type":"object"},"STATE":{"description":"The current state of analysis of this decision.\n\nFlat name: DOCUMENT_STATE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.STATE","example":"UPLOADED","type":"string"},"SUBTYPE":{"description":"The sub-type of the document. Only applicable for PRELUDE and DECISIONS_AND_ORDERS. Possible values are on_the_merits, provisional, other_decisions, complaint, hearing, notice_of_appeal, preliminary_proceedings and verdict.\n\nFlat name: DOCUMENT_SUBTYPE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.SUBTYPE","example":"COMPLAINT","type":"string"},"TRADEMARK_REPUTATION":{"description":"Set when the domain is TRADEMARK and the document contains points of law that relate to trademark reputation.\n\nFlat name: DOCUMENT_TRADEMARK_REPUTATION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.TRADEMARK_REPUTATION","example":false,"type":"boolean"},"WINNER":{"description":"The set of Parties that has won the Legal Case at the time of this document.\n\nFlat name: DOCUMENT_WINNER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.WINNER","example":false,"type":"boolean"}},"type":"object"},"REFERENCE":{"description":"A Court-specific reference for this Docket.\n\nFlat name: DOCKET_REFERENCE\nHierarchical name: BINDER.DOCKETS.REFERENCE","example":"RU-WO-1559837","type":"string"}},"type":"object"},"DOCKET_COURT_COUNTRIES":{"items":{"description":"The countries in which the case is being litigated.\n\nFlat name: DOCKET_COURT_COUNTRIES\nHierarchical name: BINDER.DOCKET_COURT_COUNTRIES","example":"[\"BE\", \"DE\"]","type":"string"},"type":"array"},"DOCKET_COURT_NAMES":{"items":{"description":"The courts in which the case is being litigated.\n\nFlat name: DOCKET_COURT_NAMES\nHierarchical name: BINDER.DOCKET_COURT_NAMES","example":"[\"CALIFORNIA CENTRAL DISTRICT COURT\", \"THE FORUM UDRP - GTLDS\"]","type":"string"},"type":"array"},"EARLIEST_EVENT_DATE":{"description":"The filing date of the case or the earliest document date in case the filing cannot be identified.\nThis field is of type date but will be serialized to type string.\n\nFlat name: EARLIEST_EVENT_DATE\nHierarchical name: BINDER.EARLIEST_EVENT_DATE","example":"2021-04-24","format":"date","type":"string"},"EU_TRADEMARK":{"description":"Whether the first action of this binder is an action wherein a national court acts as a supranational court, on a community right, based on community law in an infringement action.\n\nFlat name: EU_TRADEMARK\nHierarchical name: BINDER.EU_TRADEMARK","example":false,"type":"boolean"},"EX_OFFICIO":{"description":"Whether an IP office is acting on behalf of any of the Parties in this Legal Case.\n\nFlat name: EX_OFFICIO\nHierarchical name: BINDER.EX_OFFICIO","example":false,"type":"boolean"},"FIRST_ACTION_DATE":{"description":"Filing date of the first action in a case. Can be null if no date is available.\nThis field is of type date but will be serialized to type string.\n\nFlat name: FIRST_ACTION_DATE\nHierarchical name: BINDER.FIRST_ACTION_DATE","example":"2012-04-24","format":"date","type":"string"},"FIRST_ACTION_TYPE":{"description":"Type of the first action.\n\nFlat name: FIRST_ACTION_TYPE\nHierarchical name: BINDER.FIRST_ACTION_TYPE","example":"ADMINISTRATIVE_HEARINGS","type":"string"},"LAST_EVENT_DATE":{"description":"The date of the last recorded document in the case\nThis field is of type date but will be serialized to type string.\n\nFlat name: LAST_EVENT_DATE\nHierarchical name: BINDER.LAST_EVENT_DATE","example":"2021-04-24","format":"date","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database.\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: BINDER.LAST_UPDATED_DATE","example":"2022-05-05 23:56:24.757579","type":"string"},"NUMBER_DEFENDANTS":{"description":"The number of defendant parties involved in the case.\n\nFlat name: NUMBER_DEFENDANTS\nHierarchical name: BINDER.NUMBER_DEFENDANTS","example":1,"type":"number"},"NUMBER_PLAINTIFFS":{"description":"The number of plaintiff parties involved in the case. (excluding ex-officio parties)\n\nFlat name: NUMBER_PLAINTIFFS\nHierarchical name: BINDER.NUMBER_PLAINTIFFS","example":1,"type":"number"},"NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO":{"description":"The number of plaintiff parties, including ex-officio parties, involved in the case. A party is ex-officio when the IP office is acting on behalf of the party in this Legal Case.\n\nFlat name: NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO\nHierarchical name: BINDER.NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","example":1,"type":"number"},"PARTIES":{"properties":{"ACTOR_ID":{"description":"Unique identifier that represents the actor.\n\nFlat name: PARTY_ACTOR_ID\nHierarchical name: BINDER.PARTIES.ACTOR_ID","example":876,"type":"number"},"ALTERNATIVE_ULTIMATE_PARENT":{"items":{"description":"Alternative group name that this party is part of.\n\nFlat name: PARTY_ALTERNATIVE_ULTIMATE_PARENT\nHierarchical name: BINDER.PARTIES.ALTERNATIVE_ULTIMATE_PARENT","example":"L'Oreal","type":"string"},"type":"array"},"ANONYMOUS":{"description":"Whether the party is anonymous or not.\n\nFlat name: PARTY_IS_ANONYMOUS\nHierarchical name: BINDER.PARTIES.ANONYMOUS","example":false,"type":"boolean"},"COUNTRY":{"description":"The ISO country code for the country of registration of this party (ISO 3166-1 alpha-2).\n\nFlat name: PARTY_COUNTRY\nHierarchical name: BINDER.PARTIES.COUNTRY","example":"PL","type":"string"},"EX_OFFICIO":{"description":"For proceedings initiated by the IP Office, where a prior right is cited by the Office and where the plaintiff is not the one filing the action but just the owner of the cited right.\n\nFlat name: PARTY_IS_EX_OFFICIO\nHierarchical name: BINDER.PARTIES.EX_OFFICIO","example":false,"type":"boolean"},"LEGAL_FORM":{"description":"The legal form of the party\n\nFlat name: PARTY_LEGAL_FORM\nHierarchical name: BINDER.PARTIES.LEGAL_FORM","example":"LTD.","type":"string"},"OPTIMIZED_NAME":{"description":"The party name, filled from one of the scripts based on following order: LATIN -> CHINESE -> TRADITIONAL_CHINESE -> JAPANESE -> KOREAN -> CYRILLIC -> THAI -> HEBREW -> GREEK ->ARABIC\n\nFlat name: PARTY_OPTIMIZED_NAME\nHierarchical name: BINDER.PARTIES.OPTIMIZED_NAME","example":"CAMELOT UK BIDCO","type":"string"},"REPRESENTATIVES":{"properties":{"COUNTRY":{"description":"The ISO country code for the country of registration of the representative.\n\nFlat name: REPRESENTATIVE_COUNTRY\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.COUNTRY","example":"IT","type":"string"},"LEGAL_FORM":{"description":"The legal form of the representative.\n\nFlat name: REPRESENTATIVE_LEGAL_FORM\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.LEGAL_FORM","example":"S.R.L.","type":"string"},"OPTIMIZED_NAME":{"description":"The representative name, filled from one of the scripts based on following order: LATIN -> CHINESE -> TRADITIONAL_CHINESE -> JAPANESE -> KOREAN -> CYRILLIC -> THAI -> HEBREW -> GREEK ->ARABIC\n\nFlat name: REPRESENTATIVE_OPTIMIZED_NAME\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.OPTIMIZED_NAME","example":"\"L. POPOLO\",","type":"string"},"TYPE":{"description":"The type of entity this representative represents, possible values are: AUTHORITY, COMPANY, NPE, PERSON or UNIVERSITY\n\nFlat name: REPRESENTATIVE_TYPE\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.TYPE","example":"PERSON","type":"string"}},"type":"object"},"ROLE":{"description":"Role of the party within the context of the legal case, possible values are PLAINTIFF and DEFENDANT. Plaintiff, is the party that initiates the legal action. Defendant is the party that is targeted by the action. Opponent is the same as plaintiff.\n\nFlat name: PARTY_ROLE\nHierarchical name: BINDER.PARTIES.ROLE","example":"DEFENDANT","type":"string"},"TYPE":{"description":"The type of entity this party represents, possible values are: AUTHORITY, COMPANY, NPE, PERSON or UNIVERSITY\n\nFlat name: PARTY_TYPE\nHierarchical name: BINDER.PARTIES.TYPE","example":"COMPANY","type":"string"},"ULTIMATE_PARENT":{"description":"A group name that this party is part of.\n\nFlat name: PARTY_ULTIMATE_PARENT\nHierarchical name: BINDER.PARTIES.ULTIMATE_PARENT","example":"CLARIVATE","type":"string"}},"type":"object"},"PARTIES_DEFENDANT":{"items":{"description":"The defendant parties involved in a case.\n\nFlat name: _BINDER.PARTIES_DEFENDANT\nHierarchical name: BINDER.PARTIES_DEFENDANT","properties":{"ACTOR_ID":{"description":"A unique identifier that represents the defendant party\n\nFlat name: _BINDER.PARTIES_DEFENDANT.ACTOR_ID\nHierarchical name: BINDER.PARTIES_DEFENDANT.ACTOR_ID","example":1293134,"type":"number"},"NATIONALITY":{"description":"The nationality of the defendant party\n\nFlat name: _BINDER.PARTIES_DEFENDANT.NATIONALITY\nHierarchical name: BINDER.PARTIES_DEFENDANT.NATIONALITY","type":"string"}},"type":"object"},"type":"array"},"PARTIES_PLAINTIFF":{"items":{"description":"The plaintiff parties involved in a case, excluding ex-officio parties.\n\nFlat name: _BINDER.PARTIES_PLAINTIFF\nHierarchical name: BINDER.PARTIES_PLAINTIFF","properties":{"ACTOR_ID":{"description":"A unique identifier that represents the plaintiff party\n\nFlat name: _BINDER.PARTIES_PLAINTIFF.ACTOR_ID\nHierarchical name: BINDER.PARTIES_PLAINTIFF.ACTOR_ID","example":61304,"type":"number"},"LEGAL_FORM":{"description":"The legal form of the plaintiff party\n\nFlat name: _BINDER.PARTIES_PLAINTIFF.LEGAL_FORM\nHierarchical name: BINDER.PARTIES_PLAINTIFF.LEGAL_FORM","type":"string"},"TYPE":{"description":"The type of entity this plaintiff party represents, possible values are: AUTHORITY, COMPANY, NPE, PERSON or UNIVERSITY\n\nFlat name: _BINDER.PARTIES_PLAINTIFF.TYPE\nHierarchical name: BINDER.PARTIES_PLAINTIFF.TYPE","type":"string"}},"type":"object"},"type":"array"},"PATENT_ASSERTIONS":{"description":"Set when the domain is PATENT and the first action is one of: INFRINGEMENT, DECLARATORY, CRIMINAL_ACTION or TRIAL_FOR_SCOPE\n\nFlat name: PATENT_ASSERTIONS\nHierarchical name: BINDER.PATENT_ASSERTIONS","example":false,"type":"boolean"},"PATENT_DAMAGES_ASSIGNED":{"description":"Set when the domain is PATENT and damages higher than 0 have been assigned by the judge that are of one of the following types: INFRINGEMENT, BREACH_OF_CONTRACT, PUNITIVE, UNFAIR_COMPETITION\n\nFlat name: PATENT_DAMAGES_ASSIGNED\nHierarchical name: BINDER.PATENT_DAMAGES_ASSIGNED","example":false,"type":"boolean"},"PATENT_VALIDITY_CHALLENGES":{"description":"Set when the domain is PATENT and the first action is one of: OPPOSITION, INTER_PARTIES_REVIEW_PETITION, PTO_REEXAMINATION, EX_PARTE_REEXAMINATION_PETITION, PETITION_UNDER_TRANSITIONAL_PROGRAM, INVALIDITY_CANCELLATION, INTERFERENCE\n\nFlat name: PATENT_VALIDITY_CHALLENGES\nHierarchical name: BINDER.PATENT_VALIDITY_CHALLENGES","example":false,"type":"boolean"},"REMEDY":{"items":{"description":"Any remedies granted during the case such as preliminary or permanent injunctions.\n\nFlat name: REMEDY\nHierarchical name: BINDER.REMEDY","example":"PRELIMINARY INJUNCTION TO STOP INFRINGEMENT\", \"PERMANENT INJUNCTION TO STOP INFRINGEMENT\", \"SEIZURE OF INFRINGING GOODS\",\" DELIVERY UP OF GOODS\", \"WITHDRAWAL OF GOODS FROM THE MARKET\", \"DESTRUCTION OF GOODS","type":"string"},"type":"array"},"RIGHTS":{"properties":{"COPYRIGHTS":{"properties":{"ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: COPYRIGHT_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.ANONYMOUS","example":false,"type":"boolean"},"DESCRIPTION":{"description":"A description of the copyright.\n\nFlat name: COPYRIGHT_DESCRIPTION\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.DESCRIPTION","example":"DESIGN PATTERN -","type":"string"},"ROLE":{"description":"Whether the copyright belongs to the plaintiff or not.\n\nFlat name: COPYRIGHT_ROLE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.ROLE","example":"PLAINTIFF","type":"string"},"TITLE":{"description":"The name of the copyright\n\nFlat name: COPYRIGHT_TITLE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.TITLE","example":"NEW RED","type":"string"},"TYPE":{"description":"The type of copyright.\n\nFlat name: COPYRIGHT_TYPE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.TYPE","example":"APPLIED_ART","type":"string"}},"type":"object"},"DESIGNS":{"properties":{"ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: DESIGN_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.DESIGNS.ANONYMOUS","example":false,"type":"boolean"},"LOCARNO_CLASSES":{"description":"The Locarno classes associated with the design.\n\nFlat name: DESIGN_LOCARNO_CLASS\nHierarchical name: BINDER.RIGHTS.DESIGNS.LOCARNO_CLASSES","example":"3.01,21.02","type":"string"},"PRODUCT":{"description":"The type of product of the design.\n\nFlat name: DESIGN_PRODUCT\nHierarchical name: BINDER.RIGHTS.DESIGNS.PRODUCT","example":"GAMEBOARDS","type":"string"},"PRODUCT_LANGUAGE":{"description":"The language of the design right.\n\nFlat name: DESIGN_PRODUCT_LANGUAGE\nHierarchical name: BINDER.RIGHTS.DESIGNS.PRODUCT_LANGUAGE","example":"EN","type":"string"},"REGISTRATION_NUMBER":{"description":"The registration number with which this design is registered.\n\nFlat name: DESIGN_REGISTRATION_NUMBER\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_NUMBER","example":"000074463-0001","type":"string"},"REGISTRATION_OFFICE":{"description":"The IP Organization with which the design is registered.\n\nFlat name: DESIGN_REGISTRATION_OFFICE\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_OFFICE","example":"EM","type":"string"},"REGISTRATION_STATUS":{"description":"Whether the design is registered or not.\n\nFlat name: DESIGN_REGISTRATION_STATUS\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_STATUS","example":false,"type":"boolean"},"ROLE":{"description":"Whether the design belongs to the plaintiff or not.\n\nFlat name: DESIGN_ROLE\nHierarchical name: BINDER.RIGHTS.DESIGNS.ROLE","example":"DEFENDANT","type":"string"},"VERBAL_ELEMENT":{"description":"The name of the design.\n\nFlat name: DESIGN_VERBAL_ELEMENT\nHierarchical name: BINDER.RIGHTS.DESIGNS.VERBAL_ELEMENT","example":"GAMES","type":"string"},"VIENNA_CLASSES":{"description":"The Vienna classes associated with the design.\n\nFlat name: DESIGN_VIENNA_CLASS\nHierarchical name: BINDER.RIGHTS.DESIGNS.VIENNA_CLASSES","example":"27.05,27.05","type":"string"}},"type":"object"},"DOMAIN_NAMES":{"properties":{"ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: DOMAIN_NAME_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.ANONYMOUS","example":false,"type":"boolean"},"DOMAIN_NAME":{"description":"The name of the domain.\n\nFlat name: DOMAIN_NAME\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.DOMAIN_NAME","example":"TRADEMARK","type":"string"},"ROLE":{"description":"Whether the domain name belongs to the plaintiff or not.\n\nFlat name: DOMAIN_NAME_ROLE\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.ROLE","example":"DEFENDANT","type":"string"},"TLD":{"description":"The top-level domain.\n\nFlat name: DOMAIN_NAME_TLD\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.TLD","example":".BIZ","type":"string"}},"type":"object"},"PATENTS":{"properties":{"AMENDED_CLAIMS":{"description":"Whether amendments to the patent claims were made.\n\nFlat name: _BINDER.RIGHTS.PATENTS.AMENDED_CLAIMS\nHierarchical name: BINDER.RIGHTS.PATENTS.AMENDED_CLAIMS","example":false,"type":"boolean"},"ANONYMOUS":{"description":"Whether the patent right is anonymous or not.\n\nFlat name: PATENT_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.PATENTS.ANONYMOUS","example":false,"type":"boolean"},"APPLICATION_ID":{"description":"Only applicable for Patstat inventions. The identifier with which the invention's application is known in Patstat.\n\nFlat name: PATENT_APPLICATION_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.APPLICATION_ID","example":"\"49084922\",","type":"string"},"APPLICATION_NUMBER":{"description":"The application number of the invention.\n\nFlat name: PATENT_APPLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.APPLICATION_NUMBER","example":"FR9103887(A)","type":"string"},"DWPI_APPLICATION_NUMBER":{"description":"Unique identifier that represents the Derwent application number.\n\nFlat name: PATENT_DWPI_APPLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.DWPI_APPLICATION_NUMBER","example":"FR19913887A","type":"string"},"EXTENDED_FAMILY_ID":{"description":"Applies mostly to Patstat inventions and is in limited cases available for Darts inventions, the Inpadoc Family Id of the invention.\n\nFlat name: PATENT_INPADOC_FAMILY_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.EXTENDED_FAMILY_ID","example":"1464080","type":"string"},"INDEX":{"description":"An index relative to this right. This is used in order to be able to link right assessments to a right.\n\nFlat name: PATENT_INDEX\nHierarchical name: BINDER.RIGHTS.PATENTS.INDEX","example":1,"type":"number"},"INFRINGEMENT":{"description":"Whether according to the latest ON_THE_MERITS or OTHER_DECISIONS, the patent was seen as valid\n\nFlat name: PATENT_INFRINGEMENT\nHierarchical name: BINDER.RIGHTS.PATENTS.INFRINGEMENT","example":"YES","type":"string"},"INVENTION_ID":{"description":"Unique identifier that represents the invention.\n\nFlat name: PATENT_INVENTION_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.INVENTION_ID","example":25448433,"type":"number"},"IPC_CLASSES":{"items":{"description":"The patent classification code.\n\nFlat name: IPC_CLASS_CODE\nHierarchical name: BINDER.RIGHTS.PATENTS.IPC_CLASSES","example":"A23","type":"string"},"type":"array"},"NATURE":{"description":"The type of the patent.\n\nFlat name: PATENT_TYPE\nHierarchical name: BINDER.RIGHTS.PATENTS.NATURE","example":"INVENTION_PATENT","type":"string"},"OPTIMIZED_TITLE":{"description":"The title of the invention.\n\nFlat name: PATENT_OPTIMIZED_TITLE\nHierarchical name: BINDER.RIGHTS.PATENTS.OPTIMIZED_TITLE","example":"DISPOSITIF APPLICATEUR POUR RECIPIENT CONTENANT UN PRODUIT LIQUIDE OU FLUIDE A OUVERTURE ET FERMETURE AUTOMATIQUE DE DEBIT.","type":"string"},"PUBLICATION_NUMBER":{"description":"The publication number as it is mentioned in the decisions of this Binder.\n\nFlat name: PATENT_PUBLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.PUBLICATION_NUMBER","example":"FR2674453(A1)","type":"string"},"REFERENCES":{"properties":{"AUTHORITY":{"description":"The two-character IP authority with which the application/publication reference is registered.\n\nFlat name: PATENT_REFERENCE_AUTHORITY\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.AUTHORITY","example":"FR","type":"string"},"KIND":{"description":"The kind code for the application or publication reference.\n\nFlat name: PATENT_REFERENCE_KIND\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.KIND","example":"A","type":"string"},"NUMBER":{"description":"The reference assigned to the application or publication. If original is true, this reference is in the format of the IP office, otherwise it is in the Patstat or EPO format.\n\nFlat name: PATENT_REFERENCE_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.NUMBER","example":"7709CHENP2014","type":"string"},"ORIGINAL":{"description":"Whether the reference is in the format with which it was registered with the IP office, or it is in the normalized format defined by Patstat.\n\nFlat name: PATENT_REFERENCE_ORIGINAL\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.ORIGINAL","example":false,"type":"boolean"},"TYPE":{"description":"Whether the reference is an application or publication reference.\n\nFlat name: PATENT_REFERENCE_TYPE\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.TYPE","example":"APPLICATION","type":"string"}},"type":"object"},"ROLE":{"description":"Whether the patent belongs to the plaintiff or not.\n\nFlat name: PATENT_ROLE\nHierarchical name: BINDER.RIGHTS.PATENTS.ROLE","example":"DEFENDANT","type":"string"},"SIMPLE_FAMILY_ID":{"description":"Applies mostly to Patstat inventions and is in limited cases available for Darts inventions, the DocDB Family Id of the invention.\n\nFlat name: PATENT_DOCDB_FAMILY_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.SIMPLE_FAMILY_ID","example":"32303805","type":"string"},"SOURCE":{"description":"Whether the information was imported from the Patstat database or was manually encoded in Darts.\n\nFlat name: PATENT_SOURCE\nHierarchical name: BINDER.RIGHTS.PATENTS.SOURCE","example":"PATSTAT","type":"string"},"TITLES":{"properties":{"LANGUAGE":{"description":"The language of the invention title.\n\nFlat name: PATENT_TITLE_LANGUAGE\nHierarchical name: BINDER.RIGHTS.PATENTS.TITLES.LANGUAGE","example":"FR","type":"string"},"TITLE":{"description":"The actual title of the invention.\n\nFlat name: PATENT_TITLE\nHierarchical name: BINDER.RIGHTS.PATENTS.TITLES.TITLE","example":"DISPOSITIF APPLICATEUR POUR RECIPIENT CONTENANT UN PRODUIT LIQUIDE OU FLUIDE A OUVERTURE ET FERMETURE AUTOMATIQUE DE DEBIT.","type":"string"}},"type":"object"},"VALIDITY":{"description":"Whether according to the latest ON_THE_MERITS decision in this case the patent was seen as infringed\n\nFlat name: PATENT_VALIDITY\nHierarchical name: BINDER.RIGHTS.PATENTS.VALIDITY","example":"VALID","type":"string"}},"type":"object"},"TRADEMARKS":{"properties":{"ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: TRADEMARK_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.ANONYMOUS","example":false,"type":"boolean"},"COMPUMARK_GUID":{"description":"The unique identifier used by CompuMark to identify this trademark.\n\nFlat name: TRADEMARK_ID\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.COMPUMARK_GUID","example":"CTMSI4398BAA8118911E19FC38AE717F0E620","type":"string"},"LOCARNO_CLASSES":{"description":"The Locarno Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_LOCARNO_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.LOCARNO_CLASSES","example":"17.01,17.01","type":"string"},"NICE_CLASSES":{"description":"The Nice Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_NICE_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.NICE_CLASSES","example":"14.11.\",\"14.H3.\", \"18.C2.\", \"25.146.\",  \"25.151.\",\"25.26.\",\"25.3.\",\"25.45.\",  \"34.3.\",  \"34.H2.\",\"42.C77.\",\"9.331.","type":"string"},"REGISTRATION_NUMBER":{"description":"The number with which the trademark is registered.\n\nFlat name: TRADEMARK_REGISTRATION_NUMBER\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.REGISTRATION_NUMBER","example":"01424922","type":"string"},"REGISTRATION_OFFICE":{"description":"The IP Organization with which the trademark is registered.\n\nFlat name: TRADEMARK_REGISTRATION_OFFICE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.REGISTRATION_OFFICE","example":"EU","type":"string"},"ROLE":{"description":"Whether the trademark belongs to the plaintiff or not.\n\nFlat name: TRADEMARK_ROLE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.ROLE","example":"DEFENDANT","type":"string"},"TYPE":{"description":"The type of trademark.\n\nFlat name: TRADEMARK_TYPE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.TYPE","example":"VERBAL","type":"string"},"VERBAL_ELEMENT":{"description":"The name of the trademark.\n\nFlat name: TRADEMARK_VERBAL_ELEMENT\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.VERBAL_ELEMENT","example":"GOCARD","type":"string"},"VIENNA_CLASSES":{"description":"The Vienna Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_VIENNA_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.VIENNA_CLASSES","example":"27.05.C7\",\"27.05.01","type":"string"}},"type":"object"}},"type":"object"},"SETTLED":{"description":"Whether the parties in this binder made an agreement to settle (not only on the costs, but on the entire binder).\n\nFlat name: SETTLED\nHierarchical name: BINDER.SETTLED","example":false,"type":"boolean"},"TOTAL_DAMAGES":{"items":{"description":"The total sum of damages awarded in a case, per type and currency.\n\nFlat name: _BINDER.TOTAL_DAMAGES\nHierarchical name: BINDER.TOTAL_DAMAGES","properties":{},"type":"object"},"type":"array"},"WITHDRAWN":{"description":"Whether the plaintiff or defendant has withdrawn from this binder.\n\nFlat name: WITHDRAWN\nHierarchical name: BINDER.WITHDRAWN","example":false,"type":"boolean"}},"type":"object"},"EXPORT_TIMESTAMP":{"description":"Value containing stamped date (YYYY-MM-DD) & Time of day (hr:MM:SEC)\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: _EXPORT_TIMESTAMP\nHierarchical name: EXPORT_TIMESTAMP","example":"2022-02-06 07:41:56.000","type":"string"},"GUID":{"description":"Unique IP case identifier\n\nFlat name: GUID\nHierarchical name: GUID","example":"2706413","type":"string"}},"type":"object"},"type":"array"},"total_count":{"description":"Total number of results","type":"number"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Call to fetch one or more full caselaw documents by GUID, with possibile filters.","tags":["IP Cases"]}},"/caselaw/document/json/{binder_id}":{"get":{"description":"Call to fetch a full caselaw document by GUID.","operationId":"getCaselawDocument","parameters":[{"description":"Unique ID of caselaw document to retrieve","in":"path","name":"binder_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"BINDER":{"properties":{"AREA":{"description":"Represents the legal area where the case takes place as defined by Darts-ip (i.e. countries grouped together under harmonized legal provisions).\n\nFlat name: AREA\nHierarchical name: BINDER.AREA","example":"JAPAN","type":"string"},"CASE_DOMAINS":{"items":{"description":"The IP right types that the case pertains to. Possible values are: copyright, design_model, domain_name, patent, trademark, unfair_competition or other\n\nFlat name: CASE_DOMAIN\nHierarchical name: BINDER.CASE_DOMAINS","example":"[\"PATENT\", \"DOMAIN_NAME\", \"TRADEMARK\"]","type":"string"},"type":"array"},"CASE_NAME":{"description":"The name of the Binder, about 4% of our Binders have a case name.\n\nFlat name: CASE_NAME\nHierarchical name: BINDER.CASE_NAME","example":"EX PARTE SAGHEER AHMAD","type":"string"},"CASE_REFERENCES":{"items":{"description":"The docket references for this specific case.\n\nFlat name: _BINDER.CASE_REFERENCES\nHierarchical name: BINDER.CASE_REFERENCES","example":"81 O 25/99\", \"6 U 179/99","type":"string"},"type":"array"},"CASE_RESOLUTION":{"description":"The outcome of the case according to the information collected. Possible values are: claimant wins, defendant wins, split win, settled, withdrawn or unknown (null value).\n\nFlat name: CASE_RESOLUTION\nHierarchical name: BINDER.CASE_RESOLUTION","example":"SETTLED","type":"string"},"CASE_STAGE":{"description":"The current stage of the case according to the information collected\n\nFlat name: CASE_STAGE\nHierarchical name: BINDER.CASE_STAGE","example":"HEARING","type":"string"},"CASE_STATUS":{"description":"The current status of an IP Case. Possible values are open, closed or inactive.\n\nFlat name: CASE_STATUS\nHierarchical name: BINDER.CASE_STATUS","example":"CLOSED","type":"string"},"CLOSED":{"description":"Whether the binder has been closed. (US Only)\n\nFlat name: CLOSED\nHierarchical name: BINDER.CLOSED","example":false,"type":"boolean"},"DOCKETS":{"properties":{"COURT":{"properties":{"AREA":{"description":"The legal area this court is part of.\n\nFlat name: DOCKET_COURT_AREA\nHierarchical name: BINDER.DOCKETS.COURT.AREA","example":"EUROPE","type":"string"},"COURT_COUNTRY":{"description":"A two-character WIPO ST.3 code representing the country or the international organization the court is part of.\n\nFlat name: DOCKET_COURT_COUNTRY\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY","example":"RU","type":"string"},"COURT_COUNTRY_DERIVED":{"properties":{"COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2":{"description":"A two-character code mapping from the court country code to the countries belonging to the court country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","example":"AD","type":"string"},"COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3":{"description":"A three-character code mapping from the court country code to the countries belonging to the court country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","example":"AND","type":"string"},"COURT_COUNTRY_DERIVED_TEXT":{"description":"The country name mapping from the court country code to the countries belonging to the country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_TEXT\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_TEXT","example":"ALBANIA","type":"string"}},"type":"object"},"COURT_COUNTRY_TEXT":{"description":"The country or the international organization the court is part of.\n\nFlat name: DOCKET_COURT_COUNTRY_TEXT\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_TEXT","example":"AFRICAN INTELLECTUAL PROPERTY ORGANIZATION","type":"string"},"NAME":{"description":"The English name of the Court.\n\nFlat name: DOCKET_COURT_NAME\nHierarchical name: BINDER.DOCKETS.COURT.NAME","example":"FEDERAL SERVICE FOR IP - WIPO","type":"string"},"PATH":{"description":"Information about the Court in which this Docket was handled.\n\nFlat name: DOCKET_COURT_PATH\nHierarchical name: BINDER.DOCKETS.COURT.PATH","example":"COMMONW. OF INDEP. STATES/RUSSIAN FEDERATION/FEDERAL SERVICE FOR IP - WIPO","type":"string"},"TYPES":{"items":{"description":"Domain Types such as wethere a document is Administrative, Judical, or Arbitration.\n\nFlat name: _BINDER.DOCKETS.COURT.TYPES\nHierarchical name: BINDER.DOCKETS.COURT.TYPES","example":"ADMINISTRATIVE","type":"string"},"type":"array"}},"type":"object"},"DOCUMENTS":{"properties":{"CITABLE":{"description":"Whether the decision has a reporter citation.\n\nFlat name: DOCUMENT_CITABLE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CITABLE","example":false,"type":"boolean"},"CITATION_REFERENCE":{"description":"An unique internal reference in the format 'darts-000-000-A'.\n\nFlat name: DOCUMENT_CITATION_REFERENCE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CITATION_REFERENCE","example":"\"DARTS-998-200-L\",","type":"string"},"CLAIM_CONSTRUCTIONS":{"properties":{"AGREED":{"description":"Whether both the plaintiff(s) and defendant(s) agreed with the definition put forward by the judge.\n\nFlat name: CLAIM_CONSTRUCTION_AGREED\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.AGREED","example":false,"type":"boolean"},"DEFINITION":{"description":"The definition that was given for the term in this decision.\n\nFlat name: CLAIM_CONSTRUCTION_DEFINITION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.DEFINITION","example":"NICHT GLEICHZEITIG","type":"string"},"MEANS_PLUS_FUNCTION":{"description":"Whether the term was considered as describing a function the technology performs, rather than the structure of the technology.(US Only)\n\nFlat name: CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.MEANS_PLUS_FUNCTION","example":"NOT_DISCUSSED","type":"string"},"NOT_NECESSARY":{"description":"Whether the judge deemed a definition of the term to unnecessary for a variety of reasons.\n\nFlat name: CLAIM_CONSTRUCTION_NOT_NECESSARY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.NOT_NECESSARY","example":false,"type":"boolean"},"TERM":{"description":"The term for which a definition or interpretation was given by the judge in this decision.\n\nFlat name: CLAIM_CONSTRUCTION_TERM\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.TERM","example":"ASYNCHROM","type":"string"}},"type":"object"},"DAMAGES":{"properties":{"AMOUNT":{"description":"The amount of damages that needs to be paid.\n\nFlat name: DAMAGE_AMOUNT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.AMOUNT","example":137240,"type":"number"},"CALCULATION_METHOD":{"description":"How the damages have been calculated.\n\nFlat name: DAMAGE_CALCULATION_METHOD\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CALCULATION_METHOD","example":"LOSS_OF_PROFITS","type":"string"},"CURRENCY":{"description":"A 3-character ISO currency code for the main currency of the damage.\n\nFlat name: DAMAGE_CURRENCY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENCY","example":"EUR","type":"string"},"CURRENT_CNY_EQUIVALENT":{"description":"The amount converted to Chinese Yuan.\n\nFlat name: DAMAGE_CURRENT_CNY_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_CNY_EQUIVALENT","example":1454475,"type":"number"},"CURRENT_EUR_EQUIVALENT":{"description":"The amount converted to Euro.\n\nFlat name: DAMAGE_CURRENT_EUR_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_EUR_EQUIVALENT","example":186335,"type":"number"},"CURRENT_USD_EQUIVALENT":{"description":"The amount converted to US Dollars.\n\nFlat name: DAMAGE_CURRENT_USD_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_USD_EQUIVALENT","example":224108,"type":"number"},"NATURE":{"description":"The nature of the damages mentioned in the decision document.\n\nFlat name: DAMAGE_NATURE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.NATURE","example":"INFRINGEMENT","type":"string"},"TYPES":{"properties":{"LATER":{"description":"Indicates that damages have been assigned, but the amount has not been specified in this decision.\n\nFlat name: DAMAGE_LATER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.LATER","example":false,"type":"boolean"},"PARTIAL":{"description":"Indicates whether the damage amount is potentially incomplete and might be amended in a future decision.\n\nFlat name: DAMAGE_PARTIAL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.PARTIAL","example":false,"type":"boolean"},"REQUESTED":{"description":"Indicates that the damage was requested by the plaintiff, but not necessarily granted.\n\nFlat name: DAMAGE_REQUESTED\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.REQUESTED","example":false,"type":"boolean"}},"type":"object"}},"type":"object"},"DECLARATORY":{"description":"Whether the decision addresses a motion for declaratory judgment(US Only).\n\nFlat name: DOCUMENT_DECLARATORY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DECLARATORY","example":false,"type":"boolean"},"DEFAULT_JUDGEMENT":{"description":"Whether the decision is granting a default judgment (US Only).\n\nFlat name: DOCUMENT_DEFAULT_JUDGEMENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DEFAULT_JUDGEMENT","example":false,"type":"boolean"},"DOCUMENT_DATE":{"description":"Judgment Date: The date of this Document.\nThis field is of type date but will be serialized to type string.\n\nFlat name: DOCUMENT_DATE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DOCUMENT_DATE","example":"2021-10-04","format":"date","type":"string"},"DOCUMENT_TYPE":{"description":"The type of the document. Possible values are: decisions_and_orders, prelude, process_procedure_information, settlement_information, briefs_and_memorandums, motions, evidence and conclusions_of_advocate_generale\n\nFlat name: DOCUMENT_TYPE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DOCUMENT_TYPE","example":"DECISIONS_AND_ORDERS","type":"string"},"LEVEL":{"description":"The level of the document. Possible values are first_instance, appeal, judicial_review and preliminary_ruling\n\nFlat name: DOCUMENT_LEVEL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.LEVEL","example":"FIRST_INSTANCE","type":"string"},"POINT_OF_LAWS":{"properties":{"CONFIDENCE_LEVEL":{"description":"Whether the point of law was suggested by AI or was manually encoded.\n\nFlat name: POINT_OF_LAW_CONFIDENCE_LEVEL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.CONFIDENCE_LEVEL","example":"CONFIDENT","type":"string"},"NAME":{"description":"The name of this Point of Law.\n\nFlat name: POINT_OF_LAW_NAME\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.NAME","example":"BETWEEN GOODS IN DIFFERENT CLASSES","type":"string"},"OUTCOMES":{"properties":{"NEGATIVE":{"description":"The name of the negative outcome (if applicable).\n\nFlat name: POINT_OF_LAW_OUTCOME_NEGATIVE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.NEGATIVE","example":"DIFFERENT","type":"string"},"OUTCOME":{"description":"The outcome either positive, negative or both for this Point of Law.\n\nFlat name: POINT_OF_LAW_OUTCOME\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.OUTCOME","example":"NEGATIVE","type":"string"},"POSITIVE":{"description":"The name of the positive outcome (if applicable).\n\nFlat name: POINT_OF_LAW_OUTCOME_POSITIVE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.POSITIVE","example":"DIFFERENT","type":"string"}},"type":"object"},"PARENT_PATH":{"description":"The parent of this Point of Law in the Point of Law tree.\n\nFlat name: POINT_OF_LAW_PARENT_PATH\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PARENT_PATH","example":"CONFLICT BETWEEN TRADE MARKS/LIKELIHOOD OF CONFUSION (IDENTICAL/SIMILAR TRADE MARKS FOR IDENTICAL/SIMILAR GOODS OR SERVICES)/SIMILARITY BETWEEN THE GOODS/SERVICES/BETWEEN GOODS IN DIFFERENT CLASSES","type":"string"},"PREFIX":{"description":"The parent of this Point of Law in the Point of Law tree.\n\nFlat name: POINT_OF_LAW_PREFIX\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PREFIX","example":"EUR-06.2.2.4","type":"string"}},"type":"object"},"PRODUCT_COMPARISONS":{"properties":{"PRODUCT_A":{"properties":{"DESCRIPTION":{"description":"Description of the first product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.DESCRIPTION","example":"DEBIT CARD SERVICES; PROCESSING OF PAYMENTS IN RELATION TO CHARGE CARDS; PROCESSING PAYMENTS MADE BY CHARGE CARDS; CHEQUE GUARANTEE CARD PROCESSING; ISSUING OF CREDIT AND DEBIT CARDS; FINANCIAL TRANSACTIONS; ELECTRONIC FUNDS TRANSFER; PAYMENT SETTLEMENT, BANKING OPERATIONS; BANKS (BANKING); BANKING; FINANCIAL CONSULTANCY; CREDIT CONSULTANCY; BUDGET ACCOUNT SERVICES; BANK ACCOUNT AND SAVINGS ACCOUNT SERVICES; FINANCIAL SERVICES IN THE FIELD OF BANK CARDS; BANK ACCOUNT INFORMATION SERVICES; PROVIDING OF BANKING SERVICES; MONEY TRANSFER SERVICES BY ELECTRONIC MEANS; ELECTRONIC FUND TRANSFER FOR OTHERS; PROVIDING MULTIPLE PAYMENT OPTIONS BY MEANS OF CUSTOMER-OPERATED ELECTRONIC TERMINALS AVAILABLE ON-SITE IN RETAIL STORES","type":"string"},"NICE_CLASSES":{"description":"The Nice Classes of the first product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.NICE_CLASSES","example":"36.\",\"36.13\",\"36.41","type":"string"}},"type":"object"},"PRODUCT_B":{"properties":{"DESCRIPTION":{"description":"Description of the second product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_B.DESCRIPTION","example":"FARE CARD FOR ACCESSING FARE COLLECTION EQUIPMENT FOR MASS TRANSPORTATION","type":"string"},"NICE_CLASSES":{"description":"The Nice Classes of the second product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_B.NICE_CLASSES","example":"\"41.H2.\",\"35.2\",\"25.45\",","type":"string"}},"type":"object"},"SIMILAR":{"description":"Whether both products being compared where deemed similar or not by the judge.\n\nFlat name: PRODUCT_COMPARISON_SIMILAR\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.SIMILAR","example":false,"type":"boolean"}},"type":"object"},"REFUSAL":{"description":"For Trademark cases. True for any first instance document issued by an IP office of type ADMINISTRATIVE_HEARING.\n\nFlat name: DOCUMENT_REFUSAL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.REFUSAL","example":false,"type":"boolean"},"RELATIONS":{"properties":{"RATING":{"description":"Describes to what length the current decision follows the reasoning presented in the target decision.\n\nFlat name: RELATION_RATING\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.RATING","example":"UPHELD","type":"string"},"RELATION":{"description":"The type of relation. The current decision either follows up on another decision or refers to another decision.\n\nFlat name: RELATION_RELATION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.RELATION","example":"INSTANCE_FOLLOWS","type":"string"},"TARGET_DECISION":{"description":"The citation reference of the decision that the current decision relates to (e.g. darts-000-000-A).\n\nFlat name: RELATION_TARGET_DECISION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.TARGET_DECISION","example":"DARTS-404-771-D","type":"string"},"TARGET_REFERENCE":{"description":"The reference/description of the decision that the current decision relates to.\n\nFlat name: RELATION_TARGET_REFERENCE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.TARGET_REFERENCE","example":"FR-2004038828_20070323","type":"string"}},"type":"object"},"RELEVANT_PUBLIC":{"properties":{"AVERAGE_CONSUMER":{"description":"Whether average consumer attention was considered in the decision when discussing the relevant public.\n\nFlat name: RELEVANT_PUBLIC_AVERAGE_CONSUMER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.AVERAGE_CONSUMER","example":true,"type":"boolean"},"AWARENESS":{"description":"The level of awareness that the consumer has of the product.\n\nFlat name: RELEVANT_PUBLIC_AWARENESS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.AWARENESS","example":"AWARE","type":"string"},"NICE_CLASSES":{"items":{"description":"The Nice Classes of the product being discussed.\n\nFlat name: RELEVANT_PUBLIC_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.NICE_CLASSES","example":"18\",\"14\",\"34","type":"string"},"type":"array"},"PROFESSIONAL_CONSUMER":{"description":"Whether professional consumer attention was considered in the decision when discussing the relevant public\n\nFlat name: RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.PROFESSIONAL_CONSUMER","example":true,"type":"boolean"}},"type":"object"},"RIGHT_ASSESSMENTS":{"properties":{"AMENDED_CLAIMS":{"description":"Whether amendments to the patent claims were made in this decision.\n\nFlat name: RIGHT_ASSESSMENT_AMENDED_CLAIMS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.AMENDED_CLAIMS","example":false,"type":"boolean"},"INFRINGEMENT":{"description":"Indicates whether infringement of the patent was discussed in this decision and, if so, whether the patent was considered to be infringed or not.\n\nFlat name: RIGHT_ASSESSMENT_INFRINGEMENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.INFRINGEMENT","example":"INFRINGED","type":"string"},"RIGHT_ASSESSMENT_INDEX":{"description":"An index identifying to which patent right in this legal case the right assessment relates.\n\nFlat name: RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.RIGHT_ASSESSMENT_INDEX","example":1,"type":"number"},"VALIDITY":{"description":"Indicates whether validity of the patent was discussed in this decision and, if so, whether the patent claims were considered to be valid or not.\n\nFlat name: RIGHT_ASSESSMENT_VALIDITY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.VALIDITY","example":"UNDECIDED","type":"string"}},"type":"object"},"STATE":{"description":"The current state of analysis of this decision.\n\nFlat name: DOCUMENT_STATE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.STATE","example":"UPLOADED","type":"string"},"SUBTYPE":{"description":"The sub-type of the document. Only applicable for PRELUDE and DECISIONS_AND_ORDERS. Possible values are on_the_merits, provisional, other_decisions, complaint, hearing, notice_of_appeal, preliminary_proceedings and verdict.\n\nFlat name: DOCUMENT_SUBTYPE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.SUBTYPE","example":"COMPLAINT","type":"string"},"TRADEMARK_REPUTATION":{"description":"Set when the domain is TRADEMARK and the document contains points of law that relate to trademark reputation.\n\nFlat name: DOCUMENT_TRADEMARK_REPUTATION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.TRADEMARK_REPUTATION","example":false,"type":"boolean"},"WINNER":{"description":"The set of Parties that has won the Legal Case at the time of this document.\n\nFlat name: DOCUMENT_WINNER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.WINNER","example":false,"type":"boolean"}},"type":"object"},"REFERENCE":{"description":"A Court-specific reference for this Docket.\n\nFlat name: DOCKET_REFERENCE\nHierarchical name: BINDER.DOCKETS.REFERENCE","example":"RU-WO-1559837","type":"string"}},"type":"object"},"DOCKET_COURT_COUNTRIES":{"items":{"description":"The countries in which the case is being litigated.\n\nFlat name: DOCKET_COURT_COUNTRIES\nHierarchical name: BINDER.DOCKET_COURT_COUNTRIES","example":"[\"BE\", \"DE\"]","type":"string"},"type":"array"},"DOCKET_COURT_NAMES":{"items":{"description":"The courts in which the case is being litigated.\n\nFlat name: DOCKET_COURT_NAMES\nHierarchical name: BINDER.DOCKET_COURT_NAMES","example":"[\"CALIFORNIA CENTRAL DISTRICT COURT\", \"THE FORUM UDRP - GTLDS\"]","type":"string"},"type":"array"},"EARLIEST_EVENT_DATE":{"description":"The filing date of the case or the earliest document date in case the filing cannot be identified.\nThis field is of type date but will be serialized to type string.\n\nFlat name: EARLIEST_EVENT_DATE\nHierarchical name: BINDER.EARLIEST_EVENT_DATE","example":"2021-04-24","format":"date","type":"string"},"EU_TRADEMARK":{"description":"Whether the first action of this binder is an action wherein a national court acts as a supranational court, on a community right, based on community law in an infringement action.\n\nFlat name: EU_TRADEMARK\nHierarchical name: BINDER.EU_TRADEMARK","example":false,"type":"boolean"},"EX_OFFICIO":{"description":"Whether an IP office is acting on behalf of any of the Parties in this Legal Case.\n\nFlat name: EX_OFFICIO\nHierarchical name: BINDER.EX_OFFICIO","example":false,"type":"boolean"},"FIRST_ACTION_DATE":{"description":"Filing date of the first action in a case. Can be null if no date is available.\nThis field is of type date but will be serialized to type string.\n\nFlat name: FIRST_ACTION_DATE\nHierarchical name: BINDER.FIRST_ACTION_DATE","example":"2012-04-24","format":"date","type":"string"},"FIRST_ACTION_TYPE":{"description":"Type of the first action.\n\nFlat name: FIRST_ACTION_TYPE\nHierarchical name: BINDER.FIRST_ACTION_TYPE","example":"ADMINISTRATIVE_HEARINGS","type":"string"},"LAST_EVENT_DATE":{"description":"The date of the last recorded document in the case\nThis field is of type date but will be serialized to type string.\n\nFlat name: LAST_EVENT_DATE\nHierarchical name: BINDER.LAST_EVENT_DATE","example":"2021-04-24","format":"date","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database.\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: BINDER.LAST_UPDATED_DATE","example":"2022-05-05 23:56:24.757579","type":"string"},"NUMBER_DEFENDANTS":{"description":"The number of defendant parties involved in the case.\n\nFlat name: NUMBER_DEFENDANTS\nHierarchical name: BINDER.NUMBER_DEFENDANTS","example":1,"type":"number"},"NUMBER_PLAINTIFFS":{"description":"The number of plaintiff parties involved in the case. (excluding ex-officio parties)\n\nFlat name: NUMBER_PLAINTIFFS\nHierarchical name: BINDER.NUMBER_PLAINTIFFS","example":1,"type":"number"},"NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO":{"description":"The number of plaintiff parties, including ex-officio parties, involved in the case. A party is ex-officio when the IP office is acting on behalf of the party in this Legal Case.\n\nFlat name: NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO\nHierarchical name: BINDER.NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","example":1,"type":"number"},"PARTIES":{"properties":{"ACTOR_ID":{"description":"Unique identifier that represents the actor.\n\nFlat name: PARTY_ACTOR_ID\nHierarchical name: BINDER.PARTIES.ACTOR_ID","example":876,"type":"number"},"ALTERNATIVE_ULTIMATE_PARENT":{"items":{"description":"Alternative group name that this party is part of.\n\nFlat name: PARTY_ALTERNATIVE_ULTIMATE_PARENT\nHierarchical name: BINDER.PARTIES.ALTERNATIVE_ULTIMATE_PARENT","example":"L'Oreal","type":"string"},"type":"array"},"ANONYMOUS":{"description":"Whether the party is anonymous or not.\n\nFlat name: PARTY_IS_ANONYMOUS\nHierarchical name: BINDER.PARTIES.ANONYMOUS","example":false,"type":"boolean"},"COUNTRY":{"description":"The ISO country code for the country of registration of this party (ISO 3166-1 alpha-2).\n\nFlat name: PARTY_COUNTRY\nHierarchical name: BINDER.PARTIES.COUNTRY","example":"PL","type":"string"},"EX_OFFICIO":{"description":"For proceedings initiated by the IP Office, where a prior right is cited by the Office and where the plaintiff is not the one filing the action but just the owner of the cited right.\n\nFlat name: PARTY_IS_EX_OFFICIO\nHierarchical name: BINDER.PARTIES.EX_OFFICIO","example":false,"type":"boolean"},"LEGAL_FORM":{"description":"The legal form of the party\n\nFlat name: PARTY_LEGAL_FORM\nHierarchical name: BINDER.PARTIES.LEGAL_FORM","example":"LTD.","type":"string"},"OPTIMIZED_NAME":{"description":"The party name, filled from one of the scripts based on following order: LATIN -> CHINESE -> TRADITIONAL_CHINESE -> JAPANESE -> KOREAN -> CYRILLIC -> THAI -> HEBREW -> GREEK ->ARABIC\n\nFlat name: PARTY_OPTIMIZED_NAME\nHierarchical name: BINDER.PARTIES.OPTIMIZED_NAME","example":"CAMELOT UK BIDCO","type":"string"},"REPRESENTATIVES":{"properties":{"COUNTRY":{"description":"The ISO country code for the country of registration of the representative.\n\nFlat name: REPRESENTATIVE_COUNTRY\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.COUNTRY","example":"IT","type":"string"},"LEGAL_FORM":{"description":"The legal form of the representative.\n\nFlat name: REPRESENTATIVE_LEGAL_FORM\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.LEGAL_FORM","example":"S.R.L.","type":"string"},"OPTIMIZED_NAME":{"description":"The representative name, filled from one of the scripts based on following order: LATIN -> CHINESE -> TRADITIONAL_CHINESE -> JAPANESE -> KOREAN -> CYRILLIC -> THAI -> HEBREW -> GREEK ->ARABIC\n\nFlat name: REPRESENTATIVE_OPTIMIZED_NAME\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.OPTIMIZED_NAME","example":"\"L. POPOLO\",","type":"string"},"TYPE":{"description":"The type of entity this representative represents, possible values are: AUTHORITY, COMPANY, NPE, PERSON or UNIVERSITY\n\nFlat name: REPRESENTATIVE_TYPE\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.TYPE","example":"PERSON","type":"string"}},"type":"object"},"ROLE":{"description":"Role of the party within the context of the legal case, possible values are PLAINTIFF and DEFENDANT. Plaintiff, is the party that initiates the legal action. Defendant is the party that is targeted by the action. Opponent is the same as plaintiff.\n\nFlat name: PARTY_ROLE\nHierarchical name: BINDER.PARTIES.ROLE","example":"DEFENDANT","type":"string"},"TYPE":{"description":"The type of entity this party represents, possible values are: AUTHORITY, COMPANY, NPE, PERSON or UNIVERSITY\n\nFlat name: PARTY_TYPE\nHierarchical name: BINDER.PARTIES.TYPE","example":"COMPANY","type":"string"},"ULTIMATE_PARENT":{"description":"A group name that this party is part of.\n\nFlat name: PARTY_ULTIMATE_PARENT\nHierarchical name: BINDER.PARTIES.ULTIMATE_PARENT","example":"CLARIVATE","type":"string"}},"type":"object"},"PARTIES_DEFENDANT":{"items":{"description":"The defendant parties involved in a case.\n\nFlat name: _BINDER.PARTIES_DEFENDANT\nHierarchical name: BINDER.PARTIES_DEFENDANT","properties":{"ACTOR_ID":{"description":"A unique identifier that represents the defendant party\n\nFlat name: _BINDER.PARTIES_DEFENDANT.ACTOR_ID\nHierarchical name: BINDER.PARTIES_DEFENDANT.ACTOR_ID","example":1293134,"type":"number"},"NATIONALITY":{"description":"The nationality of the defendant party\n\nFlat name: _BINDER.PARTIES_DEFENDANT.NATIONALITY\nHierarchical name: BINDER.PARTIES_DEFENDANT.NATIONALITY","type":"string"}},"type":"object"},"type":"array"},"PARTIES_PLAINTIFF":{"items":{"description":"The plaintiff parties involved in a case, excluding ex-officio parties.\n\nFlat name: _BINDER.PARTIES_PLAINTIFF\nHierarchical name: BINDER.PARTIES_PLAINTIFF","properties":{"ACTOR_ID":{"description":"A unique identifier that represents the plaintiff party\n\nFlat name: _BINDER.PARTIES_PLAINTIFF.ACTOR_ID\nHierarchical name: BINDER.PARTIES_PLAINTIFF.ACTOR_ID","example":61304,"type":"number"},"LEGAL_FORM":{"description":"The legal form of the plaintiff party\n\nFlat name: _BINDER.PARTIES_PLAINTIFF.LEGAL_FORM\nHierarchical name: BINDER.PARTIES_PLAINTIFF.LEGAL_FORM","type":"string"},"TYPE":{"description":"The type of entity this plaintiff party represents, possible values are: AUTHORITY, COMPANY, NPE, PERSON or UNIVERSITY\n\nFlat name: _BINDER.PARTIES_PLAINTIFF.TYPE\nHierarchical name: BINDER.PARTIES_PLAINTIFF.TYPE","type":"string"}},"type":"object"},"type":"array"},"PATENT_ASSERTIONS":{"description":"Set when the domain is PATENT and the first action is one of: INFRINGEMENT, DECLARATORY, CRIMINAL_ACTION or TRIAL_FOR_SCOPE\n\nFlat name: PATENT_ASSERTIONS\nHierarchical name: BINDER.PATENT_ASSERTIONS","example":false,"type":"boolean"},"PATENT_DAMAGES_ASSIGNED":{"description":"Set when the domain is PATENT and damages higher than 0 have been assigned by the judge that are of one of the following types: INFRINGEMENT, BREACH_OF_CONTRACT, PUNITIVE, UNFAIR_COMPETITION\n\nFlat name: PATENT_DAMAGES_ASSIGNED\nHierarchical name: BINDER.PATENT_DAMAGES_ASSIGNED","example":false,"type":"boolean"},"PATENT_VALIDITY_CHALLENGES":{"description":"Set when the domain is PATENT and the first action is one of: OPPOSITION, INTER_PARTIES_REVIEW_PETITION, PTO_REEXAMINATION, EX_PARTE_REEXAMINATION_PETITION, PETITION_UNDER_TRANSITIONAL_PROGRAM, INVALIDITY_CANCELLATION, INTERFERENCE\n\nFlat name: PATENT_VALIDITY_CHALLENGES\nHierarchical name: BINDER.PATENT_VALIDITY_CHALLENGES","example":false,"type":"boolean"},"REMEDY":{"items":{"description":"Any remedies granted during the case such as preliminary or permanent injunctions.\n\nFlat name: REMEDY\nHierarchical name: BINDER.REMEDY","example":"PRELIMINARY INJUNCTION TO STOP INFRINGEMENT\", \"PERMANENT INJUNCTION TO STOP INFRINGEMENT\", \"SEIZURE OF INFRINGING GOODS\",\" DELIVERY UP OF GOODS\", \"WITHDRAWAL OF GOODS FROM THE MARKET\", \"DESTRUCTION OF GOODS","type":"string"},"type":"array"},"RIGHTS":{"properties":{"COPYRIGHTS":{"properties":{"ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: COPYRIGHT_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.ANONYMOUS","example":false,"type":"boolean"},"DESCRIPTION":{"description":"A description of the copyright.\n\nFlat name: COPYRIGHT_DESCRIPTION\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.DESCRIPTION","example":"DESIGN PATTERN -","type":"string"},"ROLE":{"description":"Whether the copyright belongs to the plaintiff or not.\n\nFlat name: COPYRIGHT_ROLE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.ROLE","example":"PLAINTIFF","type":"string"},"TITLE":{"description":"The name of the copyright\n\nFlat name: COPYRIGHT_TITLE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.TITLE","example":"NEW RED","type":"string"},"TYPE":{"description":"The type of copyright.\n\nFlat name: COPYRIGHT_TYPE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.TYPE","example":"APPLIED_ART","type":"string"}},"type":"object"},"DESIGNS":{"properties":{"ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: DESIGN_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.DESIGNS.ANONYMOUS","example":false,"type":"boolean"},"LOCARNO_CLASSES":{"description":"The Locarno classes associated with the design.\n\nFlat name: DESIGN_LOCARNO_CLASS\nHierarchical name: BINDER.RIGHTS.DESIGNS.LOCARNO_CLASSES","example":"3.01,21.02","type":"string"},"PRODUCT":{"description":"The type of product of the design.\n\nFlat name: DESIGN_PRODUCT\nHierarchical name: BINDER.RIGHTS.DESIGNS.PRODUCT","example":"GAMEBOARDS","type":"string"},"PRODUCT_LANGUAGE":{"description":"The language of the design right.\n\nFlat name: DESIGN_PRODUCT_LANGUAGE\nHierarchical name: BINDER.RIGHTS.DESIGNS.PRODUCT_LANGUAGE","example":"EN","type":"string"},"REGISTRATION_NUMBER":{"description":"The registration number with which this design is registered.\n\nFlat name: DESIGN_REGISTRATION_NUMBER\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_NUMBER","example":"000074463-0001","type":"string"},"REGISTRATION_OFFICE":{"description":"The IP Organization with which the design is registered.\n\nFlat name: DESIGN_REGISTRATION_OFFICE\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_OFFICE","example":"EM","type":"string"},"REGISTRATION_STATUS":{"description":"Whether the design is registered or not.\n\nFlat name: DESIGN_REGISTRATION_STATUS\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_STATUS","example":false,"type":"boolean"},"ROLE":{"description":"Whether the design belongs to the plaintiff or not.\n\nFlat name: DESIGN_ROLE\nHierarchical name: BINDER.RIGHTS.DESIGNS.ROLE","example":"DEFENDANT","type":"string"},"VERBAL_ELEMENT":{"description":"The name of the design.\n\nFlat name: DESIGN_VERBAL_ELEMENT\nHierarchical name: BINDER.RIGHTS.DESIGNS.VERBAL_ELEMENT","example":"GAMES","type":"string"},"VIENNA_CLASSES":{"description":"The Vienna classes associated with the design.\n\nFlat name: DESIGN_VIENNA_CLASS\nHierarchical name: BINDER.RIGHTS.DESIGNS.VIENNA_CLASSES","example":"27.05,27.05","type":"string"}},"type":"object"},"DOMAIN_NAMES":{"properties":{"ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: DOMAIN_NAME_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.ANONYMOUS","example":false,"type":"boolean"},"DOMAIN_NAME":{"description":"The name of the domain.\n\nFlat name: DOMAIN_NAME\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.DOMAIN_NAME","example":"TRADEMARK","type":"string"},"ROLE":{"description":"Whether the domain name belongs to the plaintiff or not.\n\nFlat name: DOMAIN_NAME_ROLE\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.ROLE","example":"DEFENDANT","type":"string"},"TLD":{"description":"The top-level domain.\n\nFlat name: DOMAIN_NAME_TLD\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.TLD","example":".BIZ","type":"string"}},"type":"object"},"PATENTS":{"properties":{"AMENDED_CLAIMS":{"description":"Whether amendments to the patent claims were made.\n\nFlat name: _BINDER.RIGHTS.PATENTS.AMENDED_CLAIMS\nHierarchical name: BINDER.RIGHTS.PATENTS.AMENDED_CLAIMS","example":false,"type":"boolean"},"ANONYMOUS":{"description":"Whether the patent right is anonymous or not.\n\nFlat name: PATENT_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.PATENTS.ANONYMOUS","example":false,"type":"boolean"},"APPLICATION_ID":{"description":"Only applicable for Patstat inventions. The identifier with which the invention's application is known in Patstat.\n\nFlat name: PATENT_APPLICATION_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.APPLICATION_ID","example":"\"49084922\",","type":"string"},"APPLICATION_NUMBER":{"description":"The application number of the invention.\n\nFlat name: PATENT_APPLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.APPLICATION_NUMBER","example":"FR9103887(A)","type":"string"},"DWPI_APPLICATION_NUMBER":{"description":"Unique identifier that represents the Derwent application number.\n\nFlat name: PATENT_DWPI_APPLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.DWPI_APPLICATION_NUMBER","example":"FR19913887A","type":"string"},"EXTENDED_FAMILY_ID":{"description":"Applies mostly to Patstat inventions and is in limited cases available for Darts inventions, the Inpadoc Family Id of the invention.\n\nFlat name: PATENT_INPADOC_FAMILY_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.EXTENDED_FAMILY_ID","example":"1464080","type":"string"},"INDEX":{"description":"An index relative to this right. This is used in order to be able to link right assessments to a right.\n\nFlat name: PATENT_INDEX\nHierarchical name: BINDER.RIGHTS.PATENTS.INDEX","example":1,"type":"number"},"INFRINGEMENT":{"description":"Whether according to the latest ON_THE_MERITS or OTHER_DECISIONS, the patent was seen as valid\n\nFlat name: PATENT_INFRINGEMENT\nHierarchical name: BINDER.RIGHTS.PATENTS.INFRINGEMENT","example":"YES","type":"string"},"INVENTION_ID":{"description":"Unique identifier that represents the invention.\n\nFlat name: PATENT_INVENTION_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.INVENTION_ID","example":25448433,"type":"number"},"IPC_CLASSES":{"items":{"description":"The patent classification code.\n\nFlat name: IPC_CLASS_CODE\nHierarchical name: BINDER.RIGHTS.PATENTS.IPC_CLASSES","example":"A23","type":"string"},"type":"array"},"NATURE":{"description":"The type of the patent.\n\nFlat name: PATENT_TYPE\nHierarchical name: BINDER.RIGHTS.PATENTS.NATURE","example":"INVENTION_PATENT","type":"string"},"OPTIMIZED_TITLE":{"description":"The title of the invention.\n\nFlat name: PATENT_OPTIMIZED_TITLE\nHierarchical name: BINDER.RIGHTS.PATENTS.OPTIMIZED_TITLE","example":"DISPOSITIF APPLICATEUR POUR RECIPIENT CONTENANT UN PRODUIT LIQUIDE OU FLUIDE A OUVERTURE ET FERMETURE AUTOMATIQUE DE DEBIT.","type":"string"},"PUBLICATION_NUMBER":{"description":"The publication number as it is mentioned in the decisions of this Binder.\n\nFlat name: PATENT_PUBLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.PUBLICATION_NUMBER","example":"FR2674453(A1)","type":"string"},"REFERENCES":{"properties":{"AUTHORITY":{"description":"The two-character IP authority with which the application/publication reference is registered.\n\nFlat name: PATENT_REFERENCE_AUTHORITY\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.AUTHORITY","example":"FR","type":"string"},"KIND":{"description":"The kind code for the application or publication reference.\n\nFlat name: PATENT_REFERENCE_KIND\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.KIND","example":"A","type":"string"},"NUMBER":{"description":"The reference assigned to the application or publication. If original is true, this reference is in the format of the IP office, otherwise it is in the Patstat or EPO format.\n\nFlat name: PATENT_REFERENCE_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.NUMBER","example":"7709CHENP2014","type":"string"},"ORIGINAL":{"description":"Whether the reference is in the format with which it was registered with the IP office, or it is in the normalized format defined by Patstat.\n\nFlat name: PATENT_REFERENCE_ORIGINAL\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.ORIGINAL","example":false,"type":"boolean"},"TYPE":{"description":"Whether the reference is an application or publication reference.\n\nFlat name: PATENT_REFERENCE_TYPE\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.TYPE","example":"APPLICATION","type":"string"}},"type":"object"},"ROLE":{"description":"Whether the patent belongs to the plaintiff or not.\n\nFlat name: PATENT_ROLE\nHierarchical name: BINDER.RIGHTS.PATENTS.ROLE","example":"DEFENDANT","type":"string"},"SIMPLE_FAMILY_ID":{"description":"Applies mostly to Patstat inventions and is in limited cases available for Darts inventions, the DocDB Family Id of the invention.\n\nFlat name: PATENT_DOCDB_FAMILY_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.SIMPLE_FAMILY_ID","example":"32303805","type":"string"},"SOURCE":{"description":"Whether the information was imported from the Patstat database or was manually encoded in Darts.\n\nFlat name: PATENT_SOURCE\nHierarchical name: BINDER.RIGHTS.PATENTS.SOURCE","example":"PATSTAT","type":"string"},"TITLES":{"properties":{"LANGUAGE":{"description":"The language of the invention title.\n\nFlat name: PATENT_TITLE_LANGUAGE\nHierarchical name: BINDER.RIGHTS.PATENTS.TITLES.LANGUAGE","example":"FR","type":"string"},"TITLE":{"description":"The actual title of the invention.\n\nFlat name: PATENT_TITLE\nHierarchical name: BINDER.RIGHTS.PATENTS.TITLES.TITLE","example":"DISPOSITIF APPLICATEUR POUR RECIPIENT CONTENANT UN PRODUIT LIQUIDE OU FLUIDE A OUVERTURE ET FERMETURE AUTOMATIQUE DE DEBIT.","type":"string"}},"type":"object"},"VALIDITY":{"description":"Whether according to the latest ON_THE_MERITS decision in this case the patent was seen as infringed\n\nFlat name: PATENT_VALIDITY\nHierarchical name: BINDER.RIGHTS.PATENTS.VALIDITY","example":"VALID","type":"string"}},"type":"object"},"TRADEMARKS":{"properties":{"ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: TRADEMARK_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.ANONYMOUS","example":false,"type":"boolean"},"COMPUMARK_GUID":{"description":"The unique identifier used by CompuMark to identify this trademark.\n\nFlat name: TRADEMARK_ID\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.COMPUMARK_GUID","example":"CTMSI4398BAA8118911E19FC38AE717F0E620","type":"string"},"LOCARNO_CLASSES":{"description":"The Locarno Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_LOCARNO_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.LOCARNO_CLASSES","example":"17.01,17.01","type":"string"},"NICE_CLASSES":{"description":"The Nice Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_NICE_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.NICE_CLASSES","example":"14.11.\",\"14.H3.\", \"18.C2.\", \"25.146.\",  \"25.151.\",\"25.26.\",\"25.3.\",\"25.45.\",  \"34.3.\",  \"34.H2.\",\"42.C77.\",\"9.331.","type":"string"},"REGISTRATION_NUMBER":{"description":"The number with which the trademark is registered.\n\nFlat name: TRADEMARK_REGISTRATION_NUMBER\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.REGISTRATION_NUMBER","example":"01424922","type":"string"},"REGISTRATION_OFFICE":{"description":"The IP Organization with which the trademark is registered.\n\nFlat name: TRADEMARK_REGISTRATION_OFFICE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.REGISTRATION_OFFICE","example":"EU","type":"string"},"ROLE":{"description":"Whether the trademark belongs to the plaintiff or not.\n\nFlat name: TRADEMARK_ROLE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.ROLE","example":"DEFENDANT","type":"string"},"TYPE":{"description":"The type of trademark.\n\nFlat name: TRADEMARK_TYPE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.TYPE","example":"VERBAL","type":"string"},"VERBAL_ELEMENT":{"description":"The name of the trademark.\n\nFlat name: TRADEMARK_VERBAL_ELEMENT\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.VERBAL_ELEMENT","example":"GOCARD","type":"string"},"VIENNA_CLASSES":{"description":"The Vienna Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_VIENNA_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.VIENNA_CLASSES","example":"27.05.C7\",\"27.05.01","type":"string"}},"type":"object"}},"type":"object"},"SETTLED":{"description":"Whether the parties in this binder made an agreement to settle (not only on the costs, but on the entire binder).\n\nFlat name: SETTLED\nHierarchical name: BINDER.SETTLED","example":false,"type":"boolean"},"TOTAL_DAMAGES":{"items":{"description":"The total sum of damages awarded in a case, per type and currency.\n\nFlat name: _BINDER.TOTAL_DAMAGES\nHierarchical name: BINDER.TOTAL_DAMAGES","properties":{},"type":"object"},"type":"array"},"WITHDRAWN":{"description":"Whether the plaintiff or defendant has withdrawn from this binder.\n\nFlat name: WITHDRAWN\nHierarchical name: BINDER.WITHDRAWN","example":false,"type":"boolean"}},"type":"object"},"EXPORT_TIMESTAMP":{"description":"Value containing stamped date (YYYY-MM-DD) & Time of day (hr:MM:SEC)\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: _EXPORT_TIMESTAMP\nHierarchical name: EXPORT_TIMESTAMP","example":"2022-02-06 07:41:56.000","type":"string"},"GUID":{"description":"Unique IP case identifier\n\nFlat name: GUID\nHierarchical name: GUID","example":"2706413","type":"string"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Call to fetch a full caselaw document by GUID.","tags":["IP Cases"]}},"/caselaw/search":{"post":{"description":"Call to fetch one or more full caselaw documents by GUID, with possibile filters.","operationId":"searchCaselaw","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_request_caselaw"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Page of results","items":{"properties":{"AREA":{"description":"Represents the legal area where the case takes place as defined by Darts-ip (i.e. countries grouped together under harmonized legal provisions).\n\nFlat name: AREA\nHierarchical name: BINDER.AREA","example":"JAPAN","type":"string"},"BINDER_ID":{"description":"Unique IP case identifier\n\nFlat name: BINDER_ID\nHierarchical name: GUID","example":"2706413","type":"string"},"CASE_DOMAIN":{"description":"The IP right types that the case pertains to. Possible values are: copyright, design_model, domain_name, patent, trademark, unfair_competition or other\n\nFlat name: CASE_DOMAIN\nHierarchical name: BINDER.CASE_DOMAINS","example":"[\"PATENT\", \"DOMAIN_NAME\", \"TRADEMARK\"]","type":"string"},"CASE_NAME":{"description":"The name of the Binder, about 4% of our Binders have a case name.\n\nFlat name: CASE_NAME\nHierarchical name: BINDER.CASE_NAME","example":"EX PARTE SAGHEER AHMAD","type":"string"},"CASE_RESOLUTION":{"description":"The outcome of the case according to the information collected. Possible values are: claimant wins, defendant wins, split win, settled, withdrawn or unknown (null value).\n\nFlat name: CASE_RESOLUTION\nHierarchical name: BINDER.CASE_RESOLUTION","example":"SETTLED","type":"string"},"CASE_STAGE":{"description":"The current stage of the case according to the information collected\n\nFlat name: CASE_STAGE\nHierarchical name: BINDER.CASE_STAGE","example":"HEARING","type":"string"},"CASE_STATUS":{"description":"The current status of an IP Case. Possible values are open, closed or inactive.\n\nFlat name: CASE_STATUS\nHierarchical name: BINDER.CASE_STATUS","example":"CLOSED","type":"string"},"CLAIM_CONSTRUCTION_AGREED":{"description":"Whether both the plaintiff(s) and defendant(s) agreed with the definition put forward by the judge.\n\nFlat name: CLAIM_CONSTRUCTION_AGREED\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.AGREED","example":false,"type":"boolean"},"CLAIM_CONSTRUCTION_DEFINITION":{"description":"The definition that was given for the term in this decision.\n\nFlat name: CLAIM_CONSTRUCTION_DEFINITION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.DEFINITION","example":"NICHT GLEICHZEITIG","type":"string"},"CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION":{"description":"Whether the term was considered as describing a function the technology performs, rather than the structure of the technology.(US Only)\n\nFlat name: CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.MEANS_PLUS_FUNCTION","example":"NOT_DISCUSSED","type":"string"},"CLAIM_CONSTRUCTION_NOT_NECESSARY":{"description":"Whether the judge deemed a definition of the term to unnecessary for a variety of reasons.\n\nFlat name: CLAIM_CONSTRUCTION_NOT_NECESSARY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.NOT_NECESSARY","example":false,"type":"boolean"},"CLAIM_CONSTRUCTION_TERM":{"description":"The term for which a definition or interpretation was given by the judge in this decision.\n\nFlat name: CLAIM_CONSTRUCTION_TERM\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.TERM","example":"ASYNCHROM","type":"string"},"CLOSED":{"description":"Whether the binder has been closed. (US Only)\n\nFlat name: CLOSED\nHierarchical name: BINDER.CLOSED","example":false,"type":"boolean"},"COPYRIGHT_ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: COPYRIGHT_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.ANONYMOUS","example":false,"type":"boolean"},"COPYRIGHT_DESCRIPTION":{"description":"A description of the copyright.\n\nFlat name: COPYRIGHT_DESCRIPTION\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.DESCRIPTION","example":"DESIGN PATTERN -","type":"string"},"COPYRIGHT_ROLE":{"description":"Whether the copyright belongs to the plaintiff or not.\n\nFlat name: COPYRIGHT_ROLE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.ROLE","example":"PLAINTIFF","type":"string"},"COPYRIGHT_TITLE":{"description":"The name of the copyright\n\nFlat name: COPYRIGHT_TITLE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.TITLE","example":"NEW RED","type":"string"},"COPYRIGHT_TYPE":{"description":"The type of copyright.\n\nFlat name: COPYRIGHT_TYPE\nHierarchical name: BINDER.RIGHTS.COPYRIGHTS.TYPE","example":"APPLIED_ART","type":"string"},"DAMAGE_AMOUNT":{"description":"The amount of damages that needs to be paid.\n\nFlat name: DAMAGE_AMOUNT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.AMOUNT","example":137240,"type":"number"},"DAMAGE_CALCULATION_METHOD":{"description":"How the damages have been calculated.\n\nFlat name: DAMAGE_CALCULATION_METHOD\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CALCULATION_METHOD","example":"LOSS_OF_PROFITS","type":"string"},"DAMAGE_CURRENCY":{"description":"A 3-character ISO currency code for the main currency of the damage.\n\nFlat name: DAMAGE_CURRENCY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENCY","example":"EUR","type":"string"},"DAMAGE_CURRENT_CNY_EQUIVALENT":{"description":"The amount converted to Chinese Yuan.\n\nFlat name: DAMAGE_CURRENT_CNY_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_CNY_EQUIVALENT","example":1454475,"type":"number"},"DAMAGE_CURRENT_EUR_EQUIVALENT":{"description":"The amount converted to Euro.\n\nFlat name: DAMAGE_CURRENT_EUR_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_EUR_EQUIVALENT","example":186335,"type":"number"},"DAMAGE_CURRENT_USD_EQUIVALENT":{"description":"The amount converted to US Dollars.\n\nFlat name: DAMAGE_CURRENT_USD_EQUIVALENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_USD_EQUIVALENT","example":224108,"type":"number"},"DAMAGE_LATER":{"description":"Indicates that damages have been assigned, but the amount has not been specified in this decision.\n\nFlat name: DAMAGE_LATER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.LATER","example":false,"type":"boolean"},"DAMAGE_NATURE":{"description":"The nature of the damages mentioned in the decision document.\n\nFlat name: DAMAGE_NATURE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.NATURE","example":"INFRINGEMENT","type":"string"},"DAMAGE_PARTIAL":{"description":"Indicates whether the damage amount is potentially incomplete and might be amended in a future decision.\n\nFlat name: DAMAGE_PARTIAL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.PARTIAL","example":false,"type":"boolean"},"DAMAGE_REQUESTED":{"description":"Indicates that the damage was requested by the plaintiff, but not necessarily granted.\n\nFlat name: DAMAGE_REQUESTED\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.REQUESTED","example":false,"type":"boolean"},"DESIGN_ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: DESIGN_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.DESIGNS.ANONYMOUS","example":false,"type":"boolean"},"DESIGN_LOCARNO_CLASS":{"description":"The Locarno classes associated with the design.\n\nFlat name: DESIGN_LOCARNO_CLASS\nHierarchical name: BINDER.RIGHTS.DESIGNS.LOCARNO_CLASSES","example":"3.01,21.02","type":"string"},"DESIGN_PRODUCT":{"description":"The type of product of the design.\n\nFlat name: DESIGN_PRODUCT\nHierarchical name: BINDER.RIGHTS.DESIGNS.PRODUCT","example":"GAMEBOARDS","type":"string"},"DESIGN_PRODUCT_LANGUAGE":{"description":"The language of the design right.\n\nFlat name: DESIGN_PRODUCT_LANGUAGE\nHierarchical name: BINDER.RIGHTS.DESIGNS.PRODUCT_LANGUAGE","example":"EN","type":"string"},"DESIGN_REGISTRATION_NUMBER":{"description":"The registration number with which this design is registered.\n\nFlat name: DESIGN_REGISTRATION_NUMBER\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_NUMBER","example":"000074463-0001","type":"string"},"DESIGN_REGISTRATION_OFFICE":{"description":"The IP Organization with which the design is registered.\n\nFlat name: DESIGN_REGISTRATION_OFFICE\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_OFFICE","example":"EM","type":"string"},"DESIGN_REGISTRATION_STATUS":{"description":"Whether the design is registered or not.\n\nFlat name: DESIGN_REGISTRATION_STATUS\nHierarchical name: BINDER.RIGHTS.DESIGNS.REGISTRATION_STATUS","example":false,"type":"boolean"},"DESIGN_ROLE":{"description":"Whether the design belongs to the plaintiff or not.\n\nFlat name: DESIGN_ROLE\nHierarchical name: BINDER.RIGHTS.DESIGNS.ROLE","example":"DEFENDANT","type":"string"},"DESIGN_VERBAL_ELEMENT":{"description":"The name of the design.\n\nFlat name: DESIGN_VERBAL_ELEMENT\nHierarchical name: BINDER.RIGHTS.DESIGNS.VERBAL_ELEMENT","example":"GAMES","type":"string"},"DESIGN_VIENNA_CLASS":{"description":"The Vienna classes associated with the design.\n\nFlat name: DESIGN_VIENNA_CLASS\nHierarchical name: BINDER.RIGHTS.DESIGNS.VIENNA_CLASSES","example":"27.05,27.05","type":"string"},"DOCKET_COURT_AREA":{"description":"The legal area this court is part of.\n\nFlat name: DOCKET_COURT_AREA\nHierarchical name: BINDER.DOCKETS.COURT.AREA","example":"EUROPE","type":"string"},"DOCKET_COURT_COUNTRY":{"description":"A two-character WIPO ST.3 code representing the country or the international organization the court is part of.\n\nFlat name: DOCKET_COURT_COUNTRY\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY","example":"RU","type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2":{"description":"A two-character code mapping from the court country code to the countries belonging to the court country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2","example":"AD","type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3":{"description":"A three-character code mapping from the court country code to the countries belonging to the court country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3","example":"AND","type":"string"},"DOCKET_COURT_COUNTRY_DERIVED_TEXT":{"description":"The country name mapping from the court country code to the countries belonging to the country code\n\nFlat name: DOCKET_COURT_COUNTRY_DERIVED_TEXT\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_TEXT","example":"ALBANIA","type":"string"},"DOCKET_COURT_COUNTRY_TEXT":{"description":"The country or the international organization the court is part of.\n\nFlat name: DOCKET_COURT_COUNTRY_TEXT\nHierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_TEXT","example":"AFRICAN INTELLECTUAL PROPERTY ORGANIZATION","type":"string"},"DOCKET_COURT_NAME":{"description":"The English name of the Court.\n\nFlat name: DOCKET_COURT_NAME\nHierarchical name: BINDER.DOCKETS.COURT.NAME","example":"FEDERAL SERVICE FOR IP - WIPO","type":"string"},"DOCKET_COURT_PATH":{"description":"Information about the Court in which this Docket was handled.\n\nFlat name: DOCKET_COURT_PATH\nHierarchical name: BINDER.DOCKETS.COURT.PATH","example":"COMMONW. OF INDEP. STATES/RUSSIAN FEDERATION/FEDERAL SERVICE FOR IP - WIPO","type":"string"},"DOCKET_COURT_TYPE_ADMINISTRATIVE":{"description":"Whether the type of the court is administrative.\n\nFlat name: DOCKET_COURT_TYPE_ADMINISTRATIVE\nHierarchical name: BINDER.DOCKETS.COURT.TYPES.COURT_TYPE_ADMINISTRATIVE","example":false,"type":"boolean"},"DOCKET_COURT_TYPE_ARBITRATION":{"description":"Whether the type of the court is arbitration.\n\nFlat name: DOCKET_COURT_TYPE_ARBITRATION\nHierarchical name: BINDER.DOCKETS.COURT.TYPES.COURT_TYPE_ARBITRATION","example":false,"type":"boolean"},"DOCKET_COURT_TYPE_JUDICIAL":{"description":"Whether the type of the court is judicial.\n\nFlat name: DOCKET_COURT_TYPE_JUDICIAL\nHierarchical name: BINDER.DOCKETS.COURT.TYPES.COURT_TYPE_JUDICAL","example":false,"type":"boolean"},"DOCKET_REFERENCE":{"description":"A Court-specific reference for this Docket.\n\nFlat name: DOCKET_REFERENCE\nHierarchical name: BINDER.DOCKETS.REFERENCE","example":"RU-WO-1559837","type":"string"},"DOCUMENT_CITABLE":{"description":"Whether the decision has a reporter citation.\n\nFlat name: DOCUMENT_CITABLE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CITABLE","example":false,"type":"boolean"},"DOCUMENT_CITATION_REFERENCE":{"description":"An unique internal reference in the format 'darts-000-000-A'.\n\nFlat name: DOCUMENT_CITATION_REFERENCE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.CITATION_REFERENCE","example":"\"DARTS-998-200-L\",","type":"string"},"DOCUMENT_DATE":{"description":"Judgment Date: The date of this Document.\nThis field is of type date but will be serialized to type string.\n\nFlat name: DOCUMENT_DATE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DOCUMENT_DATE","example":"2021-10-04","format":"date","type":"string"},"DOCUMENT_DECLARATORY":{"description":"Whether the decision addresses a motion for declaratory judgment(US Only).\n\nFlat name: DOCUMENT_DECLARATORY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DECLARATORY","example":false,"type":"boolean"},"DOCUMENT_DEFAULT_JUDGEMENT":{"description":"Whether the decision is granting a default judgment (US Only).\n\nFlat name: DOCUMENT_DEFAULT_JUDGEMENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DEFAULT_JUDGEMENT","example":false,"type":"boolean"},"DOCUMENT_LEVEL":{"description":"The level of the document. Possible values are first_instance, appeal, judicial_review and preliminary_ruling\n\nFlat name: DOCUMENT_LEVEL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.LEVEL","example":"FIRST_INSTANCE","type":"string"},"DOCUMENT_REFUSAL":{"description":"For Trademark cases. True for any first instance document issued by an IP office of type ADMINISTRATIVE_HEARING.\n\nFlat name: DOCUMENT_REFUSAL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.REFUSAL","example":false,"type":"boolean"},"DOCUMENT_STATE":{"description":"The current state of analysis of this decision.\n\nFlat name: DOCUMENT_STATE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.STATE","example":"UPLOADED","type":"string"},"DOCUMENT_SUBTYPE":{"description":"The sub-type of the document. Only applicable for PRELUDE and DECISIONS_AND_ORDERS. Possible values are on_the_merits, provisional, other_decisions, complaint, hearing, notice_of_appeal, preliminary_proceedings and verdict.\n\nFlat name: DOCUMENT_SUBTYPE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.SUBTYPE","example":"COMPLAINT","type":"string"},"DOCUMENT_TRADEMARK_REPUTATION":{"description":"Set when the domain is TRADEMARK and the document contains points of law that relate to trademark reputation.\n\nFlat name: DOCUMENT_TRADEMARK_REPUTATION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.TRADEMARK_REPUTATION","example":false,"type":"boolean"},"DOCUMENT_TYPE":{"description":"The type of the document. Possible values are: decisions_and_orders, prelude, process_procedure_information, settlement_information, briefs_and_memorandums, motions, evidence and conclusions_of_advocate_generale\n\nFlat name: DOCUMENT_TYPE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.DOCUMENT_TYPE","example":"DECISIONS_AND_ORDERS","type":"string"},"DOCUMENT_WINNER":{"description":"The set of Parties that has won the Legal Case at the time of this document.\n\nFlat name: DOCUMENT_WINNER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.WINNER","example":false,"type":"boolean"},"DOMAIN_IS_COPYRIGHT":{"description":"Copyright IP right at stake (a case might have more than one IP right)\n\nFlat name: DOMAIN_IS_COPYRIGHT\nHierarchical name: BINDER.DOMAIN_IS_COPYRIGHT","example":false,"type":"boolean"},"DOMAIN_IS_DESIGN_MODEL":{"description":"Design Model IP right at stake (a case might have more than one IP right)\n\nFlat name: DOMAIN_IS_DESIGN_MODEL\nHierarchical name: BINDER.DOMAIN_IS_DESIGN_MODEL","example":false,"type":"boolean"},"DOMAIN_IS_DOMAIN_NAME":{"description":"Domain name IP right at stake (a case might have more than one IP right)\n\nFlat name: DOMAIN_IS_DOMAIN_NAME\nHierarchical name: BINDER.DOMAIN_IS_DOMAIN_NAME","example":false,"type":"boolean"},"DOMAIN_IS_OTHER":{"description":"Other name IP right at stake (a case might have more than one IP right)\n\nFlat name: DOMAIN_IS_OTHER\nHierarchical name: BINDER.DOMAIN_IS_OTHER","example":false,"type":"boolean"},"DOMAIN_IS_PATENT":{"description":"Patent IP right at stake (a case might have more than one IP right)\n\nFlat name: DOMAIN_IS_PATENT\nHierarchical name: BINDER.DOMAIN_IS_PATENT","example":false,"type":"boolean"},"DOMAIN_IS_TRADEMARK":{"description":"Trademark IP right at stake (a case might have more than one IP right)\n\nFlat name: DOMAIN_IS_TRADEMARK\nHierarchical name: BINDER.DOMAIN_IS_TRADEMARK","example":false,"type":"boolean"},"DOMAIN_IS_UNFAIR_COMPETITION":{"description":"Unfair Competition IP right at stake (a case might have more than one IP right)\n\nFlat name: DOMAIN_IS_UNFAIR_COMPETITION\nHierarchical name: BINDER.DOMAIN_IS_UNFAIR_COMPETITION","example":false,"type":"boolean"},"DOMAIN_NAME":{"description":"The name of the domain.\n\nFlat name: DOMAIN_NAME\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.DOMAIN_NAME","example":"TRADEMARK","type":"string"},"DOMAIN_NAME_ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: DOMAIN_NAME_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.ANONYMOUS","example":false,"type":"boolean"},"DOMAIN_NAME_ROLE":{"description":"Whether the domain name belongs to the plaintiff or not.\n\nFlat name: DOMAIN_NAME_ROLE\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.ROLE","example":"DEFENDANT","type":"string"},"DOMAIN_NAME_TLD":{"description":"The top-level domain.\n\nFlat name: DOMAIN_NAME_TLD\nHierarchical name: BINDER.RIGHTS.DOMAIN_NAMES.TLD","example":".BIZ","type":"string"},"EARLIEST_EVENT_DATE":{"description":"The filing date of the case or the earliest document date in case the filing cannot be identified.\nThis field is of type date but will be serialized to type string.\n\nFlat name: EARLIEST_EVENT_DATE\nHierarchical name: BINDER.EARLIEST_EVENT_DATE","example":"2021-04-24","format":"date","type":"string"},"EU_TRADEMARK":{"description":"Whether the first action of this binder is an action wherein a national court acts as a supranational court, on a community right, based on community law in an infringement action.\n\nFlat name: EU_TRADEMARK\nHierarchical name: BINDER.EU_TRADEMARK","example":false,"type":"boolean"},"EX_OFFICIO":{"description":"Whether an IP office is acting on behalf of any of the Parties in this Legal Case.\n\nFlat name: EX_OFFICIO\nHierarchical name: BINDER.EX_OFFICIO","example":false,"type":"boolean"},"FIRST_ACTION_DATE":{"description":"Filing date of the first action in a case. Can be null if no date is available.\nThis field is of type date but will be serialized to type string.\n\nFlat name: FIRST_ACTION_DATE\nHierarchical name: BINDER.FIRST_ACTION_DATE","example":"2012-04-24","format":"date","type":"string"},"FIRST_ACTION_TYPE":{"description":"Type of the first action.\n\nFlat name: FIRST_ACTION_TYPE\nHierarchical name: BINDER.FIRST_ACTION_TYPE","example":"ADMINISTRATIVE_HEARINGS","type":"string"},"GUID":{"description":"Unique IP case identifier\n\nFlat name: GUID\nHierarchical name: GUID","example":"2706413","type":"string"},"IPC_CLASS_CODE":{"description":"The patent classification code.\n\nFlat name: IPC_CLASS_CODE\nHierarchical name: BINDER.RIGHTS.PATENTS.IPC_CLASSES","example":"A23","type":"string"},"IPC_CLASS_INDUSTRY_AREA":{"description":"The larger area of industry that this IPC classification corresponds to\n\nFlat name: IPC_CLASS_INDUSTRY_AREA\nHierarchical name: BINDER.RIGHTS.PATENTS.IPC_CLASSES.INDUSTRY_AREA","example":"CHEMISTRY","type":"string"},"IPC_CLASS_INDUSTRY_FIELD":{"description":"The actual industry that this IPC classification corresponds to\n\nFlat name: IPC_CLASS_INDUSTRY_FIELD\nHierarchical name: BINDER.RIGHTS.PATENTS.IPC_CLASSES.INDUSTRY_FIELD","example":"ANALYSIS_OF_BIOLOGICAL_MATERIALS","type":"string"},"LAST_EVENT_DATE":{"description":"The date of the last recorded document in the case\nThis field is of type date but will be serialized to type string.\n\nFlat name: LAST_EVENT_DATE\nHierarchical name: BINDER.LAST_EVENT_DATE","example":"2021-04-24","format":"date","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database.\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: BINDER.LAST_UPDATED_DATE","example":"2022-05-05","format":"date","type":"string"},"NUMBER_DEFENDANTS":{"description":"The number of defendant parties involved in the case.\n\nFlat name: NUMBER_DEFENDANTS\nHierarchical name: BINDER.NUMBER_DEFENDANTS","example":1,"type":"number"},"NUMBER_PLAINTIFFS":{"description":"The number of plaintiff parties involved in the case. (excluding ex-officio parties)\n\nFlat name: NUMBER_PLAINTIFFS\nHierarchical name: BINDER.NUMBER_PLAINTIFFS","example":1,"type":"number"},"NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO":{"description":"The number of plaintiff parties, including ex-officio parties, involved in the case. A party is ex-officio when the IP office is acting on behalf of the party in this Legal Case.\n\nFlat name: NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO\nHierarchical name: BINDER.NUMBER_PLAINTIFFS_INCLUDE_EX_OFFICIO","example":1,"type":"number"},"PARTY_ALTERNATIVE_ULTIMATE_PARENT":{"description":"Alternative group name that this party is part of.\n\nFlat name: PARTY_ALTERNATIVE_ULTIMATE_PARENT\nHierarchical name: BINDER.PARTIES.ALTERNATIVE_ULTIMATE_PARENT","example":"L'Oreal","type":"string"},"PARTY_COUNTRY":{"description":"The ISO country code for the country of registration of this party (ISO 3166-1 alpha-2).\n\nFlat name: PARTY_COUNTRY\nHierarchical name: BINDER.PARTIES.COUNTRY","example":"PL","type":"string"},"PARTY_DEFENDANT_NAME":{"description":"The defendant party name of an IP Case.\n\nFlat name: PARTY_DEFENDANT_NAME\nHierarchical name: BINDER.PARTIES_DEFENDANT.NAME","example":"BEIJING JINGDONG 360 DEGREE E-COMMERCE","type":"string"},"PARTY_DEFENDANT_ULTIMATE_PARENT":{"description":"A group name that this defendant party is part of. If no group name, the party name.\n\nFlat name: PARTY_DEFENDANT_ULTIMATE_PARENT\nHierarchical name: BINDER.PARTIES_DEFENDANT.ULTIMATE_PARENT","example":"JD.COM","type":"string"},"PARTY_IS_ANONYMOUS":{"description":"Whether the party is anonymous or not.\n\nFlat name: PARTY_IS_ANONYMOUS\nHierarchical name: BINDER.PARTIES.ANONYMOUS","example":false,"type":"boolean"},"PARTY_IS_EX_OFFICIO":{"description":"For proceedings initiated by the IP Office, where a prior right is cited by the Office and where the plaintiff is not the one filing the action but just the owner of the cited right.\n\nFlat name: PARTY_IS_EX_OFFICIO\nHierarchical name: BINDER.PARTIES.EX_OFFICIO","example":false,"type":"boolean"},"PARTY_LEGAL_FORM":{"description":"The legal form of the party\n\nFlat name: PARTY_LEGAL_FORM\nHierarchical name: BINDER.PARTIES.LEGAL_FORM","example":"LTD.","type":"string"},"PARTY_OPTIMIZED_NAME":{"description":"The party name, filled from one of the scripts based on following order: LATIN -> CHINESE -> TRADITIONAL_CHINESE -> JAPANESE -> KOREAN -> CYRILLIC -> THAI -> HEBREW -> GREEK ->ARABIC\n\nFlat name: PARTY_OPTIMIZED_NAME\nHierarchical name: BINDER.PARTIES.OPTIMIZED_NAME","example":"CAMELOT UK BIDCO","type":"string"},"PARTY_OPTIMIZED_NAMES":{"description":"Returns multiple party optimized names","example":"[\"AA\", \"A.B\"]","type":"string"},"PARTY_PLAINTIFF_NAME":{"description":"The plaintiff party name of an IP Case (excluding ex-officio parties).\n\nFlat name: PARTY_PLAINTIFF_NAME\nHierarchical name: BINDER.PARTIES_PLAINTIFF.NAME","example":"BEIJING LONGHUI BREWERY","type":"string"},"PARTY_PLAINTIFF_ULTIMATE_PARENT":{"description":"A group name that this plaintiff party is part of. If no group name, the party name (excluding ex-officio parties).\n\nFlat name: PARTY_PLAINTIFF_ULTIMATE_PARENT\nHierarchical name: BINDER.PARTIES_PLAINTIFF.ULTIMATE_PARENT","example":"BEIJING LONGHUI BREWERY","type":"string"},"PARTY_ROLE":{"description":"Role of the party within the context of the legal case, possible values are PLAINTIFF and DEFENDANT. Plaintiff, is the party that initiates the legal action. Defendant is the party that is targeted by the action. Opponent is the same as plaintiff.\n\nFlat name: PARTY_ROLE\nHierarchical name: BINDER.PARTIES.ROLE","example":"DEFENDANT","type":"string"},"PARTY_TYPE":{"description":"The type of entity this party represents, possible values are: AUTHORITY, COMPANY, NPE, PERSON or UNIVERSITY\n\nFlat name: PARTY_TYPE\nHierarchical name: BINDER.PARTIES.TYPE","example":"COMPANY","type":"string"},"PARTY_ULTIMATE_PARENT":{"description":"A group name that this party is part of.\n\nFlat name: PARTY_ULTIMATE_PARENT\nHierarchical name: BINDER.PARTIES.ULTIMATE_PARENT","example":"CLARIVATE","type":"string"},"PATENT_ANONYMOUS":{"description":"Whether the patent right is anonymous or not.\n\nFlat name: PATENT_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.PATENTS.ANONYMOUS","example":false,"type":"boolean"},"PATENT_APPLICATION_ID":{"description":"Only applicable for Patstat inventions. The identifier with which the invention's application is known in Patstat.\n\nFlat name: PATENT_APPLICATION_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.APPLICATION_ID","example":"\"49084922\",","type":"string"},"PATENT_APPLICATION_NUMBER":{"description":"The application number of the invention.\n\nFlat name: PATENT_APPLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.APPLICATION_NUMBER","example":"FR9103887(A)","type":"string"},"PATENT_ASSERTIONS":{"description":"Set when the domain is PATENT and the first action is one of: INFRINGEMENT, DECLARATORY, CRIMINAL_ACTION or TRIAL_FOR_SCOPE\n\nFlat name: PATENT_ASSERTIONS\nHierarchical name: BINDER.PATENT_ASSERTIONS","example":false,"type":"boolean"},"PATENT_DAMAGES_ASSIGNED":{"description":"Set when the domain is PATENT and damages higher than 0 have been assigned by the judge that are of one of the following types: INFRINGEMENT, BREACH_OF_CONTRACT, PUNITIVE, UNFAIR_COMPETITION\n\nFlat name: PATENT_DAMAGES_ASSIGNED\nHierarchical name: BINDER.PATENT_DAMAGES_ASSIGNED","example":false,"type":"boolean"},"PATENT_DOCDB_FAMILY_ID":{"description":"Applies mostly to Patstat inventions and is in limited cases available for Darts inventions, the DocDB Family Id of the invention.\n\nFlat name: PATENT_DOCDB_FAMILY_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.SIMPLE_FAMILY_ID","example":"32303805","type":"string"},"PATENT_DWPI_APPLICATION_NUMBER":{"description":"Unique identifier that represents the Derwent application number.\n\nFlat name: PATENT_DWPI_APPLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.DWPI_APPLICATION_NUMBER","example":"FR19913887A","type":"string"},"PATENT_INDEX":{"description":"An index relative to this right. This is used in order to be able to link right assessments to a right.\n\nFlat name: PATENT_INDEX\nHierarchical name: BINDER.RIGHTS.PATENTS.INDEX","example":1,"type":"number"},"PATENT_INFRINGEMENT":{"description":"Whether according to the latest ON_THE_MERITS or OTHER_DECISIONS, the patent was seen as valid\n\nFlat name: PATENT_INFRINGEMENT\nHierarchical name: BINDER.RIGHTS.PATENTS.INFRINGEMENT","example":"YES","type":"string"},"PATENT_INPADOC_FAMILY_ID":{"description":"Applies mostly to Patstat inventions and is in limited cases available for Darts inventions, the Inpadoc Family Id of the invention.\n\nFlat name: PATENT_INPADOC_FAMILY_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.EXTENDED_FAMILY_ID","example":"1464080","type":"string"},"PATENT_INVENTION_ID":{"description":"Unique identifier that represents the invention.\n\nFlat name: PATENT_INVENTION_ID\nHierarchical name: BINDER.RIGHTS.PATENTS.INVENTION_ID","example":25448433,"type":"number"},"PATENT_OPTIMIZED_TITLE":{"description":"The title of the invention.\n\nFlat name: PATENT_OPTIMIZED_TITLE\nHierarchical name: BINDER.RIGHTS.PATENTS.OPTIMIZED_TITLE","example":"DISPOSITIF APPLICATEUR POUR RECIPIENT CONTENANT UN PRODUIT LIQUIDE OU FLUIDE A OUVERTURE ET FERMETURE AUTOMATIQUE DE DEBIT.","type":"string"},"PATENT_PUBLICATION_NUMBER":{"description":"The publication number as it is mentioned in the decisions of this Binder.\n\nFlat name: PATENT_PUBLICATION_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.PUBLICATION_NUMBER","example":"FR2674453(A1)","type":"string"},"PATENT_REFERENCE_AUTHORITY":{"description":"The two-character IP authority with which the application/publication reference is registered.\n\nFlat name: PATENT_REFERENCE_AUTHORITY\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.AUTHORITY","example":"FR","type":"string"},"PATENT_REFERENCE_KIND":{"description":"The kind code for the application or publication reference.\n\nFlat name: PATENT_REFERENCE_KIND\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.KIND","example":"A","type":"string"},"PATENT_REFERENCE_NUMBER":{"description":"The reference assigned to the application or publication. If original is true, this reference is in the format of the IP office, otherwise it is in the Patstat or EPO format.\n\nFlat name: PATENT_REFERENCE_NUMBER\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.NUMBER","example":"7709CHENP2014","type":"string"},"PATENT_REFERENCE_ORIGINAL":{"description":"Whether the reference is in the format with which it was registered with the IP office, or it is in the normalized format defined by Patstat.\n\nFlat name: PATENT_REFERENCE_ORIGINAL\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.ORIGINAL","example":false,"type":"boolean"},"PATENT_REFERENCE_TYPE":{"description":"Whether the reference is an application or publication reference.\n\nFlat name: PATENT_REFERENCE_TYPE\nHierarchical name: BINDER.RIGHTS.PATENTS.REFERENCES.TYPE","example":"APPLICATION","type":"string"},"PATENT_ROLE":{"description":"Whether the patent belongs to the plaintiff or not.\n\nFlat name: PATENT_ROLE\nHierarchical name: BINDER.RIGHTS.PATENTS.ROLE","example":"DEFENDANT","type":"string"},"PATENT_SOURCE":{"description":"Whether the information was imported from the Patstat database or was manually encoded in Darts.\n\nFlat name: PATENT_SOURCE\nHierarchical name: BINDER.RIGHTS.PATENTS.SOURCE","example":"PATSTAT","type":"string"},"PATENT_TITLE":{"description":"The actual title of the invention.\n\nFlat name: PATENT_TITLE\nHierarchical name: BINDER.RIGHTS.PATENTS.TITLES.TITLE","example":"DISPOSITIF APPLICATEUR POUR RECIPIENT CONTENANT UN PRODUIT LIQUIDE OU FLUIDE A OUVERTURE ET FERMETURE AUTOMATIQUE DE DEBIT.","type":"string"},"PATENT_TITLE_LANGUAGE":{"description":"The language of the invention title.\n\nFlat name: PATENT_TITLE_LANGUAGE\nHierarchical name: BINDER.RIGHTS.PATENTS.TITLES.LANGUAGE","example":"FR","type":"string"},"PATENT_TYPE":{"description":"The type of the patent.\n\nFlat name: PATENT_TYPE\nHierarchical name: BINDER.RIGHTS.PATENTS.NATURE","example":"INVENTION_PATENT","type":"string"},"PATENT_VALIDITY":{"description":"Whether according to the latest ON_THE_MERITS decision in this case the patent was seen as infringed\n\nFlat name: PATENT_VALIDITY\nHierarchical name: BINDER.RIGHTS.PATENTS.VALIDITY","example":"VALID","type":"string"},"PATENT_VALIDITY_CHALLENGES":{"description":"Set when the domain is PATENT and the first action is one of: OPPOSITION, INTER_PARTIES_REVIEW_PETITION, PTO_REEXAMINATION, EX_PARTE_REEXAMINATION_PETITION, PETITION_UNDER_TRANSITIONAL_PROGRAM, INVALIDITY_CANCELLATION, INTERFERENCE\n\nFlat name: PATENT_VALIDITY_CHALLENGES\nHierarchical name: BINDER.PATENT_VALIDITY_CHALLENGES","example":false,"type":"boolean"},"POINT_OF_LAW_CONFIDENCE_LEVEL":{"description":"Whether the point of law was suggested by AI or was manually encoded.\n\nFlat name: POINT_OF_LAW_CONFIDENCE_LEVEL\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.CONFIDENCE_LEVEL","example":"CONFIDENT","type":"string"},"POINT_OF_LAW_NAME":{"description":"The name of this Point of Law.\n\nFlat name: POINT_OF_LAW_NAME\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.NAME","example":"BETWEEN GOODS IN DIFFERENT CLASSES","type":"string"},"POINT_OF_LAW_OUTCOME":{"description":"The outcome either positive, negative or both for this Point of Law.\n\nFlat name: POINT_OF_LAW_OUTCOME\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.OUTCOME","example":"NEGATIVE","type":"string"},"POINT_OF_LAW_OUTCOME_NEGATIVE":{"description":"The name of the negative outcome (if applicable).\n\nFlat name: POINT_OF_LAW_OUTCOME_NEGATIVE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.NEGATIVE","example":"DIFFERENT","type":"string"},"POINT_OF_LAW_OUTCOME_POSITIVE":{"description":"The name of the positive outcome (if applicable).\n\nFlat name: POINT_OF_LAW_OUTCOME_POSITIVE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.POSITIVE","example":"DIFFERENT","type":"string"},"POINT_OF_LAW_PARENT_PATH":{"description":"The parent of this Point of Law in the Point of Law tree.\n\nFlat name: POINT_OF_LAW_PARENT_PATH\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PARENT_PATH","example":"CONFLICT BETWEEN TRADE MARKS/LIKELIHOOD OF CONFUSION (IDENTICAL/SIMILAR TRADE MARKS FOR IDENTICAL/SIMILAR GOODS OR SERVICES)/SIMILARITY BETWEEN THE GOODS/SERVICES/BETWEEN GOODS IN DIFFERENT CLASSES","type":"string"},"POINT_OF_LAW_PREFIX":{"description":"The parent of this Point of Law in the Point of Law tree.\n\nFlat name: POINT_OF_LAW_PREFIX\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PREFIX","example":"EUR-06.2.2.4","type":"string"},"PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION":{"description":"Description of the first product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.DESCRIPTION","example":"DEBIT CARD SERVICES; PROCESSING OF PAYMENTS IN RELATION TO CHARGE CARDS; PROCESSING PAYMENTS MADE BY CHARGE CARDS; CHEQUE GUARANTEE CARD PROCESSING; ISSUING OF CREDIT AND DEBIT CARDS; FINANCIAL TRANSACTIONS; ELECTRONIC FUNDS TRANSFER; PAYMENT SETTLEMENT, BANKING OPERATIONS; BANKS (BANKING); BANKING; FINANCIAL CONSULTANCY; CREDIT CONSULTANCY; BUDGET ACCOUNT SERVICES; BANK ACCOUNT AND SAVINGS ACCOUNT SERVICES; FINANCIAL SERVICES IN THE FIELD OF BANK CARDS; BANK ACCOUNT INFORMATION SERVICES; PROVIDING OF BANKING SERVICES; MONEY TRANSFER SERVICES BY ELECTRONIC MEANS; ELECTRONIC FUND TRANSFER FOR OTHERS; PROVIDING MULTIPLE PAYMENT OPTIONS BY MEANS OF CUSTOMER-OPERATED ELECTRONIC TERMINALS AVAILABLE ON-SITE IN RETAIL STORES","type":"string"},"PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS":{"description":"The Nice Classes of the first product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.NICE_CLASSES","example":"36.\",\"36.13\",\"36.41","type":"string"},"PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION":{"description":"Description of the second product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_B_DESCRIPTION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_B.DESCRIPTION","example":"FARE CARD FOR ACCESSING FARE COLLECTION EQUIPMENT FOR MASS TRANSPORTATION","type":"string"},"PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS":{"description":"The Nice Classes of the second product.\n\nFlat name: PRODUCT_COMPARISON_PRODUCT_B_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_B.NICE_CLASSES","example":"\"41.H2.\",\"35.2\",\"25.45\",","type":"string"},"PRODUCT_COMPARISON_SIMILAR":{"description":"Whether both products being compared where deemed similar or not by the judge.\n\nFlat name: PRODUCT_COMPARISON_SIMILAR\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.SIMILAR","example":false,"type":"boolean"},"RELATION_RATING":{"description":"Describes to what length the current decision follows the reasoning presented in the target decision.\n\nFlat name: RELATION_RATING\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.RATING","example":"UPHELD","type":"string"},"RELATION_RELATION":{"description":"The type of relation. The current decision either follows up on another decision or refers to another decision.\n\nFlat name: RELATION_RELATION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.RELATION","example":"INSTANCE_FOLLOWS","type":"string"},"RELATION_TARGET_DECISION":{"description":"The citation reference of the decision that the current decision relates to (e.g. darts-000-000-A).\n\nFlat name: RELATION_TARGET_DECISION\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.TARGET_DECISION","example":"DARTS-404-771-D","type":"string"},"RELATION_TARGET_REFERENCE":{"description":"The reference/description of the decision that the current decision relates to.\n\nFlat name: RELATION_TARGET_REFERENCE\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELATIONS.TARGET_REFERENCE","example":"FR-2004038828_20070323","type":"string"},"RELEVANT_PUBLIC_AVERAGE_CONSUMER":{"description":"Whether average consumer attention was considered in the decision when discussing the relevant public.\n\nFlat name: RELEVANT_PUBLIC_AVERAGE_CONSUMER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.AVERAGE_CONSUMER","example":true,"type":"boolean"},"RELEVANT_PUBLIC_AWARENESS":{"description":"The level of awareness that the consumer has of the product.\n\nFlat name: RELEVANT_PUBLIC_AWARENESS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.AWARENESS","example":"AWARE","type":"string"},"RELEVANT_PUBLIC_NICE_CLASS":{"description":"The Nice Classes of the product being discussed.\n\nFlat name: RELEVANT_PUBLIC_NICE_CLASS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.NICE_CLASSES","example":"18\",\"14\",\"34","type":"string"},"RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER":{"description":"Whether professional consumer attention was considered in the decision when discussing the relevant public\n\nFlat name: RELEVANT_PUBLIC_PROFESSIONAL_CONSUMER\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RELEVANT_PUBLIC.PROFESSIONAL_CONSUMER","example":true,"type":"boolean"},"REMEDY":{"description":"Any remedies granted during the case such as preliminary or permanent injunctions.\n\nFlat name: REMEDY\nHierarchical name: BINDER.REMEDY","example":"PRELIMINARY INJUNCTION TO STOP INFRINGEMENT\", \"PERMANENT INJUNCTION TO STOP INFRINGEMENT\", \"SEIZURE OF INFRINGING GOODS\",\" DELIVERY UP OF GOODS\", \"WITHDRAWAL OF GOODS FROM THE MARKET\", \"DESTRUCTION OF GOODS","type":"string"},"REPRESENTATIVE_COUNTRY":{"description":"The ISO country code for the country of registration of the representative.\n\nFlat name: REPRESENTATIVE_COUNTRY\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.COUNTRY","example":"IT","type":"string"},"REPRESENTATIVE_LEGAL_FORM":{"description":"The legal form of the representative.\n\nFlat name: REPRESENTATIVE_LEGAL_FORM\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.LEGAL_FORM","example":"S.R.L.","type":"string"},"REPRESENTATIVE_OPTIMIZED_NAME":{"description":"The representative name, filled from one of the scripts based on following order: LATIN -> CHINESE -> TRADITIONAL_CHINESE -> JAPANESE -> KOREAN -> CYRILLIC -> THAI -> HEBREW -> GREEK ->ARABIC\n\nFlat name: REPRESENTATIVE_OPTIMIZED_NAME\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.OPTIMIZED_NAME","example":"\"L. POPOLO\",","type":"string"},"REPRESENTATIVE_TYPE":{"description":"The type of entity this representative represents, possible values are: AUTHORITY, COMPANY, NPE, PERSON or UNIVERSITY\n\nFlat name: REPRESENTATIVE_TYPE\nHierarchical name: BINDER.PARTIES.REPRESENTATIVES.TYPE","example":"PERSON","type":"string"},"RIGHT_ASSESSMENT_AMENDED_CLAIMS":{"description":"Whether amendments to the patent claims were made in this decision.\n\nFlat name: RIGHT_ASSESSMENT_AMENDED_CLAIMS\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.AMENDED_CLAIMS","example":false,"type":"boolean"},"RIGHT_ASSESSMENT_INFRINGEMENT":{"description":"Indicates whether infringement of the patent was discussed in this decision and, if so, whether the patent was considered to be infringed or not.\n\nFlat name: RIGHT_ASSESSMENT_INFRINGEMENT\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.INFRINGEMENT","example":"INFRINGED","type":"string"},"RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX":{"description":"An index identifying to which patent right in this legal case the right assessment relates.\n\nFlat name: RIGHT_ASSESSMENT_RIGHT_ASSESSMENT_INDEX\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.RIGHT_ASSESSMENT_INDEX","example":1,"type":"number"},"RIGHT_ASSESSMENT_VALIDITY":{"description":"Indicates whether validity of the patent was discussed in this decision and, if so, whether the patent claims were considered to be valid or not.\n\nFlat name: RIGHT_ASSESSMENT_VALIDITY\nHierarchical name: BINDER.DOCKETS.DOCUMENTS.RIGHT_ASSESSMENTS.VALIDITY","example":"UNDECIDED","type":"string"},"SETTLED":{"description":"Whether the parties in this binder made an agreement to settle (not only on the costs, but on the entire binder).\n\nFlat name: SETTLED\nHierarchical name: BINDER.SETTLED","example":false,"type":"boolean"},"TOTAL_DAMAGE_AMOUNT":{"description":"The total amount of damages that needs to be paid (for given type and currency).\n\nFlat name: TOTAL_DAMAGE_AMOUNT\nHierarchical name: BINDER.TOTAL_DAMAGES.AMOUNT","example":313770,"type":"number"},"TOTAL_DAMAGE_CURRENCY":{"description":"A 3-character ISO currency code for the main currency of the damage.\n\nFlat name: TOTAL_DAMAGE_CURRENCY\nHierarchical name: BINDER.TOTAL_DAMAGES.CURRENCY","example":"EUR","type":"string"},"TOTAL_DAMAGE_TYPE":{"description":"The type of damage: infringement, breach of contract, punitive or non-material.\n\nFlat name: TOTAL_DAMAGE_TYPE\nHierarchical name: BINDER.TOTAL_DAMAGES.TYPE","example":"INFRINGEMENT","type":"string"},"TRADEMARK_ANONYMOUS":{"description":"Whether the right is anonymous or not.\n\nFlat name: TRADEMARK_ANONYMOUS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.ANONYMOUS","example":false,"type":"boolean"},"TRADEMARK_ID":{"description":"The unique identifier used by CompuMark to identify this trademark.\n\nFlat name: TRADEMARK_ID\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.COMPUMARK_GUID","example":"CTMSI4398BAA8118911E19FC38AE717F0E620","type":"string"},"TRADEMARK_LOCARNO_CLASS":{"description":"The Locarno Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_LOCARNO_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.LOCARNO_CLASSES","example":"17.01,17.01","type":"string"},"TRADEMARK_NICE_CLASS":{"description":"The Nice Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_NICE_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.NICE_CLASSES","example":"14.11.\",\"14.H3.\", \"18.C2.\", \"25.146.\",  \"25.151.\",\"25.26.\",\"25.3.\",\"25.45.\",  \"34.3.\",  \"34.H2.\",\"42.C77.\",\"9.331.","type":"string"},"TRADEMARK_REGISTRATION_NUMBER":{"description":"The number with which the trademark is registered.\n\nFlat name: TRADEMARK_REGISTRATION_NUMBER\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.REGISTRATION_NUMBER","example":"01424922","type":"string"},"TRADEMARK_REGISTRATION_OFFICE":{"description":"The IP Organization with which the trademark is registered.\n\nFlat name: TRADEMARK_REGISTRATION_OFFICE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.REGISTRATION_OFFICE","example":"EU","type":"string"},"TRADEMARK_ROLE":{"description":"Whether the trademark belongs to the plaintiff or not.\n\nFlat name: TRADEMARK_ROLE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.ROLE","example":"DEFENDANT","type":"string"},"TRADEMARK_TYPE":{"description":"The type of trademark.\n\nFlat name: TRADEMARK_TYPE\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.TYPE","example":"VERBAL","type":"string"},"TRADEMARK_VERBAL_ELEMENT":{"description":"The name of the trademark.\n\nFlat name: TRADEMARK_VERBAL_ELEMENT\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.VERBAL_ELEMENT","example":"GOCARD","type":"string"},"TRADEMARK_VIENNA_CLASS":{"description":"The Vienna Classes for which the trademark was registered.\n\nFlat name: TRADEMARK_VIENNA_CLASS\nHierarchical name: BINDER.RIGHTS.TRADEMARKS.VIENNA_CLASSES","example":"27.05.C7\",\"27.05.01","type":"string"},"WITHDRAWN":{"description":"Whether the plaintiff or defendant has withdrawn from this binder.\n\nFlat name: WITHDRAWN\nHierarchical name: BINDER.WITHDRAWN","example":false,"type":"boolean"}},"type":"object"},"type":"array"},"total_count":{"description":"Total number of results","type":"number"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Search caselaw, analytic format","tags":["IP Cases"]}},"/ip/patents/derwent/document/images/{document_guid}":{"get":{"description":"Fetch a list of the images associated with this document, as URLs","operationId":"derwentGetDocumentImages","parameters":[{"description":"Unique document ID","in":"path","name":"document_guid","required":true,"schema":{"type":"string"}},{"default":380,"description":"Requested image size in pixels","in":"query","name":"size","schema":{"type":"integer"}},{"default":true,"description":"Return IP API wrapper URLs when true; return direct CLIPS URLs when false","in":"query","name":"wrap","schema":{"type":"boolean"}},{"default":"gif","description":"Image format requested from CLIPS","example":"gif","in":"query","name":"format","schema":{"type":"string"}},{"default":"normal","description":"Image type to retrieve. Supported values: normal, inline","example":"inline","in":"query","name":"type","schema":{"type":"string"}},{"default":0,"description":"Front-page image flag. Use 1 for front-page images.","example":1,"in":"query","name":"fponly","schema":{"type":"integer"}},{"description":"DWPI image mode. Use 0 for DWPI front page or 1 for all DWPI images.","example":1,"in":"query","name":"dwpi","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_url_list_derwent_api"}}},"description":"Success"},"400":{"content":{"application/json":{"examples":{"invalidImageType":{"summary":"Invalid image type","value":{"code":2200,"error":"Invalid image type requested"}}},"schema":{"oneOf":[{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"},{"properties":{"error":{"description":"Error message","type":"string"}},"required":["error"],"type":"object"}]}}},"description":"Invalid image request. Relevant Derwent error codes include 2200 for invalid values."},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"insufficientEntitlements":{"summary":"Missing Derwent images entitlement","value":{"code":2400,"error":"Insufficient entitlements to access this resource"}}},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to retrieve images for patents using jwt authentication","tags":["Derwent API"]},"post":{"description":"Fetch Derwent image URLs for one or more patent IDs or publication numbers, including all-image and inline-image requests.","operationId":"derwentPostDocumentImages","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/derwent_images_request"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_url_list_derwent_api"}}},"description":"Success"},"400":{"content":{"application/json":{"examples":{"countOutOfRange":{"summary":"ids/pn count out of range","value":{"error":"ids/pn count must be between 1 and 500"}},"idsAndPn":{"summary":"Both ids and pn supplied","value":{"error":"Provide either ids or pn, not both"}},"idsLimitExceeded":{"summary":"IDs limit exceeded","value":{"code":2300,"error":"The number of IDs in the request must not exceed {limit}"}},"invalidImageType":{"summary":"Invalid image type","value":{"code":2200,"error":"Invalid image type requested"}},"invalidRequestBody":{"summary":"Request body is not a JSON object","value":{"error":"Request body must be a JSON object"}},"invalidSize":{"summary":"Invalid size parameter","value":{"error":"Invalid size parameter value"}},"missingIdsOrPn":{"summary":"ids or pn required","value":{"error":"Provide ids or pn"}},"missingParams":{"summary":"Missing params list","value":{"error":"Missing params list"}},"pnsLimitExceeded":{"summary":"PNs limit exceeded","value":{"code":2300,"error":"The number of PNs in the request must not exceed {limit}"}}},"schema":{"oneOf":[{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"},{"properties":{"error":{"description":"Error message","type":"string"}},"required":["error"],"type":"object"}]}}},"description":"Invalid image request. Relevant Derwent error codes include 2200 for invalid values and 2300 for request limits."},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"insufficientEntitlements":{"summary":"Missing Derwent images entitlement","value":{"code":2400,"error":"Insufficient entitlements to access this resource"}}},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to retrieve images for patents using jwt authentication using POST method","tags":["Derwent API"]}},"/patents/derwent/class-browse":{"post":{"description":"Request to provide a class lookup service that supports hierarchical classification code lists for a given classification code, e.g., ipc8","operationId":"derwentClassBrowse","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class_browsing_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"classificationresponse":{"properties":{"classdescription":{"items":{"properties":{"child_count":{"description":"Number of child classes","example":37,"type":"integer"},"classes":{"description":"Classification code","example":"A01B","type":"string"},"level":{"description":"Classification level","example":3,"type":"integer"},"value":{"description":"Description of the class","example":"SOIL WORKING IN AGRICULTURE OR FORESTRY; PARTS, DETAILS, OR ACCESSORIES OF AGRICULTURAL MACHINES OR IMPLEMENTS, IN GENERAL...","type":"string"}},"required":["classes","level","child_count","value"],"type":"object"},"type":"array"}},"type":"object"},"duration":{"description":"Duration of the operation","example":"17","type":"string"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to perform class browsing service to support the search of keyword terms to retrieve matching 'classification codes' ","tags":["Derwent API"]}},"/patents/derwent/class-search":{"post":{"description":"Request to provide the ability to perform class searching service to support the search of keyword terms to retrieve matching 'classification codes', e.g., ipc8","operationId":"derwentClassSearch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/class_search_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"classificationresponse":{"properties":{"classdescription":{"items":{"properties":{"child_count":{"description":"Number of child classes","example":0,"type":"integer"},"classes":{"description":"Classification code","example":"A61K003658","type":"string"},"level":{"description":"Classification level","example":0,"type":"integer"},"value":{"description":"Description of the class","example":"Meliaceae (Chinaberry or Mahogany family), e.g. Azadirachta (neem)","type":"string"}},"required":["classes","level","child_count","value"],"type":"object"},"type":"array"},"searched":{"description":"Number of items searched","example":0,"type":"integer"},"total":{"description":"Total number of results","example":2,"type":"integer"}},"type":"object"},"duration":{"description":"Duration of the operation","example":"17","type":"string"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to perform class searching service to support the search of keyword terms to retrieve matching 'classification codes' ","tags":["Derwent API"]}},"/patents/derwent/combined-search":{"post":{"description":"Request to provide the ability to search a combination of queries","operationId":"derwentCombinedSearch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/combined_search_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"body":{"items":{"properties":{"field":{"items":{"properties":{"form":{"description":"Field form","example":"orig","type":"string"},"name":{"description":"Field name","example":"pn","type":"string"},"value":{"description":"Field value","example":"USRE50627E1","type":"string"}},"required":["name","form","value"],"type":"object"},"type":"array"},"id":{"description":"Unique identifier for the record","example":"USRE50627E120251007","type":"string"},"rank":{"description":"Rank of the record","example":1,"type":"integer"}},"required":["id","rank","field"],"type":"object"},"type":"array"},"header":{"properties":{"duration":{"description":"Duration of the operation in milliseconds","example":"605","type":"string"},"found":{"description":"Number of items found","example":"28880,4731,216523,6601581","type":"string"},"searched":{"description":"Total number of items searched","example":177472411,"type":"integer"},"size":{"description":"Number of items returned in this response","example":30000,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to search with combination of queries","tags":["Derwent API"]}},"/patents/derwent/corporate-tree":{"post":{"description":"Request to look-up entities as either code or terms within corporate tree resulting in tree structure","operationId":"derwentCorporateTree","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/corporate_tree_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"corporateTreeResponse":{"properties":{"corporationDescription":{"items":{"properties":{"code":{"description":"Corporation code","example":"MICROSOFT","type":"string"},"docCount":{"description":"Document count","example":0,"type":"integer"},"level":{"description":"Hierarchy level","example":0,"type":"integer"},"spellings":{"properties":{"spelling":{"items":{"properties":{"mapid":{"description":"Spelling map ID","example":"9264041","type":"string"},"value":{"description":"Spelling value","example":"FSLOGIX INC","type":"string"}},"required":["mapid","value"],"type":"object"},"type":"array"}},"required":["spelling"],"type":"object"},"title":{"properties":{"value":{"description":"Corporation title","example":"Microsoft Corporation","type":"string"}},"required":["value"],"type":"object"}},"required":["code","level","docCount","title","spellings"],"type":"object"},"type":"array"}},"type":"object"},"duration":{"description":"Duration of the operation","example":"315","type":"string"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to lookup Entities within the corporate tree. ","tags":["Derwent API"]}},"/patents/derwent/document/images":{"post":{"description":"Fetch Derwent image URLs for one or more patent IDs or publication numbers, including all-image and inline-image requests.","operationId":"derwentPostDocumentImages","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/derwent_images_request"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_url_list_derwent_api"}}},"description":"Success"},"400":{"content":{"application/json":{"examples":{"countOutOfRange":{"summary":"ids/pn count out of range","value":{"error":"ids/pn count must be between 1 and 500"}},"idsAndPn":{"summary":"Both ids and pn supplied","value":{"error":"Provide either ids or pn, not both"}},"idsLimitExceeded":{"summary":"IDs limit exceeded","value":{"code":2300,"error":"The number of IDs in the request must not exceed {limit}"}},"invalidImageType":{"summary":"Invalid image type","value":{"code":2200,"error":"Invalid image type requested"}},"invalidRequestBody":{"summary":"Request body is not a JSON object","value":{"error":"Request body must be a JSON object"}},"invalidSize":{"summary":"Invalid size parameter","value":{"error":"Invalid size parameter value"}},"missingIdsOrPn":{"summary":"ids or pn required","value":{"error":"Provide ids or pn"}},"missingParams":{"summary":"Missing params list","value":{"error":"Missing params list"}},"pnsLimitExceeded":{"summary":"PNs limit exceeded","value":{"code":2300,"error":"The number of PNs in the request must not exceed {limit}"}}},"schema":{"oneOf":[{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"},{"properties":{"error":{"description":"Error message","type":"string"}},"required":["error"],"type":"object"}]}}},"description":"Invalid image request. Relevant Derwent error codes include 2200 for invalid values and 2300 for request limits."},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"insufficientEntitlements":{"summary":"Missing Derwent images entitlement","value":{"code":2400,"error":"Insufficient entitlements to access this resource"}}},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to retrieve images for patents","tags":["Derwent API"]}},"/patents/derwent/document/images/{document_guid}":{"get":{"description":"Fetch a list of the images associated with this document, as URLs","operationId":"derwentGetDocumentImages","parameters":[{"description":"Unique document ID","in":"path","name":"document_guid","required":true,"schema":{"type":"string"}},{"default":380,"description":"Requested image size in pixels","in":"query","name":"size","schema":{"type":"integer"}},{"default":true,"description":"Return IP API wrapper URLs when true; return direct CLIPS URLs when false","in":"query","name":"wrap","schema":{"type":"boolean"}},{"default":"gif","description":"Image format requested from CLIPS","example":"gif","in":"query","name":"format","schema":{"type":"string"}},{"default":"normal","description":"Image type to retrieve. Supported values: normal, inline","example":"inline","in":"query","name":"type","schema":{"type":"string"}},{"default":0,"description":"Front-page image flag. Use 1 for front-page images.","example":1,"in":"query","name":"fponly","schema":{"type":"integer"}},{"description":"DWPI image mode. Use 0 for DWPI front page or 1 for all DWPI images.","example":1,"in":"query","name":"dwpi","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_url_list_derwent_api"}}},"description":"Success"},"400":{"content":{"application/json":{"examples":{"invalidImageType":{"summary":"Invalid image type","value":{"code":2200,"error":"Invalid image type requested"}}},"schema":{"oneOf":[{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"},{"properties":{"error":{"description":"Error message","type":"string"}},"required":["error"],"type":"object"}]}}},"description":"Invalid image request. Relevant Derwent error codes include 2200 for invalid values."},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"insufficientEntitlements":{"summary":"Missing Derwent images entitlement","value":{"code":2400,"error":"Insufficient entitlements to access this resource"}}},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to retrieve images for patents","tags":["Derwent API"]}},"/patents/derwent/document/pdf":{"post":{"description":"Return PDF availability with direct DocDel URLs or wrapped URLs for one or more Derwent patents.","operationId":"derwentGetDocumentsPdf","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_pdf_request_derwent_api_post"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_pdf_response_derwent_api_post"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to retrieve PDF URLs for one or more Derwent patents.","tags":["Derwent API"]}},"/patents/derwent/document/pdf/{document_guid}":{"get":{"description":"Fetch a PDF of the document specified by document_guid.","operationId":"derwentGetDocumentPdf","parameters":[{"description":"Unique document ID","in":"path","name":"document_guid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to retrieve PDF files for Derwent patents","tags":["Derwent API"]}},"/patents/derwent/documents-IdMapping":{"post":{"description":"Request to provide the ability to generate list of Derwent format GUID(s)","operationId":"getPublicationIdMapping","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/doc_idmapping_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"body":{"items":{"properties":{"field":{"items":{"properties":{"form":{"description":"Field form (e.g., orig, docdb, dwpi)","example":"orig","type":"string"},"name":{"description":"Field name","example":"pn","type":"string"},"value":{"description":"Field value","example":"EP4451620A1","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"Document GUID","example":"EP4451620A120241023","type":"string"}},"type":"object"},"type":"array"},"header":{"properties":{"download_details":{"properties":{"available_this_month":{"example":199954,"type":"integer"},"available_this_year":{"example":999369,"type":"integer"},"available_today":{"example":59999,"type":"integer"},"downloaded_this_day":{"example":1,"type":"integer"},"downloaded_this_month":{"example":46,"type":"integer"},"downloaded_this_year":{"example":631,"type":"integer"},"export_per_call":{"example":100,"type":"integer"},"export_per_day":{"example":60000,"type":"integer"},"export_per_month":{"example":200000,"type":"integer"},"export_per_year":{"example":1000000,"type":"integer"}},"type":"object"},"duration":{"description":"Duration of the operation","example":"1","type":"string"},"found":{"description":"Number of items found","example":"1","type":"string"},"response_id":{"description":"Response identifier","example":"EP4451620A120241023","type":"string"},"size":{"description":"Size of the response","example":1,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent wrapper endpoint: ID mapping (proxies TSIP /id-mapping-proto).","tags":["Derwent API"]}},"/patents/derwent/documents-by-id":{"post":{"description":"Request to provide the ability to download Document(s) based on the Derwent document GUID(s)","operationId":"derwentDocumentsByIds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_by_ids_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"body":{"items":{"properties":{"field":{"items":{"properties":{"form":{"description":"Field form (e.g., orig, docdb, dwpi)","example":"orig","type":"string"},"name":{"description":"Field name","example":"pn","type":"string"},"value":{"description":"Field value","example":"EP4451620A1","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"Document GUID","example":"EP4451620A120241023","type":"string"}},"type":"object"},"type":"array"},"header":{"properties":{"download_details":{"properties":{"available_this_month":{"example":199954,"type":"integer"},"available_this_year":{"example":999369,"type":"integer"},"available_today":{"example":59999,"type":"integer"},"downloaded_this_day":{"example":1,"type":"integer"},"downloaded_this_month":{"example":46,"type":"integer"},"downloaded_this_year":{"example":631,"type":"integer"},"export_per_call":{"example":100,"type":"integer"},"export_per_day":{"example":60000,"type":"integer"},"export_per_month":{"example":200000,"type":"integer"},"export_per_year":{"example":1000000,"type":"integer"}},"type":"object"},"duration":{"description":"Duration of the operation","example":"1","type":"string"},"found":{"description":"Number of items found","example":"1","type":"string"},"response_id":{"description":"Response identifier","example":"EP4451620A120241023","type":"string"},"size":{"description":"Size of the response","example":1,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to download Document(s) based on document GUID(s)","tags":["Derwent API"]}},"/patents/derwent/documents-by-listref":{"post":{"description":"Request to provide the ability to download Derwent Document(s) fields for document GUID's stored in a LISTREF","operationId":"derwentDocumentsByListref","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_by_listref_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"body":{"items":{"properties":{"field":{"items":{"properties":{"form":{"description":"Field form","example":"orig","type":"string"},"name":{"description":"Field name","example":"pn","type":"string"},"value":{"description":"Field value","example":"USRE50627E1","type":"string"}},"required":["name","form","value"],"type":"object"},"type":"array"},"id":{"description":"Unique identifier for the record","example":"USRE50627E120251007","type":"string"},"rank":{"description":"Rank of the record","example":1,"type":"integer"}},"required":["id","rank","field"],"type":"object"},"type":"array"},"header":{"properties":{"duration":{"description":"Duration of the operation in milliseconds","example":"605","type":"string"},"found":{"description":"Number of items found","example":"21142652","type":"string"},"searched":{"description":"Total number of items searched","example":177472411,"type":"integer"},"size":{"description":"Number of items returned in this response","example":30000,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to download Document(s) fields based on a LISTREF","tags":["Derwent API"]}},"/patents/derwent/documents-by-pn":{"post":{"description":"Request to provide the ability to download Document(s) based on patent or publication number(s)","operationId":"derwentDocumentsByPns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_by_pns_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"body":{"items":{"properties":{"field":{"items":{"properties":{"form":{"description":"Field form (e.g., orig, docdb, dwpi)","example":"orig","type":"string"},"name":{"description":"Field name","example":"pn","type":"string"},"value":{"description":"Field value","example":"EP4451620A1","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"Document GUID","example":"EP4451620A120241023","type":"string"}},"type":"object"},"type":"array"},"header":{"properties":{"download_details":{"properties":{"available_this_month":{"example":199954,"type":"integer"},"available_this_year":{"example":999369,"type":"integer"},"available_today":{"example":59999,"type":"integer"},"downloaded_this_day":{"example":1,"type":"integer"},"downloaded_this_month":{"example":46,"type":"integer"},"downloaded_this_year":{"example":631,"type":"integer"},"export_per_call":{"example":100,"type":"integer"},"export_per_day":{"example":60000,"type":"integer"},"export_per_month":{"example":200000,"type":"integer"},"export_per_year":{"example":1000000,"type":"integer"}},"type":"object"},"duration":{"description":"Duration of the operation","example":"1","type":"string"},"found":{"description":"Number of items found","example":"1","type":"string"},"response_id":{"description":"Response identifier","example":"EP4451620A120241023","type":"string"},"size":{"description":"Size of the response","example":1,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to download Document(s) based on patent number(s)","tags":["Derwent API"]}},"/patents/derwent/search-by-ids":{"post":{"description":"Request to provide the ability to search by Derwent document GUIDs","operationId":"derwentSearchByIds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_by_ids_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"body":{"items":{"properties":{"field":{"items":{"properties":{"form":{"description":"Field form (e.g., orig, docdb, dwpi)","example":"orig","type":"string"},"name":{"description":"Field name","example":"pn","type":"string"},"value":{"description":"Field value","example":"EP4451620A1","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"Document GUID","example":"EP4451620A120241023","type":"string"}},"type":"object"},"type":"array"},"header":{"properties":{"download_details":{"properties":{"available_this_month":{"example":199954,"type":"integer"},"available_this_year":{"example":999369,"type":"integer"},"available_today":{"example":59999,"type":"integer"},"downloaded_this_day":{"example":1,"type":"integer"},"downloaded_this_month":{"example":46,"type":"integer"},"downloaded_this_year":{"example":631,"type":"integer"},"export_per_call":{"example":100,"type":"integer"},"export_per_day":{"example":60000,"type":"integer"},"export_per_month":{"example":200000,"type":"integer"},"export_per_year":{"example":1000000,"type":"integer"}},"type":"object"},"duration":{"description":"Duration of the operation","example":"1","type":"string"},"found":{"description":"Number of items found","example":"1","type":"string"},"response_id":{"description":"Response identifier","example":"EP4451620A120241023","type":"string"},"size":{"description":"Size of the response","example":1,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to search by Document GUIDs","tags":["Derwent API"]}},"/patents/derwent/search-by-pns":{"post":{"description":"Request to provide the ability to search by patent or publication numbers","operationId":"derwentSearchByPatentNumbers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_by_pns_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"body":{"items":{"properties":{"field":{"items":{"properties":{"form":{"description":"Field form (e.g., orig, docdb, dwpi)","example":"orig","type":"string"},"name":{"description":"Field name","example":"pn","type":"string"},"value":{"description":"Field value","example":"EP4451620A1","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"Document GUID","example":"EP4451620A120241023","type":"string"}},"type":"object"},"type":"array"},"header":{"properties":{"download_details":{"properties":{"available_this_month":{"example":199954,"type":"integer"},"available_this_year":{"example":999369,"type":"integer"},"available_today":{"example":59999,"type":"integer"},"downloaded_this_day":{"example":1,"type":"integer"},"downloaded_this_month":{"example":46,"type":"integer"},"downloaded_this_year":{"example":631,"type":"integer"},"export_per_call":{"example":100,"type":"integer"},"export_per_day":{"example":60000,"type":"integer"},"export_per_month":{"example":200000,"type":"integer"},"export_per_year":{"example":1000000,"type":"integer"}},"type":"object"},"duration":{"description":"Duration of the operation","example":"1","type":"string"},"found":{"description":"Number of items found","example":"1","type":"string"},"response_id":{"description":"Response identifier","example":"EP4451620A120241023","type":"string"},"size":{"description":"Size of the response","example":1,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to search by patent numbers","tags":["Derwent API"]}},"/patents/derwent/search-by-query":{"post":{"description":"Request to provide the ability to search by query","operationId":"derwentSearchByQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_by_query_request_derwent_api"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"body":{"items":{"properties":{"field":{"items":{"properties":{"form":{"description":"Field form","example":"orig","type":"string"},"name":{"description":"Field name","example":"pn","type":"string"},"value":{"description":"Field value","example":"USRE50627E1","type":"string"}},"required":["name","form","value"],"type":"object"},"type":"array"},"id":{"description":"Unique identifier for the record","example":"USRE50627E120251007","type":"string"},"rank":{"description":"Rank of the record","example":1,"type":"integer"}},"required":["id","rank","field"],"type":"object"},"type":"array"},"header":{"properties":{"duration":{"description":"Duration of the operation in milliseconds","example":"605","type":"string"},"found":{"description":"Number of items found","example":"21142652","type":"string"},"searched":{"description":"Total number of items searched","example":177472411,"type":"integer"},"size":{"description":"Number of items returned in this response","example":30000,"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Derwent API to provide the ability to search by query","tags":["Derwent API"]}},"/patents/document/abstract/availability":{"post":{"description":"Query the availability of abstract journals","operationId":"checkPatentAbstractAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_availability_request_patent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"available":[{"pn":"US3201444A","url":"https://docdelivery.derwentinnovation.com/get-file/00631877000165440003967700307006/US3201444(A).pdf"}],"unavailable":["JP51021981B"]},"properties":{"results":{"items":{"properties":{"available":{"description":"patent with PDFs","type":"string"},"unavailable":{"description":"patent do not have PDFs","type":"string"}},"required":["available","unavailable"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Check Abstract availability and get URLS for download","tags":["Patents"]}},"/patents/document/availability":{"post":{"description":"Query the availability of patents","operationId":"checkPatentDocumentAvailability","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document_availability_request_patent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"available":[{"pn":"US8326177B2","url":"https://docdelivery.derwentinnovation.com/get-file/00531747006127410038365200136292/US8326177(X601).pdf"}],"unavailable":["US99470720B2"]},"properties":{"results":{"items":{"properties":{"available":{"description":"patent with PDFs","type":"string"},"unavailable":{"description":"patent do not have PDFs","type":"string"}},"required":["available","unavailable"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Check Patent availability and get URLS for download","tags":["Patents"]}},"/patents/document/images/{document_guid}":{"get":{"description":"Fetch a list of the images associated with this document, as URLs","operationId":"getPatentImages","parameters":[{"description":"Unique document ID","in":"path","name":"document_guid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_url_list_patent"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"API to retrieve images for patents","tags":["Patents"]}},"/patents/document/json":{"post":{"description":"Call to fetch one or more full patent documents by GUID, with possibile filters.","operationId":"getPatentDocuments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/records_request_patent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Page of results","items":{"properties":{"APPLICATION_DATE":{"description":"The date (YYYY-MM-DD) an application was filed. This is not the same as the Publication Date, which is the date the application is finally published.\nThis field is of type date but will be serialized to type string.\n\nFlat name: APPLICATION_DATE\nHierarchical name: APPLICATION_DATE","example":"2012-11-21","format":"date","type":"string"},"APPLICATION_NUMBER":{"description":"A unique number assigned to an application when it is filed. This is not the same as the Publication Number, which is assigned when the application is published. For many authorities, the first four digits of the application number (following the country code) indicate the year the application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: APPLICATION_NUMBER\nHierarchical name: APPLICATION_NUMBER","example":"WO2012EP73219A","type":"string"},"APPLICATION_NUMBER_ORIGINAL":{"description":"\n\nFlat name: _APPLICATION_NUMBER_ORIGINAL\nHierarchical name: APPLICATION_NUMBER_ORIGINAL","type":"string"},"APPLICATION_REGISTRATION_OFFICE":{"description":"The country / region in which an application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: APPLICATION_REGISTRATION_OFFICE\nHierarchical name: APPLICATION_REGISTRATION_OFFICE","example":"EP","type":"string"},"ASSIGNEES_CURRENT_US":{"items":{"description":"Entity to which this patent is currently assigned (who owns the patent currently), based on US Reassignment data. For more information see [Assignee Current US](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#assignee-current_us)\n\nFlat name: ASSIGNEE_CURRENT_US\nHierarchical name: ASSIGNEES_CURRENT_US","example":"CONOPCO, INC., D/B/A UNILEVER","type":"string"},"type":"array"},"ASSIGNEES_ORIGINAL":{"items":{"description":"The legal person or entity who owned the patent property right at the time of grant. This may or may not be the inventor and is also known as the applicant by some authorities.\n\nFlat name: _ASSIGNEES_ORIGINAL\nHierarchical name: ASSIGNEES_ORIGINAL","properties":{"TYPE":{"description":"A single character representing the type of publication. I = Main invention publication;  T = Translation;  R = Reissued patent;  U = Utility Model;  S = Statutory Invention Publication;  P = NTIS Publication;  V = Trial Voluntary Protest Program.\n\nFlat name: ASSIGNEE_ORIGINAL_TYPE\nHierarchical name: ASSIGNEES_ORIGINAL.TYPE","example":"P","type":"string"}},"type":"object"},"type":"array"},"ASSIGNEE_NAMES":{"items":{"description":"The person or entity who owned/owns the patent. See [Optimized Assignee and Ultimate Parent](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/optimized_assignee.htm) on how we determine the owners.\nThis field will be normalized to uppercase.\n\nFlat name: ASSIGNEE_NAME\nHierarchical name: ASSIGNEE_NAMES","example":"GOOGLE INC.","type":"string"},"type":"array"},"AUTHOR_ABSTRACTS":{"items":{"description":"The front page abstracts as written by the author.\n\nFlat name: _AUTHOR_ABSTRACTS\nHierarchical name: AUTHOR_ABSTRACTS","example":"The French author's abstract text in xml","properties":{},"type":"object"},"type":"array"},"BACKWARD_CITATION":{"items":{"description":"\n\nFlat name: _BACKWARD_CITATION\nHierarchical name: BACKWARD_CITATION","properties":{},"type":"object"},"type":"array"},"CLAIMS":{"items":{"description":"Defines the boundaries of an invention, and therefore lays down what the patent does and does not cover.\n\nFlat name: _CLAIMS\nHierarchical name: CLAIMS","example":"1. A headgear apparatus I claim , wherein said eye shield member is adjustable with respect to said headband member.","properties":{},"type":"object"},"type":"array"},"CORRESPONDENTS":{"items":{"description":"The correspondent acting on behalf of the patent applicant.\n\nFlat name: _CORRESPONDENTS\nHierarchical name: CORRESPONDENTS","properties":{},"type":"object"},"type":"array"},"CPCS":{"items":{"description":"Cooperative Patent Classifications (CPC) are an extension of the IPC. They are divided into nine sections, A-H and Y presenting an identifier made up of letter and numbers, which in turn are sub-divided into classes, sub-classes, groups and sub-groups.\n\nFlat name: _CPCS\nHierarchical name: CPCS","properties":{},"type":"object"},"type":"array"},"CPCS_CURRENT":{"items":{"description":"These are the most recent CPC symbols and they overwrite/replace any earlier classifications. They can come from the Front Page or from the EPO (DocDB, through its weekly updates, or MCD quarterly update).  For more information see [CPC symbol](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#cpc)\nThis field will be normalized to uppercase.\n\nFlat name: CPC_CURRENT\nHierarchical name: CPCS_CURRENT","example":"G06N001000","type":"string"},"type":"array"},"DEAD_ALIVE_STATUS":{"description":"Patent and family status, dead (D) or alive (A) quickly shows you whether a patent or patent family is currently enforceable. Patent status uses a machine-learning algorithm to examine crucial patent data to determine the vitality status of a single patent or a patent family. The factors considered to predict patent status include: expiration date, legal status data, inherited status. If a record does not have an expiration date, filing date, and/or relevant legal status data, its status may be classified as Indeterminate (I). When a true/false is required, indeterminate should be considered as alive. [See the detailed process used to determine the status](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/pat_fam_status_doa.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DEAD_ALIVE_STATUS\nHierarchical name: DEAD_ALIVE_STATUS","example":"D","type":"string"},"DERWENT_BACKWARD_CITATION_COUNT":{"description":"Number of patents citing the DWPI family.\nThis field will be normalized to number.\n\nFlat name: DERWENT_BACKWARD_CITATION_COUNT\nHierarchical name: DERWENT_BACKWARD_CITATION_COUNT","example":15,"type":"number"},"DERWENT_FORWARD_CITATION_COUNT":{"description":"Number of patents cited by at least one member of the DWPI family.\nThis field will be normalized to number.\n\nFlat name: DERWENT_FORWARD_CITATION_COUNT\nHierarchical name: DERWENT_FORWARD_CITATION_COUNT","example":17,"type":"number"},"DESCRIPTIONS":{"items":{"description":"Part of a patent application or specification. Discloses the invention as claimed, specifies the technical field to which the invention relates and indicates any prior art the applicant is aware of.\n\nFlat name: _DESCRIPTIONS\nHierarchical name: DESCRIPTIONS","example":"characterised by ingredients other than fatty acid triglycerides","properties":{},"type":"object"},"type":"array"},"DESIGNATED_OFFICES":{"items":{"description":"The designated states are the countries/regions in which an invention is protected in addition to the country/region, in which the patent for the invention is filed. Filings under the PCT are identified by filing region XX. Other filing regions are EP (European Patent Office), EA (Eurasian Patent Organization), AP (African Regional IP Organization) or OA (African Intellectual Property Organization).\n\nFlat name: _DESIGNATED_OFFICES\nHierarchical name: DESIGNATED_OFFICES","properties":{},"type":"object"},"type":"array"},"DOCDB_SIMPLE_FAMILY_ID":{"description":"A unique identifier for the simple family (a patent family identified/defined by INPADOC using INPADOC methodology.\nThis field will be normalized to number.\n\nFlat name: DOCDB_SIMPLE_FAMILY_ID\nHierarchical name: DOCDB_SIMPLE_FAMILY_ID","example":7843694,"type":"number"},"DPCI_CITED_COUNTS":{"properties":{"ACCESSION_NUMBERS_TOTAL":{"description":"The number of unique Accession Numbers (showing the number of inventions) from the cited patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.ACCESSION_NUMBERS_TOTAL","example":3,"type":"number"},"AUTHORITIES_TOTAL":{"description":"The number of unique patenting authorities (country codes) from the cited patents from any citation source. This shows the number of distinct regions where the cited patents are originating from.\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_AUTHORITIES_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.AUTHORITIES_TOTAL","example":3,"type":"number"},"NON_PATENTS_TOTAL":{"description":"The number of unique articles from the cited non-patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_NON_PATENTS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.NON_PATENTS_TOTAL","example":8,"type":"number"},"PATENTS_TOTAL":{"description":"The number of unique patent numbers from the cited patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_PATENTS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.PATENTS_TOTAL","example":4,"type":"number"}},"type":"object"},"DPCI_CITED_NON_PATENTS":{"items":{"description":"Non-patent citation sources including abstracts and articles from scientific and technical literature.\n\nFlat name: _DPCI_CITED_NON_PATENTS\nHierarchical name: DPCI_CITED_NON_PATENTS","properties":{"DOC_ID":{"description":"A unique ID given to the non-patent article.\n\nFlat name: _DPCI_CITED_NON_PATENTS.DOC_ID\nHierarchical name: DPCI_CITED_NON_PATENTS.DOC_ID","example":"XP002220247","type":"string"},"MEMBERS":{"properties":{"FAMILY_MEMBER":{"description":"Patent number of  the family member where the non-patent citation originally populated from.\n\nFlat name: _DPCI_CITED_NON_PATENTS.MEMBERS.FAMILY_MEMBER\nHierarchical name: DPCI_CITED_NON_PATENTS.MEMBERS.FAMILY_MEMBER","example":"US8178699B2","type":"string"},"SOURCE":{"description":"Patent source of  the family member where the non-patent citation originally populated from.\n\nFlat name: _DPCI_CITED_NON_PATENTS.MEMBERS.SOURCE\nHierarchical name: DPCI_CITED_NON_PATENTS.MEMBERS.SOURCE","example":"1 (Applicant)","type":"string"}},"type":"object"},"TEXT":{"description":"A detailed description of the non-patent property rights.\n\nFlat name: _DPCI_CITED_NON_PATENTS.TEXT\nHierarchical name: DPCI_CITED_NON_PATENTS.TEXT","example":"J. C. LANCELOT ET AL.: A Facile Synthesis of New .beta.-Lactams, J. HETEROCYCL. CHEM., vol. 33, no. 2, 1996, pages 427 - 430, XP002220247,relevantClaims[1-5],relevantPassages[<compound>2</compound>]","type":"string"}},"type":"object"},"type":"array"},"DPCI_CITED_PATENTS":{"items":{"description":"Backward citing patents\n\nFlat name: _DPCI_CITED_PATENTS\nHierarchical name: DPCI_CITED_PATENTS","properties":{"APPLICATION_DATE":{"description":"Application date of the cited patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _DPCI_CITED_PATENTS.APPLICATION_DATE\nHierarchical name: DPCI_CITED_PATENTS.APPLICATION_DATE","example":"2004-08-06","format":"date","type":"string"},"DWPI_ACCESSION_NUMBER":{"description":"DWPI Accession Number of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_ACCESSION_NUMBER\nHierarchical name: DPCI_CITED_PATENTS.DWPI_ACCESSION_NUMBER","example":"2006120600","type":"string"},"DWPI_ASSIGNEES":{"items":{"description":"DWPI Assignee names and codes of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_ASSIGNEES\nHierarchical name: DPCI_CITED_PATENTS.DWPI_ASSIGNEES","properties":{"NAME":{"description":"DWPI Assignee names of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_ASSIGNEES.NAME\nHierarchical name: DPCI_CITED_PATENTS.DWPI_ASSIGNEES.NAME","example":"KRAFT FOODS HOLDINGS INC","type":"string"}},"type":"object"},"type":"array"},"DWPI_INVENTOR_NAMES":{"description":"DWPI Inventor names of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_INVENTOR_NAMES\nHierarchical name: DPCI_CITED_PATENTS.DWPI_INVENTOR_NAMES","example":"ALMENDAREZ M E|BUDZIK P J|BUDZIK P J H|JACKSON L K|LUDWIG C J|SHAH M","type":"string"},"DWPI_TITLE":{"description":"DWPI Title of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_TITLE\nHierarchical name: DPCI_CITED_PATENTS.DWPI_TITLE","example":"Mustard bran granulation process to form granulated mustard bran useful in food products e.g. barbecue sauce, involves introducing compressed heated air in cyclonic enclosure to form a vortex; and introducing mustard bran in the enclosure","type":"string"},"EARLIEST_PRIORITY_DATE":{"description":"Earliest priority date of the cited patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _DPCI_CITED_PATENTS.EARLIEST_PRIORITY_DATE\nHierarchical name: DPCI_CITED_PATENTS.EARLIEST_PRIORITY_DATE","example":"2004-08-06","format":"date","type":"string"},"MEMBERS":{"properties":{"RELEVANCE_CATEGORY":{"description":"Examiner-applied relevance codes of  the family member where the patent citation originally populated from.\n\nFlat name: _DPCI_CITED_PATENTS.MEMBERS.RELEVANCE_CATEGORY\nHierarchical name: DPCI_CITED_PATENTS.MEMBERS.RELEVANCE_CATEGORY","example":"A","type":"string"},"SOURCE":{"description":"Patent source of  the family member where the patent citation originally populated from.\n\nFlat name: _DPCI_CITED_PATENTS.MEMBERS.SOURCE\nHierarchical name: DPCI_CITED_PATENTS.MEMBERS.SOURCE","example":"1 (Applicant)","type":"string"}},"type":"object"},"PUBLICATION_DATE":{"description":"Publication date of the cited patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _DPCI_CITED_PATENTS.PUBLICATION_DATE\nHierarchical name: DPCI_CITED_PATENTS.PUBLICATION_DATE","example":"2006-02-09","format":"date","type":"string"},"PUBLICATION_NUMBER":{"description":"Publication number of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.PUBLICATION_NUMBER\nHierarchical name: DPCI_CITED_PATENTS.PUBLICATION_NUMBER","example":"\"US20060029703A1","type":"string"}},"type":"object"},"type":"array"},"DPCI_CITING_COUNTS":{"properties":{"ACCESSION_NUMBERS_TOTAL":{"description":"The number of unique Accession Numbers (showing the number of inventions) from the citing patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.ACCESSION_NUMBERS_TOTAL","example":3,"type":"number"},"AUTHORITIES_TOTAL":{"description":"The number of unique patenting authorities (country codes) from the citing patents from any citation source. This shows the number of distinct regions where the citing patents are originating from.\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_AUTHORITIES_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.AUTHORITIES_TOTAL","example":2,"type":"number"},"PATENTS_TOTAL":{"description":"The number of unique patent numbers from the citing patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_PATENTS_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.PATENTS_TOTAL","example":4,"type":"number"}},"type":"object"},"DPCI_CITING_PATENTS":{"items":{"description":"Forward citing patents.\n\nFlat name: _DPCI_CITING_PATENTS\nHierarchical name: DPCI_CITING_PATENTS","properties":{"DWPI_ASSIGNEES":{"items":{"description":"DWPI Assignee names and codes of the citing patent.\n\nFlat name: _DPCI_CITING_PATENTS.DWPI_ASSIGNEES\nHierarchical name: DPCI_CITING_PATENTS.DWPI_ASSIGNEES","properties":{},"type":"object"},"type":"array"},"MEMBERS":{"properties":{"SOURCE":{"description":"Patent source of  the family member where the patent citation originally populated from.\n\nFlat name: _DPCI_CITING_PATENTS.MEMBERS.SOURCE\nHierarchical name: DPCI_CITING_PATENTS.MEMBERS.SOURCE","example":"1 (Applicant)","type":"string"}},"type":"object"},"PUBLICATION_DATE":{"description":"Publication date of the citing patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _DPCI_CITING_PATENTS.PUBLICATION_DATE\nHierarchical name: DPCI_CITING_PATENTS.PUBLICATION_DATE","example":"2018-05-29","format":"date","type":"string"}},"type":"object"},"type":"array"},"DWPI_ABSTRACT":{"description":"Enhanced abstract curated by the DWPI editorial technology experts. For more information see [DWPI-Abstract] (https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#abstract_dwpi)\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _DWPI_ABSTRACT\nHierarchical name: DWPI_ABSTRACT","example":{"value":"A method of diagnosing and treating systemic Human Papilloma Virus (HPV) in particular \\\"viral colonies\\\" is disclosed. This method involves covering the skin of the feet and legs of a suspected infected human with topical applications selected from povidine iodine, potassium permanganate, aspirin, salicylic acid, natural salicin, lactic acid, alcohol, ether and any combination or mixture of them, and detecting \\\"HPV colony centres\\\" or lesions. The method of treatment of the detected HPV colony centres on the infected human includes topically administering any combination, mixture or percentage of aspirin, salicylic acid, natural salicin, paracetamol, phenacetin, whole natural grapefruit, povidine iodine and alcohol. These ingredients may be pureed, crushed, powered and or dissolved in water or grapefruit puree/juice, iodine or alcohol. The method optionally may contain the following further steps: a) initial intestinal cleansing with grapefruit seed extract(GSE) and /or Epsom salts, b) stretching and exercising the core infected area, c) i)treatment of the core infected area with firstly a topical treatment of any combination mixture or percentage of pureed whole potato and /or aloe vera stems mixed with either aspirin, salicylic acid, natural salicin, paracetamol, phenacetin, podivine iodine, alcohol, and/or epsom salts, then the core infected area is wrapped tightly in a sealed layer of plastic sheeting, and ii) secondly treating with another and final topical application consisting of any combinations, mixes and percentages of powdered Tobacco/nicotine, paracetamol, alcohol, Epsom salts, phenacetin, salicylic acid, salicin and/or aspirin. The method is supported or underpinned by a healthy lifestyle, a specified restrictive diet which avoids sugars and wheat products and certain vegetables and restricts the type and amounts of carbohydrates, a regime of daily specified supplements including salt, kelp, GSE, vitamin C, cod liver oil and Epsom salts and daily unprotected exposure to the sun.\""},"properties":{"NOVELTY":{"description":"Describes the unique inventive features introduced by the inventor which is not conventional and an improvement on existing technology.\n\nFlat name: _DWPI_ABSTRACT.NOVELTY\nHierarchical name: DWPI_ABSTRACT.NOVELTY","example":"The vent cover (20) comprises a peripheral wall (22) defining a boundary, and a cover plate extending between edges of the peripheral wall. A vent aperture (26) is arranged in the cover plate adjacent to a recess (28). A grate (30) extends from a rear side of the plate. A drain attachment is arranged above the grate on the rear side, and has a C-shaped cross-section.","type":"string"}},"type":"object"},"DWPI_ABSTRACT_EXT":{"description":"Additional patent details about chemical or pharmaceutical patents. Examples include experimental details, drug administration, or lists of specific compounds used. For more information see [Abastract-Extension-DWPI](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#abx)\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _DWPI_ABSTRACT_EXT\nHierarchical name: DWPI_ABSTRACT_EXT","properties":{"ADMINISTRATION":{"description":"Provides details of dosages and methods of administration for pharmaceutical/ veterinary patents, or application rates and methods in agrochemical patents.\n\nFlat name: _DWPI_ABSTRACT_EXT.ADMINISTRATION\nHierarchical name: DWPI_ABSTRACT_EXT.ADMINISTRATION","example":"Dosage is 0.01-50 mg/kg, preferably 0.05-10 mg/kg. Administration can be through subcutaneous, intraperitoneal, intravenous, intramuscular, oral, pulmonary, suppository, and transdermal route.","type":"string"},"DEFINITION":{"description":"Covers the Markush chemical formula definitions from the main and other independent claims if their inclusion in the Detailed Description field causes the field character limits to be exceeded. It also covers the narrower Markush formulae definitions given in the Dependent Claims.\n\nFlat name: _DWPI_ABSTRACT_EXT.DEFINITION\nHierarchical name: DWPI_ABSTRACT_EXT.DEFINITION","example":"Full Definition: Fossil fuels includes waste plastics such as polyolefins and other combustible solid and semi-solid wastes are pre-treated with non-toxic auxiliary materials, mixed, molded, and then stacked in stoves that are limited to non-mandatory combustion uses, and molded fuel static","type":"string"},"DOCUMENTATION":{"description":"DWPI abstract data from 1994 to 1998. Includes the complete text from the DWPI Abstract, and includes a number of possible section headings. For more information see [DWDOC](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#abstract_dwpi)\n\nFlat name: _DWPI_ABSTRACT_EXT.DOCUMENTATION\nHierarchical name: DWPI_ABSTRACT_EXT.DOCUMENTATION","example":"USE The process is useful for releasing salmon eggs, anise, blood, dairy products, molluscs, fish or crustacean parts or other materials that will attract when dispersed as particulates in water. ADVANTAGE The dried fish attracting powder coating the lure dissolves slowly to release the attractant. EXAMPLE The volume ratio of powdered mix (the attractant and carrier) to the blend of adhesive and gel-forming component was 1:1-20.","type":"string"},"EXAMPLE":{"description":"A summary of a full patent example which provides experimental data in support of the claimed invention, or details about how the invention is carried out in practice.\n\nFlat name: _DWPI_ABSTRACT_EXT.EXAMPLE\nHierarchical name: DWPI_ABSTRACT_EXT.EXAMPLE","example":"A dietary supplement comprising (g): purified water (19.29), ascorbyl palmitate (0.2), sorbic acid (0.16), sucrose (25), glycerin (5), xanthan gum (0.3), concentrated borage oil (40% γ-linolenic acid) (20), concentrated marine oil (33% eicosapentaenoic acid) (15), flavor (orange/peach) (15) and colorant (orange) (0.05) was prepared.","type":"string"},"PRIOR_ART":{"description":"This field usually does not contain information and is not currently populated.\n\nFlat name: _DWPI_ABSTRACT_EXT.PRIOR_ART\nHierarchical name: DWPI_ABSTRACT_EXT.PRIOR_ART","example":"When electronic apparatuses using a tin-lead solder are disposed of as general industrial wastes and exposed to the atmospheric environment, a lead component in the solder elutes to give adverse effects to human bodies; this has accelerated the development of a tin-zinc unleaded solder.","type":"string"},"SPECIFIC_COMPOUND":{"description":"Specific substances which relate to, or exemplify, the novel features of the invention.\n\nFlat name: _DWPI_ABSTRACT_EXT.SPECIFIC_COMPOUND\nHierarchical name: DWPI_ABSTRACT_EXT.SPECIFIC_COMPOUND","example":"SPECIFIC SEQUENCES- Specifically claimed is stress-phosphorylated endoplasmic reticulum protein, Nogo B, comprising 373 amino acids (SEQ ID NO. 2), and encoded by a nucleic acid comprising 2240 bp (SEQ ID NO. 1). All sequences are fully defined in the specification.","type":"string"},"WIDER_DISCLOSURE":{"description":"Identifies areas where the scope and/or novelty of the invention, as defined in the body of the specification, is broader than that of the main independent claim(s).\n\nFlat name: _DWPI_ABSTRACT_EXT.WIDER_DISCLOSURE\nHierarchical name: DWPI_ABSTRACT_EXT.WIDER_DISCLOSURE","example":"Also disclosed are: antibodies, including monoclonal and polyclonal antibodies, that recognize all or part of the Nogo protein; a method of identifying the Nogo proteins using the antibodies; a method of identifying or quantifying expression products of the gene encoding the Nogo of the invention; a method of detecting cell stress, where the phosphorylation of the protein of the invention is detected or measured;","type":"string"}},"type":"object"},"DWPI_ACCESSION_NUMBER":{"description":"The DWPI Primary Accession number (also known as PAN) is a unique identifier for the whole DWPI family representing a single invention. The first four digits represent the year the record was created. DWPI has a strict family definition in which each member shares exact priorities (except for non-convention equivalents) with each and every other family member. INPADOC, in contrast, has a very broad family definition that includes divisions, continuations and continuations in part. All that is needed is a shared priority of any one member to another.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_ACCESSION_NUMBER\nHierarchical name: DWPI_ACCESSION_NUMBER","example":"2018741525","type":"string"},"DWPI_APPLICATION_NUMBER_BASIC":{"description":"The application number of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_APPLICATION_NUMBER_BASIC\nHierarchical name: DWPI_APPLICATION_NUMBER_BASIC","example":"WO2012EP73219A","type":"string"},"DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC":{"description":"Country code that is part of the application number of the basic publication for a given DWPI family and represents the first instance of the invention ex. (US).\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC\nHierarchical name: DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","example":"EP","type":"string"},"DWPI_ASSIGNEES":{"items":{"description":"Standardized version of the assignee/applicant, as assigned during the review performed by DWPI editors. This standardized version is matched to our database of assignees to ensure that names are applied consistently.\n\nFlat name: _DWPI_ASSIGNEES\nHierarchical name: DWPI_ASSIGNEES","properties":{},"type":"object"},"type":"array"},"DWPI_CLASSES":{"items":{"description":"The DWPI collection categorizes patent documents using two classification systems, [DWPI Class](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields/details/DWPI_Class_Details.htm) and DWPI Manual Codes. Subject specialists consistently apply these unique classification systems to the DWPI patent documents. DWPI Class is a broad, simple system, whereas DWPI Manual Codes are more detailed and granular. Both DWPI Class and DWPI Manual Codes cover all technologies within 20 subject areas, identified by Section letters A-X which are grouped into three broad categories for Chemistry, Engineering and Electronics.\n\nFlat name: _DWPI_CLASSES\nHierarchical name: DWPI_CLASSES","properties":{},"type":"object"},"type":"array"},"DWPI_DESIGNATED_OFFICE_COUNT":{"description":"The number of countries/regions within which protection of the DWPI family members was sought.\nThis field will be normalized to number.\n\nFlat name: DWPI_DESIGNATED_OFFICE_COUNT\nHierarchical name: DWPI_DESIGNATED_OFFICE_COUNT","example":117,"type":"number"},"DWPI_EARLIEST_PRIORITY_DATE":{"description":"The earliest date for the DWPI family when the priority application was filed.\nThis field is of type date but will be serialized to type string.\n\nFlat name: DWPI_EARLIEST_PRIORITY_DATE\nHierarchical name: DWPI_EARLIEST_PRIORITY_DATE","example":"2017-04-21","format":"date","type":"string"},"DWPI_FAMILY_MEMBER_COUNT":{"description":"The number of DWPI family members within a given family.\nThis field will be normalized to number.\n\nFlat name: DWPI_FAMILY_MEMBER_COUNT\nHierarchical name: DWPI_FAMILY_MEMBER_COUNT","example":13,"type":"number"},"DWPI_FAMILY_STATUS":{"description":"DWPI Family status, dead (D) or alive (A) quickly shows you whether a DWPI patent family is currently enforceable. Patent status uses a machine-learning algorithm to examine crucial patent data to determine the vitality status of a single patent or a patent family. The factors considered to predict patent status include: expiration date, legal status data, inherited status. If a record does not have an expiration date, filing date, and/or relevant legal status data, its status may be classified as Indeterminate (I). A DWPI Family remains alive as long as at least one patent in the family is still active. When a true/false is required, indeterminate should be considered as alive. [See the detailed process used to determine the status](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/pat_fam_status_doa.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_FAMILY_STATUS\nHierarchical name: DWPI_FAMILY_STATUS","example":"D","type":"string"},"DWPI_INVENTORS":{"items":{"description":"The DWPI Inventor information within a patent record.\n\nFlat name: _DWPI_INVENTORS\nHierarchical name: DWPI_INVENTORS","properties":{},"type":"object"},"type":"array"},"DWPI_KIND_CODE_BASIC":{"description":"Indicates the version or level of a patent document, also known as publication stage. See the list of [DWPI Kind Codes](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/dwpi_kinds.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_KIND_CODE_BASIC\nHierarchical name: DWPI_KIND_CODE_BASIC","example":"A1","type":"string"},"DWPI_MANUAL_CODES":{"items":{"description":"A hierarchical indexing system to index the inventive and significant aspects of an invention, plus its commercial applications. The [DWPI Manual Codes](https://clarivate.com/derwent/dwpi-reference-center/dwpi-manual-code/) are consistently applied by specialist teams and divided into 20 technology sections.\n\nFlat name: _DWPI_MANUAL_CODES\nHierarchical name: DWPI_MANUAL_CODES","properties":{},"type":"object"},"type":"array"},"DWPI_PUBLICATION_NUMBER_BASIC":{"description":"The publication number of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_PUBLICATION_NUMBER_BASIC\nHierarchical name: DWPI_PUBLICATION_NUMBER_BASIC","example":"WO2018169585A1","type":"string"},"DWPI_REGISTRATION_OFFICE_BASIC":{"description":"The registration office code (country code) of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_REGISTRATION_OFFICE_BASIC\nHierarchical name: DWPI_REGISTRATION_OFFICE_BASIC","example":"WO","type":"string"},"DWPI_TITLE":{"description":"Provides more information than the original patent title, written specifically to enable easy review of large lists of records and covers brief details of the scope, use and novelty of the invention. For more information see [Derwent World Patents Index](https://support.clarivate.com/Patents/s/article/Derwent-World-Patents-Index-Derwent-value-added-information?language=en_US)\nThis field will be normalized to mixed-case.\n\nFlat name: DWPI_TITLE\nHierarchical name: DWPI_TITLE","example":"Stacked quantum computing device, includes shielding layer which covers dielectric layer which covers control wire on dielectric substrate of second chip","type":"string"},"DWPI_UPDATE":{"description":"This is a unique identification number assigned to each DWPI database update and comprises a 4-digit year followed by a 2-digit serial number (for updates before 1 Jan. 2020) or a 3-digit serial number (for updates on or after 1 Jan. 2020). The 4-digit year and 2- or 3-digit serial number the  represent the year of the update and the number of the update, respectively.\nThis field will be normalized to number.\n\nFlat name: DWPI_UPDATE\nHierarchical name: DWPI_UPDATE","example":2021045,"type":"number"},"DWPI_UPDATE_BASIC":{"description":"The DWPI update number for the first member of the patent family. Find out more about the  [DWPI Data](https://www.derwentinnovation.com/tip-innovation/support/help/dwpi.htm).\nThis field will be normalized to number.\n\nFlat name: DWPI_UPDATE_BASIC\nHierarchical name: DWPI_UPDATE_BASIC","example":199945,"type":"number"},"DW_KEYWORDS":{"items":{"description":"Derwent Manual Code keywords list (multi-valued).\n\nFlat name: DW_KEYWORDS\nHierarchical name: DW_KEYWORDS","type":"string"},"type":"array"},"EARLIEST_PRIORITY_COUNTRY":{"description":"The earliest data of all the priority countries/regions on the record.\nThis field will be normalized to uppercase.\n\nFlat name: EARLIEST_PRIORITY_COUNTRY\nHierarchical name: EARLIEST_PRIORITY_COUNTRY","example":"US","type":"string"},"EARLIEST_PRIORITY_DATE":{"description":"The earliest data of all the priority dates on the record.\nThis field is of type date but will be serialized to type string.\n\nFlat name: EARLIEST_PRIORITY_DATE\nHierarchical name: EARLIEST_PRIORITY_DATE","example":"2017-03-13","format":"date","type":"string"},"EARLIEST_PRIORITY_NUMBER":{"description":"The earliest data of all the priority numbers on the record.\nThis field will be normalized to uppercase.\n\nFlat name: EARLIEST_PRIORITY_NUMBER\nHierarchical name: EARLIEST_PRIORITY_NUMBER","example":"US62470694P","type":"string"},"EARLIEST_PRIORITY_YEAR":{"description":"The earliest data of all the priority years on the record.\nThis field will be normalized to number.\n\nFlat name: EARLIEST_PRIORITY_YEAR\nHierarchical name: EARLIEST_PRIORITY_YEAR","example":2011,"type":"number"},"ESTIMATED_EXPIRATION":{"description":"Estimated expiration information.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _ESTIMATED_EXPIRATION\nHierarchical name: ESTIMATED_EXPIRATION","properties":{},"type":"object"},"EXAMINERS":{"description":"The examiner(s) at the patent office who examined the patent.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _EXAMINERS\nHierarchical name: EXAMINERS","properties":{},"type":"object"},"FIRST_CLAIM":{"description":"Defines the boundaries first instance of an invention, and therefore lays down what the patent does and does not cover.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _FIRST_CLAIM\nHierarchical name: FIRST_CLAIM","example":{"value":"\"en\":\"<tsip:claimTsxm xmlns=\\\"http://schemas.thomson.com/ts/20041221/tsxm\\\" xmlns:tsip=\\\"http://schemas.thomson.com/ts/20041221/tsip\\\" tsip:no=\\\"1\\\" tsip:type=\\\"main\\\" id=\\\"cl0001\\\" num=\\\"0001\\\">1. A mould opening mechanism, comprising a static panel (4), stripper plate (6), A plate (7), plate B (8) and locating rod (5), a stripper plate (6) is connected with the A plate (7) are fixed together; plastic waste between the static panel (4) and between the stripper plate (6), plastic product located between plate A (7) and the B plate (8), a fixed panel (4) and stripper plate (6) through a locating pull rod (5) to adjust the separation distance between the two and ensure that both without departing from. wherein it further comprises a static mould opening-closing driving block (1), a movable mould inverted hook block (3) and a reverse hook (2), the static mould opening-closing driving block (1) and the static panel (4) are fixedly connected; the movable mould inverted hook block (3) and the B plate (8) is fixedly connected with the static mould opening-closing driving block (1) and the movable mould inverted hook block (3) located on the same side of the mould; the inverted hook (2) of the inner space between the stripper plate (6) and the A plate (7) to move. pulling the inverted hook (2) on the movable mould inverted hook block (3) in the process of moving downwards inverted hook block by the movable mould (3) and the static mould opening-closing driving block (1) and pressed and retracted inside space ensured in panel (4) and the stripper plate (6) of the separating plate A (7) and B plate (8) for separating, the static mould opening-closing driving block (1) is inverted \\\" L \\\" - shaped structure, the upper part and the static panel (4) is fixedly connected with the inner side of the lower end is provided with a bump structure; the bump structure is provided with a first wedge surface (11); the movable mould inverted hook block (3) is L-shaped structure, and the lower part and the B plate (8) is fixedly connected with the inner side of the upper end is provided with a barb (31) form space M; the inverted hook (2) is set on the A plate (7) sliding in slide left and right along the chute, the inverse hook mechanism (2) comprises a reversed hook the small sliding block (21) and a spring (23), the spring (23) is set on the bottom of the A plate (7) of the chute. said converse hook small slide block (21) and one end of the spring (23) is connected, the other end of the inverted hook of the slide block (21) is provided with a second oblique wedge surface (211), B plate (8) and a movable mould inverted hook block (3) moves upwards; A plate (7) and the B plate (8) firstly assembling mould and drives the plate A (7) and stripper plate (6) continues to move upwards, the inversed hooks are small slide block (21) by a spring (23) to reset force side do pop-up movement to the left, the inversed hooks are small sliding block (21) enters the space M of the moving die inverted hook block (3); the B plate (8) and the movable mould inverted hook block (3) continues to move upwards to finish the static panel (4) and the stripper plate (6), the locating pull rod (5) passes through the panel (4) is stepped hole (41) and the stripper plate (6), said plate A (7) are fixedly connected together; the locating pull rod (5) can move up and down along the step hole (41); the inverted hook (2) further comprises a limiting pin (22); the limiting pin (22) passes through the stripper plate (6) is inserted in the small barb sliding block (21) on the upper surface of the long groove (212).</tsip:claimTsxm>\",_x000D_\n_x000D_\n                 \"ZH\":\"<tsip:claimTsxm xmlns=\\\"http://schemas.thomson.com/ts/20041221/tsxm\\\" xmlns:tsip=\\\"http://schemas.thomson.com/ts/20041221/tsip\\\" id=\\\"cl0001\\\" num=\\\"0001\\\" tsip:no=\\\"1\\\" tsip:type=\\\"main\\\">1.一种三板模具开模机构，包括静模面板（4）、脱料板（6）、A板（7）、B板（8）和定位拉杆（5），脱料板（6）与A板（7）固定在一起，塑料废料位于静模面板（4）和脱料板（6）之间，塑料成品位于A板（7）和B板（8）之间，静模面板（4）和脱料板（6）通过定位拉杆（5）调节两者之间的分离距离并确保两者_x000D_\n不脱离，其特征在于：还包括静模开模驱动块（1）、动模倒钩拉块（3）和倒勾机构（2），所述静模开模驱动块（1）与所述静模面板（4）固定连接，所述动模倒钩拉块（3）与所述B板（8）固定连接，所述静模开_x000D_\n模驱动块（1）和所述动模倒钩拉块（3）位于模具的同一侧；所述倒勾机构（2）在所述脱料板（6）和所述A板（7）之间的内侧空间中移动，所述倒勾机构（2）在动模倒钩拉块（3）向下移动过程中受到所述动模倒_x000D_\n钩拉块（3）和所述静模开模驱动块（1）的拉动和挤压并缩进内侧空间中确保静模面板（4）与脱料板（6）的分离先于A板（7）和B板（8）的分离；   <br type=\\\"required\\\"/>所述静模开模驱动块（1）是倒“L” 状结构，其上部和所述静模面板（4）固定连接，其下端内侧设置有突起结构，所述突起结构上设置有第一斜楔面（11）；   <br type=\\\"required\\\"/>所述动模倒钩拉块（3）是“L”状结构，其下部和所述B板（8）固定连接，其上端内侧设置有一倒钩（31）形成倒扣空间M；   <br type=\\\"required\\\"/>所述倒勾机构（2）设置在所述A板（7）上的滑槽内沿所述滑槽左右滑动，所述倒勾机构（2）包括倒勾小滑块（21）和弹簧(23)，所述弹簧(23)设置在所述A板（7）上的滑槽的底部，所述倒勾小滑块（21）的一端和所述弹簧(23)连接，所述倒勾小滑块（21）的另一端设置有第二斜楔面（211）；   <br type=\\\"required\\\"/>合模时，B板（8）和动模倒钩拉块（3）向上移动，B板（8）和A板（7）先合模并带动A板（7）和脱料板（6）继续向上移动，倒勾小滑块（21）受弹簧（23）复位力向左边做弹出运动，倒勾小滑块（21）外端进入动模倒钩拉块（3）的倒扣空间M，B板（8）和动模倒钩拉块（3）继续向上移动完成静模面板（4）与脱料板（6）的合模；   <br type=\\\"required\\\"/>所述定位拉杆（5）穿过所述静模面板（4）上的阶梯孔（41）和所述脱料板（6）、所述A板（7）固连在一起，所述定位拉杆（5）可沿着所述阶梯孔（41）上下移动；   <br type=\\\"required\\\"/>所述倒勾机构（2）还包括限位销（22），所述限位销（22）穿过所述脱料板（6）插在所述倒勾小滑块（21）上表面的长形凹槽（212）内。</tsip:claimTsxm>\""},"properties":{},"type":"object"},"FORWARD_CITATION":{"items":{"description":"\n\nFlat name: _FORWARD_CITATION\nHierarchical name: FORWARD_CITATION","properties":{"ASSIGNEE":{"description":"\n\nFlat name: _FORWARD_CITATION.ASSIGNEE\nHierarchical name: FORWARD_CITATION.ASSIGNEE","type":"string"},"DWPI_ACCESSION_NUMBER":{"description":"\n\nFlat name: _FORWARD_CITATION.DWPI_ACCESSION_NUMBER\nHierarchical name: FORWARD_CITATION.DWPI_ACCESSION_NUMBER","type":"string"},"DWPI_ASSIGNEES":{"items":{"description":"\n\nFlat name: _FORWARD_CITATION.DWPI_ASSIGNEES\nHierarchical name: FORWARD_CITATION.DWPI_ASSIGNEES","properties":{"CODE":{"description":"\n\nFlat name: _FORWARD_CITATION.DWPI_ASSIGNEES.CODE\nHierarchical name: FORWARD_CITATION.DWPI_ASSIGNEES.CODE","type":"string"},"NAME":{"description":"\n\nFlat name: _FORWARD_CITATION.DWPI_ASSIGNEES.NAME\nHierarchical name: FORWARD_CITATION.DWPI_ASSIGNEES.NAME","type":"string"}},"type":"object"},"type":"array"},"INVENTOR":{"description":"\n\nFlat name: _FORWARD_CITATION.INVENTOR\nHierarchical name: FORWARD_CITATION.INVENTOR","type":"string"},"KIND_CODE":{"description":"\n\nFlat name: _FORWARD_CITATION.KIND_CODE\nHierarchical name: FORWARD_CITATION.KIND_CODE","type":"string"},"MEMBERS":{"properties":{"RELEVANCE_CATEGORY":{"description":"\n\nFlat name: _FORWARD_CITATION.MEMBERS.RELEVANCE_CATEGORY\nHierarchical name: FORWARD_CITATION.MEMBERS.RELEVANCE_CATEGORY","type":"string"}},"type":"object"},"PUBLICATION_DATE":{"description":"\nThis field is of type date but will be serialized to type string.\n\nFlat name: _FORWARD_CITATION.PUBLICATION_DATE\nHierarchical name: FORWARD_CITATION.PUBLICATION_DATE","format":"date","type":"string"},"PUBLICATION_NUMBER":{"description":"\n\nFlat name: _FORWARD_CITATION.PUBLICATION_NUMBER\nHierarchical name: FORWARD_CITATION.PUBLICATION_NUMBER","type":"string"}},"type":"object"},"type":"array"},"FORWARD_CITATIONS":{"properties":{"MEMBERS":{"properties":{"SOURCE":{"description":"\n\nFlat name: _FORWARD_CITATIONS.MEMBERS.SOURCE\nHierarchical name: FORWARD_CITATIONS.MEMBERS.SOURCE","type":"string"}},"type":"object"}},"type":"object"},"GRANTED":{"description":"A flag  indicating whether the document is granted. Once a patent is granted, the patent holder has been granted the right to restrict others from using, making, selling, and importing his invention without his express permission.\nThis field will be normalized to boolean.\n\nFlat name: GRANTED\nHierarchical name: GRANTED","example":true,"type":"boolean"},"GRANT_DATE":{"description":"The date (YYYY-MM-DD) on which the patent office grants the patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: GRANT_DATE\nHierarchical name: GRANT_DATE","example":"2017-04-17","format":"date","type":"string"},"GUID":{"description":"A unique document identifier for this particular publication.\nThis field will be normalized to uppercase.\n\nFlat name: DOCUMENT_GUID\nHierarchical name: GUID","example":"WO2021243294A120211202","type":"string"},"INDEPENDENT_CLAIMS":{"items":{"description":"A claim on a patent record that is determined to not rely on any other claims in the patent.\n\nFlat name: _INDEPENDENT_CLAIMS\nHierarchical name: INDEPENDENT_CLAIMS","properties":{"INDEX":{"description":"Number representing which one of a set of claims this one is - i.e. whether it is the first, second, etc.\n\nFlat name: _INDEPENDENT_CLAIMS.INDEX\nHierarchical name: INDEPENDENT_CLAIMS.INDEX","example":"1","type":"string"},"LANGUAGE":{"description":"The publication language of this claim.\n\nFlat name: _INDEPENDENT_CLAIMS.LANGUAGE\nHierarchical name: INDEPENDENT_CLAIMS.LANGUAGE","example":"en","type":"string"},"SOURCE":{"description":"Indicator showing the origin of the data.\n\nFlat name: _INDEPENDENT_CLAIMS.SOURCE\nHierarchical name: INDEPENDENT_CLAIMS.SOURCE","example":"ORIG","type":"string"},"XML":{"description":"Text in the patent about the subject matter and scope of the invention.\n\nFlat name: _INDEPENDENT_CLAIMS.XML\nHierarchical name: INDEPENDENT_CLAIMS.XML","example":"1. A single channel photoelectric detector with offset zero and continuously adjustable gain, wherein it comprises power supply voltage stabilizing circuit, a photoelectric conversion circuit, an active filter circuit, an adjustable gain circuit, bias voltage zeroing circuit. BNC joint (J), the power supply voltage stabilizing circuit comprises a first voltage regulator (U1), the second voltage (U2), a first capacitor","type":"string"}},"type":"object"},"type":"array"},"INPADOC_FAMILY":{"items":{"description":"\n\nFlat name: _INPADOC_FAMILY\nHierarchical name: INPADOC_FAMILY","properties":{"PUBLICATION_DATE":{"description":"\nThis field is of type date but will be serialized to type string.\n\nFlat name: _INPADOC_FAMILY.PUBLICATION_DATE\nHierarchical name: INPADOC_FAMILY.PUBLICATION_DATE","format":"date","type":"string"}},"type":"object"},"type":"array"},"INPADOC_FAMILY_ID":{"description":"Internal unique identifier for the Inpadoc family\n\nFlat name: _INPADOC_FAMILY_ID\nHierarchical name: INPADOC_FAMILY_ID","example":"20131211EP2671741A1","type":"string"},"INPADOC_FAMILY_STATUS":{"description":"Dead (D) / Alive (A) status of the Inpadoc family quickly shows whether an INPADOC Patent Family is currently enforceable. If a record does not have relevant legal status data, its status may be classified as Indeterminate (I) or None (N). An INPADOC Family remains alive as long as at least one patent in the family is still active\nThis field will be normalized to uppercase.\n\nFlat name: INPADOC_FAMILY_STATUS\nHierarchical name: INPADOC_FAMILY_STATUS","example":"D","type":"string"},"INPADOC_LEGAL_STATUS_EVENTS":{"items":{"description":"The entries made or procedural steps or events taken during the patent-granting process and throughout the lifetime of the patent.\nThis field will be normalized to can there be multiple ones?.\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS","properties":{"CODE":{"description":"INPADOC Legal Status Codes (LSC) and their meanings are country/region-specific\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS.CODE\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS.CODE","example":"REG","type":"string"},"DESCRIPTION":{"description":"Detailed text description of the code.\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS.DESCRIPTION\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS.DESCRIPTION","example":"REFERENCE TO NATIONAL CODE DE 8642 PROCEDURE RELATING TO PCT APPLICATION: CEASED TO HAVE EFFECT FOR DE","type":"string"},"GAZETTE_DATE":{"description":"The date which the status was officially published.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS.GAZETTE_DATE\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS.GAZETTE_DATE","example":"2004-04-22","format":"date","type":"string"},"IMPACT":{"description":"INPADOC Legal Status Impact (LSI) indicates whether a legal status change has a positive (+), negative (-), or neutral (no symbol) impact on a patent.\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS.IMPACT\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS.IMPACT","example":"-","type":"string"}},"type":"object"},"type":"array"},"INVENTORS":{"items":{"description":"The inventor information on a patent or application.\n\nFlat name: _INVENTORS\nHierarchical name: INVENTORS","properties":{},"type":"object"},"type":"array"},"IPCS":{"items":{"description":"International patent classifications (IPC or IC) are Classification symbols or codes that can be allotted to patent documents. IPC classification symbols are made up of a letter denoting the IPC section (ex. A), followed by a number (two digits) denoting the IPC class (ex. A63), then a letter denoting the IPC subclass (ex. A63B). A number (variable, 1-4 digits) denotes the IPC main group (ex. A63B49).\n\nFlat name: _IPCS\nHierarchical name: IPCS","properties":{},"type":"object"},"type":"array"},"IPCS_CURRENT":{"items":{"description":"The most recent IPC classifications. They overwrite/replace any earlier classifications. They can come from Front Page or EPO (DocDB, through its weekly updates, or MCD quarterly update). For more information see [IPC classification]§\nThis field will be normalized to uppercase.\n\nFlat name: IPC_CURRENT\nHierarchical name: IPCS_CURRENT","example":"A23D0007005","type":"string"},"type":"array"},"JP_CLASSES":{"description":"A patent classifications applied by the Japanese patent office.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _JP_CLASSES\nHierarchical name: JP_CLASSES","properties":{},"type":"object"},"KIND_CODE":{"description":"A one-or two-character code (one alpha plus one optional numeric) that always follows the publication number. Kind Codes indicate the version or level of examination of a patent document. [Kind codes](https://clarivate.com/derwent/wp-content/uploads/sites/3/dlm_uploads/2019/08/Kind-Code-Summary.pdf]) and their meanings are country/region specific.\nThis field will be normalized to uppercase.\n\nFlat name: KIND_CODE\nHierarchical name: KIND_CODE","example":"A1","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database.\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: LAST_UPDATED_DATE","example":"2022-05-05","format":"date","type":"string"},"LEGAL_STATUS_FACTOR":{"description":"The legal status factors used in the calculation of the derived data.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _LEGAL_STATUS_FACTOR\nHierarchical name: LEGAL_STATUS_FACTOR","properties":{"CODE":{"description":"INPADOC Legal Status Codes (LSC) and their meanings are country/region-specific\n\nFlat name: _LEGAL_STATUS_FACTOR.CODE\nHierarchical name: LEGAL_STATUS_FACTOR.CODE","example":"C12","type":"string"},"COUNTRY":{"description":"State, nation or territory considered as an organized political community under one government where application was filed.\n\nFlat name: _LEGAL_STATUS_FACTOR.COUNTRY\nHierarchical name: LEGAL_STATUS_FACTOR.COUNTRY","example":"CN","type":"string"},"DESCRIPTION":{"description":"Detailed text description of the code.\n\nFlat name: _LEGAL_STATUS_FACTOR.DESCRIPTION\nHierarchical name: LEGAL_STATUS_FACTOR.DESCRIPTION","example":"REJECTION OF A PATENT APPLICATION AFTER ITS PUBLICATION","type":"string"}},"type":"object"},"PATENT_TYPE":{"description":"An indicator of whether a patent is an application (A), a granted patent (G) or a utility model (U). Utility models supplement the patent system by providing protection for innovations which are not regarded as inventive enough to warrant a patent grant. 90% of the Utility Models in the database originate from China, Japan, Germany and South Korea.\nThis field will be normalized to uppercase.\n\nFlat name: PATENT_TYPE\nHierarchical name: PATENT_TYPE","example":"A","type":"string"},"PREDICTIVE":{"items":{"description":"Evaluation metrics, which indicate the probability of future occurrences, relative strength, and importance of a patent\n\nFlat name: _PREDICTIVE\nHierarchical name: PREDICTIVE","properties":{"DOMAIN_INFLUENCE":{"description":"How important/influential is this patent to the technical domain that it sits in?\n\nFlat name: _PREDICTIVE.DOMAIN_INFLUENCE\nHierarchical name: PREDICTIVE.DOMAIN_INFLUENCE","example":5.65,"type":"number"},"GRANT_PROBABILITY":{"description":"What is the probability that this patent application will be granted? (Calculated for patent applications only.)\n\nFlat name: _PREDICTIVE.GRANT_PROBABILITY\nHierarchical name: PREDICTIVE.GRANT_PROBABILITY","example":0.33,"type":"number"}},"type":"object"},"type":"array"},"PRIORITIES":{"items":{"description":"A list of any previously filed applications from which this application had claimed priority.\n\nFlat name: _PRIORITIES\nHierarchical name: PRIORITIES","properties":{"COUNTRY":{"description":"The country/region in which the priority application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: _PRIORITIES.COUNTRY\nHierarchical name: PRIORITIES.COUNTRY","example":"US","type":"string"},"DATE":{"description":"The date when the priority application was filed.\nThis field is of type date but will be serialized to type string.\nThis field will be normalized to uppercase.\n\nFlat name: _PRIORITIES.DATE\nHierarchical name: PRIORITIES.DATE","example":"2017-03-13","format":"date","type":"string"},"NUMBER":{"description":"The application number of a previously filed application ( the priority application)  from which a patent application claims priority.\nThis field will be normalized to uppercase.\n\nFlat name: _PRIORITIES.NUMBER\nHierarchical name: PRIORITIES.NUMBER","example":"US62470694P","type":"string"}},"type":"object"},"type":"array"},"PUBLICATION_DATE":{"description":"The date a patent or application was officially published.\nThis field is of type date but will be serialized to type string.\n\nFlat name: PUBLICATION_DATE\nHierarchical name: PUBLICATION_DATE","example":"2021-07-21","format":"date","type":"string"},"PUBLICATION_LANGUAGE":{"description":"The publication language of a record. See [language codes (ISO 639-2)](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/iso_639.htm).\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_LANGUAGE\nHierarchical name: PUBLICATION_LANGUAGE","example":"EN","type":"string"},"PUBLICATION_NUMBER":{"description":"A unique identifier assigned to a patent publication which can represent a published application, a published grant or a utility model. A publication number will always be preceded by a country code and followed by a kind code. For more information see [Publication number formats](https://support.clarivate.com/Patents/s/article/Derwent-Innovation-Publication-Number-PN-Formats?language=en_US).\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_NUMBER\nHierarchical name: PUBLICATION_NUMBER","example":"EP3852021A1","type":"string"},"PUBLICATION_TYPE":{"description":"A single character representing the type of publication. I = Main invention publication;  T = Translation;  R = Reissued patent;  U = Utility Model;  S = Statutory Invention Publication;  P = NTIS Publication;  V = Trial Voluntary Protest Program.\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_TYPE\nHierarchical name: PUBLICATION_TYPE","example":"I","type":"string"},"PUBLICATION_YEAR":{"description":"The year a patent or application was officially published.\nThis field will be normalized to number.\n\nFlat name: PUBLICATION_YEAR\nHierarchical name: PUBLICATION_YEAR","example":2013,"type":"number"},"REGISTRATION_OFFICE":{"description":"The registration office code, also known as the country code, is a [two-character code (WIPO ST.3)](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/patent_country_codes.htm) indicating the country/region where the application has been made or the patent has been granted.\nThis field will be normalized to uppercase.\n\nFlat name: REGISTRATION_OFFICE\nHierarchical name: REGISTRATION_OFFICE","example":"EP","type":"string"},"REPRESENTATIVES":{"items":{"description":"The legal representative of a patent application is the person or entity who is legally able to work on, file, and initiate applications for clients who are interested in acquiring a patent.\n\nFlat name: _REPRESENTATIVES\nHierarchical name: REPRESENTATIVES","properties":{},"type":"object"},"type":"array"},"SERIAL_NUMBER":{"description":"Original Serial Number of a Patent document as appears in Patent office gazette, without country code or kind code.\nThis field will be normalized to uppercase.\n\nFlat name: SERIAL_NUMBER\nHierarchical name: SERIAL_NUMBER","example":"3852021","type":"string"},"TITLES":{"items":{"description":"The title information shown on the patent document.\n\nFlat name: _TITLES\nHierarchical name: TITLES","example":"Pressure intensifier unit for vehicle braking system","properties":{},"type":"object"},"type":"array"},"ULTIMATE_PARENTS":{"items":{"description":"Provides the entity name which has ultimate and current responsibility for the patent and who has the ability to exploit it. See [Optimized Assignee and Ultimate Parent](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/optimized_assignee.htm) on how we determine the owners.\nThis field will be normalized to uppercase.\n\nFlat name: ULTIMATE_PARENT\nHierarchical name: ULTIMATE_PARENTS","example":"ALPHABET INC.","type":"string"},"type":"array"},"US_REASSIGNMENTS":{"properties":{"ASSIGNEES":{"properties":{"ADDRESS":{"description":"USPTO US reassignment assignee address.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.ADDRESS\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.ADDRESS","example":"1 WAYSIDE ROAD BURLINGTON MASSACHUSETTS 01803","type":"string"},"CITY":{"description":"USPTO US reassignment assignee city.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.CITY\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.CITY","example":"BURLINGTON","type":"string"},"COUNTRY":{"description":"USPTO US reassignment assignee country.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.COUNTRY\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.COUNTRY","example":"US","type":"string"},"NAME":{"description":"USPTO US reassignment assignee name.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.NAME\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.NAME","example":"\"NUANCE COMMUNICATIONS, INC., AS GRANTOR\",","type":"string"},"ORDINAL":{"description":"USPTO US reassignment assignee ordinal.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.ORDINAL\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.ORDINAL","example":1,"type":"number"},"STATE":{"description":"USPTO US reassignment assignee state.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.STATE\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.STATE","example":"MA","type":"string"},"ZIP_CODE":{"description":"USPTO US reassignment assignee zip code.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.ZIP_CODE\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.ZIP_CODE","example":"01803","type":"string"}},"type":"object"},"ASSIGNORS":{"properties":{"DATE_SIGNED":{"description":"\nThis field is of type date but will be serialized to type string.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNORS.DATE_SIGNED\nHierarchical name: US_REASSIGNMENTS.ASSIGNORS.DATE_SIGNED","example":"2016-05-20","format":"date","type":"string"},"NAME":{"description":"\n\nFlat name: _US_REASSIGNMENTS.ASSIGNORS.NAME\nHierarchical name: US_REASSIGNMENTS.ASSIGNORS.NAME","example":"\"MORGAN STANLEY SENIOR FUNDING, INC., AS ADMINISTRATIVE AGENT\",","type":"string"},"ORDINAL":{"description":"\n\nFlat name: _US_REASSIGNMENTS.ASSIGNORS.ORDINAL\nHierarchical name: US_REASSIGNMENTS.ASSIGNORS.ORDINAL","example":1,"type":"number"}},"type":"object"},"CONVEYANCE":{"description":"\n\nFlat name: _US_REASSIGNMENTS.CONVEYANCE\nHierarchical name: US_REASSIGNMENTS.CONVEYANCE","example":"\"PATENT RELEASE (REEL:018160/FRAME:0909)\",","type":"string"},"CORRESPONDENT_ADDRESS":{"description":"\n\nFlat name: _US_REASSIGNMENTS.CORRESPONDENT_ADDRESS\nHierarchical name: US_REASSIGNMENTS.CORRESPONDENT_ADDRESS","example":"\"4400 EASTON COMMONS WAY SUITE 125 COLUMBUS, OH 43219\",","type":"string"},"CORRESPONDENT_NAME":{"description":"\n\nFlat name: _US_REASSIGNMENTS.CORRESPONDENT_NAME\nHierarchical name: US_REASSIGNMENTS.CORRESPONDENT_NAME","example":"\"MICHAEL VIOLET\",","type":"string"},"DATE_RECORDED":{"description":"\nThis field is of type date but will be serialized to type string.\n\nFlat name: _US_REASSIGNMENTS.DATE_RECORDED\nHierarchical name: US_REASSIGNMENTS.DATE_RECORDED","example":"2016-05-20","format":"date","type":"string"},"PATENT_ORDINAL":{"description":"\n\nFlat name: _US_REASSIGNMENTS.PATENT_ORDINAL\nHierarchical name: US_REASSIGNMENTS.PATENT_ORDINAL","example":"\"2016-05-20\",","type":"number"},"REEL_FRAME":{"description":"\n\nFlat name: _US_REASSIGNMENTS.REEL_FRAME\nHierarchical name: US_REASSIGNMENTS.REEL_FRAME","example":"\"387700869\",","type":"string"}},"type":"object"}},"type":"object"},"type":"array"},"total_count":{"description":"Total number of results","type":"number"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Call to fetch one or more full patent documents by GUID, with possibile filters.","tags":["Patents"]}},"/patents/document/json/{document_guid}":{"get":{"description":"Call to fetch a full patent document by GUID.","operationId":"getPatentDocument","parameters":[{"description":"Unique ID of patent document to retrieve","in":"path","name":"document_guid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"APPLICATION_DATE":{"description":"The date (YYYY-MM-DD) an application was filed. This is not the same as the Publication Date, which is the date the application is finally published.\nThis field is of type date but will be serialized to type string.\n\nFlat name: APPLICATION_DATE\nHierarchical name: APPLICATION_DATE","example":"2012-11-21","format":"date","type":"string"},"APPLICATION_NUMBER":{"description":"A unique number assigned to an application when it is filed. This is not the same as the Publication Number, which is assigned when the application is published. For many authorities, the first four digits of the application number (following the country code) indicate the year the application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: APPLICATION_NUMBER\nHierarchical name: APPLICATION_NUMBER","example":"WO2012EP73219A","type":"string"},"APPLICATION_NUMBER_ORIGINAL":{"description":"\n\nFlat name: _APPLICATION_NUMBER_ORIGINAL\nHierarchical name: APPLICATION_NUMBER_ORIGINAL","type":"string"},"APPLICATION_REGISTRATION_OFFICE":{"description":"The country / region in which an application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: APPLICATION_REGISTRATION_OFFICE\nHierarchical name: APPLICATION_REGISTRATION_OFFICE","example":"EP","type":"string"},"ASSIGNEES_CURRENT_US":{"items":{"description":"Entity to which this patent is currently assigned (who owns the patent currently), based on US Reassignment data. For more information see [Assignee Current US](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#assignee-current_us)\n\nFlat name: ASSIGNEE_CURRENT_US\nHierarchical name: ASSIGNEES_CURRENT_US","example":"CONOPCO, INC., D/B/A UNILEVER","type":"string"},"type":"array"},"ASSIGNEES_ORIGINAL":{"items":{"description":"The legal person or entity who owned the patent property right at the time of grant. This may or may not be the inventor and is also known as the applicant by some authorities.\n\nFlat name: _ASSIGNEES_ORIGINAL\nHierarchical name: ASSIGNEES_ORIGINAL","properties":{"TYPE":{"description":"A single character representing the type of publication. I = Main invention publication;  T = Translation;  R = Reissued patent;  U = Utility Model;  S = Statutory Invention Publication;  P = NTIS Publication;  V = Trial Voluntary Protest Program.\n\nFlat name: ASSIGNEE_ORIGINAL_TYPE\nHierarchical name: ASSIGNEES_ORIGINAL.TYPE","example":"P","type":"string"}},"type":"object"},"type":"array"},"ASSIGNEE_NAMES":{"items":{"description":"The person or entity who owned/owns the patent. See [Optimized Assignee and Ultimate Parent](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/optimized_assignee.htm) on how we determine the owners.\nThis field will be normalized to uppercase.\n\nFlat name: ASSIGNEE_NAME\nHierarchical name: ASSIGNEE_NAMES","example":"GOOGLE INC.","type":"string"},"type":"array"},"AUTHOR_ABSTRACTS":{"items":{"description":"The front page abstracts as written by the author.\n\nFlat name: _AUTHOR_ABSTRACTS\nHierarchical name: AUTHOR_ABSTRACTS","example":"The French author's abstract text in xml","properties":{},"type":"object"},"type":"array"},"BACKWARD_CITATION":{"items":{"description":"\n\nFlat name: _BACKWARD_CITATION\nHierarchical name: BACKWARD_CITATION","properties":{},"type":"object"},"type":"array"},"CLAIMS":{"items":{"description":"Defines the boundaries of an invention, and therefore lays down what the patent does and does not cover.\n\nFlat name: _CLAIMS\nHierarchical name: CLAIMS","example":"1. A headgear apparatus I claim , wherein said eye shield member is adjustable with respect to said headband member.","properties":{},"type":"object"},"type":"array"},"CORRESPONDENTS":{"items":{"description":"The correspondent acting on behalf of the patent applicant.\n\nFlat name: _CORRESPONDENTS\nHierarchical name: CORRESPONDENTS","properties":{},"type":"object"},"type":"array"},"CPCS":{"items":{"description":"Cooperative Patent Classifications (CPC) are an extension of the IPC. They are divided into nine sections, A-H and Y presenting an identifier made up of letter and numbers, which in turn are sub-divided into classes, sub-classes, groups and sub-groups.\n\nFlat name: _CPCS\nHierarchical name: CPCS","properties":{},"type":"object"},"type":"array"},"CPCS_CURRENT":{"items":{"description":"These are the most recent CPC symbols and they overwrite/replace any earlier classifications. They can come from the Front Page or from the EPO (DocDB, through its weekly updates, or MCD quarterly update).  For more information see [CPC symbol](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#cpc)\nThis field will be normalized to uppercase.\n\nFlat name: CPC_CURRENT\nHierarchical name: CPCS_CURRENT","example":"G06N001000","type":"string"},"type":"array"},"DEAD_ALIVE_STATUS":{"description":"Patent and family status, dead (D) or alive (A) quickly shows you whether a patent or patent family is currently enforceable. Patent status uses a machine-learning algorithm to examine crucial patent data to determine the vitality status of a single patent or a patent family. The factors considered to predict patent status include: expiration date, legal status data, inherited status. If a record does not have an expiration date, filing date, and/or relevant legal status data, its status may be classified as Indeterminate (I). When a true/false is required, indeterminate should be considered as alive. [See the detailed process used to determine the status](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/pat_fam_status_doa.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DEAD_ALIVE_STATUS\nHierarchical name: DEAD_ALIVE_STATUS","example":"D","type":"string"},"DERWENT_BACKWARD_CITATION_COUNT":{"description":"Number of patents citing the DWPI family.\nThis field will be normalized to number.\n\nFlat name: DERWENT_BACKWARD_CITATION_COUNT\nHierarchical name: DERWENT_BACKWARD_CITATION_COUNT","example":15,"type":"number"},"DERWENT_FORWARD_CITATION_COUNT":{"description":"Number of patents cited by at least one member of the DWPI family.\nThis field will be normalized to number.\n\nFlat name: DERWENT_FORWARD_CITATION_COUNT\nHierarchical name: DERWENT_FORWARD_CITATION_COUNT","example":17,"type":"number"},"DESCRIPTIONS":{"items":{"description":"Part of a patent application or specification. Discloses the invention as claimed, specifies the technical field to which the invention relates and indicates any prior art the applicant is aware of.\n\nFlat name: _DESCRIPTIONS\nHierarchical name: DESCRIPTIONS","example":"characterised by ingredients other than fatty acid triglycerides","properties":{},"type":"object"},"type":"array"},"DESIGNATED_OFFICES":{"items":{"description":"The designated states are the countries/regions in which an invention is protected in addition to the country/region, in which the patent for the invention is filed. Filings under the PCT are identified by filing region XX. Other filing regions are EP (European Patent Office), EA (Eurasian Patent Organization), AP (African Regional IP Organization) or OA (African Intellectual Property Organization).\n\nFlat name: _DESIGNATED_OFFICES\nHierarchical name: DESIGNATED_OFFICES","properties":{},"type":"object"},"type":"array"},"DOCDB_SIMPLE_FAMILY_ID":{"description":"A unique identifier for the simple family (a patent family identified/defined by INPADOC using INPADOC methodology.\nThis field will be normalized to number.\n\nFlat name: DOCDB_SIMPLE_FAMILY_ID\nHierarchical name: DOCDB_SIMPLE_FAMILY_ID","example":7843694,"type":"number"},"DPCI_CITED_COUNTS":{"properties":{"ACCESSION_NUMBERS_TOTAL":{"description":"The number of unique Accession Numbers (showing the number of inventions) from the cited patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.ACCESSION_NUMBERS_TOTAL","example":3,"type":"number"},"AUTHORITIES_TOTAL":{"description":"The number of unique patenting authorities (country codes) from the cited patents from any citation source. This shows the number of distinct regions where the cited patents are originating from.\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_AUTHORITIES_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.AUTHORITIES_TOTAL","example":3,"type":"number"},"NON_PATENTS_TOTAL":{"description":"The number of unique articles from the cited non-patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_NON_PATENTS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.NON_PATENTS_TOTAL","example":8,"type":"number"},"PATENTS_TOTAL":{"description":"The number of unique patent numbers from the cited patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_PATENTS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.PATENTS_TOTAL","example":4,"type":"number"}},"type":"object"},"DPCI_CITED_NON_PATENTS":{"items":{"description":"Non-patent citation sources including abstracts and articles from scientific and technical literature.\n\nFlat name: _DPCI_CITED_NON_PATENTS\nHierarchical name: DPCI_CITED_NON_PATENTS","properties":{"DOC_ID":{"description":"A unique ID given to the non-patent article.\n\nFlat name: _DPCI_CITED_NON_PATENTS.DOC_ID\nHierarchical name: DPCI_CITED_NON_PATENTS.DOC_ID","example":"XP002220247","type":"string"},"MEMBERS":{"properties":{"FAMILY_MEMBER":{"description":"Patent number of  the family member where the non-patent citation originally populated from.\n\nFlat name: _DPCI_CITED_NON_PATENTS.MEMBERS.FAMILY_MEMBER\nHierarchical name: DPCI_CITED_NON_PATENTS.MEMBERS.FAMILY_MEMBER","example":"US8178699B2","type":"string"},"SOURCE":{"description":"Patent source of  the family member where the non-patent citation originally populated from.\n\nFlat name: _DPCI_CITED_NON_PATENTS.MEMBERS.SOURCE\nHierarchical name: DPCI_CITED_NON_PATENTS.MEMBERS.SOURCE","example":"1 (Applicant)","type":"string"}},"type":"object"},"TEXT":{"description":"A detailed description of the non-patent property rights.\n\nFlat name: _DPCI_CITED_NON_PATENTS.TEXT\nHierarchical name: DPCI_CITED_NON_PATENTS.TEXT","example":"J. C. LANCELOT ET AL.: A Facile Synthesis of New .beta.-Lactams, J. HETEROCYCL. CHEM., vol. 33, no. 2, 1996, pages 427 - 430, XP002220247,relevantClaims[1-5],relevantPassages[<compound>2</compound>]","type":"string"}},"type":"object"},"type":"array"},"DPCI_CITED_PATENTS":{"items":{"description":"Backward citing patents\n\nFlat name: _DPCI_CITED_PATENTS\nHierarchical name: DPCI_CITED_PATENTS","properties":{"APPLICATION_DATE":{"description":"Application date of the cited patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _DPCI_CITED_PATENTS.APPLICATION_DATE\nHierarchical name: DPCI_CITED_PATENTS.APPLICATION_DATE","example":"2004-08-06","format":"date","type":"string"},"DWPI_ACCESSION_NUMBER":{"description":"DWPI Accession Number of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_ACCESSION_NUMBER\nHierarchical name: DPCI_CITED_PATENTS.DWPI_ACCESSION_NUMBER","example":"2006120600","type":"string"},"DWPI_ASSIGNEES":{"items":{"description":"DWPI Assignee names and codes of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_ASSIGNEES\nHierarchical name: DPCI_CITED_PATENTS.DWPI_ASSIGNEES","properties":{"NAME":{"description":"DWPI Assignee names of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_ASSIGNEES.NAME\nHierarchical name: DPCI_CITED_PATENTS.DWPI_ASSIGNEES.NAME","example":"KRAFT FOODS HOLDINGS INC","type":"string"}},"type":"object"},"type":"array"},"DWPI_INVENTOR_NAMES":{"description":"DWPI Inventor names of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_INVENTOR_NAMES\nHierarchical name: DPCI_CITED_PATENTS.DWPI_INVENTOR_NAMES","example":"ALMENDAREZ M E|BUDZIK P J|BUDZIK P J H|JACKSON L K|LUDWIG C J|SHAH M","type":"string"},"DWPI_TITLE":{"description":"DWPI Title of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.DWPI_TITLE\nHierarchical name: DPCI_CITED_PATENTS.DWPI_TITLE","example":"Mustard bran granulation process to form granulated mustard bran useful in food products e.g. barbecue sauce, involves introducing compressed heated air in cyclonic enclosure to form a vortex; and introducing mustard bran in the enclosure","type":"string"},"EARLIEST_PRIORITY_DATE":{"description":"Earliest priority date of the cited patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _DPCI_CITED_PATENTS.EARLIEST_PRIORITY_DATE\nHierarchical name: DPCI_CITED_PATENTS.EARLIEST_PRIORITY_DATE","example":"2004-08-06","format":"date","type":"string"},"MEMBERS":{"properties":{"RELEVANCE_CATEGORY":{"description":"Examiner-applied relevance codes of  the family member where the patent citation originally populated from.\n\nFlat name: _DPCI_CITED_PATENTS.MEMBERS.RELEVANCE_CATEGORY\nHierarchical name: DPCI_CITED_PATENTS.MEMBERS.RELEVANCE_CATEGORY","example":"A","type":"string"},"SOURCE":{"description":"Patent source of  the family member where the patent citation originally populated from.\n\nFlat name: _DPCI_CITED_PATENTS.MEMBERS.SOURCE\nHierarchical name: DPCI_CITED_PATENTS.MEMBERS.SOURCE","example":"1 (Applicant)","type":"string"}},"type":"object"},"PUBLICATION_DATE":{"description":"Publication date of the cited patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _DPCI_CITED_PATENTS.PUBLICATION_DATE\nHierarchical name: DPCI_CITED_PATENTS.PUBLICATION_DATE","example":"2006-02-09","format":"date","type":"string"},"PUBLICATION_NUMBER":{"description":"Publication number of the cited patent.\n\nFlat name: _DPCI_CITED_PATENTS.PUBLICATION_NUMBER\nHierarchical name: DPCI_CITED_PATENTS.PUBLICATION_NUMBER","example":"\"US20060029703A1","type":"string"}},"type":"object"},"type":"array"},"DPCI_CITING_COUNTS":{"properties":{"ACCESSION_NUMBERS_TOTAL":{"description":"The number of unique Accession Numbers (showing the number of inventions) from the citing patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.ACCESSION_NUMBERS_TOTAL","example":3,"type":"number"},"AUTHORITIES_TOTAL":{"description":"The number of unique patenting authorities (country codes) from the citing patents from any citation source. This shows the number of distinct regions where the citing patents are originating from.\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_AUTHORITIES_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.AUTHORITIES_TOTAL","example":2,"type":"number"},"PATENTS_TOTAL":{"description":"The number of unique patent numbers from the citing patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_PATENTS_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.PATENTS_TOTAL","example":4,"type":"number"}},"type":"object"},"DPCI_CITING_PATENTS":{"items":{"description":"Forward citing patents.\n\nFlat name: _DPCI_CITING_PATENTS\nHierarchical name: DPCI_CITING_PATENTS","properties":{"DWPI_ASSIGNEES":{"items":{"description":"DWPI Assignee names and codes of the citing patent.\n\nFlat name: _DPCI_CITING_PATENTS.DWPI_ASSIGNEES\nHierarchical name: DPCI_CITING_PATENTS.DWPI_ASSIGNEES","properties":{},"type":"object"},"type":"array"},"MEMBERS":{"properties":{"SOURCE":{"description":"Patent source of  the family member where the patent citation originally populated from.\n\nFlat name: _DPCI_CITING_PATENTS.MEMBERS.SOURCE\nHierarchical name: DPCI_CITING_PATENTS.MEMBERS.SOURCE","example":"1 (Applicant)","type":"string"}},"type":"object"},"PUBLICATION_DATE":{"description":"Publication date of the citing patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _DPCI_CITING_PATENTS.PUBLICATION_DATE\nHierarchical name: DPCI_CITING_PATENTS.PUBLICATION_DATE","example":"2018-05-29","format":"date","type":"string"}},"type":"object"},"type":"array"},"DWPI_ABSTRACT":{"description":"Enhanced abstract curated by the DWPI editorial technology experts. For more information see [DWPI-Abstract] (https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#abstract_dwpi)\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _DWPI_ABSTRACT\nHierarchical name: DWPI_ABSTRACT","example":{"value":"A method of diagnosing and treating systemic Human Papilloma Virus (HPV) in particular \\\"viral colonies\\\" is disclosed. This method involves covering the skin of the feet and legs of a suspected infected human with topical applications selected from povidine iodine, potassium permanganate, aspirin, salicylic acid, natural salicin, lactic acid, alcohol, ether and any combination or mixture of them, and detecting \\\"HPV colony centres\\\" or lesions. The method of treatment of the detected HPV colony centres on the infected human includes topically administering any combination, mixture or percentage of aspirin, salicylic acid, natural salicin, paracetamol, phenacetin, whole natural grapefruit, povidine iodine and alcohol. These ingredients may be pureed, crushed, powered and or dissolved in water or grapefruit puree/juice, iodine or alcohol. The method optionally may contain the following further steps: a) initial intestinal cleansing with grapefruit seed extract(GSE) and /or Epsom salts, b) stretching and exercising the core infected area, c) i)treatment of the core infected area with firstly a topical treatment of any combination mixture or percentage of pureed whole potato and /or aloe vera stems mixed with either aspirin, salicylic acid, natural salicin, paracetamol, phenacetin, podivine iodine, alcohol, and/or epsom salts, then the core infected area is wrapped tightly in a sealed layer of plastic sheeting, and ii) secondly treating with another and final topical application consisting of any combinations, mixes and percentages of powdered Tobacco/nicotine, paracetamol, alcohol, Epsom salts, phenacetin, salicylic acid, salicin and/or aspirin. The method is supported or underpinned by a healthy lifestyle, a specified restrictive diet which avoids sugars and wheat products and certain vegetables and restricts the type and amounts of carbohydrates, a regime of daily specified supplements including salt, kelp, GSE, vitamin C, cod liver oil and Epsom salts and daily unprotected exposure to the sun.\""},"properties":{"NOVELTY":{"description":"Describes the unique inventive features introduced by the inventor which is not conventional and an improvement on existing technology.\n\nFlat name: _DWPI_ABSTRACT.NOVELTY\nHierarchical name: DWPI_ABSTRACT.NOVELTY","example":"The vent cover (20) comprises a peripheral wall (22) defining a boundary, and a cover plate extending between edges of the peripheral wall. A vent aperture (26) is arranged in the cover plate adjacent to a recess (28). A grate (30) extends from a rear side of the plate. A drain attachment is arranged above the grate on the rear side, and has a C-shaped cross-section.","type":"string"}},"type":"object"},"DWPI_ABSTRACT_EXT":{"description":"Additional patent details about chemical or pharmaceutical patents. Examples include experimental details, drug administration, or lists of specific compounds used. For more information see [Abastract-Extension-DWPI](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#abx)\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _DWPI_ABSTRACT_EXT\nHierarchical name: DWPI_ABSTRACT_EXT","properties":{"ADMINISTRATION":{"description":"Provides details of dosages and methods of administration for pharmaceutical/ veterinary patents, or application rates and methods in agrochemical patents.\n\nFlat name: _DWPI_ABSTRACT_EXT.ADMINISTRATION\nHierarchical name: DWPI_ABSTRACT_EXT.ADMINISTRATION","example":"Dosage is 0.01-50 mg/kg, preferably 0.05-10 mg/kg. Administration can be through subcutaneous, intraperitoneal, intravenous, intramuscular, oral, pulmonary, suppository, and transdermal route.","type":"string"},"DEFINITION":{"description":"Covers the Markush chemical formula definitions from the main and other independent claims if their inclusion in the Detailed Description field causes the field character limits to be exceeded. It also covers the narrower Markush formulae definitions given in the Dependent Claims.\n\nFlat name: _DWPI_ABSTRACT_EXT.DEFINITION\nHierarchical name: DWPI_ABSTRACT_EXT.DEFINITION","example":"Full Definition: Fossil fuels includes waste plastics such as polyolefins and other combustible solid and semi-solid wastes are pre-treated with non-toxic auxiliary materials, mixed, molded, and then stacked in stoves that are limited to non-mandatory combustion uses, and molded fuel static","type":"string"},"DOCUMENTATION":{"description":"DWPI abstract data from 1994 to 1998. Includes the complete text from the DWPI Abstract, and includes a number of possible section headings. For more information see [DWDOC](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#abstract_dwpi)\n\nFlat name: _DWPI_ABSTRACT_EXT.DOCUMENTATION\nHierarchical name: DWPI_ABSTRACT_EXT.DOCUMENTATION","example":"USE The process is useful for releasing salmon eggs, anise, blood, dairy products, molluscs, fish or crustacean parts or other materials that will attract when dispersed as particulates in water. ADVANTAGE The dried fish attracting powder coating the lure dissolves slowly to release the attractant. EXAMPLE The volume ratio of powdered mix (the attractant and carrier) to the blend of adhesive and gel-forming component was 1:1-20.","type":"string"},"EXAMPLE":{"description":"A summary of a full patent example which provides experimental data in support of the claimed invention, or details about how the invention is carried out in practice.\n\nFlat name: _DWPI_ABSTRACT_EXT.EXAMPLE\nHierarchical name: DWPI_ABSTRACT_EXT.EXAMPLE","example":"A dietary supplement comprising (g): purified water (19.29), ascorbyl palmitate (0.2), sorbic acid (0.16), sucrose (25), glycerin (5), xanthan gum (0.3), concentrated borage oil (40% γ-linolenic acid) (20), concentrated marine oil (33% eicosapentaenoic acid) (15), flavor (orange/peach) (15) and colorant (orange) (0.05) was prepared.","type":"string"},"PRIOR_ART":{"description":"This field usually does not contain information and is not currently populated.\n\nFlat name: _DWPI_ABSTRACT_EXT.PRIOR_ART\nHierarchical name: DWPI_ABSTRACT_EXT.PRIOR_ART","example":"When electronic apparatuses using a tin-lead solder are disposed of as general industrial wastes and exposed to the atmospheric environment, a lead component in the solder elutes to give adverse effects to human bodies; this has accelerated the development of a tin-zinc unleaded solder.","type":"string"},"SPECIFIC_COMPOUND":{"description":"Specific substances which relate to, or exemplify, the novel features of the invention.\n\nFlat name: _DWPI_ABSTRACT_EXT.SPECIFIC_COMPOUND\nHierarchical name: DWPI_ABSTRACT_EXT.SPECIFIC_COMPOUND","example":"SPECIFIC SEQUENCES- Specifically claimed is stress-phosphorylated endoplasmic reticulum protein, Nogo B, comprising 373 amino acids (SEQ ID NO. 2), and encoded by a nucleic acid comprising 2240 bp (SEQ ID NO. 1). All sequences are fully defined in the specification.","type":"string"},"WIDER_DISCLOSURE":{"description":"Identifies areas where the scope and/or novelty of the invention, as defined in the body of the specification, is broader than that of the main independent claim(s).\n\nFlat name: _DWPI_ABSTRACT_EXT.WIDER_DISCLOSURE\nHierarchical name: DWPI_ABSTRACT_EXT.WIDER_DISCLOSURE","example":"Also disclosed are: antibodies, including monoclonal and polyclonal antibodies, that recognize all or part of the Nogo protein; a method of identifying the Nogo proteins using the antibodies; a method of identifying or quantifying expression products of the gene encoding the Nogo of the invention; a method of detecting cell stress, where the phosphorylation of the protein of the invention is detected or measured;","type":"string"}},"type":"object"},"DWPI_ACCESSION_NUMBER":{"description":"The DWPI Primary Accession number (also known as PAN) is a unique identifier for the whole DWPI family representing a single invention. The first four digits represent the year the record was created. DWPI has a strict family definition in which each member shares exact priorities (except for non-convention equivalents) with each and every other family member. INPADOC, in contrast, has a very broad family definition that includes divisions, continuations and continuations in part. All that is needed is a shared priority of any one member to another.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_ACCESSION_NUMBER\nHierarchical name: DWPI_ACCESSION_NUMBER","example":"2018741525","type":"string"},"DWPI_APPLICATION_NUMBER_BASIC":{"description":"The application number of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_APPLICATION_NUMBER_BASIC\nHierarchical name: DWPI_APPLICATION_NUMBER_BASIC","example":"WO2012EP73219A","type":"string"},"DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC":{"description":"Country code that is part of the application number of the basic publication for a given DWPI family and represents the first instance of the invention ex. (US).\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC\nHierarchical name: DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","example":"EP","type":"string"},"DWPI_ASSIGNEES":{"items":{"description":"Standardized version of the assignee/applicant, as assigned during the review performed by DWPI editors. This standardized version is matched to our database of assignees to ensure that names are applied consistently.\n\nFlat name: _DWPI_ASSIGNEES\nHierarchical name: DWPI_ASSIGNEES","properties":{},"type":"object"},"type":"array"},"DWPI_CLASSES":{"items":{"description":"The DWPI collection categorizes patent documents using two classification systems, [DWPI Class](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields/details/DWPI_Class_Details.htm) and DWPI Manual Codes. Subject specialists consistently apply these unique classification systems to the DWPI patent documents. DWPI Class is a broad, simple system, whereas DWPI Manual Codes are more detailed and granular. Both DWPI Class and DWPI Manual Codes cover all technologies within 20 subject areas, identified by Section letters A-X which are grouped into three broad categories for Chemistry, Engineering and Electronics.\n\nFlat name: _DWPI_CLASSES\nHierarchical name: DWPI_CLASSES","properties":{},"type":"object"},"type":"array"},"DWPI_DESIGNATED_OFFICE_COUNT":{"description":"The number of countries/regions within which protection of the DWPI family members was sought.\nThis field will be normalized to number.\n\nFlat name: DWPI_DESIGNATED_OFFICE_COUNT\nHierarchical name: DWPI_DESIGNATED_OFFICE_COUNT","example":117,"type":"number"},"DWPI_EARLIEST_PRIORITY_DATE":{"description":"The earliest date for the DWPI family when the priority application was filed.\nThis field is of type date but will be serialized to type string.\n\nFlat name: DWPI_EARLIEST_PRIORITY_DATE\nHierarchical name: DWPI_EARLIEST_PRIORITY_DATE","example":"2017-04-21","format":"date","type":"string"},"DWPI_FAMILY_MEMBER_COUNT":{"description":"The number of DWPI family members within a given family.\nThis field will be normalized to number.\n\nFlat name: DWPI_FAMILY_MEMBER_COUNT\nHierarchical name: DWPI_FAMILY_MEMBER_COUNT","example":13,"type":"number"},"DWPI_FAMILY_STATUS":{"description":"DWPI Family status, dead (D) or alive (A) quickly shows you whether a DWPI patent family is currently enforceable. Patent status uses a machine-learning algorithm to examine crucial patent data to determine the vitality status of a single patent or a patent family. The factors considered to predict patent status include: expiration date, legal status data, inherited status. If a record does not have an expiration date, filing date, and/or relevant legal status data, its status may be classified as Indeterminate (I). A DWPI Family remains alive as long as at least one patent in the family is still active. When a true/false is required, indeterminate should be considered as alive. [See the detailed process used to determine the status](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/pat_fam_status_doa.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_FAMILY_STATUS\nHierarchical name: DWPI_FAMILY_STATUS","example":"D","type":"string"},"DWPI_INVENTORS":{"items":{"description":"The DWPI Inventor information within a patent record.\n\nFlat name: _DWPI_INVENTORS\nHierarchical name: DWPI_INVENTORS","properties":{},"type":"object"},"type":"array"},"DWPI_KIND_CODE_BASIC":{"description":"Indicates the version or level of a patent document, also known as publication stage. See the list of [DWPI Kind Codes](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/dwpi_kinds.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_KIND_CODE_BASIC\nHierarchical name: DWPI_KIND_CODE_BASIC","example":"A1","type":"string"},"DWPI_MANUAL_CODES":{"items":{"description":"A hierarchical indexing system to index the inventive and significant aspects of an invention, plus its commercial applications. The [DWPI Manual Codes](https://clarivate.com/derwent/dwpi-reference-center/dwpi-manual-code/) are consistently applied by specialist teams and divided into 20 technology sections.\n\nFlat name: _DWPI_MANUAL_CODES\nHierarchical name: DWPI_MANUAL_CODES","properties":{},"type":"object"},"type":"array"},"DWPI_PUBLICATION_NUMBER_BASIC":{"description":"The publication number of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_PUBLICATION_NUMBER_BASIC\nHierarchical name: DWPI_PUBLICATION_NUMBER_BASIC","example":"WO2018169585A1","type":"string"},"DWPI_REGISTRATION_OFFICE_BASIC":{"description":"The registration office code (country code) of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_REGISTRATION_OFFICE_BASIC\nHierarchical name: DWPI_REGISTRATION_OFFICE_BASIC","example":"WO","type":"string"},"DWPI_TITLE":{"description":"Provides more information than the original patent title, written specifically to enable easy review of large lists of records and covers brief details of the scope, use and novelty of the invention. For more information see [Derwent World Patents Index](https://support.clarivate.com/Patents/s/article/Derwent-World-Patents-Index-Derwent-value-added-information?language=en_US)\nThis field will be normalized to mixed-case.\n\nFlat name: DWPI_TITLE\nHierarchical name: DWPI_TITLE","example":"Stacked quantum computing device, includes shielding layer which covers dielectric layer which covers control wire on dielectric substrate of second chip","type":"string"},"DWPI_UPDATE":{"description":"This is a unique identification number assigned to each DWPI database update and comprises a 4-digit year followed by a 2-digit serial number (for updates before 1 Jan. 2020) or a 3-digit serial number (for updates on or after 1 Jan. 2020). The 4-digit year and 2- or 3-digit serial number the  represent the year of the update and the number of the update, respectively.\nThis field will be normalized to number.\n\nFlat name: DWPI_UPDATE\nHierarchical name: DWPI_UPDATE","example":2021045,"type":"number"},"DWPI_UPDATE_BASIC":{"description":"The DWPI update number for the first member of the patent family. Find out more about the  [DWPI Data](https://www.derwentinnovation.com/tip-innovation/support/help/dwpi.htm).\nThis field will be normalized to number.\n\nFlat name: DWPI_UPDATE_BASIC\nHierarchical name: DWPI_UPDATE_BASIC","example":199945,"type":"number"},"DW_KEYWORDS":{"items":{"description":"Derwent Manual Code keywords list (multi-valued).\n\nFlat name: DW_KEYWORDS\nHierarchical name: DW_KEYWORDS","type":"string"},"type":"array"},"EARLIEST_PRIORITY_COUNTRY":{"description":"The earliest data of all the priority countries/regions on the record.\nThis field will be normalized to uppercase.\n\nFlat name: EARLIEST_PRIORITY_COUNTRY\nHierarchical name: EARLIEST_PRIORITY_COUNTRY","example":"US","type":"string"},"EARLIEST_PRIORITY_DATE":{"description":"The earliest data of all the priority dates on the record.\nThis field is of type date but will be serialized to type string.\n\nFlat name: EARLIEST_PRIORITY_DATE\nHierarchical name: EARLIEST_PRIORITY_DATE","example":"2017-03-13","format":"date","type":"string"},"EARLIEST_PRIORITY_NUMBER":{"description":"The earliest data of all the priority numbers on the record.\nThis field will be normalized to uppercase.\n\nFlat name: EARLIEST_PRIORITY_NUMBER\nHierarchical name: EARLIEST_PRIORITY_NUMBER","example":"US62470694P","type":"string"},"EARLIEST_PRIORITY_YEAR":{"description":"The earliest data of all the priority years on the record.\nThis field will be normalized to number.\n\nFlat name: EARLIEST_PRIORITY_YEAR\nHierarchical name: EARLIEST_PRIORITY_YEAR","example":2011,"type":"number"},"ESTIMATED_EXPIRATION":{"description":"Estimated expiration information.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _ESTIMATED_EXPIRATION\nHierarchical name: ESTIMATED_EXPIRATION","properties":{},"type":"object"},"EXAMINERS":{"description":"The examiner(s) at the patent office who examined the patent.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _EXAMINERS\nHierarchical name: EXAMINERS","properties":{},"type":"object"},"FIRST_CLAIM":{"description":"Defines the boundaries first instance of an invention, and therefore lays down what the patent does and does not cover.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _FIRST_CLAIM\nHierarchical name: FIRST_CLAIM","example":{"value":"\"en\":\"<tsip:claimTsxm xmlns=\\\"http://schemas.thomson.com/ts/20041221/tsxm\\\" xmlns:tsip=\\\"http://schemas.thomson.com/ts/20041221/tsip\\\" tsip:no=\\\"1\\\" tsip:type=\\\"main\\\" id=\\\"cl0001\\\" num=\\\"0001\\\">1. A mould opening mechanism, comprising a static panel (4), stripper plate (6), A plate (7), plate B (8) and locating rod (5), a stripper plate (6) is connected with the A plate (7) are fixed together; plastic waste between the static panel (4) and between the stripper plate (6), plastic product located between plate A (7) and the B plate (8), a fixed panel (4) and stripper plate (6) through a locating pull rod (5) to adjust the separation distance between the two and ensure that both without departing from. wherein it further comprises a static mould opening-closing driving block (1), a movable mould inverted hook block (3) and a reverse hook (2), the static mould opening-closing driving block (1) and the static panel (4) are fixedly connected; the movable mould inverted hook block (3) and the B plate (8) is fixedly connected with the static mould opening-closing driving block (1) and the movable mould inverted hook block (3) located on the same side of the mould; the inverted hook (2) of the inner space between the stripper plate (6) and the A plate (7) to move. pulling the inverted hook (2) on the movable mould inverted hook block (3) in the process of moving downwards inverted hook block by the movable mould (3) and the static mould opening-closing driving block (1) and pressed and retracted inside space ensured in panel (4) and the stripper plate (6) of the separating plate A (7) and B plate (8) for separating, the static mould opening-closing driving block (1) is inverted \\\" L \\\" - shaped structure, the upper part and the static panel (4) is fixedly connected with the inner side of the lower end is provided with a bump structure; the bump structure is provided with a first wedge surface (11); the movable mould inverted hook block (3) is L-shaped structure, and the lower part and the B plate (8) is fixedly connected with the inner side of the upper end is provided with a barb (31) form space M; the inverted hook (2) is set on the A plate (7) sliding in slide left and right along the chute, the inverse hook mechanism (2) comprises a reversed hook the small sliding block (21) and a spring (23), the spring (23) is set on the bottom of the A plate (7) of the chute. said converse hook small slide block (21) and one end of the spring (23) is connected, the other end of the inverted hook of the slide block (21) is provided with a second oblique wedge surface (211), B plate (8) and a movable mould inverted hook block (3) moves upwards; A plate (7) and the B plate (8) firstly assembling mould and drives the plate A (7) and stripper plate (6) continues to move upwards, the inversed hooks are small slide block (21) by a spring (23) to reset force side do pop-up movement to the left, the inversed hooks are small sliding block (21) enters the space M of the moving die inverted hook block (3); the B plate (8) and the movable mould inverted hook block (3) continues to move upwards to finish the static panel (4) and the stripper plate (6), the locating pull rod (5) passes through the panel (4) is stepped hole (41) and the stripper plate (6), said plate A (7) are fixedly connected together; the locating pull rod (5) can move up and down along the step hole (41); the inverted hook (2) further comprises a limiting pin (22); the limiting pin (22) passes through the stripper plate (6) is inserted in the small barb sliding block (21) on the upper surface of the long groove (212).</tsip:claimTsxm>\",_x000D_\n_x000D_\n                 \"ZH\":\"<tsip:claimTsxm xmlns=\\\"http://schemas.thomson.com/ts/20041221/tsxm\\\" xmlns:tsip=\\\"http://schemas.thomson.com/ts/20041221/tsip\\\" id=\\\"cl0001\\\" num=\\\"0001\\\" tsip:no=\\\"1\\\" tsip:type=\\\"main\\\">1.一种三板模具开模机构，包括静模面板（4）、脱料板（6）、A板（7）、B板（8）和定位拉杆（5），脱料板（6）与A板（7）固定在一起，塑料废料位于静模面板（4）和脱料板（6）之间，塑料成品位于A板（7）和B板（8）之间，静模面板（4）和脱料板（6）通过定位拉杆（5）调节两者之间的分离距离并确保两者_x000D_\n不脱离，其特征在于：还包括静模开模驱动块（1）、动模倒钩拉块（3）和倒勾机构（2），所述静模开模驱动块（1）与所述静模面板（4）固定连接，所述动模倒钩拉块（3）与所述B板（8）固定连接，所述静模开_x000D_\n模驱动块（1）和所述动模倒钩拉块（3）位于模具的同一侧；所述倒勾机构（2）在所述脱料板（6）和所述A板（7）之间的内侧空间中移动，所述倒勾机构（2）在动模倒钩拉块（3）向下移动过程中受到所述动模倒_x000D_\n钩拉块（3）和所述静模开模驱动块（1）的拉动和挤压并缩进内侧空间中确保静模面板（4）与脱料板（6）的分离先于A板（7）和B板（8）的分离；   <br type=\\\"required\\\"/>所述静模开模驱动块（1）是倒“L” 状结构，其上部和所述静模面板（4）固定连接，其下端内侧设置有突起结构，所述突起结构上设置有第一斜楔面（11）；   <br type=\\\"required\\\"/>所述动模倒钩拉块（3）是“L”状结构，其下部和所述B板（8）固定连接，其上端内侧设置有一倒钩（31）形成倒扣空间M；   <br type=\\\"required\\\"/>所述倒勾机构（2）设置在所述A板（7）上的滑槽内沿所述滑槽左右滑动，所述倒勾机构（2）包括倒勾小滑块（21）和弹簧(23)，所述弹簧(23)设置在所述A板（7）上的滑槽的底部，所述倒勾小滑块（21）的一端和所述弹簧(23)连接，所述倒勾小滑块（21）的另一端设置有第二斜楔面（211）；   <br type=\\\"required\\\"/>合模时，B板（8）和动模倒钩拉块（3）向上移动，B板（8）和A板（7）先合模并带动A板（7）和脱料板（6）继续向上移动，倒勾小滑块（21）受弹簧（23）复位力向左边做弹出运动，倒勾小滑块（21）外端进入动模倒钩拉块（3）的倒扣空间M，B板（8）和动模倒钩拉块（3）继续向上移动完成静模面板（4）与脱料板（6）的合模；   <br type=\\\"required\\\"/>所述定位拉杆（5）穿过所述静模面板（4）上的阶梯孔（41）和所述脱料板（6）、所述A板（7）固连在一起，所述定位拉杆（5）可沿着所述阶梯孔（41）上下移动；   <br type=\\\"required\\\"/>所述倒勾机构（2）还包括限位销（22），所述限位销（22）穿过所述脱料板（6）插在所述倒勾小滑块（21）上表面的长形凹槽（212）内。</tsip:claimTsxm>\""},"properties":{},"type":"object"},"FORWARD_CITATION":{"items":{"description":"\n\nFlat name: _FORWARD_CITATION\nHierarchical name: FORWARD_CITATION","properties":{"ASSIGNEE":{"description":"\n\nFlat name: _FORWARD_CITATION.ASSIGNEE\nHierarchical name: FORWARD_CITATION.ASSIGNEE","type":"string"},"DWPI_ACCESSION_NUMBER":{"description":"\n\nFlat name: _FORWARD_CITATION.DWPI_ACCESSION_NUMBER\nHierarchical name: FORWARD_CITATION.DWPI_ACCESSION_NUMBER","type":"string"},"DWPI_ASSIGNEES":{"items":{"description":"\n\nFlat name: _FORWARD_CITATION.DWPI_ASSIGNEES\nHierarchical name: FORWARD_CITATION.DWPI_ASSIGNEES","properties":{"CODE":{"description":"\n\nFlat name: _FORWARD_CITATION.DWPI_ASSIGNEES.CODE\nHierarchical name: FORWARD_CITATION.DWPI_ASSIGNEES.CODE","type":"string"},"NAME":{"description":"\n\nFlat name: _FORWARD_CITATION.DWPI_ASSIGNEES.NAME\nHierarchical name: FORWARD_CITATION.DWPI_ASSIGNEES.NAME","type":"string"}},"type":"object"},"type":"array"},"INVENTOR":{"description":"\n\nFlat name: _FORWARD_CITATION.INVENTOR\nHierarchical name: FORWARD_CITATION.INVENTOR","type":"string"},"KIND_CODE":{"description":"\n\nFlat name: _FORWARD_CITATION.KIND_CODE\nHierarchical name: FORWARD_CITATION.KIND_CODE","type":"string"},"MEMBERS":{"properties":{"RELEVANCE_CATEGORY":{"description":"\n\nFlat name: _FORWARD_CITATION.MEMBERS.RELEVANCE_CATEGORY\nHierarchical name: FORWARD_CITATION.MEMBERS.RELEVANCE_CATEGORY","type":"string"}},"type":"object"},"PUBLICATION_DATE":{"description":"\nThis field is of type date but will be serialized to type string.\n\nFlat name: _FORWARD_CITATION.PUBLICATION_DATE\nHierarchical name: FORWARD_CITATION.PUBLICATION_DATE","format":"date","type":"string"},"PUBLICATION_NUMBER":{"description":"\n\nFlat name: _FORWARD_CITATION.PUBLICATION_NUMBER\nHierarchical name: FORWARD_CITATION.PUBLICATION_NUMBER","type":"string"}},"type":"object"},"type":"array"},"FORWARD_CITATIONS":{"properties":{"MEMBERS":{"properties":{"SOURCE":{"description":"\n\nFlat name: _FORWARD_CITATIONS.MEMBERS.SOURCE\nHierarchical name: FORWARD_CITATIONS.MEMBERS.SOURCE","type":"string"}},"type":"object"}},"type":"object"},"GRANTED":{"description":"A flag  indicating whether the document is granted. Once a patent is granted, the patent holder has been granted the right to restrict others from using, making, selling, and importing his invention without his express permission.\nThis field will be normalized to boolean.\n\nFlat name: GRANTED\nHierarchical name: GRANTED","example":true,"type":"boolean"},"GRANT_DATE":{"description":"The date (YYYY-MM-DD) on which the patent office grants the patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: GRANT_DATE\nHierarchical name: GRANT_DATE","example":"2017-04-17","format":"date","type":"string"},"GUID":{"description":"A unique document identifier for this particular publication.\nThis field will be normalized to uppercase.\n\nFlat name: DOCUMENT_GUID\nHierarchical name: GUID","example":"WO2021243294A120211202","type":"string"},"INDEPENDENT_CLAIMS":{"items":{"description":"A claim on a patent record that is determined to not rely on any other claims in the patent.\n\nFlat name: _INDEPENDENT_CLAIMS\nHierarchical name: INDEPENDENT_CLAIMS","properties":{"INDEX":{"description":"Number representing which one of a set of claims this one is - i.e. whether it is the first, second, etc.\n\nFlat name: _INDEPENDENT_CLAIMS.INDEX\nHierarchical name: INDEPENDENT_CLAIMS.INDEX","example":"1","type":"string"},"LANGUAGE":{"description":"The publication language of this claim.\n\nFlat name: _INDEPENDENT_CLAIMS.LANGUAGE\nHierarchical name: INDEPENDENT_CLAIMS.LANGUAGE","example":"en","type":"string"},"SOURCE":{"description":"Indicator showing the origin of the data.\n\nFlat name: _INDEPENDENT_CLAIMS.SOURCE\nHierarchical name: INDEPENDENT_CLAIMS.SOURCE","example":"ORIG","type":"string"},"XML":{"description":"Text in the patent about the subject matter and scope of the invention.\n\nFlat name: _INDEPENDENT_CLAIMS.XML\nHierarchical name: INDEPENDENT_CLAIMS.XML","example":"1. A single channel photoelectric detector with offset zero and continuously adjustable gain, wherein it comprises power supply voltage stabilizing circuit, a photoelectric conversion circuit, an active filter circuit, an adjustable gain circuit, bias voltage zeroing circuit. BNC joint (J), the power supply voltage stabilizing circuit comprises a first voltage regulator (U1), the second voltage (U2), a first capacitor","type":"string"}},"type":"object"},"type":"array"},"INPADOC_FAMILY":{"items":{"description":"\n\nFlat name: _INPADOC_FAMILY\nHierarchical name: INPADOC_FAMILY","properties":{"PUBLICATION_DATE":{"description":"\nThis field is of type date but will be serialized to type string.\n\nFlat name: _INPADOC_FAMILY.PUBLICATION_DATE\nHierarchical name: INPADOC_FAMILY.PUBLICATION_DATE","format":"date","type":"string"}},"type":"object"},"type":"array"},"INPADOC_FAMILY_ID":{"description":"Internal unique identifier for the Inpadoc family\n\nFlat name: _INPADOC_FAMILY_ID\nHierarchical name: INPADOC_FAMILY_ID","example":"20131211EP2671741A1","type":"string"},"INPADOC_FAMILY_STATUS":{"description":"Dead (D) / Alive (A) status of the Inpadoc family quickly shows whether an INPADOC Patent Family is currently enforceable. If a record does not have relevant legal status data, its status may be classified as Indeterminate (I) or None (N). An INPADOC Family remains alive as long as at least one patent in the family is still active\nThis field will be normalized to uppercase.\n\nFlat name: INPADOC_FAMILY_STATUS\nHierarchical name: INPADOC_FAMILY_STATUS","example":"D","type":"string"},"INPADOC_LEGAL_STATUS_EVENTS":{"items":{"description":"The entries made or procedural steps or events taken during the patent-granting process and throughout the lifetime of the patent.\nThis field will be normalized to can there be multiple ones?.\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS","properties":{"CODE":{"description":"INPADOC Legal Status Codes (LSC) and their meanings are country/region-specific\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS.CODE\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS.CODE","example":"REG","type":"string"},"DESCRIPTION":{"description":"Detailed text description of the code.\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS.DESCRIPTION\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS.DESCRIPTION","example":"REFERENCE TO NATIONAL CODE DE 8642 PROCEDURE RELATING TO PCT APPLICATION: CEASED TO HAVE EFFECT FOR DE","type":"string"},"GAZETTE_DATE":{"description":"The date which the status was officially published.\nThis field is of type date but will be serialized to type string.\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS.GAZETTE_DATE\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS.GAZETTE_DATE","example":"2004-04-22","format":"date","type":"string"},"IMPACT":{"description":"INPADOC Legal Status Impact (LSI) indicates whether a legal status change has a positive (+), negative (-), or neutral (no symbol) impact on a patent.\n\nFlat name: _INPADOC_LEGAL_STATUS_EVENTS.IMPACT\nHierarchical name: INPADOC_LEGAL_STATUS_EVENTS.IMPACT","example":"-","type":"string"}},"type":"object"},"type":"array"},"INVENTORS":{"items":{"description":"The inventor information on a patent or application.\n\nFlat name: _INVENTORS\nHierarchical name: INVENTORS","properties":{},"type":"object"},"type":"array"},"IPCS":{"items":{"description":"International patent classifications (IPC or IC) are Classification symbols or codes that can be allotted to patent documents. IPC classification symbols are made up of a letter denoting the IPC section (ex. A), followed by a number (two digits) denoting the IPC class (ex. A63), then a letter denoting the IPC subclass (ex. A63B). A number (variable, 1-4 digits) denotes the IPC main group (ex. A63B49).\n\nFlat name: _IPCS\nHierarchical name: IPCS","properties":{},"type":"object"},"type":"array"},"IPCS_CURRENT":{"items":{"description":"The most recent IPC classifications. They overwrite/replace any earlier classifications. They can come from Front Page or EPO (DocDB, through its weekly updates, or MCD quarterly update). For more information see [IPC classification]§\nThis field will be normalized to uppercase.\n\nFlat name: IPC_CURRENT\nHierarchical name: IPCS_CURRENT","example":"A23D0007005","type":"string"},"type":"array"},"JP_CLASSES":{"description":"A patent classifications applied by the Japanese patent office.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _JP_CLASSES\nHierarchical name: JP_CLASSES","properties":{},"type":"object"},"KIND_CODE":{"description":"A one-or two-character code (one alpha plus one optional numeric) that always follows the publication number. Kind Codes indicate the version or level of examination of a patent document. [Kind codes](https://clarivate.com/derwent/wp-content/uploads/sites/3/dlm_uploads/2019/08/Kind-Code-Summary.pdf]) and their meanings are country/region specific.\nThis field will be normalized to uppercase.\n\nFlat name: KIND_CODE\nHierarchical name: KIND_CODE","example":"A1","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database.\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: LAST_UPDATED_DATE","example":"2022-05-05","format":"date","type":"string"},"LEGAL_STATUS_FACTOR":{"description":"The legal status factors used in the calculation of the derived data.\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _LEGAL_STATUS_FACTOR\nHierarchical name: LEGAL_STATUS_FACTOR","properties":{"CODE":{"description":"INPADOC Legal Status Codes (LSC) and their meanings are country/region-specific\n\nFlat name: _LEGAL_STATUS_FACTOR.CODE\nHierarchical name: LEGAL_STATUS_FACTOR.CODE","example":"C12","type":"string"},"COUNTRY":{"description":"State, nation or territory considered as an organized political community under one government where application was filed.\n\nFlat name: _LEGAL_STATUS_FACTOR.COUNTRY\nHierarchical name: LEGAL_STATUS_FACTOR.COUNTRY","example":"CN","type":"string"},"DESCRIPTION":{"description":"Detailed text description of the code.\n\nFlat name: _LEGAL_STATUS_FACTOR.DESCRIPTION\nHierarchical name: LEGAL_STATUS_FACTOR.DESCRIPTION","example":"REJECTION OF A PATENT APPLICATION AFTER ITS PUBLICATION","type":"string"}},"type":"object"},"PATENT_TYPE":{"description":"An indicator of whether a patent is an application (A), a granted patent (G) or a utility model (U). Utility models supplement the patent system by providing protection for innovations which are not regarded as inventive enough to warrant a patent grant. 90% of the Utility Models in the database originate from China, Japan, Germany and South Korea.\nThis field will be normalized to uppercase.\n\nFlat name: PATENT_TYPE\nHierarchical name: PATENT_TYPE","example":"A","type":"string"},"PREDICTIVE":{"items":{"description":"Evaluation metrics, which indicate the probability of future occurrences, relative strength, and importance of a patent\n\nFlat name: _PREDICTIVE\nHierarchical name: PREDICTIVE","properties":{"DOMAIN_INFLUENCE":{"description":"How important/influential is this patent to the technical domain that it sits in?\n\nFlat name: _PREDICTIVE.DOMAIN_INFLUENCE\nHierarchical name: PREDICTIVE.DOMAIN_INFLUENCE","example":5.65,"type":"number"},"GRANT_PROBABILITY":{"description":"What is the probability that this patent application will be granted? (Calculated for patent applications only.)\n\nFlat name: _PREDICTIVE.GRANT_PROBABILITY\nHierarchical name: PREDICTIVE.GRANT_PROBABILITY","example":0.33,"type":"number"}},"type":"object"},"type":"array"},"PRIORITIES":{"items":{"description":"A list of any previously filed applications from which this application had claimed priority.\n\nFlat name: _PRIORITIES\nHierarchical name: PRIORITIES","properties":{"COUNTRY":{"description":"The country/region in which the priority application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: _PRIORITIES.COUNTRY\nHierarchical name: PRIORITIES.COUNTRY","example":"US","type":"string"},"DATE":{"description":"The date when the priority application was filed.\nThis field is of type date but will be serialized to type string.\nThis field will be normalized to uppercase.\n\nFlat name: _PRIORITIES.DATE\nHierarchical name: PRIORITIES.DATE","example":"2017-03-13","format":"date","type":"string"},"NUMBER":{"description":"The application number of a previously filed application ( the priority application)  from which a patent application claims priority.\nThis field will be normalized to uppercase.\n\nFlat name: _PRIORITIES.NUMBER\nHierarchical name: PRIORITIES.NUMBER","example":"US62470694P","type":"string"}},"type":"object"},"type":"array"},"PUBLICATION_DATE":{"description":"The date a patent or application was officially published.\nThis field is of type date but will be serialized to type string.\n\nFlat name: PUBLICATION_DATE\nHierarchical name: PUBLICATION_DATE","example":"2021-07-21","format":"date","type":"string"},"PUBLICATION_LANGUAGE":{"description":"The publication language of a record. See [language codes (ISO 639-2)](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/iso_639.htm).\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_LANGUAGE\nHierarchical name: PUBLICATION_LANGUAGE","example":"EN","type":"string"},"PUBLICATION_NUMBER":{"description":"A unique identifier assigned to a patent publication which can represent a published application, a published grant or a utility model. A publication number will always be preceded by a country code and followed by a kind code. For more information see [Publication number formats](https://support.clarivate.com/Patents/s/article/Derwent-Innovation-Publication-Number-PN-Formats?language=en_US).\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_NUMBER\nHierarchical name: PUBLICATION_NUMBER","example":"EP3852021A1","type":"string"},"PUBLICATION_TYPE":{"description":"A single character representing the type of publication. I = Main invention publication;  T = Translation;  R = Reissued patent;  U = Utility Model;  S = Statutory Invention Publication;  P = NTIS Publication;  V = Trial Voluntary Protest Program.\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_TYPE\nHierarchical name: PUBLICATION_TYPE","example":"I","type":"string"},"PUBLICATION_YEAR":{"description":"The year a patent or application was officially published.\nThis field will be normalized to number.\n\nFlat name: PUBLICATION_YEAR\nHierarchical name: PUBLICATION_YEAR","example":2013,"type":"number"},"REGISTRATION_OFFICE":{"description":"The registration office code, also known as the country code, is a [two-character code (WIPO ST.3)](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/patent_country_codes.htm) indicating the country/region where the application has been made or the patent has been granted.\nThis field will be normalized to uppercase.\n\nFlat name: REGISTRATION_OFFICE\nHierarchical name: REGISTRATION_OFFICE","example":"EP","type":"string"},"REPRESENTATIVES":{"items":{"description":"The legal representative of a patent application is the person or entity who is legally able to work on, file, and initiate applications for clients who are interested in acquiring a patent.\n\nFlat name: _REPRESENTATIVES\nHierarchical name: REPRESENTATIVES","properties":{},"type":"object"},"type":"array"},"SERIAL_NUMBER":{"description":"Original Serial Number of a Patent document as appears in Patent office gazette, without country code or kind code.\nThis field will be normalized to uppercase.\n\nFlat name: SERIAL_NUMBER\nHierarchical name: SERIAL_NUMBER","example":"3852021","type":"string"},"TITLES":{"items":{"description":"The title information shown on the patent document.\n\nFlat name: _TITLES\nHierarchical name: TITLES","example":"Pressure intensifier unit for vehicle braking system","properties":{},"type":"object"},"type":"array"},"ULTIMATE_PARENTS":{"items":{"description":"Provides the entity name which has ultimate and current responsibility for the patent and who has the ability to exploit it. See [Optimized Assignee and Ultimate Parent](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/optimized_assignee.htm) on how we determine the owners.\nThis field will be normalized to uppercase.\n\nFlat name: ULTIMATE_PARENT\nHierarchical name: ULTIMATE_PARENTS","example":"ALPHABET INC.","type":"string"},"type":"array"},"US_REASSIGNMENTS":{"properties":{"ASSIGNEES":{"properties":{"ADDRESS":{"description":"USPTO US reassignment assignee address.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.ADDRESS\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.ADDRESS","example":"1 WAYSIDE ROAD BURLINGTON MASSACHUSETTS 01803","type":"string"},"CITY":{"description":"USPTO US reassignment assignee city.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.CITY\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.CITY","example":"BURLINGTON","type":"string"},"COUNTRY":{"description":"USPTO US reassignment assignee country.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.COUNTRY\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.COUNTRY","example":"US","type":"string"},"NAME":{"description":"USPTO US reassignment assignee name.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.NAME\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.NAME","example":"\"NUANCE COMMUNICATIONS, INC., AS GRANTOR\",","type":"string"},"ORDINAL":{"description":"USPTO US reassignment assignee ordinal.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.ORDINAL\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.ORDINAL","example":1,"type":"number"},"STATE":{"description":"USPTO US reassignment assignee state.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.STATE\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.STATE","example":"MA","type":"string"},"ZIP_CODE":{"description":"USPTO US reassignment assignee zip code.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNEES.ZIP_CODE\nHierarchical name: US_REASSIGNMENTS.ASSIGNEES.ZIP_CODE","example":"01803","type":"string"}},"type":"object"},"ASSIGNORS":{"properties":{"DATE_SIGNED":{"description":"\nThis field is of type date but will be serialized to type string.\n\nFlat name: _US_REASSIGNMENTS.ASSIGNORS.DATE_SIGNED\nHierarchical name: US_REASSIGNMENTS.ASSIGNORS.DATE_SIGNED","example":"2016-05-20","format":"date","type":"string"},"NAME":{"description":"\n\nFlat name: _US_REASSIGNMENTS.ASSIGNORS.NAME\nHierarchical name: US_REASSIGNMENTS.ASSIGNORS.NAME","example":"\"MORGAN STANLEY SENIOR FUNDING, INC., AS ADMINISTRATIVE AGENT\",","type":"string"},"ORDINAL":{"description":"\n\nFlat name: _US_REASSIGNMENTS.ASSIGNORS.ORDINAL\nHierarchical name: US_REASSIGNMENTS.ASSIGNORS.ORDINAL","example":1,"type":"number"}},"type":"object"},"CONVEYANCE":{"description":"\n\nFlat name: _US_REASSIGNMENTS.CONVEYANCE\nHierarchical name: US_REASSIGNMENTS.CONVEYANCE","example":"\"PATENT RELEASE (REEL:018160/FRAME:0909)\",","type":"string"},"CORRESPONDENT_ADDRESS":{"description":"\n\nFlat name: _US_REASSIGNMENTS.CORRESPONDENT_ADDRESS\nHierarchical name: US_REASSIGNMENTS.CORRESPONDENT_ADDRESS","example":"\"4400 EASTON COMMONS WAY SUITE 125 COLUMBUS, OH 43219\",","type":"string"},"CORRESPONDENT_NAME":{"description":"\n\nFlat name: _US_REASSIGNMENTS.CORRESPONDENT_NAME\nHierarchical name: US_REASSIGNMENTS.CORRESPONDENT_NAME","example":"\"MICHAEL VIOLET\",","type":"string"},"DATE_RECORDED":{"description":"\nThis field is of type date but will be serialized to type string.\n\nFlat name: _US_REASSIGNMENTS.DATE_RECORDED\nHierarchical name: US_REASSIGNMENTS.DATE_RECORDED","example":"2016-05-20","format":"date","type":"string"},"PATENT_ORDINAL":{"description":"\n\nFlat name: _US_REASSIGNMENTS.PATENT_ORDINAL\nHierarchical name: US_REASSIGNMENTS.PATENT_ORDINAL","example":"\"2016-05-20\",","type":"number"},"REEL_FRAME":{"description":"\n\nFlat name: _US_REASSIGNMENTS.REEL_FRAME\nHierarchical name: US_REASSIGNMENTS.REEL_FRAME","example":"\"387700869\",","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Call to fetch a full patent document by GUID.","tags":["Patents"]}},"/patents/document/pdf/{document_guid}":{"get":{"description":"Fetch a PDF of the document specified by document_guid.","operationId":"getPatentPdf","parameters":[{"description":"Unique document ID","in":"path","name":"document_guid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Retrieve PDF files for patents","tags":["Patents"]}},"/patents/match_entity":{"post":{"description":"Look up a field value by fuzzy match","operationId":"getMatchPatentEntities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/match_patent"}}}},"responses":{"200":{"content":{"application/json":{"example":{"assignee":[{"count":162441,"name":"MICROSOFT TECHNOLOGY LICENSING LLC","score":0.6922},{"count":70711,"name":"MICROSOFT CORPORATION","score":0.3013}],"parent_assignee":[{"count":232129,"name":"MICROSOFT CORPORATION","score":0.9926},{"count":636,"name":"MICROSOFT TECHNOLOGY LICENSING, LLC (US)","score":0.0027}]},"schema":{"$ref":"#/components/schemas/match_response_patent"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"API to use match entity model ","tags":["Patents"]}},"/patents/match_entity/{entity}":{"get":{"description":"Look up a field value by fuzzy match","operationId":"getMatchPatentEntity","parameters":[{"description":"A field value to attempt to match. Must match against one of the following fields: ('assignee', 'parent_assignee')","in":"path","name":"entity","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"assignee":[{"count":162441,"name":"MICROSOFT TECHNOLOGY LICENSING LLC","score":0.6922},{"count":70711,"name":"MICROSOFT CORPORATION","score":0.3013}],"parent_assignee":[{"count":232129,"name":"MICROSOFT CORPORATION","score":0.9926},{"count":636,"name":"MICROSOFT TECHNOLOGY LICENSING, LLC (US)","score":0.0027}]},"schema":{"$ref":"#/components/schemas/match_response_patent"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"API to use match entity model ","tags":["Patents"]}},"/patents/search":{"post":{"description":"Call to fetch one or more full patent documents by GUID, with possibile filters.","operationId":"searchPatents","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_request_patent"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Page of results","items":{"properties":{"AGENT_ADDRESS":{"description":"The agent address\nThis field will be normalized to uppercase.","example":"CONSEIL EN PROPRIETE INDUSTRIELLE 26 QUAI CLAUDE BERNARD, 69007 LYON, FR","type":"string"},"AGENT_CITY":{"description":"The agent city on the application\nThis field will be normalized to uppercase.","example":"LYON","type":"string"},"AGENT_COUNTRY":{"description":"The agent country on the application\nThis field will be normalized to uppercase.","example":"FR","type":"string"},"AGENT_INID":{"description":"The agent INID\nThis field will be normalized to uppercase.","example":"442972790","type":"string"},"AGENT_NAME":{"description":"The agent listed on the application\nThis field will be normalized to uppercase.","example":"CABINET JEANNET & ASSOCIES","type":"string"},"AGENT_STATE":{"description":"The agent state on the application\nThis field will be normalized to uppercase.","type":"string"},"AGENT_ZIP_CODE":{"description":"The agent zip code on the application\nThis field will be normalized to mixed-case.","example":"69007","type":"string"},"APPLICATION_DATE":{"description":"The date (YYYY-MM-DD) an application was filed. This is not the same as the Publication Date, which is the date the application is finally published.\nThis field is of type date but will be serialized to type string.\n\nFlat name: APPLICATION_DATE\nHierarchical name: APPLICATION_DATE","example":"2012-11-21","format":"date","type":"string"},"APPLICATION_NUMBER":{"description":"A unique number assigned to an application when it is filed. This is not the same as the Publication Number, which is assigned when the application is published. For many authorities, the first four digits of the application number (following the country code) indicate the year the application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: APPLICATION_NUMBER\nHierarchical name: APPLICATION_NUMBER","example":"WO2012EP73219A","type":"string"},"APPLICATION_REGISTRATION_OFFICE":{"description":"The country / region in which an application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: APPLICATION_REGISTRATION_OFFICE\nHierarchical name: APPLICATION_REGISTRATION_OFFICE","example":"EP","type":"string"},"ASSIGNEE_CURRENT_US":{"description":"Entity to which this patent is currently assigned (who owns the patent currently), based on US Reassignment data. For more information see [Assignee Current US](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#assignee-current_us)\n\nFlat name: ASSIGNEE_CURRENT_US\nHierarchical name: ASSIGNEES_CURRENT_US","example":"CONOPCO, INC., D/B/A UNILEVER","type":"string"},"ASSIGNEE_NAME":{"description":"The person or entity who owned/owns the patent. See [Optimized Assignee and Ultimate Parent](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/optimized_assignee.htm) on how we determine the owners.\nThis field will be normalized to uppercase.\n\nFlat name: ASSIGNEE_NAME\nHierarchical name: ASSIGNEE_NAMES","example":"GOOGLE INC.","type":"string"},"ASSIGNEE_ORIGINAL_ADDRESS":{"description":"Original assignee/applicant's address of the applicant/assignee.\nThis field will be normalized to uppercase.\n\nFlat name: ASSIGNEE_ORIGINAL_ADDRESS\nHierarchical name: ASSIGNEES_ORIGINAL.ADDRESS","example":"16640 - 111 AVE NW, EDMONTON, A1, T5M 2S5, CA","type":"string"},"ASSIGNEE_ORIGINAL_CITY":{"description":"Original assignee/applicant's of the publication city filed.\nThis field will be normalized to uppercase.\n\nFlat name: ASSIGNEE_ORIGINAL_CITY\nHierarchical name: ASSIGNEES_ORIGINAL.CITY","example":"EDMONTON","type":"string"},"ASSIGNEE_ORIGINAL_COUNTRY":{"description":"Original assignee/applicant's country/region of origin, as determined by address information provided by patent issuing authorities. Use this to research assignees/applicants from specific countries/regions.\nThis field will be normalized to uppercase.\n\nFlat name: ASSIGNEE_ORIGINAL_COUNTRY\nHierarchical name: ASSIGNEES_ORIGINAL.COUNTRY","example":"CA","type":"string"},"ASSIGNEE_ORIGINAL_INID":{"description":"Original assignee INID\nThis field will be normalized to uppercase.","example":"130433","type":"string"},"ASSIGNEE_ORIGINAL_NAME":{"description":"Original assignee/applicant's name.\nThis field will be normalized to uppercase.\n\nFlat name: ASSIGNEE_ORIGINAL_NAME\nHierarchical name: ASSIGNEES_ORIGINAL.NAME","example":"8 ALBERTA LTD.","type":"string"},"ASSIGNEE_ORIGINAL_NATIONALITY":{"description":"Original name, residence, and citizenship of each person believed to be an involved.\nThis field will be normalized to uppercase.\n\nFlat name: ASSIGNEE_ORIGINAL_NATIONALITY\nHierarchical name: ASSIGNEES_ORIGINAL.NATIONALITY","type":"string"},"ASSIGNEE_ORIGINAL_STATE":{"description":"Original assignee/applicant's of the publication two digit state, nation or territory considered as an organized political community under one government filed.\nThis field will be normalized to mixed-case.\n\nFlat name: ASSIGNEE_ORIGINAL_STATE\nHierarchical name: ASSIGNEES_ORIGINAL.STATE","example":"AB","type":"string"},"ASSIGNEE_ORIGINAL_ZIP_CODE":{"description":"Original assignee/applicant's of the publication five digit zipcode filed.\nThis field will be normalized to mixed-case.\n\nFlat name: ASSIGNEE_ORIGINAL_ZIP_CODE\nHierarchical name: ASSIGNEES_ORIGINAL.ZIP_CODE","example":"T5M 2S5","type":"string"},"CITATION_WOS_CLUSTERKEY":{"description":"Clusterkey of the cited WoS article.","example":"JOHN5636130019CL","type":"string"},"CITATION_WOS_SCORE":{"description":"Score of the match to WoS article.","example":0.97646093,"type":"number"},"CORRESPONDENT_ADDRESS":{"description":"Address for the correspondent.\nThis field will be normalized to uppercase.\n\nFlat name: CORRESPONDENT_ADDRESS\nHierarchical name: CORRESPONDENTS.ADDRESS","example":"1100 PEACHTREE STREET, ATLANTA, 30309, GA, US","type":"string"},"CORRESPONDENT_CITY":{"description":"Correspondents city of application filed.\nThis field will be normalized to uppercase.\n\nFlat name: CORRESPONDENT_CITY\nHierarchical name: CORRESPONDENTS.CITY","example":"ATLANTA","type":"string"},"CORRESPONDENT_COUNTRY":{"description":"Correspondents State, nation or territory considered as an organized political community under one government.\nThis field will be normalized to uppercase.\n\nFlat name: CORRESPONDENT_COUNTRY\nHierarchical name: CORRESPONDENTS.COUNTRY","example":"US","type":"string"},"CORRESPONDENT_NAME":{"description":"Name of the correspondent.\nThis field will be normalized to uppercase.\n\nFlat name: CORRESPONDENT_NAME\nHierarchical name: CORRESPONDENTS.NAME","example":"JOHN S. PRATT, ESQ;KILPATRICK STOCKTON, LLP","type":"string"},"CORRESPONDENT_STATE":{"description":"State for the correspondent\nThis field will be normalized to uppercase.","example":"GA","type":"string"},"CORRESPONDENT_ZIP_CODE":{"description":"Zipcode for the correspondent\nThis field will be normalized to mixed-case.","example":"30309","type":"string"},"CPC_4":{"description":"First 4 characters of the CPC Symbol","example":"A61F","type":"string"},"CPC_CURRENT":{"description":"These are the most recent CPC symbols and they overwrite/replace any earlier classifications. They can come from the Front Page or from the EPO (DocDB, through its weekly updates, or MCD quarterly update).  For more information see [CPC symbol](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#cpc)\nThis field will be normalized to uppercase.\n\nFlat name: CPC_CURRENT\nHierarchical name: CPCS_CURRENT","example":"G06N001000","type":"string"},"CPC_SYMBOL":{"description":"CPC symbols assigned to this patent.\nThis field will be normalized to uppercase.\n\nFlat name: CPC_SYMBOL\nHierarchical name: CPCS.SYMBOL","example":"G06N001000","type":"string"},"CPC_TYPE":{"description":"Indicators showing whether it is Current or Original and Inventive or Additional.\nThis field will be normalized to uppercase.\n\nFlat name: CPC_TYPE\nHierarchical name: CPCS.TYPE","example":"CURRENT_INVENTIVE","type":"string"},"DEAD_ALIVE_STATUS":{"description":"Patent and family status, dead (D) or alive (A) quickly shows you whether a patent or patent family is currently enforceable. Patent status uses a machine-learning algorithm to examine crucial patent data to determine the vitality status of a single patent or a patent family. The factors considered to predict patent status include: expiration date, legal status data, inherited status. If a record does not have an expiration date, filing date, and/or relevant legal status data, its status may be classified as Indeterminate (I). When a true/false is required, indeterminate should be considered as alive. [See the detailed process used to determine the status](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/pat_fam_status_doa.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DEAD_ALIVE_STATUS\nHierarchical name: DEAD_ALIVE_STATUS","example":"D","type":"string"},"DERWENT_BACKWARD_CITATION_COUNT":{"description":"Number of patents citing the DWPI family.\nThis field will be normalized to number.\n\nFlat name: DERWENT_BACKWARD_CITATION_COUNT\nHierarchical name: DERWENT_BACKWARD_CITATION_COUNT","example":15,"type":"number"},"DERWENT_FORWARD_CITATION_COUNT":{"description":"Number of patents cited by at least one member of the DWPI family.\nThis field will be normalized to number.\n\nFlat name: DERWENT_FORWARD_CITATION_COUNT\nHierarchical name: DERWENT_FORWARD_CITATION_COUNT","example":17,"type":"number"},"DOCDB_SIMPLE_FAMILY_ID":{"description":"A unique identifier for the simple family (a patent family identified/defined by INPADOC using INPADOC methodology.\nThis field will be normalized to number.\n\nFlat name: DOCDB_SIMPLE_FAMILY_ID\nHierarchical name: DOCDB_SIMPLE_FAMILY_ID","example":7843694,"type":"number"},"DOCUMENT_GUID":{"description":"A unique document identifier for this particular publication.\nThis field will be normalized to uppercase.\n\nFlat name: DOCUMENT_GUID\nHierarchical name: GUID","example":"WO2021243294A120211202","type":"string"},"DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL":{"description":"The number of unique Accession Numbers (showing the number of inventions) from the cited patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.ACCESSION_NUMBERS_TOTAL","example":3,"type":"number"},"DPCI_CITED_COUNTS_AUTHORITIES_TOTAL":{"description":"The number of unique patenting authorities (country codes) from the cited patents from any citation source. This shows the number of distinct regions where the cited patents are originating from.\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_AUTHORITIES_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.AUTHORITIES_TOTAL","example":3,"type":"number"},"DPCI_CITED_COUNTS_NON_PATENTS_TOTAL":{"description":"The number of unique articles from the cited non-patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_NON_PATENTS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.NON_PATENTS_TOTAL","example":8,"type":"number"},"DPCI_CITED_COUNTS_PATENTS_TOTAL":{"description":"The number of unique patent numbers from the cited patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITED_COUNTS_PATENTS_TOTAL\nHierarchical name: DPCI_CITED_COUNTS.PATENTS_TOTAL","example":4,"type":"number"},"DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL":{"description":"The number of unique Accession Numbers (showing the number of inventions) from the citing patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_ACCESSION_NUMBERS_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.ACCESSION_NUMBERS_TOTAL","example":3,"type":"number"},"DPCI_CITING_COUNTS_AUTHORITIES_TOTAL":{"description":"The number of unique patenting authorities (country codes) from the citing patents from any citation source. This shows the number of distinct regions where the citing patents are originating from.\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_AUTHORITIES_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.AUTHORITIES_TOTAL","example":2,"type":"number"},"DPCI_CITING_COUNTS_PATENTS_TOTAL":{"description":"The number of unique patent numbers from the citing patents from any citation source\nThis field will be normalized to number.\n\nFlat name: DPCI_CITING_COUNTS_PATENTS_TOTAL\nHierarchical name: DPCI_CITING_COUNTS.PATENTS_TOTAL","example":4,"type":"number"},"DSI_AGE_DISCOUNT":{"description":"A weighting factor for inventions.","example":0.26543465,"type":"number"},"DSI_AVERAGE_SCORE":{"description":"The Derwent Strength Index score without weighting by age.","example":875.875,"type":"number"},"DSI_INVENTION_GLOBALIZATION_SCORE":{"description":"Globalization or filing breadth. The dedication to each patented idea, measured by the level of international patent filing committed to by the applicant. The greater the level of geographic breadth attempted, the higher the investment level the idea had lavished upon it.\nThis field will be normalized to number [0-100].","example":34,"type":"number"},"DSI_INVENTION_INFLUENCE_SCORE":{"description":"Influence or citation score. The downstream influence on other innovators of each patented idea, compiled by patent examiners, and normalized for variation by technology sector and differences that occur by geography or language. Every combination of technical theme and geography has an expected level of patent citation over time, and we assess individual inventions in comparison to that influence curve.\nThis field will be normalized to number [0-100].","example":41,"type":"number"},"DSI_INVENTION_SUCCESS_SCORE":{"description":"Success or grant breadth. The proportion of the world economy that each patented idea has covered by a granted, issued patent right, providing a basis from which the rights’ owner can use their technology.\nThis field will be normalized to number [0-100].","example":59,"type":"number"},"DSI_STRENGTH_INDEX":{"description":"Each invention returns a Derwent Strength Index based on 4 metrics: influence, success, globalization and technical distinctiveness.\nThis field will be normalized to number [0-100].","example":67,"type":"number"},"DSI_TECHNICAL_DISTINCTIVENESS_SCORE":{"description":"The rarity of the combination of technical features and use cases presented within the patented idea, and therefore the level of technical extension the invention supports.","example":51,"type":"number"},"DSI_YEARS_REMAINING":{"description":"The years remaining for the invention.","example":5.308693,"type":"number"},"DWPI_ACCESSION_NUMBER":{"description":"The DWPI Primary Accession number (also known as PAN) is a unique identifier for the whole DWPI family representing a single invention. The first four digits represent the year the record was created. DWPI has a strict family definition in which each member shares exact priorities (except for non-convention equivalents) with each and every other family member. INPADOC, in contrast, has a very broad family definition that includes divisions, continuations and continuations in part. All that is needed is a shared priority of any one member to another.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_ACCESSION_NUMBER\nHierarchical name: DWPI_ACCESSION_NUMBER","example":"2018741525","type":"string"},"DWPI_APPLICATION_NUMBER_BASIC":{"description":"The application number of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_APPLICATION_NUMBER_BASIC\nHierarchical name: DWPI_APPLICATION_NUMBER_BASIC","example":"WO2012EP73219A","type":"string"},"DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC":{"description":"Country code that is part of the application number of the basic publication for a given DWPI family and represents the first instance of the invention ex. (US).\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC\nHierarchical name: DWPI_APPLICATION_REGISTRATION_OFFICE_BASIC","example":"EP","type":"string"},"DWPI_ASSIGNEE_CODE":{"description":"A unique 4-character Assignee Code assigned to a company and all of its subsidiaries.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_ASSIGNEE_CODE\nHierarchical name: DWPI_ASSIGNEES.CODE","example":"GOOG-C","type":"string"},"DWPI_ASSIGNEE_CODE_TYPE":{"description":"A single character representing the assignee code type. C: standard codes; N: non-standard codes; I: individual codes; R: Russian codes.\nThis field will be normalized to uppercase.","example":"C","type":"string"},"DWPI_ASSIGNEE_NAME":{"description":"DWPI standardized assignee name, as assigned during the review performed by DWPI editors.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_ASSIGNEE_NAME\nHierarchical name: DWPI_ASSIGNEES.NAME","example":"GOOGLE INC.","type":"string"},"DWPI_CLASS":{"description":"The DWPI collection categorizes patent documents using two classification systems, [DWPI Class](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields/details/DWPI_Class_Details.htm) and DWPI Manual Codes. Subject specialists consistently apply these unique classification systems to the DWPI patent documents. DWPI Class is a broad, simple system, whereas DWPI Manual Codes are more detailed and granular. Both DWPI Class and DWPI Manual Codes cover all technologies within 20 subject areas, identified by Section letters A-X which are grouped into three broad categories for Chemistry, Engineering and Electronics.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_CLASS\nHierarchical name: DWPI_CLASSES.CLASS","example":"A97","type":"string"},"DWPI_CLASS_DESCRIPTION":{"description":"Textual description of the scope of the DWPI Classes applied to the document.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_CLASS_DESCRIPTION\nHierarchical name: DWPI_CLASSES.DESCRIPTION","example":"Miscellaneous goods not specified elsewhere","type":"string"},"DWPI_CLASS_SECTION":{"description":"The DWPI section, which is the highest level in the DWPI classification system. This is also shown by the first character of the DWPI Class.\nThis field will be normalized to uppercase.","example":"A","type":"string"},"DWPI_CLASS_SECTION_DESCRIPTION":{"description":"Description of the technical scope of the highest level of the DWPI classification system.\nThis field will be normalized to uppercase.","example":"Polymers; Plastics","type":"string"},"DWPI_DESIGNATED_OFFICE_COUNT":{"description":"The number of countries/regions within which protection of the DWPI family members was sought.\nThis field will be normalized to number.\n\nFlat name: DWPI_DESIGNATED_OFFICE_COUNT\nHierarchical name: DWPI_DESIGNATED_OFFICE_COUNT","example":117,"type":"number"},"DWPI_EARLIEST_PRIORITY_DATE":{"description":"The earliest date for the DWPI family when the priority application was filed.\nThis field is of type date but will be serialized to type string.\n\nFlat name: DWPI_EARLIEST_PRIORITY_DATE\nHierarchical name: DWPI_EARLIEST_PRIORITY_DATE","example":"2017-04-21","format":"date","type":"string"},"DWPI_EARLIEST_PRIORITY_YEAR":{"description":"The earliest year for the DWPI family when the priority application was filed.","example":2017,"type":"number"},"DWPI_FAMILY_MEMBER_COUNT":{"description":"The number of DWPI family members within a given family.\nThis field will be normalized to number.\n\nFlat name: DWPI_FAMILY_MEMBER_COUNT\nHierarchical name: DWPI_FAMILY_MEMBER_COUNT","example":13,"type":"number"},"DWPI_FAMILY_STATUS":{"description":"DWPI Family status, dead (D) or alive (A) quickly shows you whether a DWPI patent family is currently enforceable. Patent status uses a machine-learning algorithm to examine crucial patent data to determine the vitality status of a single patent or a patent family. The factors considered to predict patent status include: expiration date, legal status data, inherited status. If a record does not have an expiration date, filing date, and/or relevant legal status data, its status may be classified as Indeterminate (I). A DWPI Family remains alive as long as at least one patent in the family is still active. When a true/false is required, indeterminate should be considered as alive. [See the detailed process used to determine the status](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/pat_fam_status_doa.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_FAMILY_STATUS\nHierarchical name: DWPI_FAMILY_STATUS","example":"D","type":"string"},"DWPI_INVENTOR_NAME":{"description":"The name of the inventor.\n\nFlat name: DWPI_INVENTOR_NAME\nHierarchical name: DWPI_INVENTORS.NAME","example":"KELLY J S","type":"string"},"DWPI_KIND_CODE_BASIC":{"description":"Indicates the version or level of a patent document, also known as publication stage. See the list of [DWPI Kind Codes](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/dwpi_kinds.htm)\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_KIND_CODE_BASIC\nHierarchical name: DWPI_KIND_CODE_BASIC","example":"A1","type":"string"},"DWPI_MANUAL_CODE":{"description":"A hierarchical indexing system to index the inventive and significant aspects of an invention, plus its commercial applications. The [DWPI Manual Codes](https://clarivate.com/derwent/dwpi-reference-center/dwpi-manual-code/) are consistently applied by specialist teams and divided into 20 technology sections.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_MANUAL_CODE\nHierarchical name: DWPI_MANUAL_CODES.CODE","example":"A03-A01","type":"string"},"DWPI_MANUAL_CODE_4":{"description":"First 4 characters of the DWPI Manual Code","example":"A03A","type":"string"},"DWPI_MANUAL_CODE_CLASS":{"description":"Part of the DWPI Manual Code representing the second hiearchical level.\nThis field will be normalized to uppercase.","example":"A03","type":"string"},"DWPI_MANUAL_CODE_CLASS_DESCRIPTION":{"description":"The description of the technical scope of the second hierarchical level of the Manual Code.\nThis field will be normalized to uppercase.","example":"NATURAL POLYMERS","type":"string"},"DWPI_MANUAL_CODE_DESCRIPTION":{"description":"Textual description of the technical scope of the DWPI Manual Code.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_MANUAL_CODE_DESCRIPTION\nHierarchical name: DWPI_MANUAL_CODES.DESCRIPTION","example":"General","type":"string"},"DWPI_MANUAL_CODE_SECTION":{"description":"The first character of the DWPI Manual Code representing the technology section.\nThis field will be normalized to uppercase.","example":"A","type":"string"},"DWPI_MANUAL_CODE_SECTION_DESCRIPTION":{"description":"The description of the technical scope of the first level in the Manual Code Hierarchy.\nThis field will be normalized to uppercase.","example":"Polymers; Plastics","type":"string"},"DWPI_PUBLICATION_NUMBER_BASIC":{"description":"The publication number of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_PUBLICATION_NUMBER_BASIC\nHierarchical name: DWPI_PUBLICATION_NUMBER_BASIC","example":"WO2018169585A1","type":"string"},"DWPI_REGISTRATION_OFFICE_BASIC":{"description":"The registration office code (country code) of the first member of the DWPI family.\nThis field will be normalized to uppercase.\n\nFlat name: DWPI_REGISTRATION_OFFICE_BASIC\nHierarchical name: DWPI_REGISTRATION_OFFICE_BASIC","example":"WO","type":"string"},"DWPI_TITLE":{"description":"Provides more information than the original patent title, written specifically to enable easy review of large lists of records and covers brief details of the scope, use and novelty of the invention. For more information see [Derwent World Patents Index](https://support.clarivate.com/Patents/s/article/Derwent-World-Patents-Index-Derwent-value-added-information?language=en_US)\nThis field will be normalized to mixed-case.\n\nFlat name: DWPI_TITLE\nHierarchical name: DWPI_TITLE","example":"Stacked quantum computing device, includes shielding layer which covers dielectric layer which covers control wire on dielectric substrate of second chip","type":"string"},"DWPI_UPDATE":{"description":"This is a unique identification number assigned to each DWPI database update and comprises a 4-digit year followed by a 2-digit serial number (for updates before 1 Jan. 2020) or a 3-digit serial number (for updates on or after 1 Jan. 2020). The 4-digit year and 2- or 3-digit serial number the  represent the year of the update and the number of the update, respectively.\nThis field will be normalized to number.\n\nFlat name: DWPI_UPDATE\nHierarchical name: DWPI_UPDATE","example":2021045,"type":"number"},"DWPI_UPDATE_BASIC":{"description":"The DWPI update number for the first member of the patent family. Find out more about the  [DWPI Data](https://www.derwentinnovation.com/tip-innovation/support/help/dwpi.htm).\nThis field will be normalized to number.\n\nFlat name: DWPI_UPDATE_BASIC\nHierarchical name: DWPI_UPDATE_BASIC","example":199945,"type":"number"},"EARLIEST_PRIORITY_COUNTRY":{"description":"The earliest data of all the priority countries/regions on the record.\nThis field will be normalized to uppercase.\n\nFlat name: EARLIEST_PRIORITY_COUNTRY\nHierarchical name: EARLIEST_PRIORITY_COUNTRY","example":"US","type":"string"},"EARLIEST_PRIORITY_DATE":{"description":"The earliest data of all the priority dates on the record.\nThis field is of type date but will be serialized to type string.\n\nFlat name: EARLIEST_PRIORITY_DATE\nHierarchical name: EARLIEST_PRIORITY_DATE","example":"2017-03-13","format":"date","type":"string"},"EARLIEST_PRIORITY_NUMBER":{"description":"The earliest data of all the priority numbers on the record.\nThis field will be normalized to uppercase.\n\nFlat name: EARLIEST_PRIORITY_NUMBER\nHierarchical name: EARLIEST_PRIORITY_NUMBER","example":"US62470694P","type":"string"},"EARLIEST_PRIORITY_YEAR":{"description":"The earliest data of all the priority years on the record.\nThis field will be normalized to number.\n\nFlat name: EARLIEST_PRIORITY_YEAR\nHierarchical name: EARLIEST_PRIORITY_YEAR","example":2011,"type":"number"},"ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR":{"description":"An indicator showing whether the expiration date is confirmed as being definitive or whether it is an estimation.\n\nFlat name: ESTIMATED_EXPIRATION_CONFIRMATION_INDICATOR\nHierarchical name: ESTIMATED_EXPIRATION.CONFIRMATION_INDICATOR","example":"estimated","type":"string"},"ESTIMATED_EXPIRATION_DATE":{"description":"Predictive Data provides an expiration date for an individual patent. A machine-learning algorithm examines all available data, including editorially enhanced data from the Derwent World Patents Index (DWPI), to accurately predict a patent's expiration date. See [Expiration Date and Remaining Life](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/Remaining_Life_and_Expiration_Date.htm) for more details.\nThis field is of type date but will be serialized to type string.\n\nFlat name: ESTIMATED_EXPIRATION_DATE\nHierarchical name: ESTIMATED_EXPIRATION.DATE","example":"2037-01-02","format":"date","type":"string"},"ESTIMATED_EXPIRATION_DISCLAIMER_FLAG":{"description":"Field that indicates that this patent has a Terminal Disclaimer ex. (Y) yes (N) no.\n\nFlat name: ESTIMATED_EXPIRATION_DISCLAIMER_FLAG\nHierarchical name: ESTIMATED_EXPIRATION.DISCLAIMER_FLAG","example":"Y","type":"string"},"ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM":{"description":"The initial term in years for the US design patent.\n\nFlat name: ESTIMATED_EXPIRATION_FACTOR_DESIGN_TERM\nHierarchical name: ESTIMATED_EXPIRATION.FACTOR_DESIGN_TERM","example":14,"type":"number"},"ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE":{"description":"The calculation may need to take into account a patent's priority date or other dates that are prior to the filing date and this is shown as the Earliest Effective Filing Date(YYYY-MM-DD).\nThis field is of type date but will be serialized to type string.\n\nFlat name: ESTIMATED_EXPIRATION_FACTOR_EARLIEST_EFFECTIVE_FILING_DATE\nHierarchical name: ESTIMATED_EXPIRATION.FACTOR_EARLIEST_EFFECTIVE_FILING_DATE","example":"2005-07-22","format":"date","type":"string"},"ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT":{"description":"The adjustment made to a patent in the event that its approval is delayed by the Patent Office and therefore additional days are added to its expiration date through a patent term adjustment.\n\nFlat name: ESTIMATED_EXPIRATION_FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT\nHierarchical name: ESTIMATED_EXPIRATION.FACTOR_POST_GRANT_PATENT_TERM_ADJUSTMENT","example":396,"type":"number"},"ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE":{"description":"If a patent has a Terminal Disclaimer, this is the expiration date of other patent where it filed the Terminal Disclaimer on (YYYY-MM-DD).\nThis field is of type date but will be serialized to type string.\n\nFlat name: ESTIMATED_EXPIRATION_FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE\nHierarchical name: ESTIMATED_EXPIRATION.FACTOR_TERMINAL_DISC_PRIOR_EXPIRY_DATE","example":"2027-05-02","format":"date","type":"string"},"EXAMINER_MAIN":{"description":"The main examiner who examined this patent. From December 2016 onward, the examiner's four-digit art unit is also included.\nThis field will be normalized to uppercase.\n\nFlat name: EXAMINER_MAIN\nHierarchical name: EXAMINERS.MAIN","example":"HINDENLANG, ALISON L","type":"string"},"EXAMINER_SECONDARY":{"description":"Any secondary examiners for the patent.\nThis field will be normalized to uppercase.\n\nFlat name: EXAMINER_SECONDARY\nHierarchical name: EXAMINERS.SECONDARIES","example":"KRASNOW, NICHOLAS R","type":"string"},"GRANTED":{"description":"A flag  indicating whether the document is granted. Once a patent is granted, the patent holder has been granted the right to restrict others from using, making, selling, and importing his invention without his express permission.\nThis field will be normalized to boolean.\n\nFlat name: GRANTED\nHierarchical name: GRANTED","example":true,"type":"boolean"},"GRANT_DATE":{"description":"The date (YYYY-MM-DD) on which the patent office grants the patent.\nThis field is of type date but will be serialized to type string.\n\nFlat name: GRANT_DATE\nHierarchical name: GRANT_DATE","example":"2017-04-17","format":"date","type":"string"},"GREEN_DATA_CATEGORY":{"description":"The Green Data Category is a data enrichment field designed for categorising patents based on their relevant technology within the renewable energy sector. The categorisation is based on the electricity generation categories 4.1 until 4.8 from the EU Sustainable Finance taxonomy, including solar photovoltaic energy, concentrated solar power, wind power, ocean energy technologies, hydropower, geothermal energy, gas-liquid fuels and bio-energy.","example":"ENERGY_4_1","type":"string"},"GUID":{"description":"A unique document identifier for this particular publication.\nThis field will be normalized to uppercase.\n\nFlat name: GUID\nHierarchical name: GUID","example":"WO2021243294A120211202","type":"string"},"INPADOC_FAMILY_STATUS":{"description":"Dead (D) / Alive (A) status of the Inpadoc family quickly shows whether an INPADOC Patent Family is currently enforceable. If a record does not have relevant legal status data, its status may be classified as Indeterminate (I) or None (N). An INPADOC Family remains alive as long as at least one patent in the family is still active\nThis field will be normalized to uppercase.\n\nFlat name: INPADOC_FAMILY_STATUS\nHierarchical name: INPADOC_FAMILY_STATUS","example":"D","type":"string"},"INVENTOR_ADDRESS":{"description":"Inventors address of application filed.\nThis field will be normalized to uppercase.\n\nFlat name: INVENTOR_ADDRESS\nHierarchical name: INVENTORS.ADDRESS","example":"421 WADSWORTH AVENUE, PHILADELPHIA, 19119, PA, US","type":"string"},"INVENTOR_CITY":{"description":"Inventors city of application filed.\nThis field will be normalized to uppercase.\n\nFlat name: INVENTOR_CITY\nHierarchical name: INVENTORS.CITY","example":"PHILADELPHIA","type":"string"},"INVENTOR_COUNTRY":{"description":"Inventors nation or territory considered as an organized political community under one government where application was filed.\nThis field will be normalized to uppercase.\n\nFlat name: INVENTOR_COUNTRY\nHierarchical name: INVENTORS.COUNTRY","example":"US","type":"string"},"INVENTOR_NAME":{"description":"The name of the person/inventor, or organization registered on a patent or application as the inventor.\nThis field will be normalized to uppercase.\n\nFlat name: INVENTOR_NAME\nHierarchical name: INVENTORS.NAME","example":"EBEL, WOLFGANG","type":"string"},"INVENTOR_NATIONALITY":{"description":"Inventors nationality\nThis field will be normalized to uppercase.","example":"DE","type":"string"},"INVENTOR_STATE":{"description":"Inventors state, nation or territory considered as an organized political community under one government.\nThis field will be normalized to uppercase.\n\nFlat name: INVENTOR_STATE\nHierarchical name: INVENTORS.STATE","example":"PA","type":"string"},"INVENTOR_ZIP_CODE":{"description":"Inventors numerical code depending on country used for postal service and filled on application.\nThis field will be normalized to mixed-case.\n\nFlat name: INVENTOR_ZIP_CODE\nHierarchical name: INVENTORS.ZIP_CODE","example":"19119","type":"string"},"IPC_4":{"description":"First 4 characters of the IPC Symbol","example":"A23D","type":"string"},"IPC_CLASS":{"description":"Part of the IPC Symbols representing the second hierarchical level of the [IPC code structure](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields/details/IPC_Structure.htm).\nThis field will be normalized to uppercase.","example":"A23","type":"string"},"IPC_CLASS_DESCRIPTION":{"description":"IPC descriptions of the second hierarchical level of the classification. The class level is the first subdivision of the section.\nThis field will be normalized to uppercase.","example":"FOODS OR FOODSTUFFS; TREATMENT THEREOF, NOT COVERED BY OTHER CLASSES","type":"string"},"IPC_CURRENT":{"description":"The most recent IPC classifications. They overwrite/replace any earlier classifications. They can come from Front Page or EPO (DocDB, through its weekly updates, or MCD quarterly update). For more information see [IPC classification]§\nThis field will be normalized to uppercase.\n\nFlat name: IPC_CURRENT\nHierarchical name: IPCS_CURRENT","example":"A23D0007005","type":"string"},"IPC_DESCRIPTION":{"description":"IPC descriptions showing the technical scope of the IPC symbols.\nThis field will be normalized to uppercase.\n\nFlat name: IPC_DESCRIPTION\nHierarchical name: IPCS.DESCRIPTION","example":"characterised by ingredients other than fatty acid triglycerides","type":"string"},"IPC_SECTION":{"description":"IPC characters representing the first hierarchical level of the [IPC code structure](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields/details/IPC_Structure.htm). (e.g. A = Human Necessitates, B = Performing Operations; Transporting, C = Chemistry; Metallurgy, D = Textiles; Paper, E = Fixed Constructions, F = Mechanical Engineering; Lighting; Heating; Weapons; Blasting, G = Physics, H = Electricity)\nThis field will be normalized to uppercase.","example":"A","type":"string"},"IPC_SECTION_DESCRIPTION":{"description":"IPC descriptions of the highest level of the classification.\nThis field will be normalized to uppercase.","example":"HUMAN NECESSITIES","type":"string"},"IPC_SUBCLASS":{"description":"Part of the IPC Symbols representing the third hierarchical level of the [IPC code structure](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields/details/IPC_Structure.htm).\nThis field will be normalized to uppercase.","example":"A23D","type":"string"},"IPC_SUBCLASS_DESCRIPTION":{"description":"IPC descriptions of the third hierarchical level of the classification. The subclass is the next subdivision of the Class level.\nThis field will be normalized to uppercase.","example":"EDIBLE OILS OR FATS, e.g. MARGARINES, SHORTENINGS, COOKING OILS (obtaining, refining, preserving C11B, C11C; hydrogenation C11C 3/12)","type":"string"},"IPC_SYMBOL":{"description":"IPC symbols assigned to this patent.\nThis field will be normalized to uppercase.\n\nFlat name: IPC_SYMBOL\nHierarchical name: IPCS.SYMBOL","example":"A23D0007005","type":"string"},"IPC_TYPE":{"description":"Indicators showing whether it is Current or Original, Inventive or Additional and Core or Advanced.\nThis field will be normalized to uppercase.\n\nFlat name: IPC_TYPE\nHierarchical name: IPCS.TYPE","example":"CURRENT_INVENTIVE_ADVANCED","type":"string"},"JP_CLASS_FI_CODE":{"description":"FI Codes and facets assigned to patent. For more information see [JP-FI Codes](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#ficode)\nThis field will be normalized to uppercase.\n\nFlat name: JP_CLASS_FI_CODE\nHierarchical name: JP_CLASSES.FI_CODES","example":"B41J002938-301","type":"string"},"JP_CLASS_F_TERM":{"description":"JP F-Terms classification scheme classifies inventions from multiple viewpoints and is not hierarchical. For more information see [JP F-Term] (https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#fterm)\nThis field will be normalized to uppercase.\n\nFlat name: JP_CLASS_F_TERM\nHierarchical name: JP_CLASSES.F_TERMS","example":"2C061AP01","type":"string"},"KIND_CODE":{"description":"A one-or two-character code (one alpha plus one optional numeric) that always follows the publication number. Kind Codes indicate the version or level of examination of a patent document. [Kind codes](https://clarivate.com/derwent/wp-content/uploads/sites/3/dlm_uploads/2019/08/Kind-Code-Summary.pdf]) and their meanings are country/region specific.\nThis field will be normalized to uppercase.\n\nFlat name: KIND_CODE\nHierarchical name: KIND_CODE","example":"A1","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database.\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: LAST_UPDATED_DATE","example":"2022-05-05","format":"date","type":"string"},"OPTIMIZED_ASSIGNEES":{"description":"Text field with all assignee names separated by a vertical line symbol","type":"string"},"PATENT_TYPE":{"description":"An indicator of whether a patent is an application (A), a granted patent (G) or a utility model (U). Utility models supplement the patent system by providing protection for innovations which are not regarded as inventive enough to warrant a patent grant. 90% of the Utility Models in the database originate from China, Japan, Germany and South Korea.\nThis field will be normalized to uppercase.\n\nFlat name: PATENT_TYPE\nHierarchical name: PATENT_TYPE","example":"A","type":"string"},"PUBLICATION_DATE":{"description":"The date a patent or application was officially published.\nThis field is of type date but will be serialized to type string.\n\nFlat name: PUBLICATION_DATE\nHierarchical name: PUBLICATION_DATE","example":"2021-07-21","format":"date","type":"string"},"PUBLICATION_LANGUAGE":{"description":"The publication language of a record. See [language codes (ISO 639-2)](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/iso_639.htm).\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_LANGUAGE\nHierarchical name: PUBLICATION_LANGUAGE","example":"EN","type":"string"},"PUBLICATION_NUMBER":{"description":"A unique identifier assigned to a patent publication which can represent a published application, a published grant or a utility model. A publication number will always be preceded by a country code and followed by a kind code. For more information see [Publication number formats](https://support.clarivate.com/Patents/s/article/Derwent-Innovation-Publication-Number-PN-Formats?language=en_US).\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_NUMBER\nHierarchical name: PUBLICATION_NUMBER","example":"EP3852021A1","type":"string"},"PUBLICATION_TYPE":{"description":"A single character representing the type of publication. I = Main invention publication;  T = Translation;  R = Reissued patent;  U = Utility Model;  S = Statutory Invention Publication;  P = NTIS Publication;  V = Trial Voluntary Protest Program.\nThis field will be normalized to uppercase.\n\nFlat name: PUBLICATION_TYPE\nHierarchical name: PUBLICATION_TYPE","example":"I","type":"string"},"PUBLICATION_YEAR":{"description":"The year a patent or application was officially published.\nThis field will be normalized to number.\n\nFlat name: PUBLICATION_YEAR\nHierarchical name: PUBLICATION_YEAR","example":2013,"type":"number"},"REGISTRATION_OFFICE":{"description":"The registration office code, also known as the country code, is a [two-character code (WIPO ST.3)](https://www.derwentinnovation.com/tip-innovation/support/help/reference_docs/patent_country_codes.htm) indicating the country/region where the application has been made or the patent has been granted.\nThis field will be normalized to uppercase.\n\nFlat name: REGISTRATION_OFFICE\nHierarchical name: REGISTRATION_OFFICE","example":"EP","type":"string"},"REPRESENTATIVE_NAME":{"description":"Legal representatives name or law firm listed on application.\nThis field will be normalized to uppercase.\n\nFlat name: REPRESENTATIVE_NAME\nHierarchical name: REPRESENTATIVES.NAME","example":"AGFA GRAPHICS NV","type":"string"},"SERIAL_NUMBER":{"description":"Original Serial Number of a Patent document as appears in Patent office gazette, without country code or kind code.\nThis field will be normalized to uppercase.\n\nFlat name: SERIAL_NUMBER\nHierarchical name: SERIAL_NUMBER","example":"3852021","type":"string"},"ULTIMATE_PARENT":{"description":"Provides the entity name which has ultimate and current responsibility for the patent and who has the ability to exploit it. See [Optimized Assignee and Ultimate Parent](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/optimized_assignee.htm) on how we determine the owners.\nThis field will be normalized to uppercase.\n\nFlat name: ULTIMATE_PARENT\nHierarchical name: ULTIMATE_PARENTS","example":"ALPHABET INC.","type":"string"}},"type":"object"},"type":"array"},"total_count":{"description":"Total number of results","type":"number"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Search patents, analytic format","tags":["Patents"]}},"/trademarks/document/json":{"post":{"description":"Call to fetch one or more full trademark documents by GUID, with possibile filters.","operationId":"getTrademarkDocuments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/records_request_trademark"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Page of results","items":{"properties":{"APPLICANTS":{"items":{"description":"\n\nFlat name: _APPLICANTS\nHierarchical name: APPLICANTS","properties":{},"type":"object"},"type":"array"},"APPLICATION_LANGUAGE_CODE":{"description":"Application language code\n\nFlat name: APPLICATION_LANGUAGE_CODE\nHierarchical name: APPLICATION_LANGUAGE_CODE","example":"EN","type":"string"},"DESIGNATED_COUNTRY_CODE":{"items":{"description":"Designated country code for International or ARIPO trademarks; or US State for US State trademarks\n\nFlat name: DESIGNATED_COUNTRY_CODE\nHierarchical name: DESIGNATED_COUNTRY_CODE","example":"[\"CN\", \"EM\", \"IN\", \"US\"]","type":"string"},"type":"array"},"DESIGNATION_BASIS":{"description":"Either MADRID_AGREEMENT, MADRID_PROTOCOL, ARIPO or USA_STATE\n\nFlat name: DESIGNATION_BASIS\nHierarchical name: DESIGNATION_BASIS","example":"MADRID_PROTOCOL","type":"string"},"DISCLAIMERS":{"description":"Disclaimers\n\nFlat name: DISCLAIMERS\nHierarchical name: DISCLAIMERS","example":"[\"BUSINESS FINANCE\"]","type":"string"},"FIGURATIVE_ELEMENTS":{"description":"\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _FIGURATIVE_ELEMENTS\nHierarchical name: FIGURATIVE_ELEMENTS","properties":{},"type":"object"},"GOODS_SERVICES":{"description":"\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _GOODS_SERVICES\nHierarchical name: GOODS_SERVICES","properties":{"NAT_CLASS_DESCRIPTIONS":{"items":{"description":"\n\nFlat name: _GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS\nHierarchical name: GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS","properties":{},"type":"object"},"type":"array"}},"type":"object"},"GUID":{"description":"Trademark record unique global identifier\n\nFlat name: GUID\nHierarchical name: GUID","example":"USAFI65E053B1C87611DEB9C6000D609921FB","type":"string"},"ID":{"description":"Deprecated, use GUID. Trademark record unique global identifier\n\nFlat name: ID\nHierarchical name: ID","example":"INTEIF1B28495161911E58373A272ECEBA1B7","type":"string"},"IMAGES_TOTAL_QUANTITY":{"description":"Image available for the trademark record\n\nFlat name: IMAGES_TOTAL_QUANTITY\nHierarchical name: IMAGES_TOTAL_QUANTITY","example":1,"type":"number"},"IMAGE_KIND":{"description":"Kind of available image. None or PUBLICATION_COPY.\n\nFlat name: IMAGE_KIND\nHierarchical name: IMAGE_KIND","example":"PUBLICATION_COPY","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: LAST_UPDATED_DATE","example":"2022-05-05","format":"date","type":"string"},"MARK_FEATURE":{"description":"Type of trademark\n\nFlat name: MARK_FEATURE\nHierarchical name: MARK_FEATURE","example":"WORD AND DESIGN","type":"string"},"PRIORITIES":{"items":{"description":"\n\nFlat name: _PRIORITIES\nHierarchical name: PRIORITIES","properties":{},"type":"object"},"type":"array"},"REGISTRATION_OFFICE_CODE":{"description":"Office code\n\nFlat name: REGISTRATION_OFFICE_CODE\nHierarchical name: REGISTRATION_OFFICE_CODE","example":"WO","type":"string"},"REPRESENTATIVES":{"items":{"description":"\n\nFlat name: _REPRESENTATIVES\nHierarchical name: REPRESENTATIVES","properties":{},"type":"object"},"type":"array"},"REPRESENTATIVE_CORRESPONDENTS":{"items":{"description":"\n\nFlat name: _REPRESENTATIVE_CORRESPONDENTS\nHierarchical name: REPRESENTATIVE_CORRESPONDENTS","properties":{},"type":"object"},"type":"array"},"SECOND_LANGUAGE_CODE":{"description":"Application second language code\n\nFlat name: SECOND_LANGUAGE_CODE\nHierarchical name: SECOND_LANGUAGE_CODE","example":"FR","type":"string"},"STATUS":{"description":"\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _STATUS\nHierarchical name: STATUS","properties":{},"type":"object"},"WORD_MARK_SPECIFICATION":{"description":"\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _WORD_MARK_SPECIFICATION\nHierarchical name: WORD_MARK_SPECIFICATION","properties":{},"type":"object"}},"type":"object"},"type":"array"},"total_count":{"description":"Total number of results","type":"number"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Call to fetch one or more full trademark documents by GUID, with possibile filters.","tags":["Trademarks"]}},"/trademarks/document/json/{document_guid}":{"get":{"description":"Call to fetch a full trademark document by GUID.","operationId":"getTrademarkDocument","parameters":[{"description":"Unique ID of trademark document to retrieve","in":"path","name":"document_guid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"APPLICANTS":{"items":{"description":"\n\nFlat name: _APPLICANTS\nHierarchical name: APPLICANTS","properties":{},"type":"object"},"type":"array"},"APPLICATION_LANGUAGE_CODE":{"description":"Application language code\n\nFlat name: APPLICATION_LANGUAGE_CODE\nHierarchical name: APPLICATION_LANGUAGE_CODE","example":"EN","type":"string"},"DESIGNATED_COUNTRY_CODE":{"items":{"description":"Designated country code for International or ARIPO trademarks; or US State for US State trademarks\n\nFlat name: DESIGNATED_COUNTRY_CODE\nHierarchical name: DESIGNATED_COUNTRY_CODE","example":"[\"CN\", \"EM\", \"IN\", \"US\"]","type":"string"},"type":"array"},"DESIGNATION_BASIS":{"description":"Either MADRID_AGREEMENT, MADRID_PROTOCOL, ARIPO or USA_STATE\n\nFlat name: DESIGNATION_BASIS\nHierarchical name: DESIGNATION_BASIS","example":"MADRID_PROTOCOL","type":"string"},"DISCLAIMERS":{"description":"Disclaimers\n\nFlat name: DISCLAIMERS\nHierarchical name: DISCLAIMERS","example":"[\"BUSINESS FINANCE\"]","type":"string"},"FIGURATIVE_ELEMENTS":{"description":"\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _FIGURATIVE_ELEMENTS\nHierarchical name: FIGURATIVE_ELEMENTS","properties":{},"type":"object"},"GOODS_SERVICES":{"description":"\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _GOODS_SERVICES\nHierarchical name: GOODS_SERVICES","properties":{"NAT_CLASS_DESCRIPTIONS":{"items":{"description":"\n\nFlat name: _GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS\nHierarchical name: GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS","properties":{},"type":"object"},"type":"array"}},"type":"object"},"GUID":{"description":"Trademark record unique global identifier\n\nFlat name: GUID\nHierarchical name: GUID","example":"USAFI65E053B1C87611DEB9C6000D609921FB","type":"string"},"ID":{"description":"Deprecated, use GUID. Trademark record unique global identifier\n\nFlat name: ID\nHierarchical name: ID","example":"INTEIF1B28495161911E58373A272ECEBA1B7","type":"string"},"IMAGES_TOTAL_QUANTITY":{"description":"Image available for the trademark record\n\nFlat name: IMAGES_TOTAL_QUANTITY\nHierarchical name: IMAGES_TOTAL_QUANTITY","example":1,"type":"number"},"IMAGE_KIND":{"description":"Kind of available image. None or PUBLICATION_COPY.\n\nFlat name: IMAGE_KIND\nHierarchical name: IMAGE_KIND","example":"PUBLICATION_COPY","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: LAST_UPDATED_DATE","example":"2022-05-05","format":"date","type":"string"},"MARK_FEATURE":{"description":"Type of trademark\n\nFlat name: MARK_FEATURE\nHierarchical name: MARK_FEATURE","example":"WORD AND DESIGN","type":"string"},"PRIORITIES":{"items":{"description":"\n\nFlat name: _PRIORITIES\nHierarchical name: PRIORITIES","properties":{},"type":"object"},"type":"array"},"REGISTRATION_OFFICE_CODE":{"description":"Office code\n\nFlat name: REGISTRATION_OFFICE_CODE\nHierarchical name: REGISTRATION_OFFICE_CODE","example":"WO","type":"string"},"REPRESENTATIVES":{"items":{"description":"\n\nFlat name: _REPRESENTATIVES\nHierarchical name: REPRESENTATIVES","properties":{},"type":"object"},"type":"array"},"REPRESENTATIVE_CORRESPONDENTS":{"items":{"description":"\n\nFlat name: _REPRESENTATIVE_CORRESPONDENTS\nHierarchical name: REPRESENTATIVE_CORRESPONDENTS","properties":{},"type":"object"},"type":"array"},"SECOND_LANGUAGE_CODE":{"description":"Application second language code\n\nFlat name: SECOND_LANGUAGE_CODE\nHierarchical name: SECOND_LANGUAGE_CODE","example":"FR","type":"string"},"STATUS":{"description":"\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _STATUS\nHierarchical name: STATUS","properties":{},"type":"object"},"WORD_MARK_SPECIFICATION":{"description":"\nThis field is of type composite but will be serialized to type object.\n\nFlat name: _WORD_MARK_SPECIFICATION\nHierarchical name: WORD_MARK_SPECIFICATION","properties":{},"type":"object"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Call to fetch a full trademark document by GUID.","tags":["Trademarks"]}},"/trademarks/search":{"post":{"description":"Call to fetch one or more full trademark documents by GUID, with possibile filters.","operationId":"searchTrademarks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search_request_trademark"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Page of results","items":{"properties":{"APPLICANT_ADDRESS_COUNTRY_CODE":{"description":"Applicant country code\n\nFlat name: APPLICANT_ADDRESS_COUNTRY_CODE\nHierarchical name: APPLICANTS.ADDRESS_COUNTRY_CODE","example":"CN","type":"string"},"APPLICANT_ADDRESS_LINE_TEXT":{"description":"Applicant address\n\nFlat name: APPLICANT_ADDRESS_LINE_TEXT\nHierarchical name: APPLICANTS.ADDRESS_LINE_TEXT","example":"PEKING","type":"string"},"APPLICANT_ADDRESS_NATIVE_LINE_TEXT":{"description":"Applicant address in the language of the publication\n\nFlat name: APPLICANT_ADDRESS_NATIVE_LINE_TEXT\nHierarchical name: APPLICANTS.ADDRESS_NATIVE_LINE_TEXT","example":"云南省迪庆藏族自治州香格里拉市建塘镇香巴拉小镇","type":"string"},"APPLICANT_NAME":{"description":"Applicant name\n\nFlat name: APPLICANT_NAME\nHierarchical name: APPLICANTS.NAME","example":"LA DAWA CITY BIOTECHNOLOGY CO., LTD.","type":"string"},"APPLICANT_NAME_NATIVE":{"description":"Applicant name in the language of the publication\n\nFlat name: APPLICANT_NAME_NATIVE\nHierarchical name: APPLICANTS.NAME_NATIVE","example":"香格里拉市达娃生物科技有限公司","type":"string"},"APPLICATION_ABANDONED_DATE":{"description":"Abandonment date\nThis field is of type date but will be serialized to type string.\n\nFlat name: APPLICATION_ABANDONED_DATE\nHierarchical name: STATUS.APPLICATION_ABANDONED_DATE","example":"2009-05-21","format":"date","type":"string"},"APPLICATION_DATE":{"description":"Application date\nThis field is of type date but will be serialized to type string.\n\nFlat name: APPLICATION_DATE\nHierarchical name: STATUS.APPLICATION_DATE","example":"2002-05-21","format":"date","type":"string"},"APPLICATION_LANGUAGE_CODE":{"description":"Application language code\n\nFlat name: APPLICATION_LANGUAGE_CODE\nHierarchical name: APPLICATION_LANGUAGE_CODE","example":"EN","type":"string"},"APPLICATION_NUMBER_TEXT":{"description":"Application number\n\nFlat name: APPLICATION_NUMBER_TEXT\nHierarchical name: STATUS.APPLICATION_NUMBER_TEXT","type":"string"},"CANCELLATION_DATE":{"description":"Cancellation date\nThis field is of type date but will be serialized to type string.\n\nFlat name: CANCELLATION_DATE\nHierarchical name: STATUS.CANCELLATION_DATE","example":"2009-05-21","format":"date","type":"string"},"CLASSIFICATION":{"description":"Figurative classification system. Either VIENNA_CLASSIFICATION, MARK_IMAGE_EU_CLASSIFICATION_ENRICHED or MARK_IMAGE_US_CLASSIFICATION_ENRICHED\n\nFlat name: CLASSIFICATION\nHierarchical name: FIGURATIVE_ELEMENTS.CLASSIFICATION","example":"VIENNA_CLASSIFICATION","type":"string"},"CLASSIFICATION_CODE_ENRICHED":{"description":"Figurative code\n\nFlat name: CLASSIFICATION_CODE_ENRICHED\nHierarchical name: FIGURATIVE_ELEMENTS.CLASSIFICATION_CODES_ENRICHED","example":"[\"26.11.12\", \"25.07.22\"]","type":"string"},"COUNTRY_ISO_3166_ALPHA2":{"description":"Country ISO 3166 Alpha-2","example":"IN","type":"string"},"COUNTRY_ISO_3166_ALPHA3":{"description":"Country ISO 3166 Alpha-3","example":"IND","type":"string"},"COUNTRY_TEXT":{"description":"Country Text","example":"INDIA","type":"string"},"CURRENT_STATUS":{"description":"Trademark record status (office specific)\n\nFlat name: CURRENT_STATUS\nHierarchical name: STATUS.CURRENT_STATUS","example":"UNPUBLISHED APPLICATION","type":"string"},"CURRENT_STATUS_DERIVED":{"description":"Harmonized trademark record status\n\nFlat name: CURRENT_STATUS_DERIVED\nHierarchical name: STATUS.CURRENT_STATUS_DERIVED","example":"PENDING","type":"string"},"DESIGNATED_COUNTRY_CODE":{"description":"Designated country code for International or ARIPO trademarks; or US State for US State trademarks\n\nFlat name: DESIGNATED_COUNTRY_CODE\nHierarchical name: DESIGNATED_COUNTRY_CODE","example":"[\"CN\", \"EM\", \"IN\", \"US\"]","type":"string"},"DESIGNATION_BASIS":{"description":"Either MADRID_AGREEMENT, MADRID_PROTOCOL, ARIPO or USA_STATE\n\nFlat name: DESIGNATION_BASIS\nHierarchical name: DESIGNATION_BASIS","example":"MADRID_PROTOCOL","type":"string"},"DISCLAIMERS":{"description":"Disclaimers\n\nFlat name: DISCLAIMERS\nHierarchical name: DISCLAIMERS","example":"[\"BUSINESS FINANCE\"]","type":"string"},"EXPIRY_DATE":{"description":"Exipiry date\nThis field is of type date but will be serialized to type string.\n\nFlat name: EXPIRY_DATE\nHierarchical name: STATUS.EXPIRY_DATE","example":"2012-05-21","format":"date","type":"string"},"FILING_DATE_DERIVED":{"description":"Harmonized filing date\nThis field is of type date but will be serialized to type string.\n\nFlat name: FILING_DATE_DERIVED\nHierarchical name: STATUS.FILING_DATE_DERIVED","example":"2002-05-21","format":"date","type":"string"},"GUID":{"description":"Trademark record unique global identifier\n\nFlat name: GUID\nHierarchical name: GUID","example":"USAFI65E053B1C87611DEB9C6000D609921FB","type":"string"},"GUID_DERIVED":{"description":"Trademark record unique global identifier on designated country level for International marks","example":"CNINTEIF1B28495161911E58373A272ECEBA1B7","type":"string"},"ID":{"description":"Deprecated, use GUID. Trademark record unique global identifier\n\nFlat name: ID\nHierarchical name: ID","example":"INTEIF1B28495161911E58373A272ECEBA1B7","type":"string"},"ID_DERIVED":{"description":"Deprecated, use GUID_DERIVED. Trademark record unique global identifier on designated country level for International marks","example":"CNINTEIF1B28495161911E58373A272ECEBA1B7","type":"string"},"IMAGES_TOTAL_QUANTITY":{"description":"Image available for the trademark record\n\nFlat name: IMAGES_TOTAL_QUANTITY\nHierarchical name: IMAGES_TOTAL_QUANTITY","example":1,"type":"number"},"IMAGE_KIND":{"description":"Kind of available image. None or PUBLICATION_COPY.\n\nFlat name: IMAGE_KIND\nHierarchical name: IMAGE_KIND","example":"PUBLICATION_COPY","type":"string"},"INITIAL_APPLICATION_DATE":{"description":"Initial application date\nThis field is of type date but will be serialized to type string.\n\nFlat name: INITIAL_APPLICATION_DATE\nHierarchical name: STATUS.INITIAL_APPLICATION_DATE","example":"2002-05-21","format":"date","type":"string"},"INITIAL_REGISTRATION_DATE":{"description":"Initial registration date\nThis field is of type date but will be serialized to type string.\n\nFlat name: INITIAL_REGISTRATION_DATE\nHierarchical name: STATUS.INITIAL_REGISTRATION_DATE","example":"2003-03-21","format":"date","type":"string"},"INT_CLASS_HEADING_DERIVED":{"description":"Shortened Nice class heading","example":"PHARMACEUTICALS","type":"string"},"INT_CLASS_NUMBER":{"description":"Nice class number\n\nFlat name: INT_CLASS_NUMBER\nHierarchical name: GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_CLASS_NUMBER","example":"05","type":"string"},"INT_CLASS_TYPE_DERIVED":{"description":"Class type","example":"GOODS","type":"string"},"INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION":{"description":"Machine translated goods and service description\n\nFlat name: INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION\nHierarchical name: GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_DESCRIPTION","example":"ONLY TEST STRIPS FOR EXAMS.","type":"string"},"INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE":{"description":"Machine translated goods and service description language code\n\nFlat name: INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE\nHierarchical name: GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_GOODS_SERVICES_COMPUTER_TRANSLATION_ENRICHED_LANGUAGE_CODE","example":"EN","type":"string"},"INT_GOODS_SERVICES_DESCRIPTION":{"description":"Goods and service description\n\nFlat name: INT_GOODS_SERVICES_DESCRIPTION\nHierarchical name: GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_GOODS_SERVICES_DESCRIPTION","example":"SOLAMENTE TIRAS REACTIVAS PARA EXAMENES.","type":"string"},"INT_GOODS_SERVICES_LANGUAGE_CODE":{"description":"Goods and service description language code\n\nFlat name: INT_GOODS_SERVICES_LANGUAGE_CODE\nHierarchical name: GOODS_SERVICES.INT_CLASS_DESCRIPTIONS.INT_GOODS_SERVICES_LANGUAGE_CODE","example":"ES","type":"string"},"LAST_PUBLICATION_DATE":{"description":"Last publication date\nThis field is of type date but will be serialized to type string.\n\nFlat name: LAST_PUBLICATION_DATE\nHierarchical name: STATUS.LAST_PUBLICATION_DATE","example":"2002-01-21","format":"date","type":"string"},"LAST_UPDATED_DATE":{"description":"A date that symbolizes the last update in the database\nThis field is of type timestamp but will be serialized to type string.\n\nFlat name: LAST_UPDATED_DATE\nHierarchical name: LAST_UPDATED_DATE","example":"2022-05-05","format":"date","type":"string"},"MARK_FEATURE":{"description":"Type of trademark\n\nFlat name: MARK_FEATURE\nHierarchical name: MARK_FEATURE","example":"WORD AND DESIGN","type":"string"},"MARK_TRANSLATION_TEXT":{"description":"Verbal element translation\n\nFlat name: MARK_TRANSLATION_TEXT\nHierarchical name: WORD_MARK_SPECIFICATION.MARK_TRANSLATION_TEXT","example":"BUTTERFLY","type":"string"},"MARK_TRANSLITERATION_TEXT":{"description":"Verbal element transliteration\n\nFlat name: MARK_TRANSLITERATION_TEXT\nHierarchical name: WORD_MARK_SPECIFICATION.MARK_TRANSLITERATION_TEXT","example":"LAO YAO LANG","type":"string"},"MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED":{"description":"=\n\nFlat name: MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED\nHierarchical name: WORD_MARK_SPECIFICATION.MARK_VERBAL_ELEMENT_CROSS_REFERENCES_ENRICHED","example":"ZOSPREGA FOR YOU","type":"string"},"MARK_VERBAL_ELEMENT_TEXT":{"description":"Verbal element\n\nFlat name: MARK_VERBAL_ELEMENT_TEXT\nHierarchical name: WORD_MARK_SPECIFICATION.MARK_VERBAL_ELEMENT_TEXT","example":"ZOSPREGA 4U","type":"string"},"NAT_CLASS_NUMBER":{"description":"National class number\n\nFlat name: NAT_CLASS_NUMBER\nHierarchical name: GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS.NAT_CLASS_NUMBER","example":"36F01","type":"string"},"NAT_GOODS_SERVICES_DESCRIPTION":{"description":"National goods and service description\n\nFlat name: NAT_GOODS_SERVICES_DESCRIPTION\nHierarchical name: GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS.NAT_GOODS_SERVICES_DESCRIPTION","example":"APPRAISAL OF ANTIQUES, ART, JEWELRY","type":"string"},"NAT_GOODS_SERVICES_LANGUAGE_CODE":{"description":"National goods and service description language\n\nFlat name: NAT_GOODS_SERVICES_LANGUAGE_CODE\nHierarchical name: GOODS_SERVICES.NAT_CLASS_DESCRIPTIONS.NAT_GOODS_SERVICES_LANGUAGE_CODE","example":"JA","type":"string"},"PRIORITY_COUNTRY_CODE":{"description":"Country or territory of filing the application for which priority is claimed\n\nFlat name: PRIORITY_COUNTRY_CODE\nHierarchical name: PRIORITIES.COUNTRY_CODE","example":"BX","type":"string"},"PRIORITY_DATE":{"description":"Filing date of the application for which priority is claimed\nThis field is of type date but will be serialized to type string.\n\nFlat name: PRIORITY_DATE\nHierarchical name: PRIORITIES.PRIORITY_DATE","example":"2010-03-17","format":"date","type":"string"},"PRIORITY_NUMBER_TEXT":{"description":"Filing number of the application for which priority is claimed\n\nFlat name: PRIORITY_NUMBER_TEXT\nHierarchical name: PRIORITIES.NUMBER_TEXT","example":"85/535,907","type":"string"},"PUBLICATION_DATE":{"description":"Publication date\nThis field is of type date but will be serialized to type string.\n\nFlat name: PUBLICATION_DATE\nHierarchical name: STATUS.PUBLICATION_DATE","example":"2002-01-21","format":"date","type":"string"},"PUBLICATION_YEAR":{"description":"Publication year\n\nFlat name: PUBLICATION_YEAR\nHierarchical name: STATUS.PUBLICATION_YEAR","example":2002,"type":"number"},"REGISTRATION_DATE":{"description":"Registration date\nThis field is of type date but will be serialized to type string.\n\nFlat name: REGISTRATION_DATE\nHierarchical name: STATUS.REGISTRATION_DATE","example":"2003-03-21","format":"date","type":"string"},"REGISTRATION_NUMBER_TEXT":{"description":"Registration number\n\nFlat name: REGISTRATION_NUMBER_TEXT\nHierarchical name: STATUS.REGISTRATION_NUMBER_TEXT","example":"1256107","type":"string"},"REGISTRATION_OFFICE_CODE":{"description":"Office code\n\nFlat name: REGISTRATION_OFFICE_CODE\nHierarchical name: REGISTRATION_OFFICE_CODE","example":"WO","type":"string"},"REGISTRATION_OFFICE_CODE_DERIVED":{"description":"Office code of national/regional filing or of expanded designated office for International trademarks or Aripo trademarks","example":"CN","type":"string"},"RENEWAL_DATE":{"description":"Renewal date\nThis field is of type date but will be serialized to type string.\n\nFlat name: RENEWAL_DATE\nHierarchical name: STATUS.RENEWAL_DATE","example":"2012-05-21","format":"date","type":"string"},"RENEWAL_PUBLISHED_DATE":{"description":"Renewal published date\nThis field is of type date but will be serialized to type string.\n\nFlat name: RENEWAL_PUBLISHED_DATE\nHierarchical name: STATUS.RENEWAL_PUBLISHED_DATE","example":"2012-05-21","format":"date","type":"string"},"REPRESENTATIVE_ADDRESS_COUNTRY_CODE":{"description":"Representative country code\n\nFlat name: REPRESENTATIVE_ADDRESS_COUNTRY_CODE\nHierarchical name: REPRESENTATIVES.ADDRESS_COUNTRY_CODE","example":"US","type":"string"},"REPRESENTATIVE_ADDRESS_LINE_TEXT":{"description":"Representative address\n\nFlat name: REPRESENTATIVE_ADDRESS_LINE_TEXT\nHierarchical name: REPRESENTATIVES.ADDRESS_LINE_TEXT","example":"1717 K STREET NW WASHINGTON DC 20006 UNITED STATES OF AMERICA","type":"string"},"REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT":{"description":"Representative address in the language of the publication\n\nFlat name: REPRESENTATIVE_ADDRESS_NATIVE_LINE_TEXT\nHierarchical name: REPRESENTATIVES.ADDRESS_NATIVE_LINE_TEXT","example":"11000 БЕОГРАД, ВЕЛЕ НИГРИНОВЕ 16А","type":"string"},"REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE":{"description":"Representative correspondent country code\n\nFlat name: REPRESENTATIVE_CORRESPONDENT_ADDRESS_COUNTRY_CODE\nHierarchical name: REPRESENTATIVE_CORRESPONDENTS.ADDRESS_COUNTRY_CODE","example":"NZ","type":"string"},"REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT":{"description":"Representative correspondent address\n\nFlat name: REPRESENTATIVE_CORRESPONDENT_ADDRESS_LINE_TEXT\nHierarchical name: REPRESENTATIVE_CORRESPONDENTS.ADDRESS_LINE_TEXT","example":"AON CENTRE PO BOX 949 LEVEL 22 WELLINGTON 1 WILLIS STREET 6140","type":"string"},"REPRESENTATIVE_CORRESPONDENT_NAME":{"description":"Representative correspondent name\n\nFlat name: REPRESENTATIVE_CORRESPONDENT_NAME\nHierarchical name: REPRESENTATIVE_CORRESPONDENTS.NAME","example":"AJ PARK","type":"string"},"REPRESENTATIVE_NAME":{"description":"Representative name\n\nFlat name: REPRESENTATIVE_NAME\nHierarchical name: REPRESENTATIVES.NAME","example":"LUNA M. SAMMAN ARENT FOX LLP","type":"string"},"REPRESENTATIVE_NAME_NATIVE":{"description":"Representative name in the language of the publication\n\nFlat name: REPRESENTATIVE_NAME_NATIVE\nHierarchical name: REPRESENTATIVES.NAME_NATIVE","example":"PETOŠEVIĆ SLOBODAN, ADVOKAT","type":"string"},"SECOND_LANGUAGE_CODE":{"description":"Application second language code\n\nFlat name: SECOND_LANGUAGE_CODE\nHierarchical name: SECOND_LANGUAGE_CODE","example":"FR","type":"string"}},"type":"object"},"type":"array"},"total_count":{"description":"Total number of results","type":"number"}},"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"example":{"code":1200,"error":"Invalid request. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Invalid request"},"401":{"content":{"application/json":{"example":{"code":1100,"error":"Insufficient permissions to access this resources. Please contact support if you believe this is an error."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"example":{"code":10200,"error":"Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"code":1201,"error":"Endpoint not found"},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"example":{"code":1300,"error":"Something went wrong. Please try again, and contact support if error persists."},"schema":{"properties":{"code":{"description":"Application error code","type":"integer"},"error":{"description":"Error message","type":"string"}},"required":["code","error"],"type":"object"}}},"description":"Internal server error"}},"summary":"Search trademarks, analytic format","tags":["Trademarks"]}}},"servers":[{"url":"https://api.clarivate.com"}],"x-api-category":"DERWENT API","security":[{"key":[]}]}