List Keywords


URL:

https://api2.protexting.com/v1/keyword/index?access_token=your_access_token


Method:

GET

Response parameters:

Parameter Description
Id Keyword ID
Name Keyword Name
Date_Reserved Reserve Date
Number Short Code or Long Number
Status_Id Keyword Status ID »
Satus_Description Keyword Status Description »

Example Request:

curl -i -H "Accept:application/xml" "https://api2.protexting.com/v1/keyword/index?access_token=your_access_token"

 

Example Response Headers:

Status Code: 200 OK
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Connection: Keep-Alive
Content-Type: application/xml; charset=utf-8
Keep-Alive: timeout=5, max=100
Link: <https://api2.protexting.com/v1/keyword/index?access_token=your_access_token&page=1>; 
rel=self Pragma: no-cache Transfer-Encoding: chunked X-Pagination-Current-Page: 1 X-Pagination-Page-Count: 1 X-Pagination-Per-Page: 100 X-Pagination-Total-Count: 10 X-Powered-By: PHP/5.6.2 X-Rate-Limit-Limit: 60 X-Rate-Limit-Remaining: 59 X-Rate-Limit-Reset: 0

Example Response Body:

[
    {
    	"Id": 100,
        "Keyword": "MyKeyword",
"Date_Reserved":"2015-02-10",
"Number":"82257",
"Status_Id":1,
"Status_Description":"Active" }, .......... ]
<response>
    <item>
    	<Id>100</Id>
        <Keyword>MyKeyword</Keyword>
<Date_Reserved>2015-02-10</Date_Reserved>
<Number>82257</Number>
<Status_Id>1</Status_Id>
<Status_Description>Active</Status_Description> </item>
........................................ </response>

 

HTTP Status Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Error Codes:

Error Codes and Examples here »

 

Statuses

Status_Id Status_Description
1 Active
0 Not Active