Jasmin Developers - Web API Reference

Platform | Contact Group

Service to manage entities of type 'ContactGroup'.

Overview


URL api/{tenantKey}/{orgKey}/corePatterns/contactGroups
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET ContactGroups (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See ContactGroupResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /corePatterns/contactGroups/odata

GET ContactGroup by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See ContactGroupResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /corePatterns/contactGroups/{id}

GET ContactGroup by key

Returns the entity record that matches the specified key.

The following elements are required:

name (string) The name for the contact group.

Response:

When successful, the response body contains the entity record. See ContactGroupResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /corePatterns/contactGroups/{name}

POST Operations

POST ContactGroups

Creates a new entity record.

The following elements are required:

contactGroupResource (ApiContactGroupResource) The request body should contain the entity record that should be created.
See ApiContactGroupResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiContactGroupResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /corePatterns/contactGroups

POST Group Contact

Inserts a new 'Group Contact' in the 'Contact Group'.

The following elements are required:

name (string) The name for the contact group.
value (ApiContactGroupGroupContactsResource) The ApiContactGroupGroupContactsResource instance.
See ApiContactGroupGroupContactsResource.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /corePatterns/contactGroups/{name}/groupContacts

PUT Operations

PUT Set Contact GroupContact

Updates the value of attribute 'Contact' in the specified entity record.

The following elements are required:

name (string) The name for the contact group.
lineId (string) The detail identifier.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /corePatterns/contactGroups/{name}/groupContacts/{lineId}/contact

PUT Set Description ContactGroup

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

name (string) The name for the contact group.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /corePatterns/contactGroups/{name}/description

PUT Set IsActive ContactGroup

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

name (string) The name for the contact group.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /corePatterns/contactGroups/{name}/isActive

PUT Set Name ContactGroup

Updates the value of attribute 'Name' in the specified entity record.

The following elements are required:

name (string) The name for the contact group.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /corePatterns/contactGroups/{name}/name

DELETE Operations

DELETE Group Contact by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

name (string) The name for the contact group.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /corePatterns/contactGroups/{name}/groupContacts/{lineId}

DELETE ContactGroup by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /corePatterns/contactGroups/{id}

DELETE ContactGroup by key

Deletes the entity record that matches the specified key.

The following elements are required:

name (string) The name for the contact group.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /corePatterns/contactGroups/{name}

Resources


ApiContactGroupGroupContactsResource

The following elements are required:

contact (string) Contact.


ApiContactGroupResource

The following elements are required:

name (string) The name for the contact group.

The following elements are optional:

description (string) The description for the contact group.
groupContacts (List of ApiContactGroupGroupContactsResource) The group contacts.
See ApiContactGroupGroupContactsResource.


ContactGroupResource

The following elements are required:

name (string) The name for the contact group.

The following elements are optional:

description (string) The description for the contact group.
groupContacts (List of GroupContactResource) The group contacts.
See GroupContactResource.