List of my group's requests

Latest update: October 31st, 2019

You will be able to list the requests linked to your workgroup based on their status, through the following service.

Description
SERVICIO GET MESSAGES BY GROUP AND STATUS
URL /v3/messages/{status}/group/{groupCode}/{index}/{page_size}/
SEGURIDAD YES
METHOD GET
CONTENT/APPLICATION URL PARAM
PARAMS • status: status by which the queried requests will be filtered, e.g., "EXPIRED, RESPONSED, ERROR, REJECTED, WAITING, etc”.
• groupCode: group code to which the consulted requests belong.
• index: matches the index of the list from which you want the object to be returned.
• page_size: corresponds to the number of requests you wish to return. If set to 0, the whole list will be returned.
RESPONSE 200: HTTP status code 200/OK

Response body:

    {
      "messageCode": "string",
      "status": "string",
      "userCode": "string",
      "groupCode": "string",
      "templateCode": "string",
      "creationDate": timestamp
    }

Example:

    {
      "messageCode": "0Z8P1565351269642R875",
      "status": "RESPONSED",
      "userCode": "null",
      "groupCode": "apisample",
      "templateCode": "apisample_template_01",
      "creationDate": 1565351270000
    }

Response params:

  • messageCode: signing process code.
  • status: current status of the request, e.g. "WAITING".
  • userCode: username of the user who requested the signing process. If the request was requested via API the userCode will be null...
  • groupCode: group code of the group to which the signing process belongs.
  • templateCode: template code linked to the request; if templateCode is not used, it will be null.
  • creationDate: creation date of the request expressed in milliseconds.

Alternative responses in case of error: HTTP status codes other than 200/OK will be returned. In this case a JSON describing the problem will always be returned:

    {
      "code": "string",
      "type": "string",
      "message": "string",
      "trace" : "string"
    }

results matching ""

    No results matching ""