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 required data is name and organization_id .

In example requests only required data is used but you can also use other parameters according to your requirements.

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

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

Example Request

curl  -X POST "https://api2.ezeep.com/printing/v1/groups/" \
      --header "Authorization:Bearer <Access Token>" \
      --data "{
           \"name\":\"test\",
           \"organization_id\":\"3fa85f64-5717-4562-b3fc-2c963f66afsd\"
         }"

Example Response

{
  "id": "d16eeaa2-97ba-464a-b12a-f0ed66cc6078",
  "name": "Test",
  "description": "",
  "local_printing_enabled": false,
  "myprinters_enabled": false,
  "origin": { "provider": "Ezeep" },
  "organization_id": "54e3a324-cc89-4722-8338-c285d26bef15",
  "num_members": 0,
  "num_printers": 0
}

Read a Specific Group by ID

Each group get a specific id ,if you know the id of the group then associated group will be in response.

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	str	no	provider of the printing that will be ezeep
organization_id	str	no	uuid of the prganization
num_members	str	no	total user of the group
num_printers	str	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": "54e3a324-cc89-4722-8338-c285d26bef15",
  "num_members": 0,
  "num_printers": 0
}

Read all Groups

All of the existing groups can be listed,in case you dont remeber the specific 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	str	no	provider of the printing that will be ezeep
organization_id	str	no	uuid of the prganization
num_members	str	no	total user of the group
num_printers	str	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": "8228b289-2926-4813-8267-c61c767e55f0",
      "name": "free",
      "description": "free",
      "local_printing_enabled": true,
      "myprinters_enabled": false,
      "origin": { "provider": "Ezeep" },
      "organization_id": "4f0277fc-a336-4621-81f9-bea114e6fa2c",
      "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": "4f0277fc-a336-4621-81f9-bea114e6fa2c",
      "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": "4f0277fc-a336-4621-81f9-bea114e6fa2c",
      "num_members": 0,
      "num_printers": 0
    }
  ]
}

Update Group Information

Each group get a specific id ,user can delete that specific group by using this id

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

Attribute	Type	Required	Description
id	str	yes	uuid
name	str	yes	name of the group
description	str	yes	group description
local_printing_enabled	boolean	no
myprinters_enabled	boolean	no
origin	str	no	provider of the printing that will be ezeep
organization_id	str	no	uuid of the prganization
num_members	str	no	total user of the group
num_printers	str	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>" \
      --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":"4f0277fc-a336-4621-81f9-bea114e6fa2c","num_members":1,"num_printers":1
    }

Delete a Group

Each group get a specific id ,user can delete that specific group by using this 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	str	no	provider of the printing that will be ezeep
organization_id	str	no	uuid of the prganization
num_members	str	no	total user of the group
num_printers	str	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>"

Example Response

{
    204
}