GET api/Signing/SigningRooms/{signingRoomId}

Allows the current signer user to get the SigningRoom information 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 SigningRoom information.

ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomInformationModel
NameDescriptionTypeAdditional information
SigningRoomId

Gets or sets the SigningRoom identifier.

integer

None.

SigningRoomGuid

Gets or sets the SigningRoom unique identifier.

string

None.

ClientId

Gets or sets the SigningRoom's client identifier.

integer

None.

SigningRoomName

Gets or sets the SigningRoom's name.

string

None.

StartDate

Gets or sets the date and time when the SigningRoom starts.

date

None.

ExpirationDate

Gets or sets the date and time when the SigningRoom expires.

date

None.

SigningDate

Gets or sets the signing date.

date

None.

NumberOfDocumentsForUserToSign

Gets the number of documents to sign for the participant.

integer

None.

NumberOfDocumentsForUserToReview

Gets the number of documents to review for the participant.

integer

None.

ServerTimeZone

Gets or sets the time zone of the server which applies for the start, expiration, and signing dates.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SigningRoomId": 1,
  "SigningRoomGuid": "sample string 2",
  "ClientId": 3,
  "SigningRoomName": "sample string 4",
  "StartDate": "2026-01-01T17:32:39.8773163-05:00",
  "ExpirationDate": "2026-01-01T17:32:39.8773163-05:00",
  "SigningDate": "2026-01-01T17:32:39.8773163-05:00",
  "NumberOfDocumentsForUserToSign": 6,
  "NumberOfDocumentsForUserToReview": 7,
  "ServerTimeZone": "sample string 8"
}

application/xml, text/xml

Sample:
<SigningRoomInformationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
  <ClientId>3</ClientId>
  <ExpirationDate>2026-01-01T17:32:39.8773163-05:00</ExpirationDate>
  <NumberOfDocumentsForUserToReview>7</NumberOfDocumentsForUserToReview>
  <NumberOfDocumentsForUserToSign>6</NumberOfDocumentsForUserToSign>
  <ServerTimeZone>sample string 8</ServerTimeZone>
  <SigningDate>2026-01-01T17:32:39.8773163-05:00</SigningDate>
  <SigningRoomGuid>sample string 2</SigningRoomGuid>
  <SigningRoomId>1</SigningRoomId>
  <SigningRoomName>sample string 4</SigningRoomName>
  <StartDate>2026-01-01T17:32:39.8773163-05:00</StartDate>
</SigningRoomInformationModel>