Groups

**Groups** are the mechanism to organize your users and assign your printers to various users at the same time.

If you are interested in adding or removing users from groups, please take a look at the Users REST API

Create a Group

To create a group, name and organization_id are required.

The example request uses only the required attributes.

POST "https://api2.ezeep.com/printing/v1/groups/"

Attribute	Type	Required	Description
id	str	no	uuid
name	str	yes	name of the group
description	str	no	group description
local_printing_enabled	boolean	no
myprinters_enabled	boolean	no
origin	object	no	provider of the printing that will be ezeep
organization_id	str	yes	uuid of the organization
num_members	int	no	total user of the group
num_printers	int	no	total printers associated with the group

Example Request

curl  -X POST "https://api2.ezeep.com/printing/v1/groups/" \
      --header "Authorization: Bearer <access_token>" \
      --header "Content-Type: application/json" \
      --data "{
           \"name\":\"test\",
           \"organization_id\":\"11111111-1111-4111-8111-111111111111\"
         }"

Example Response

{
  "id": "d16eeaa2-97ba-464a-b12a-f0ed66cc6078",
  "name": "Test",
  "description": "",
  "local_printing_enabled": false,
  "myprinters_enabled": false,
  "origin": { "provider": "Ezeep" },
  "organization_id": "11111111-1111-4111-8111-111111111111",
  "num_members": 0,
  "num_printers": 0
}

Read a Specific Group by ID

Returns the group with the given id.

GET "https://api2.ezeep.com/printing/v1/groups/<id>/"

Attribute	Type	Required	Description
id	str	yes	uuid
name	str	no	name of the group
description	str	no	group description
local_printing_enabled	boolean	no
myprinters_enabled	boolean	no
origin	object	no	provider of the printing that will be ezeep
organization_id	str	no	uuid of the organization
num_members	int	no	total user of the group
num_printers	int	no	total printers associated with the group

Example Request

curl  -X GET "https://api2.ezeep.com/printing/v1/groups/dd8d4007-2522-42ab-ac2e-bf23d87defc3/" \
      --header "Authorization: Bearer <access_token>"

Example Response

{
  "id": "dd8d4007-2522-42ab-ac2e-bf23d87defc3",
  "name": "Test",
  "description": "",
  "local_printing_enabled": false,
  "myprinters_enabled": false,
  "origin": { "provider": "Ezeep" },
  "organization_id": "11111111-1111-4111-8111-111111111111",
  "num_members": 0,
  "num_printers": 0
}

Read all Groups

Lists all existing groups, for example to look up a group id.

GET "https://api2.ezeep.com/printing/v1/groups/"

Attribute	Type	Required	Description
id	str	no	uuid
name	str	no	name of the group
description	str	no	group description
local_printing_enabled	boolean	no
myprinters_enabled	boolean	no
origin	object	no	provider of the printing that will be ezeep
organization_id	str	no	uuid of the organization
num_members	int	no	total user of the group
num_printers	int	no	total printers associated with the group

Example Request

curl  -X GET "https://api2.ezeep.com/printing/v1/groups/" \
      --header "Authorization: Bearer <access_token>"

Example Response

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "22222222-2222-4222-8222-222222222222",
      "name": "free",
      "description": "free",
      "local_printing_enabled": true,
      "myprinters_enabled": false,
      "origin": { "provider": "Ezeep" },
      "organization_id": "11111111-1111-4111-8111-111111111111",
      "num_members": 2,
      "num_printers": 6
    },
    {
      "id": "bd63ffd9-6904-46ec-b271-b258a59f07a5",
      "name": "test",
      "description": "",
      "local_printing_enabled": false,
      "myprinters_enabled": false,
      "origin": { "provider": "Ezeep" },
      "organization_id": "11111111-1111-4111-8111-111111111111",
      "num_members": 1,
      "num_printers": 1
    },
    {
      "id": "e882245a-9619-4de8-87e4-28ccf25435cf",
      "name": "Premium",
      "description": "extar costs",
      "local_printing_enabled": false,
      "myprinters_enabled": false,
      "origin": { "provider": "Ezeep" },
      "organization_id": "11111111-1111-4111-8111-111111111111",
      "num_members": 0,
      "num_printers": 0
    }
  ]
}

Update Group Information

Updates the attributes of the group with the given id. Send only the attributes you want to change.

PATCH "https://api2.ezeep.com/printing/v1/groups/<id>/"

Attribute	Type	Required	Description
id	str	yes	uuid
name	str	no	name of the group
description	str	no	group description
local_printing_enabled	boolean	no
myprinters_enabled	boolean	no
origin	object	no	provider of the printing that will be ezeep
organization_id	str	no	uuid of the organization
num_members	int	no	total user of the group
num_printers	int	no	total printers associated with the group

Example Request

curl  -X PATCH "https://api2.ezeep.com/printing/v1/groups/bd63ffd9-6904-46ec-b271-b258a59f07a5/" \
      --header "Authorization: Bearer <access_token>" \
      --header "Content-Type: application/json" \
      --data "{
          \"name\" : \"test-2\",
          \"description\" : \"this is test group\"
       }"

Example Response

    {
        "id":"bd63ffd9-6904-46ec-b271-b258a59f07a5","name":"test-2","description":"this is test group","local_printing_enabled":false,"myprinters_enabled":false,"origin":{"provider":"Ezeep"},"organization_id":"11111111-1111-4111-8111-111111111111","num_members":1,"num_printers":1
    }

Delete a Group

Deletes the group with the given id.

DELETE "https://api2.ezeep.com/printing/v1/groups/<id>/"

Attribute	Type	Required	Description
id	str	yes	uuid
name	str	no	name of the group
description	str	no	group description
local_printing_enabled	boolean	no
myprinters_enabled	boolean	no
origin	object	no	provider of the printing that will be ezeep
organization_id	str	no	uuid of the organization
num_members	int	no	total user of the group
num_printers	int	no	total printers associated with the group

Example Request

curl  -X DELETE "https://api2.ezeep.com/printing/v1/groups/d16eeaa2-97ba-464a-b12a-f0ed66cc6078/" \
      --header "Authorization: Bearer <access_token>"

If successful, returns 204 No Content.