Groups

This section discusses the following services related to groups:

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

Retrieve a List of All Groups in the Current Account

GET /groups

Description

Retrieve a list of all groups in an account.

Resource Information

HTTP Method GET
Resource Family groups
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Optional Query Parameters

from The first record that will be returned. Useful for pagination.
to The last record that will be returned. Useful for pagination.
dir The direction according to which the data will be sorted. Give the value asc for ascending, ordes for descending.

Example Request

GET https://sandbox.e-signlive.com/api/groups

Retrieve Summaries of All Groups in the Current Account

GET /groups/summary

Description

Retrieve summaries of all groups in the current account.

Resource Information

HTTP Method GET
Resource Family groups
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Example Request

GET https://sandbox.e-signlive.com/api/groups/summary

Response Payload

{
  "results": [
    {
      "email": "bob@email.com",
      "id": "ed39b164-ecf8-44e7-a27f-a673ba637bda",
      "data": null,
      "name": "Accounting"
    }
  ],
  "count": 1
}

Retrieve a Group

GET /groups/{groupId}

Description

Retrieve a group.

Resource Information

HTTP Method GET
Resource Family groups
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Example Request

GET https://sandbox.e-signlive.com/api/groups/207855fa-1786-4cdc-8518-979dfffe5013

Create a Group

POST /groups

Description

Create a new group.

Resource Information

HTTP Method POST
Resource Family groups
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Example Request

POST https://sandbox.e-signlive.com/api/groups

Request Payload

{
  "email": "dave_m@eSignLive.com",
  "name": "eSignLive.com Group"
}

Invite a New Sender to Join a Group

POST /groups/{groupId}/invite

Description

Invite a sender who is not yet part of any OneSpan Sign account to join a group. The invitee will initially be prompted to register as an account sender.

Resource Information

HTTP Method POST
Resource Family groups
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

groupId Unique identifier of a OneSpan Sign group

Example Request

POST https://sandbox.e-signlive.com/api/groups/207855fa-1786-4cdc-8518-979dfffe5013/invite

Request Payload

{
  "email": "john_p@eSignLive.com"
}

Invite an Existing Sender to Join a Group

POST /groups/{groupId}/invite

Description

Invite an existing account sender to join a group.

Resource Information

HTTP Method POST
Resource Family groups
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

groupId Unique identifier of a OneSpan Sign group

Example Request

POST https://sandbox.e-signlive.com/api/groups/207855fa-1786-4cdc-8518-979dfffe5013/invite

Request Payload

{
  "email": "john_p@eSignLive.com"
}

Update a Group

PUT /groups/{groupId}

Description

Update an existing group.

Resource Information

HTTP Method PUT
Resource Family groups
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

groupId Unique identifier of a OneSpan Sign group

Example Request

PUT https://sandbox.e-signlive.com/api/groups/207855fa-1786-4cdc-8518-979dfffe5013

Request Payload

{
  "email": "dave_m@eSignLive.com",
  "name":"eSignLive"
}

Response Payload

{
  "updated": "2014-04-29T20:51:07Z",
  "email": "dave_m@eSignLive.com",
  "emailMembers": false,
  "account": {
    "updated": "2014-04-29T20:51:07Z",
    "customFields": [],
    "licenses": [],
    "logoUrl": "",
    "providers": null,
    "company": {
      "id": "",
      "data": null,
      "address": null,
      "name": ""
    },
    "created": "2014-04-29T20:51:07Z",
    "id": "8dfc8044-bc68-4d63-9386-0a980e174473",
    "owner": "",
    "data": null,
    "name": ""
  },
  "created": "2014-04-29T20:13:31Z",
  "id": "207855fa-1786-4cdc-8518-979dfffe5013",
  "members": [],
  "data": null,
  "name": "eSignLive"
}

Delete a Group

DELETE /groups/{groupId}

Description

Delete an existing group.

Resource Information

HTTP Method DELETE
Resource Family groups
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Required Parameters

groupId Unique identifier of a OneSpan Sign group

Example Request

DELETE https://sandbox.e-signlive.com/api/groups/207855fa-1786-4cdc-8518-979dfffe5013

Response Payload

no content