You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

POST idea

URL: https://api.ipscreener.com/v3/search

Method: POST

Headers

Required: 
Key=[value]

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.


Success Response:

data: the session ticket value associated with a search request used to GET the search results.

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 search API with the ticket 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' \





URL

Method GET


HeadersKEY
BodyCase
Success Response
Error Response
Sample Call
(cURL)

Notes
URL

Method PUT


HeadersKey
BodyCase
Success Response
Error Response
Sample Call
(cURL)

Notes
  • No labels