forked from LivePersonInc/developer-center
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of lpgithub.dev.lprnd.net:product-marketing/dev…
…elopers-community
- Loading branch information
Showing
2 changed files
with
129 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
pagename: Rest API Methods Template | ||
redirect_from: | ||
- a-link-which-will-redirect-to-this-page.html | ||
sitesection: Documents | ||
categoryname: Highest level sidebar category the document is under. eg. "Conversational AI" | ||
documentname: 2nd folder level under the category. Usually the ProductName. eg. "Templates" | ||
subfoldername: optional lowest level folder possible. eg. "Methods" | ||
permalink: documentname-subfoldername-pagename.html | ||
indicator: accepts "messaging" "chat" or "both" | ||
--- | ||
|
||
Explain what this method does. | ||
|
||
{: .important} | ||
Perhaps note that the developer should see the [introduction](introduction-to-this-product.html) to this product if they have not yet? | ||
|
||
### Request | ||
|
||
| Method | URL | | ||
| --- | --- | | ||
| GET | https://base/product/api/account/accountID/methodname?param1=value¶m2=value | | ||
|
||
#### Request Query Parameters | ||
|
||
| Name | Description | Type / Value | Required | | ||
| --- | --- | --- | --- | | ||
| param1 | This parameter specifies something | number | Yes | | ||
| param2 | This specifies something else | string | No | | ||
|
||
### Response | ||
|
||
Explain generally what you will get back from this method. | ||
|
||
| Property Name | Description | Type / Value | Optional | | ||
| --- | --- | --- | | ||
| myprop | Tells you something | number | No | | ||
| myobject | Contains info on something | object | No | | ||
| info1 | Tells you stuff | string | No | | ||
| info2 | Tells you things | string | Yes | | ||
|
||
#### Response Example | ||
|
||
```json | ||
{ | ||
"myprop": 4, | ||
"myobject": { | ||
"info1": "stuff", | ||
"info2": "things" | ||
} | ||
} | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
pagename: Rest API Method Two Template | ||
redirect_from: | ||
- a-link-which-will-redirect-to-this-page.html | ||
sitesection: Documents | ||
categoryname: Highest level sidebar category the document is under. eg. "Conversational AI" | ||
documentname: 2nd folder level under the category. Usually the ProductName. eg. "Templates" | ||
subfoldername: optional lowest level folder possible. eg. "Methods" | ||
permalink: documentname-subfoldername-pagename.html | ||
indicator: accepts "messaging" "chat" or "both" | ||
--- | ||
|
||
Explain what this method does. | ||
|
||
{: .important} | ||
Perhaps note that the developer should see the [introduction](introduction-to-this-product.html) to this product if they have not yet? | ||
|
||
### Request | ||
|
||
| Method | URL | | ||
| --- | --- | | ||
| POST | https://base/product/api/account/accountID/methodname?param1=value¶m2=value | | ||
|
||
#### Request Query Parameters | ||
|
||
| Name | Description | Type / Value | Required | | ||
| --- | --- | --- | --- | | ||
| param1 | This parameter specifies something | number | Yes | | ||
| param2 | This specifies something else | string | No | | ||
|
||
#### Request Body | ||
|
||
Explain what the POST body payload is for. | ||
|
||
| Property Name | Description | Type / Value | Required | | ||
| --- | --- | --- | --- | | ||
| filter | filters something | boolean | No | | ||
| start | specifies a timerange | object | Yes | | ||
| from | timerange starting point | number | Yes | | ||
| to | timerange ending point | number | No | | ||
|
||
##### Request Body Example | ||
|
||
```json | ||
{ | ||
"filter": true, | ||
"start": { | ||
"from": 1437054059354, | ||
"to": 1437661693023 | ||
} | ||
} | ||
``` | ||
|
||
### Response | ||
|
||
Explain generally what you will get back from this method. | ||
|
||
| Property Name | Description | Type / Value | Optional | | ||
| --- | --- | --- | | ||
| myprop | Tells you something | number | No | | ||
| myobject | Contains info on something | object | No | | ||
| info1 | Tells you stuff | string | No | | ||
| info2 | Tells you things | string | Yes | | ||
|
||
#### Response Example | ||
|
||
```json | ||
{ | ||
"myprop": 4, | ||
"myobject": { | ||
"info1": "stuff", | ||
"info2": "things" | ||
} | ||
} | ||
``` |