Page History

...

URL: https://api.ipscreener.com/v1/idea

Method: PUT

Headers

Key=[value]

Body

case=[value]

Success Response

data: contains all case data

case: the session ticket value associated with a search request used to PUT the search results.

url: a new URL token is generated.

expire: how long a case id is valid. Before expiring. Time is displayed in UNIX

Success Response:

Body content format: JSON

When checking if data is ready for retrieval you only use the parameter ticket value. The response below will be returned once the search request has been processed and is ready for delivery.

This API is used to retrive data from an expired ticket.

Code Block

language	actionscript3

{
    "status": "success",
    "message": "New token have been created successfully",
    "data": {
        "case": "20718",
        "url": "https://my.ipscreener.com/token/GJhhi9aDxovk",
        "expire": 1589810666
    }
}

Error Response

The below response will be returned if your API key is wrong or invalid.

Code Block

language	actionscript3

{
    "status": "error",
    "message": "API key is not valid"
}

The below response will be returned if your case token is;

wrong ( too long or short )
try to open a case id that belongs to another customer/company.
Special char included in id, e.g 207"4
tab, whitespace or enter is used in case id field, e.g 20 74

Code Block

language	actionscript3
title	No permission

{
    "status": "error",
    "message": "You dont have permission to do that"
}

Sample Call (cURL)

Code Block

language	actionscript3
title	Sample Call (cURL)

curl --location --request PUT 'https://api.ipscreener.com/v1/idea' \
--header 'key: [value]' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'case=20718'

GET Download

URL: https://api.ipscreener.com/v1/download

Method: GET

Headers

Key=[value]

Body

case=[value]

type=[keyword]

pdf_ranked (Only ranked document)
pdf_all (All documents)
excel_ranked (Only ranked document)
excel_all (All documents)
word_ranked (Only ranked document)

Success Response

data: contains all case data

case: the session ticket value associated with a search request used to PUT the search results.

url: a new URL token is generated.

expire: how long a case id is valid. Before expiring. Time is displayed in UNIX

The Download API is used to retrieve the original patent document(s) corresponding to a search query. From the requested patent number input via an URL query, the API request returns a PDF,Excel or Word file in base64 format.

Success Response:

Body content format: JSON

Code Block

language	actionscript3
firstline	1
title	HTTPS Success Response 200 OK
linenumbers	true
collapse	true

{
    "status": "success",
    "message": "Report has been successfully fetched",
    "data": "<Complete document encoded in Base64 format>"
 }

Sample call (cURL)

Code Block

language	actionscript3
firstline	1
title	Sample cURL
linenumbers	true
collapse	true

curl --location --request GET 'https://api.ipscreener.com/beta/v1/download' \
--header 'key: Auth-key' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'case=20990' \
--data-urlencode 'type=word_ranked'

Page tree

Versions Compared

Old Version 12

New Version 13

Key

GET Download