Skip to content

Commit

Permalink
Merge branch 'master' of lpgithub.dev.lprnd.net:product-marketing/dev…
Browse files Browse the repository at this point in the history
…elopers-community
  • Loading branch information
Eden Kupermintz committed Oct 1, 2019
2 parents eb2008d + 4800495 commit 15ce3e2
Show file tree
Hide file tree
Showing 2 changed files with 129 additions and 0 deletions.
54 changes: 54 additions & 0 deletions _template/Methods/rest-api-method1.md
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&param2=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"
}
}
```


75 changes: 75 additions & 0 deletions _template/Methods/rest-api-method2.md
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&param2=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"
}
}
```

0 comments on commit 15ce3e2

Please sign in to comment.