Teams

Teams are groups of professional who can receive or send a case/transaction.

The team model

A team consists of the following properties.

Properties

Name
uuid
Type
string
Description
Unique indentifier.
Name
name
Type
string
Description
Name of the team.
Name
specialism
Type
string
Description
Specialism.
Name
notification_email
Type
string
Description
Notification email.
Name
reminder_email
Type
string
Description
Reminder email.
Name
department
Type
object
Description
Department.

GET/v2/teams/:uuid

Retrieve a team

To retrieve a single team.

Request

GET

/v2/teams/:uuid

Http::get('/v2/teams/:uuid');

Response

{
    "name": "Team Name",
    "specialism": "Nephrology",
    "notification_email": "notifications@organization.nl",
    "reminder_email": "reminders@organization.nl",
    "department": {
        "name": "Department Name",
        "discipline": "Nephrology",
        "street": "Street 123",
        "city": "Heerenveen",
        "zipcode": "8442XX",
        "agb": "12345678",
        "organization": {
            "name": "Organization Name",
            "tenant": {
                "name": "Tenant Name"
            }
        }
    },
    "professionals": [
		{
			"uuid": "9a0f53d1-0103-4e1e-a2be-ae67fe30c2a0",
			"initials": "H.",
			"name": "Smith",
			"name_suffix": null,
			"full_last_name": "Smith",
			"email": "h.smith@organization.nl",
			"agb": "12345678",
			"big": "12345678901"
		},
    ]
}

GET/v2/teams/:code

Retrieve professionals

Only retrieve the professionals of a team.

Request

GET

/v2/teams/:uuid/professionals

Http::get('/v2/teams/:uuid/professionals');

Response

[
    {
        "uuid": "9a0f53d1-0103-4e1e-a2be-ae67fe30c2a0",
        "initials": "H.",
        "name": "Smith",
        "name_suffix": null,
        "full_last_name": "Smith",
        "email": "h.smith@organization.nl",
        "agb": "12345678",
        "big": "12345678901"
    },
    {
        "uuid": "9a0f53d1-0103-4e1e-a2be-ae67fe30c2a0",
        "initials": "R.",
        "name": "James",
        "name_suffix": null,
        "full_last_name": "James",
        "email": "r.james@organization.nl",
        "agb": "23456789",
        "big": "23456789012"
    },
]