GET api/v2/interfaceSchema/clientId/{appId}/clientAppVersion?appVersion={appVersion}

Gets the interface schema details.

Request Information

URI Parameters

Name	Description	Type	Additional information
appId	Application ID	integer	Required
appVersion	App Version	string	Required

Body Parameters

None.

Response Information

Resource Description

InterfaceSchemaConfigInfo

InterfaceSchemaResult

Name	Type	Additional information
InterfaceSchemaConfigInfo	InterfaceSchemaConfigInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "InterfaceSchemaConfigInfo": {
    "AppleDownloadURL": "sample string 1",
    "AndroidDownloadURL": "sample string 2",
    "LatestSupportedAppVersion": "sample string 3",
    "Whatsnew": "sample string 4",
    "SignalrHubUrl": "sample string 5",
    "GatewayUrl": "sample string 6",
    "SignalrHubUrlV2": "sample string 7",
    "GatewayUrlV2": "sample string 8",
    "SupportedVersion": 9,
    "UtilityUrl": "sample string 10"
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<InterfaceSchemaResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V2.Authentication">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <InterfaceSchemaConfigInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain">
    <d2p1:AndroidDownloadURL>sample string 2</d2p1:AndroidDownloadURL>
    <d2p1:AppleDownloadURL>sample string 1</d2p1:AppleDownloadURL>
    <d2p1:GatewayUrl>sample string 6</d2p1:GatewayUrl>
    <d2p1:GatewayUrlV2>sample string 8</d2p1:GatewayUrlV2>
    <d2p1:LatestSupportedAppVersion>sample string 3</d2p1:LatestSupportedAppVersion>
    <d2p1:SignalrHubUrl>sample string 5</d2p1:SignalrHubUrl>
    <d2p1:SignalrHubUrlV2>sample string 7</d2p1:SignalrHubUrlV2>
    <d2p1:SupportedVersion>9</d2p1:SupportedVersion>
    <d2p1:UtilityUrl>sample string 10</d2p1:UtilityUrl>
    <d2p1:Whatsnew>sample string 4</d2p1:Whatsnew>
  </InterfaceSchemaConfigInfo>
</InterfaceSchemaResult>