YM REST Services

ClientConfig

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin, member, oauthmember

The following routes are available for this service:
GET	/Ams/{ClientID}/ClientConfig	Retrieve standard client configuration information for use client-side.

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**ClientConfigResponse** Parameters:
Name	Parameter	Data Type	Required
Locale	form	string	No
DateFormat	form	string	No
CurrencyDecimalSeparator	form	string	No
CurrencyGroupSeparator	form	string	No
CurrencySymbol	form	string	No
CurrencyPositivePattern	form	string	No
CurrencyNegativePattern	form	string	No
SiteUrl	form	string	No
SecureUrl	form	string	No
MaxAlertRecipients	form	int	No
CareersID	form	int	No
ClientNameMobile	form	string	No
QuickLinksCount	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/ClientConfig HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <CareersID>0</CareersID>
  <ClientNameMobile>String</ClientNameMobile>
  <CurrencyDecimalSeparator>String</CurrencyDecimalSeparator>
  <CurrencyGroupSeparator>String</CurrencyGroupSeparator>
  <CurrencyNegativePattern>String</CurrencyNegativePattern>
  <CurrencyPositivePattern>String</CurrencyPositivePattern>
  <CurrencySymbol>String</CurrencySymbol>
  <DateFormat>String</DateFormat>
  <Locale>String</Locale>
  <MaxAlertRecipients>0</MaxAlertRecipients>
  <QuickLinksCount>0</QuickLinksCount>
  <SecureUrl>String</SecureUrl>
  <SiteUrl>String</SiteUrl>
</ClientConfigResponse>