GET api/Signing/SigningRooms/{invitationCode}/LoginPageInfo

Allows the current signer user to get the SigningRoom login page welcome text for the specified SigningRoom id. The current user must be a participant in the specified SigningRoom.

Request Information

URI Parameters

Name	Description	Type	Additional information
invitationCode	The invitation code.	string	Required

Body Parameters

None.

Response Information

Resource Description

The SigningRoom login page info.

ESignSystems.SmartSAFE.Models.Signing.SigningRoomInvitationInfoModel

Name	Description	Type	Additional information
FirstName	Gets or sets the first name of the user that was invited to the SigningRoom.	string	None.
LastName	Gets or sets the last name of the user that was invited to the SigningRoom.	string	None.
Email	Gets or sets the email address of the user that was invited to the SigningRoom.	string	None.
CanCreateAccount	Gets or sets a value indicating whether the participant can create a user account. This is true if client allows self registration and the participant has not already been initalized to a user.	boolean	None.
AccessCodeRequired	Gets or sets a value indicating whether the user must provide an access code that was specified by the SigningRoom admin.	boolean	None.
SigningRoomId	Gets or sets the SigningRoom id of the user that was invited to the SigningRoom.	integer	None.
EnableForgotPassword	Gets or sets the enable forgot password link.	boolean	None.
EnableForgotUsername	Gets or sets the enable forgot username link.	boolean	None.
Username	Gets or sets the username.	string	None.
RequireParticipantLogin	Gets or sets a value indicating whether to require participant login.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Email": "sample string 3",
  "CanCreateAccount": true,
  "AccessCodeRequired": true,
  "SigningRoomId": 6,
  "EnableForgotPassword": true,
  "EnableForgotUsername": true,
  "Username": "sample string 9",
  "RequireParticipantLogin": true
}

application/xml, text/xml

Sample:

<SigningRoomInvitationInfoModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
  <AccessCodeRequired>true</AccessCodeRequired>
  <CanCreateAccount>true</CanCreateAccount>
  <Email>sample string 3</Email>
  <EnableForgotPassword>true</EnableForgotPassword>
  <EnableForgotUsername>true</EnableForgotUsername>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <RequireParticipantLogin>true</RequireParticipantLogin>
  <SigningRoomId>6</SigningRoomId>
  <Username>sample string 9</Username>
</SigningRoomInvitationInfoModel>