Groups - Revision history

Harv: /* Get All Groups */

2024-04-08T19:51:30Z

‎Get All Groups

Harv: /* Updating a Group */

2024-04-08T19:49:50Z

‎Updating a Group

Harv at 19:46, 8 April 2024

2024-04-08T19:46:20Z

Harv at 19:43, 8 April 2024

2024-04-08T19:43:56Z

Harv: Created page with "== Create a Group == This allows you to start grouping client locations into groups that you manage. === API Endpoint === http://p.lssdev.com/le..."

2024-04-08T19:43:45Z

Created page with "== Create a Group == This allows you to start grouping client locations into groups that you manage. === API Endpoint === <syntaxhighlight lang="html"> http://p.lssdev.com/le..."

New page

== Create a Group ==
This allows you to start grouping client locations into groups that you manage.

=== API Endpoint ===
<syntaxhighlight lang="html">
http://p.lssdev.com/legacygroups
</syntaxhighlight>

=== Example Request ===
<syntaxhighlight lang="php">
POST /legacygroups HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json

{"name":"Test Group"}
</syntaxhighlight>

"name" is the name of the group you want to create

=== Example Response ===
<syntaxhighlight lang="json">
{
"status": 200,
"success": true,
"error": null,
"data": {
"name": "Test Group",
"createdAt": "2024-04-08T19:41:00.474Z",
"updatedAt": "2024-04-08T19:41:00.474Z",
"partner": 760
}
}
</syntaxhighlight>

@@ Line 1: / Line 1: @@
 == Get All Groups ==
-Get a list of all the groups created for this partner dashboard.
+Get a list of all the groups created for this partner dashboard.   The query parameter ?populate=clients will include an array of the clients that belong to this group.  However, it should be noted that the request may become very large as the parent request is obligated to expand the one-to-many relationship.
 === API Endpoint ===
 <syntaxhighlight lang="html">
-https://p.lssdev.com/legacygroups
+https://p.lssdev.com/legacygroups?populate=clients
 </syntaxhighlight>

@@ Line 93: / Line 93: @@
-{"name":"Test Group"}
+{"name":"Test Group", "clients": [123456, 234567]
 </syntaxhighlight>
-"name" is the desired updated name you want to chnage to
+"name" is the desired updated name you want to change to
 === Example Response ===

@@ Line 1: / Line 1: @@
 == Create a Group ==
 This allows you to start grouping client locations into groups that you manage.
@@ Line 19: / Line 60: @@
 "name" is the name of the group you want to create
 === Example Response ===