GET api/Signing/SigningRooms/{signingRoomId}/Participants

Allows the current signer user to get a list of SigningRoom participants for the specified SigningRoom Id. The current user must be a participant in the specified SigningRoom.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
signingRoomId

The id of the SigningRoom

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The list of participants associated to the SigningRoom.

Collection of ESignSystems.SmartSAFE.Models.Signing.SigningRoomParticipantModel
NameDescriptionTypeAdditional information
ParticipantId

Gets or sets the participant identifier.

 integer

None.
SigningRoomId

Gets or sets the participant's SigningRoom identifier.

 integer

None.
UserId

Gets or sets the participant user identifier.

 integer

None.
Username

Gets or sets the participant's username.

 string

None.
FirstName

Gets or sets the participant's first name.

 string

None.
LastName

Gets or sets the participant's last name.

 string

None.
Email

Gets or sets the participant's email address.

 string

Matching regular expression pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}
ESignConsentAccepted

Gets or sets a value indicating whether the participant has accepted the esign consent.

 boolean

None.
PhoneNumber

Gets or sets the participant's phone number.

 string

Matching regular expression pattern: ^[01]?[- .]?(\([2-9]\d{2}\)|[2-9]\d{2})[- .]?\d{3}[- .]?\d{4}$
InvitationCode

Gets or sets the participant's invitation code.

 string

None.
SignatureFont

Gets or sets the font of the participant's signature.

 string

None.
SignatureImage

Gets or sets the base64 custom user defined signature image.

 string

None.
InitialsImage

Gets or sets the base64 custom user defined initials image.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ParticipantId": 1,
    "SigningRoomId": 2,
    "UserId": 1,
    "Username": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Email": "sample string 6",
    "ESignConsentAccepted": true,
    "PhoneNumber": "sample string 8",
    "InvitationCode": "sample string 9",
    "SignatureFont": "sample string 10",
    "SignatureImage": "sample string 11",
    "InitialsImage": "sample string 12"
  },
  {
    "ParticipantId": 1,
    "SigningRoomId": 2,
    "UserId": 1,
    "Username": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "Email": "sample string 6",
    "ESignConsentAccepted": true,
    "PhoneNumber": "sample string 8",
    "InvitationCode": "sample string 9",
    "SignatureFont": "sample string 10",
    "SignatureImage": "sample string 11",
    "InitialsImage": "sample string 12"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSigningRoomParticipantModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
  <SigningRoomParticipantModel>
    <ESignConsentAccepted>true</ESignConsentAccepted>
    <Email>sample string 6</Email>
    <FirstName>sample string 4</FirstName>
    <InitialsImage>sample string 12</InitialsImage>
    <InvitationCode>sample string 9</InvitationCode>
    <LastName>sample string 5</LastName>
    <ParticipantId>1</ParticipantId>
    <PhoneNumber>sample string 8</PhoneNumber>
    <SignatureFont>sample string 10</SignatureFont>
    <SignatureImage>sample string 11</SignatureImage>
    <SigningRoomId>2</SigningRoomId>
    <UserId>1</UserId>
    <Username>sample string 3</Username>
  </SigningRoomParticipantModel>
  <SigningRoomParticipantModel>
    <ESignConsentAccepted>true</ESignConsentAccepted>
    <Email>sample string 6</Email>
    <FirstName>sample string 4</FirstName>
    <InitialsImage>sample string 12</InitialsImage>
    <InvitationCode>sample string 9</InvitationCode>
    <LastName>sample string 5</LastName>
    <ParticipantId>1</ParticipantId>
    <PhoneNumber>sample string 8</PhoneNumber>
    <SignatureFont>sample string 10</SignatureFont>
    <SignatureImage>sample string 11</SignatureImage>
    <SigningRoomId>2</SigningRoomId>
    <UserId>1</UserId>
    <Username>sample string 3</Username>
  </SigningRoomParticipantModel>
</ArrayOfSigningRoomParticipantModel>