Group related
Create a Group in a Shift
Creates a new Group in a Shift.
| Method | URL | API key Authentication |
|---|---|---|
| POST | /PartnerServices/AddGroupToShift | REQUIRED |
Request Body Parameters
| Field | Type | Required | Description | Format Allowed |
|---|---|---|---|---|
| kindlyShiftId | String | ✔ | Shift's ID'. | Any string value |
| partnerGroupName | String | ✔ | Group's Name. *Displayed in the app. | Any string value |
| partnerGroupType | Integer | ✔ | Group's Type. | An integer from 1 to 7 Learn more in Group Type enum |
| partnerGroupUserCount | Integer | ✔ | The maximum number of Volunteers that can join the Group. | Positive integer, greater than 0 |
| partnerRegisteredUserCount | Integer | ❌ | The number of non-Kindly Users who are members of the Group. | Positive integer, greater than or equal to 0 |
| kindlyUserId | String | ❌ | The User ID of the Group Leader. | Any string value |
| partnerGroupId | String | ❌ | Group's ID. (from Partner) | Any string value |
| partnerGroupJoinCode | String | ❌ | Group's Join Code. | Any string value |
Example Request Body
{
"kindlyShiftId": "688afa4497bd44ba852f5c5673b365f8",
"partnerGroupName": "The Cool Group",
"partnerGroupType": 4,
"partnerGroupUserCount": 15,
"partnerRegisteredUserCount": 5,
"kindlyUserId":"2c03414c91fc42c28043528edecc4fca",
"partnerGroupId": "0123456789abc",
"partnerGroupJoinCode": "abc123456"
}
Response Status Codes
| Status Code | Description |
|---|---|
| 200 - OK | When the Group was created successfully. |
| 400 - Bad Request | When the request is invalid or missing required parameters.Scenarios• Missing API key • Payload is not set • Missing required fields • Shift does not exist • Shift does not exist for Partner • Shift has finished • Field partnerGroupUserCount is less than or equal to 0• Shift does not have any open slots • Invalid Group Type • Provided Group Leader is not a registered User • Field partnerRegisteredUserCount is greater than partnerGroupUserCount |
| 401 - Unauthorized | When the API key is incorrect. |
| 409 - Conflict | When the Partner Group ID is already in use. |
| 420 - | When the provided Shift is canceled. |
| 500 - Internal Server Error | When any exception occurred. |
Success Response Format
Returns a JSON object containing details of the newly added Group.
| Field | Type | Description |
|---|---|---|
| kindlyPartnerGroupId | String | Group's ID.DetailsTo execute more transactions for this Group, you need to manage/store this ID |
| kindlyShiftId | String | Shift ID. |
| partnerGroupId | String | Group's ID. (from Partner) |
Example Response Body
{
"kindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24",
"kindlyShiftId": "688afa4497bd44ba852f5c5673b365f8",
"partnerGroupId": "0123456789abc"
}
Remove a Group from its Shift
Removes a Group from its Shift.
| Method | URL | API key Authentication |
|---|---|---|
| PUT | /PartnerServices/RemoveGroupFromShift | REQUIRED |
Request Body Parameters
| Field | Type | Required | Description | Format Allowed |
|---|---|---|---|---|
| kindlyPartnerGroupId | String | ✔ | Group's ID. | Any string value |
| kindlyShiftId | String | ✔ | Shift's ID. | Any string value |
Example Request Body
{
"kindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24",
"kindlyShiftId": "688afa4497bd44ba852f5c5673b365f8"
}
Response Status Codes
| Status Code | Description |
|---|---|
| 200 - OK | When the Group was removed successfully. |
| 400 - Bad Request | When the request is invalid or missing required parameters. |
| 401 - Unauthorized | When the API key is incorrect. |
| 500 - Internal Server Error | When any exception occurred. |
Success Response Format
Returns a boolean value true when the removal is successful.
Update details of a Group
Updates the Group's information.
The fields partnerGroupId and partnerGroupJoinCode are not defined when a Group is created through the app.
| Method | URL | API key Authentication |
|---|---|---|
| PUT | /PartnerServices/UpdateGroupInShift | REQUIRED |
Request Parameters
| Field | Type | Required | Description | Format Allowed |
|---|---|---|---|---|
| KindlyPartnerGroupId | String | ✔ | Group's ID | Any string value |
| kindlyShiftId | String | ✔ | Shift's ID | Any string value |
| partnerGroupName | String | ✔ | Group's Name. *Displayed in the app. | Any string value |
| partnerGroupType | Integer | ✔ | Group's Type. | An integer from 1 to 7 Learn more in Group Type enum |
| partnerGroupUserCount | Integer | ✔ | The maximum number of Volunteers that can join the Group. | Positive integer, greater than or equal to 0 |
| partnerRegisteredUserCount | Integer | ❌ | The number of non-Kindly Users who are members of the Group. | Positive integer, greater than or equal to 0 |
| kindlyUserId | String | ❌ | The User ID of the Group Leader. | Any string value |
| partnerGroupId | String | ❌ | Group's ID. (from Partner) | Any string value |
| partnerGroupJoinCode | String | ❌ | Group's Join Code. | Any string value |
Example Request Body
{
"KindlyPartnerGroupId": "d223d859edae404290fc6d79a393aa24",
"kindlyShiftId": "688afa4497bd44ba852f5c5673b365f8",
"partnerGroupName": "The Cool Group",
"partnerGroupType": 4,
"partnerGroupUserCount": 15,
"partnerRegisteredUserCount": 5,
"kindlyUserId":"2c03414c91fc42c28043528edecc4fca",
"partnerGroupId": "0123456789abc",
"partnerGroupJoinCode": "abc123456"
}
Response Status Codes
| Status Code | Description |
|---|---|
| 200 - OK | When the Group was updated successfully. |
| 400 - Bad Request | When the request is invalid or missing required parameters.Scenarios• Missing API key • Payload is not set • Missing required fields • Shift does not exist • Shift has finished • Field partnerGroupUserCount is less than or equal to 0• Shift does not have any open slots in order to change the Group slots count • Group does not exist • Field partnerGroupId is already in use• Invalid Group Type • Provided Group Leader is not a registered User • Field partnerGroupUserCount is less than the count of Users already registered in the Group and/or partnerRegisteredUserCount |
| 401 - Unauthorized | When the API key is incorrect. |
| 409 - Conflict | When the provided Group Leader already owns a Group in the same Shift. |
| 500 - Internal Server Error | When any exception occurred. |
Success Response Format
Returns a boolean value true when the update is successful.
Remove an Invited Name from a Group
Removes an Invited Name from a Group.
| Method | URL | API key Authentication |
|---|---|---|
| DELETE | /PartnerServices/RemoveNameFromGroup | REQUIRED |
Request Query Parameters
| Parameter | Type | Required | Description | Format Allowed |
|---|---|---|---|---|
| kindlyInvitationId | String | ✔ | Invited Name's ID. | Any string value |
Example Query Parameters
?kindlyInvitationId=10473963d373401fa1430096bfb38da7
Response Status Codes
| Status Code | Description |
|---|---|
| 200 - OK | When the Invited Name was removed successfully. |
| 400 - Bad Request | When the request is invalid or missing required parameters.Scenarios• Missing API key • Missing required fields • Shift does not exist • Shift does not exist for Partner • Shift has started • Invited Name does not exist • Invited Name does not exist for Partner |
| 401 - Unauthorized | When the API key is incorrect. |
| 500 - Internal Server Error | When any exception occurred. |
Get details of an Invited Name
Gets details of an Invited Name, added by the Group Leader.
| Method | URL | API key Authentication |
|---|---|---|
| GET | /PartnerServices/GetInviteeDetails | REQUIRED |
Request Query Parameters
| Parameter | Type | Required | Description | Format Allowed |
|---|---|---|---|---|
| kindlyInvitationId | String | ✔ | Invited Name ID. | Any string value |
Example Query Parameters
?kindlyInvitationId=10473963d373401fa1430096bfb38da7
Response Status Codes
| Status Code | Description |
|---|---|
| 200 - OK | When the details of the Invited Name are retrieved successfully. |
| 400 - Bad Request | When the request is invalid or missing required parameters.Scenarios• Missing API key • Missing required fields • Invited Name does not exist • Invited Name does not exist for Partner |
| 401 - Unauthorized | When the API key is incorrect. |
| 500 - Internal Server Error | When any exception occurred. |
Success Response Format
Returns a JSON object containing the information of the Invited Name.
| Field | Type | Description |
|---|---|---|
| firstName | String | Invited Name's First Name. |
| lastName | String | Invited Name's Last Name. |
| String | Invited Name's Email Address. | |
| isMinor | Boolean | Whether the Invited Name is a minor. |
Example Response Body
{
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@gmail.com",
"isMinor": false
}