GET api/clients/{clientId}

This method should be used to retrieve client app configuration

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Id of a supported client app

string

Required

Body Parameters

None.

Response Information

Resource Description

Instance of

ClientConfigModel
NameDescriptionTypeAdditional information
Id

integer

None.

ClientId

string

None.

Name

string

None.

ApplicationType

string

None.

RefreshTokenLifeTime

string

None.

AllowedOrigin

string

None.

TitleSuffix

string

None.

Title

string

None.

Author

string

None.

Description

string

None.

Keywords

string

None.

OgSiteName

string

None.

OgTitle

string

None.

OgDescription

string

None.

OgImage

string

None.

PaymentGatewayId

integer

None.

PaymentGatewayName

string

None.

MainLogo

string

None.

LargeLogoImage

string

None.

SmallLogoImage

string

None.

CopyrightNotice

string

None.

GoogleProfileUri

string

None.

TwitterProfileUri

string

None.

FacebookProfileUri

string

None.

SiteUri

string

None.

BwMainLogo

string

None.

PaymentGatewayIsLiveMode

boolean

None.

PaymentGatewayPublicKey

string

None.

PaymentGatewayPublicTestKey

string

None.

ReCaptchaSiteKey

string

None.

ReCaptchaSecretKey

string

None.

CompanyId

integer

None.

ReportLogo

string

None.

SupportEmail

string

None.

ExternalContactForm

string

None.

ClientUri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "clientId": "sample string 2",
  "name": "sample string 3",
  "applicationType": "sample string 4",
  "refreshTokenLifeTime": "sample string 5",
  "allowedOrigin": "sample string 6",
  "titleSuffix": "sample string 7",
  "title": "sample string 8",
  "author": "sample string 9",
  "description": "sample string 10",
  "keywords": "sample string 11",
  "ogSiteName": "sample string 12",
  "ogTitle": "sample string 13",
  "ogDescription": "sample string 14",
  "ogImage": "sample string 15",
  "paymentGatewayId": 16,
  "paymentGatewayName": "sample string 17",
  "mainLogo": "sample string 18",
  "largeLogoImage": "sample string 19",
  "smallLogoImage": "sample string 20",
  "copyrightNotice": "sample string 21",
  "googleProfileUri": "sample string 22",
  "twitterProfileUri": "sample string 23",
  "facebookProfileUri": "sample string 24",
  "siteUri": "sample string 25",
  "bwMainLogo": "sample string 26",
  "paymentGatewayIsLiveMode": true,
  "paymentGatewayPublicKey": "sample string 28",
  "paymentGatewayPublicTestKey": "sample string 29",
  "reCaptchaSiteKey": "sample string 30",
  "reCaptchaSecretKey": "sample string 31",
  "companyId": 32,
  "reportLogo": "sample string 33",
  "supportEmail": "sample string 34",
  "externalContactForm": "sample string 35",
  "clientUri": "sample string 36"
}

text/html

Sample:
{"id":1,"clientId":"sample string 2","name":"sample string 3","applicationType":"sample string 4","refreshTokenLifeTime":"sample string 5","allowedOrigin":"sample string 6","titleSuffix":"sample string 7","title":"sample string 8","author":"sample string 9","description":"sample string 10","keywords":"sample string 11","ogSiteName":"sample string 12","ogTitle":"sample string 13","ogDescription":"sample string 14","ogImage":"sample string 15","paymentGatewayId":16,"paymentGatewayName":"sample string 17","mainLogo":"sample string 18","largeLogoImage":"sample string 19","smallLogoImage":"sample string 20","copyrightNotice":"sample string 21","googleProfileUri":"sample string 22","twitterProfileUri":"sample string 23","facebookProfileUri":"sample string 24","siteUri":"sample string 25","bwMainLogo":"sample string 26","paymentGatewayIsLiveMode":true,"paymentGatewayPublicKey":"sample string 28","paymentGatewayPublicTestKey":"sample string 29","reCaptchaSiteKey":"sample string 30","reCaptchaSecretKey":"sample string 31","companyId":32,"reportLogo":"sample string 33","supportEmail":"sample string 34","externalContactForm":"sample string 35","clientUri":"sample string 36"}

application/xml, text/xml

Sample:
<ClientConfigModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos">
  <AllowedOrigin>sample string 6</AllowedOrigin>
  <ApplicationType>sample string 4</ApplicationType>
  <Author>sample string 9</Author>
  <BwMainLogo>sample string 26</BwMainLogo>
  <ClientId>sample string 2</ClientId>
  <ClientUri>sample string 36</ClientUri>
  <CompanyId>32</CompanyId>
  <CopyrightNotice>sample string 21</CopyrightNotice>
  <Description>sample string 10</Description>
  <ExternalContactForm>sample string 35</ExternalContactForm>
  <FacebookProfileUri>sample string 24</FacebookProfileUri>
  <GoogleProfileUri>sample string 22</GoogleProfileUri>
  <Id>1</Id>
  <Keywords>sample string 11</Keywords>
  <LargeLogoImage>sample string 19</LargeLogoImage>
  <MainLogo>sample string 18</MainLogo>
  <Name>sample string 3</Name>
  <OgDescription>sample string 14</OgDescription>
  <OgImage>sample string 15</OgImage>
  <OgSiteName>sample string 12</OgSiteName>
  <OgTitle>sample string 13</OgTitle>
  <PaymentGatewayId>16</PaymentGatewayId>
  <PaymentGatewayIsLiveMode>true</PaymentGatewayIsLiveMode>
  <PaymentGatewayName>sample string 17</PaymentGatewayName>
  <PaymentGatewayPublicKey>sample string 28</PaymentGatewayPublicKey>
  <PaymentGatewayPublicTestKey>sample string 29</PaymentGatewayPublicTestKey>
  <ReCaptchaSecretKey>sample string 31</ReCaptchaSecretKey>
  <ReCaptchaSiteKey>sample string 30</ReCaptchaSiteKey>
  <RefreshTokenLifeTime>sample string 5</RefreshTokenLifeTime>
  <ReportLogo>sample string 33</ReportLogo>
  <SiteUri>sample string 25</SiteUri>
  <SmallLogoImage>sample string 20</SmallLogoImage>
  <SupportEmail>sample string 34</SupportEmail>
  <Title>sample string 8</Title>
  <TitleSuffix>sample string 7</TitleSuffix>
  <TwitterProfileUri>sample string 23</TwitterProfileUri>
</ClientConfigModel>