CodeXchangeService

Click here for a complete list of operations.

GetSnippet

Get Snippet

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/GetSnippet"

<?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>
    <GetSnippet xmlns="http://www.codeXchange.org/">
      <snippetID>guid</snippetID>
    </GetSnippet>
  </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>
    <GetSnippetResponse xmlns="http://www.codeXchange.org/">
      <GetSnippetResult>
        <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>
        <DateCreated>dateTime</DateCreated>
        <DownloadCount>int</DownloadCount>
        <AverageRating>int</AverageRating>
        <Bytes>int</Bytes>
        <IsPrivate>boolean</IsPrivate>
        <HasCodeComments>boolean</HasCodeComments>
        <Summary>string</Summary>
        <Language>string</Language>
        <AuthorUsername>string</AuthorUsername>
        <AuthorFirstName>string</AuthorFirstName>
        <AuthorLastName>string</AuthorLastName>
        <AuthorFriendlyName>string</AuthorFriendlyName>
        <Code>string</Code>
        <FormattedCode>string</FormattedCode>
        <Culture>string</Culture>
        <CategoryID>guid</CategoryID>
        <LanguageID>guid</LanguageID>
        <PlatformID>guid</PlatformID>
        <UserID>guid</UserID>
        <ID>guid</ID>
        <PreviewURL>string</PreviewURL>
        <VS2005SnippetURL>string</VS2005SnippetURL>
      </GetSnippetResult>
    </GetSnippetResponse>
  </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>
    <GetSnippet xmlns="http://www.codeXchange.org/">
      <snippetID>guid</snippetID>
    </GetSnippet>
  </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>
    <GetSnippetResponse xmlns="http://www.codeXchange.org/">
      <GetSnippetResult>
        <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>
        <DateCreated>dateTime</DateCreated>
        <DownloadCount>int</DownloadCount>
        <AverageRating>int</AverageRating>
        <Bytes>int</Bytes>
        <IsPrivate>boolean</IsPrivate>
        <HasCodeComments>boolean</HasCodeComments>
        <Summary>string</Summary>
        <Language>string</Language>
        <AuthorUsername>string</AuthorUsername>
        <AuthorFirstName>string</AuthorFirstName>
        <AuthorLastName>string</AuthorLastName>
        <AuthorFriendlyName>string</AuthorFriendlyName>
        <Code>string</Code>
        <FormattedCode>string</FormattedCode>
        <Culture>string</Culture>
        <CategoryID>guid</CategoryID>
        <LanguageID>guid</LanguageID>
        <PlatformID>guid</PlatformID>
        <UserID>guid</UserID>
        <ID>guid</ID>
        <PreviewURL>string</PreviewURL>
        <VS2005SnippetURL>string</VS2005SnippetURL>
      </GetSnippetResult>
    </GetSnippetResponse>
  </soap12:Body>
</soap12:Envelope>