Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
   "time" : "2.128691",
   "status" : "success",
   "family" : {
      "members" : [
         "DE-69519006-D1",
         "EP-0700000-A2",
         "EP-0700000-A3",
         "EP-0700000-B1",
         "JP-2986075-B2",
         "JP-H0877023-A",
         "US-5581765-A"
      ],
      "root" : "EP-0700000-B1"
   }
}

 

/family/citations/forward

This service will retrieve a unique set of ucids citing each member of the simple family.

Method(s)GET
Path/family/citations/forward
Parameter
ValuesDescription

@ucidString: ex. US-5551212-AUnique character identifier (publication)


Example:

Code Block
wget -O- -q \
  --header 'x-user:x' --header 'x-password:y' \
"http://cdws21.ificlaims.com/family/citations/forward?ucid=US-5000000-A"


Response JSON:

Code Block
{
   "citations" : {
      "ucids" : [
         "AU-753879-B2",
         "EP-0576621-A1",
         "EP-0576621-A4",
         "EP-0646645-A2",
         "EP-0646645-A3",
         "EP-0711832-A2",
         "EP-0786523-A2",
; etc.
      ],
      "count" : 346,
      "root" : "US-5000000-A",
      "family_id" : "26932266"
   },
   "time" : "0.202",
   "status" : "success"
}

/family/citations/backward

This service will retrieve a unique set of ucids cited by each member of the simple family.

Method(s)GET
Path/family/citations/backward
Parameter
ValuesDescription

@ucidString: ex. US-5551212-AUnique character identifier (publication)


Example:

Code Block
wget -O- -q \
  --header 'x-user:x' --header 'x-password:y' \
"http://cdws21.ificlaims.com/family/citations/backward?ucid=US-5000000-A"


Response JSON:

Code Block
{
   "citations" : {
      "ucids" : [
         "EP-0047641-A2",
         "WO-1986001833-A1",
         "WO-1986004357-A1"
      ],
      "root" : "US-5000000-A",
      "family_id" : "26932266",
      "count" : 3
   },
   "time" : "0.187",
   "status" : "success"
}


/family/meta/dn

This service will retrieve extended data for every member of the simple family. The available fields for each family member are as follows:

MemberDescription
ucidUnique character identifier (publication)
anucidUnique character identifier (application)
publishedpublication date
filedfiling date
titletitle of document
ifi_statusIFI calculated patent status
ifi_anticipated_expirationIFI calculated expiration date
epo_legal_status

EPO Legal Status

MemberDescription
countryCountry is represented by a standard 2-character code based on WIPO ST.3
impact+ , -, or neutral

title

Description of the legal status code, e.g., LAPSED
code1-4 character code. Legal status codes are country-specific. See  https://www.epo.org/searching-for-patents/helpful-resources/data/tables/weekly.html for more information.
dateDate of public notification (YYYYMMDD), e.g., gazette date



Method(s)GET
Path/family/meta/dn
Parameter ValuesDescription
 @idString: ex. US-5551212-AOne or more space or comma-separated ucids

 

Example:

Code Block
wget -O- -q \
  --header 'x-user:x' \
  --header 'x-password:y' \
'http://cdws21.ificlaims.com/family/meta/dn?id=US-5551212-A'

...