CodeXchangeService Web Service

CodeXchangeService

Click here for a complete list of operations.

Login

Logins the user to the CodeXchange service

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/v1/CodeXchangeservice.asmx HTTP/1.1
Host: www.codexchange.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.codeXchange.org/Login"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SecurityHeader xmlns="http://www.codeXchange.org/">
      <Password>string</Password>
      <Username>string</Username>
    </SecurityHeader>
  </soap:Header>
  <soap:Body>
    <Login xmlns="http://www.codeXchange.org/" />
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoginResponse xmlns="http://www.codeXchange.org/">
      <LoginResult>
        <Stats>
          <SnippetsCount>int</SnippetsCount>
          <UsersCount>int</UsersCount>
        </Stats>
        <Categories>
          <Category>
            <ID>guid</ID>
            <Name>string</Name>
          </Category>
          <Category>
            <ID>guid</ID>
            <Name>string</Name>
          </Category>
        </Categories>
        <Languages>
          <Language>
            <ID>guid</ID>
            <Name>string</Name>
          </Language>
          <Language>
            <ID>guid</ID>
            <Name>string</Name>
          </Language>
        </Languages>
        <Platforms>
          <Platform>
            <ID>guid</ID>
            <Name>string</Name>
          </Platform>
          <Platform>
            <ID>guid</ID>
            <Name>string</Name>
          </Platform>
        </Platforms>
        <Tags>
          <Tag>
            <Word>string</Word>
            <ID>guid</ID>
            <Items>int</Items>
            <PermalLink>string</PermalLink>
          </Tag>
          <Tag>
            <Word>string</Word>
            <ID>guid</ID>
            <Items>int</Items>
            <PermalLink>string</PermalLink>
          </Tag>
        </Tags>
        <ServerVersion>string</ServerVersion>
        <ClientVersion>string</ClientVersion>
      </LoginResult>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api/v1/CodeXchangeservice.asmx HTTP/1.1
Host: www.codexchange.org
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <SecurityHeader xmlns="http://www.codeXchange.org/">
      <Password>string</Password>
      <Username>string</Username>
    </SecurityHeader>
  </soap12:Header>
  <soap12:Body>
    <Login xmlns="http://www.codeXchange.org/" />
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <LoginResponse xmlns="http://www.codeXchange.org/">
      <LoginResult>
        <Stats>
          <SnippetsCount>int</SnippetsCount>
          <UsersCount>int</UsersCount>
        </Stats>
        <Categories>
          <Category>
            <ID>guid</ID>
            <Name>string</Name>
          </Category>
          <Category>
            <ID>guid</ID>
            <Name>string</Name>
          </Category>
        </Categories>
        <Languages>
          <Language>
            <ID>guid</ID>
            <Name>string</Name>
          </Language>
          <Language>
            <ID>guid</ID>
            <Name>string</Name>
          </Language>
        </Languages>
        <Platforms>
          <Platform>
            <ID>guid</ID>
            <Name>string</Name>
          </Platform>
          <Platform>
            <ID>guid</ID>
            <Name>string</Name>
          </Platform>
        </Platforms>
        <Tags>
          <Tag>
            <Word>string</Word>
            <ID>guid</ID>
            <Items>int</Items>
            <PermalLink>string</PermalLink>
          </Tag>
          <Tag>
            <Word>string</Word>
            <ID>guid</ID>
            <Items>int</Items>
            <PermalLink>string</PermalLink>
          </Tag>
        </Tags>
        <ServerVersion>string</ServerVersion>
        <ClientVersion>string</ClientVersion>
      </LoginResult>
    </LoginResponse>
  </soap12:Body>
</soap12:Envelope>