From e1bea815c7d4053b49d309038130fb9703c81d28 Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Sat, 3 Apr 2021 23:54:09 -0400 Subject: [PATCH] Add endpoint docs to Item --- docs/api/Items.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/api/Items.md b/docs/api/Items.md index 381581f..9d14e8f 100644 --- a/docs/api/Items.md +++ b/docs/api/Items.md @@ -2,6 +2,28 @@ An item is a chronological representation of an interaction with a user. +## Endpoint +``` +GET /api/{queue}/{number} +``` +### Parameters +Name | Value +- | - +`queue` | The queue of the item. +`number` | The number of the item. + +### Query String Options +Name | Description | Possible Values +- | - | - +`headersOnly` | When `"True"`, only meta data will be loaded. When `"False"` content will be parsed. (Defaults to `"False"`.) | `"True"` \| `"False"` + +### Return Codes +Code | Description +- | - +`200 - Ok` | On success. +`500 - Internal Service Error` | On failure. + + ## Properties ### `Item.lastUpdated`