Versions Compared

Key

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

...

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

Method: PUT

Headers

authorization=[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
languageactionscript3
{
    "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
languageactionscript3
{
    "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 or dosen't exist.
  • 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
languageactionscript3
titleNo permission
{
    "status": "error",
    "message": "You dont have permission to do that"
}

Sample Call (cURL)

Code Block
languageactionscript3
titleSample 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'




...