POST idea
URL: https://api.ipscreener.com/v1/idea Method: POST Headers Required: Body Required: Username=[string] Reference=[string] Title=[string] Summary=[string] Header authorization :An API authorization key must be Body Username: What user is making the request. Reference: Reference name for your case/search. Title: The title of your idea. Summary: A description of your idea.
data: the session ticket value associated with a search request used to GET the search results. case: Your case Id used to GET your search results or to prolong a case from expired. url: A url to your search result inside IPscreener with automatic login. expire: a ticket is valid for 1 hour before expired and ticket is invalid. | Success Response Body content format: JSON The below response will be returned once the search request has been processed. To view the result please use the GET idea API with the case value. 200 Success {
"status": "success",
"message": "New idea have been created successfully",
"data": {
"case": "20696",
"url": "https://my.ipscreener.com/token/Os3MVIKTjJ4/4XyTCNgFNm5TcgsyPvJxiH8StUjM4Xz85ItLfQpfYcSs",
"expire": 1589535977
}
}
Error Response Error response {
"status": "error",
"message": "Data in required fields are missing"
}
|
Sample Call (cURL) Sample Call (cURL) curl --location --request POST 'https://api.ipscreener.com/v1/idea' \ --header 'key: <value>' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'username=<email>' \ --data-urlencode 'reference=Solid-state drive' \ --data-urlencode 'title=Solid-state drive' \ --data-urlencode 'summary=text' \ |
GET idea
URL: https://api.ipscreener.com/v1/idea Method GET Headers Key=<value> Body Case=<value> Header authorization :An API authorization key must be Body Case: the session ticket value associated with a search request used to GET the search results Sample Call Notes | 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. Do note; the response below is an example where we have truncated the data for several fields to make the view more condensed and comprehensive. Error Response |
PUT idea
| URL https://api.ipscreener.com/v1/idea Method PUT Headers Key=<value> Body case=<value> Success Response Sample Call Notes | 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. Do note; the response below is an example where we have truncated the data for several fields to make the view more condensed and comprehensive. Error Response |