Contact Group List – Django REST framework

Group of contacts.

Custom route: send

Allowed method: POST. Send Email and SMS messages to the contacts in this contact group. You need to have admin rights for the organisation the contact group belongs to.

The timeseries alarm or raster alarm parameters are used for the alarm notification status, value and timestamp.

Email:

Email must at least contain html, text or a subject and can contain any combination of those three.

The organisation the contact group belongs to needs to be configured for sending messages.

The emails may contain Jinja-style template variables. Each {{variable}} can be specified as such in the email:

{{variable}}

Three personified variables are taken from each recipient/contact in a contact group when specified using the template language: first_name: contact name last_name: contact last name email: contact email phone_number: contact mobile number

SMS:

The smses may contain Jinja-style template variables. Each {{variable}} can be specified as such in the content:

{{variable}}

Query parameters

name: Text filter on name. Supports various lookup types (name__exact by default).

created: Temporal filter on created. Supports various lookup types (exact, lt, lte, gt, gte; created__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

last_modified: Temporal filter on last_modified. Supports various lookup types (exact, lt, lte, gt, gte; last_modified__exact by default). Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.

organisation: Related filter on organisation. See the organisations endpoint.

page_size: The maximum number of results to return in list-view. The default is 10.

ordering Show the results in a specific order. You can order them by id, name, organisation__name. Add a - in front to reverse the order.

Examples

?name=Example

?name__icontains=Examp

?name__icontains=Examp&page_size=100

?created__gte=2017-01-01T00:00:00Z

?last_modified__lt=2018-01-01T00:00:00Z

?organisation__uuid=c5e37ca3495045168f5d911c37ee2319

?ordering=-organisation__name

GET /api/v4/contactgroups/?format=api

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}