YM REST Services

OAuthClientApps

**Requires Authentication**
Requires the role:	admin

The following routes are available for this service:
GET	/Ams/{ClientID}/OAuthClientApps	Return an OAuth client app.
POST	/Ams/{ClientID}/OAuthClientApps	Create an OAuth client app.
PUT	/Ams/{ClientID}/OAuthClientApps	Update an OAuth client app.
DELETE	/Ams/{ClientID}/OAuthClientApps	Delete an OAuth client app.
GET	/Ams/{ClientID}/OAuthClientApps/Generate/{KeyType}	Return an OAuth client app.

**OAuthClientApps** Parameters:
Name	Parameter	Data Type	Required
AppID	body	int	No
ClientApp	body	OAuthClientApp	No
KeyType	path	KeyTypes	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	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

**OAuthClientApp** Parameters:
Name	Parameter	Data Type	Required	Description
LogoImageContent	form	string	No

**ClientApp** Parameters:
Name	Parameter	Data Type	Required
AppID	form	int	No
ClientAppID	form	string	No
ClientAppSecret	form	string	No
AppName	form	string	No
CompanyName	form	string	No
Email	form	string	No
WebSiteUrl	form	string	No
Description	form	string	No
ContactName	form	string	No
ContactNumber	form	string	No
IsActive	form	bool	No
ScopeApproved	form	int	No
LogoImage	form	string	No
Created	form	DateTime	No
Modified	form	DateTime	No
Redirects	form	RedirectCollection	No
IsExternal	form	bool	No

**Redirect** Parameters:
Name	Parameter	Data Type	Required	Description
RedirectID	form	int	No
RedirectUrl	form	string	No

**OAuthClientAppsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ClientAppList	form	List<ClientApp>	No
KeyValue	form	string	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.

POST /Ams/{ClientID}/OAuthClientApps HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OAuthClientApps 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>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <AppID>0</AppID>
  <ClientApp>
    <AppID xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">0</AppID>
    <AppName xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</AppName>
    <ClientAppID xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</ClientAppID>
    <ClientAppSecret xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</ClientAppSecret>
    <CompanyName xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</CompanyName>
    <ContactName xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</ContactName>
    <ContactNumber xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</ContactNumber>
    <Created xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">0001-01-01T00:00:00</Created>
    <Description xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</Description>
    <Email xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</Email>
    <IsActive xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">false</IsActive>
    <IsExternal xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">false</IsExternal>
    <LogoImage xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</LogoImage>
    <Modified xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">0001-01-01T00:00:00</Modified>
    <Redirects xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">
      <Redirect>
        <RedirectID>0</RedirectID>
        <RedirectUrl>String</RedirectUrl>
      </Redirect>
    </Redirects>
    <ScopeApproved xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">0</ScopeApproved>
    <WebSiteUrl xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</WebSiteUrl>
    <LogoImageContent>String</LogoImageContent>
  </ClientApp>
  <KeyType>None</KeyType>
</OAuthClientApps>

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

<OAuthClientAppsResponse 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>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <AppID>0</AppID>
  <ClientApp>
    <AppID xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">0</AppID>
    <AppName xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</AppName>
    <ClientAppID xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</ClientAppID>
    <ClientAppSecret xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</ClientAppSecret>
    <CompanyName xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</CompanyName>
    <ContactName xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</ContactName>
    <ContactNumber xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</ContactNumber>
    <Created xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">0001-01-01T00:00:00</Created>
    <Description xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</Description>
    <Email xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</Email>
    <IsActive xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">false</IsActive>
    <IsExternal xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">false</IsExternal>
    <LogoImage xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</LogoImage>
    <Modified xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">0001-01-01T00:00:00</Modified>
    <Redirects xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">
      <Redirect>
        <RedirectID>0</RedirectID>
        <RedirectUrl>String</RedirectUrl>
      </Redirect>
    </Redirects>
    <ScopeApproved xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">0</ScopeApproved>
    <WebSiteUrl xmlns="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">String</WebSiteUrl>
    <LogoImageContent>String</LogoImageContent>
  </ClientApp>
  <KeyType>None</KeyType>
  <ClientAppList xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.OAuth">
    <d2p1:ClientApp>
      <d2p1:AppID>0</d2p1:AppID>
      <d2p1:AppName>String</d2p1:AppName>
      <d2p1:ClientAppID>String</d2p1:ClientAppID>
      <d2p1:ClientAppSecret>String</d2p1:ClientAppSecret>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:ContactName>String</d2p1:ContactName>
      <d2p1:ContactNumber>String</d2p1:ContactNumber>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsExternal>false</d2p1:IsExternal>
      <d2p1:LogoImage>String</d2p1:LogoImage>
      <d2p1:Modified>0001-01-01T00:00:00</d2p1:Modified>
      <d2p1:Redirects>
        <d2p1:Redirect>
          <d2p1:RedirectID>0</d2p1:RedirectID>
          <d2p1:RedirectUrl>String</d2p1:RedirectUrl>
        </d2p1:Redirect>
      </d2p1:Redirects>
      <d2p1:ScopeApproved>0</d2p1:ScopeApproved>
      <d2p1:WebSiteUrl>String</d2p1:WebSiteUrl>
    </d2p1:ClientApp>
  </ClientAppList>
  <KeyValue>String</KeyValue>
</OAuthClientAppsResponse>