DELETE api/Groups/{id}

Delete a Group if you have the Credentials to do so. NOTE: This will also delete all associated SubGroups under this Group.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the Group to be deleted	integer	Required

Body Parameters

None.

Response Information

Resource Description

returns false all the time at the moment

DeleteResponse

Name	Description	Type	Additional information
Success	Was it successful or not	boolean	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:37:56.3698791+10:00",
    "BuildDateUTC": "2025-11-09T21:37:56.3698791+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  },
  "Success": true
}

application/xml, text/xml

Sample:

<DeleteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
  </Messages>
  <ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
    <d2p1:BuildDateUTC>2025-11-09T21:37:56.3698791+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:37:56.3698791+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <Success>true</Success>
</DeleteResponse>