GET api/Configuration/SigningRoomBranding

Allows a SAFEAdmin to get the default SigningRoom branding, and allows a client admin to get their client's SigningRoom branding.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The SigningRoom branding.

ESignSystems.SmartSAFE.Models.SigningRoomManager.Branding.SigningRoomBrandingModel
NameDescriptionTypeAdditional information
SigningRoomBrandingId

Gets or sets the SigningRoom branding identifier.

 integer

None.
OrganizationId

Gets or sets the organization identifier.

 integer

None.
ClientId

Gets or sets the client identifier.

 integer

None.
ClientName

Gets or sets the client name.

 string

None.
SigningRoomCustomCss

Gets or sets the SigningRoom custom CSS.

 string

None.
CopyrightText

Gets or sets the copyright text.

 string

None.
CopyrightLinkText

Gets or sets the copyright link text.

 string

None.
CopyrightLinkURL

Gets or sets the copyright link URL.

 string

None.
SigningRoomSupportLinkURL

Gets or sets the SigningRoom support link URL.

 string

None.
SigningRoomSupportLinkText

Gets or sets the SigningRoom support link text.

 string

Max length: 64
SigningRoomLogo

Gets or sets the SigningRoom logo.

 Collection of byte

Required
SigningRoomLogoMimeType

Gets or sets the SigningRoom logo mime type.

 string

None.
LoginText

Gets or sets the login text.

 string

None.
HeaderBarTextColor

Gets or sets the header bar text color.

 string

Required
HeaderBarColor

Gets or sets the header bar color.

 string

None.
NavbarTextColor

Gets or sets the navbar text color.

 string

Required
NavbarColor

Gets or sets the navbar color.

 string

None.
ApplyToAll

Gets or sets a value indicating whether the saved branding should be applied to all potential subordinate organization or client brandings depending on the hierarchy.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "SigningRoomBrandingId": 1,
  "OrganizationId": 1,
  "ClientId": 1,
  "ClientName": "sample string 1",
  "SigningRoomCustomCss": "sample string 2",
  "CopyrightText": "sample string 3",
  "CopyrightLinkText": "sample string 4",
  "CopyrightLinkURL": "sample string 5",
  "SigningRoomSupportLinkURL": "sample string 6",
  "SigningRoomSupportLinkText": "sample string 7",
  "SigningRoomLogo": "QEA=",
  "SigningRoomLogoMimeType": "sample string 8",
  "LoginText": "sample string 9",
  "HeaderBarTextColor": "sample string 10",
  "HeaderBarColor": "sample string 11",
  "NavbarTextColor": "sample string 12",
  "NavbarColor": "sample string 13",
  "ApplyToAll": true
}

application/xml, text/xml

Sample: 
<SigningRoomBrandingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager.Branding">
  <ApplyToAll>true</ApplyToAll>
  <ClientId>1</ClientId>
  <ClientName>sample string 1</ClientName>
  <CopyrightLinkText>sample string 4</CopyrightLinkText>
  <CopyrightLinkURL>sample string 5</CopyrightLinkURL>
  <CopyrightText>sample string 3</CopyrightText>
  <HeaderBarColor>sample string 11</HeaderBarColor>
  <HeaderBarTextColor>sample string 10</HeaderBarTextColor>
  <LoginText>sample string 9</LoginText>
  <NavbarColor>sample string 13</NavbarColor>
  <NavbarTextColor>sample string 12</NavbarTextColor>
  <OrganizationId>1</OrganizationId>
  <SigningRoomBrandingId>1</SigningRoomBrandingId>
  <SigningRoomCustomCss>sample string 2</SigningRoomCustomCss>
  <SigningRoomLogo>QEA=</SigningRoomLogo>
  <SigningRoomLogoMimeType>sample string 8</SigningRoomLogoMimeType>
  <SigningRoomSupportLinkText>sample string 7</SigningRoomSupportLinkText>
  <SigningRoomSupportLinkURL>sample string 6</SigningRoomSupportLinkURL>
</SigningRoomBrandingModel>