Get package warnings

GET

packages

{packageId}

warnings

Error

A valid request URL is required to generate request examples

[
  {
    "ResourceType": "process",
    "Code": "ContactGroup.SomeMissingPhoneNumbers",
    "Message": "Some of the group members don't have a phone number required for [SmsOTP] signing type.",
    "Stakeholder": {
      "Id": "82c6b4f4-70fe-4fff-b176-6df0f4e79293",
      "ExternalReference": "userXYZ"
    },
    "Actor": {
      "Id": "73462bf5-8430-411d-befb-b35c92f35e10"
    }
  }
]

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

packageId

string<guid>

required

The target package's unique identifier A package's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Response

Process warning
Package warning
Document warning

A warning about the process of a package.
E.g. group members that don't have the necessary data to sign with a signing method

ResourceType

enum<string>

The subject of the warning

Available options:

process,

package,

document,

archiving

Code

string

Message

string

Stakeholder

object

The stakeholder involved

Show child attributes

Actor

object

The actor involved

Show child attributes

Send package remindersSends a reminder to the actors in the current process step who have not yet form filled, approved or signed. Only the next available form filler(s), approver(s) or signer(s) in the workflow are notified. In a serial workflow, actors who are still waiting for someone else to act first do not receive a reminder. The package must have status `Pending`; otherwise the call returns `409 Conflict`.

Error

A valid request URL is required to generate request examples

[
  {
    "ResourceType": "process",
    "Code": "ContactGroup.SomeMissingPhoneNumbers",
    "Message": "Some of the group members don't have a phone number required for [SmsOTP] signing type.",
    "Stakeholder": {
      "Id": "82c6b4f4-70fe-4fff-b176-6df0f4e79293",
      "ExternalReference": "userXYZ"
    },
    "Actor": {
      "Id": "73462bf5-8430-411d-befb-b35c92f35e10"
    }
  }
]

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

Product updates

NSEV WebPortal API

Get package warnings

Authorizations

Path Parameters

Response