GET api/v1/locations/{LocationId}/interfaceSchema/resolution/{ScreenResolutionId}/basic

Gets the interface schema details.

Request Information

URI Parameters

Name	Description	Type	Additional information
LocationId		integer	Required
ScreenResolutionId		integer	Required

Body Parameters

None.

Response Information

Resource Description

InterfaceSchemaConfigInfo

InterfaceSchemaBrand

Name	Type	Additional information
CompanyDescription	string	None.
LogoUpdatedDate	date	None.
CentralStationPhoneNumber	string	None.
UseLogo	boolean	None.
HelpURL	string	None.
LoginURL	string	None.
SupportPhoneNumber	string	None.
CompanyEmailAddress	string	None.
AppleDownloadURL	string	None.
AndroidDownloadURL	string	None.
BlackBerryDownloadURL	string	None.
WarrantyPortalURL	string	None.
SPAMobileAppBaseURL	string	None.
SignalrHubUrl	string	None.
GatewayUrl	string	None.
InterfaceSchemaID	integer	None.
SchemaName	string	None.
BaseURL	string	None.
ProductName	string	None.
CompanyName	string	None.
CompanyPhoneNumber	string	None.
WebsiteURL	string	None.
LogoURL	string	None.
CustomHeaderMessage	string	None.
CustomFooterMessage	string	None.
MiscellaneousAttributes	string	None.
MailSenderName	string	None.
SkinningEnabled	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyDescription": "sample string 1",
  "LogoUpdatedDate": "2025-04-01T23:37:51.3560698-04:00",
  "CentralStationPhoneNumber": "sample string 2",
  "UseLogo": true,
  "HelpURL": "sample string 4",
  "LoginURL": "sample string 5",
  "SupportPhoneNumber": "sample string 6",
  "CompanyEmailAddress": "sample string 7",
  "AppleDownloadURL": "sample string 8",
  "AndroidDownloadURL": "sample string 9",
  "BlackBerryDownloadURL": "sample string 10",
  "WarrantyPortalURL": "sample string 11",
  "SPAMobileAppBaseURL": "sample string 12",
  "SignalrHubUrl": "sample string 13",
  "GatewayUrl": "sample string 14",
  "InterfaceSchemaID": 15,
  "SchemaName": "sample string 16",
  "SMTPServerListID": 17,
  "BaseURL": "sample string 18",
  "ProductName": "sample string 19",
  "CompanyName": "sample string 20",
  "CompanyPhoneNumber": "sample string 21",
  "WebsiteURL": "sample string 22",
  "LogoURL": "sample string 23",
  "CustomHeaderMessage": "sample string 24",
  "CustomFooterMessage": "sample string 25",
  "MiscellaneousAttributes": "sample string 26",
  "MailSenderName": "sample string 27",
  "SkinningEnabled": true
}

application/xml, text/xml

Sample:

<InterfaceSchemaBrand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain">
  <baseURL>sample string 18</baseURL>
  <companyName>sample string 20</companyName>
  <companyPhoneNumber>sample string 21</companyPhoneNumber>
  <customFooterMessage>sample string 25</customFooterMessage>
  <customHeaderMessage>sample string 24</customHeaderMessage>
  <helpURL i:nil="true" />
  <interfaceSchemaID>15</interfaceSchemaID>
  <loginURL i:nil="true" />
  <logoURL>sample string 23</logoURL>
  <mailSenderName>sample string 27</mailSenderName>
  <miscellaneousAttributes>sample string 26</miscellaneousAttributes>
  <productName>sample string 19</productName>
  <schemaName>sample string 16</schemaName>
  <skinningEnabled>true</skinningEnabled>
  <smtpServerListID>17</smtpServerListID>
  <warrantyPortalURL i:nil="true" />
  <websiteURL>sample string 22</websiteURL>
  <androidDownloadURL>sample string 9</androidDownloadURL>
  <appleDownloadURL>sample string 8</appleDownloadURL>
  <blackBerryDownloadURL>sample string 10</blackBerryDownloadURL>
  <companyEmailAddress>sample string 7</companyEmailAddress>
  <gatewayUrl>sample string 14</gatewayUrl>
  <helpURL>sample string 4</helpURL>
  <loginURL>sample string 5</loginURL>
  <signalrHubUrl>sample string 13</signalrHubUrl>
  <spaMobileAppBaseURL>sample string 12</spaMobileAppBaseURL>
  <supportPhoneNumber>sample string 6</supportPhoneNumber>
  <warrantyPortalURL>sample string 11</warrantyPortalURL>
  <CentralStationPhoneNumber>sample string 2</CentralStationPhoneNumber>
  <CompanyDescription>sample string 1</CompanyDescription>
  <LogoUpdatedDate>2025-04-01T23:37:51.3560698-04:00</LogoUpdatedDate>
  <UseLogo>true</UseLogo>
</InterfaceSchemaBrand>