AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SaveNote

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 /AxWCC1474WS/AchademixWS.asmx HTTP/1.1
Host: wcccws.achademix.info
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.Achademix.com/SaveNote"

<?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>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap:Header>
  <soap:Body>
    <SaveNote xmlns="http://www.Achademix.com/">
      <TheNote>
        <Documents>
          <Document>
            <Data>base64Binary</Data>
            <ExpireDate>dateTime</ExpireDate>
            <FileExt>string</FileExt>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
            <DocumentID>int</DocumentID>
            <DocTypeListID>int</DocTypeListID>
          </Document>
          <Document>
            <Data>base64Binary</Data>
            <ExpireDate>dateTime</ExpireDate>
            <FileExt>string</FileExt>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
            <DocumentID>int</DocumentID>
            <DocTypeListID>int</DocTypeListID>
          </Document>
        </Documents>
        <NoteTypeId>int</NoteTypeId>
        <OwnerNoteID>int</OwnerNoteID>
        <OwnerType>string</OwnerType>
        <TypeCode>string</TypeCode>
        <TypeID>int</TypeID>
        <TypeTitle>string</TypeTitle>
        <ExpireDate>dateTime</ExpireDate>
        <HasResponse>boolean</HasResponse>
        <IsInvalid>boolean</IsInvalid>
        <MessageID>int</MessageID>
        <NoteDate>dateTime</NoteDate>
        <FormatData>string</FormatData>
        <HasAttachment>boolean</HasAttachment>
        <HasMessage>boolean</HasMessage>
        <NoteID>int</NoteID>
        <Image>string</Image>
        <ImportKey>int</ImportKey>
        <IsLock>boolean</IsLock>
        <IsPrivate>boolean</IsPrivate>
        <IsPublished>boolean</IsPublished>
        <IsSecure>boolean</IsSecure>
        <NoteLevel>int</NoteLevel>
        <Options>int</Options>
        <NoteSourceID>int</NoteSourceID>
        <Text>string</Text>
        <Title>string</Title>
        <VerifyDate>dateTime</VerifyDate>
        <VerifyStatus>short</VerifyStatus>
        <VerifyUser>int</VerifyUser>
      </TheNote>
    </SaveNote>
  </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:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap:Header>
  <soap:Body>
    <SaveNoteResponse xmlns="http://www.Achademix.com/">
      <SaveNoteResult>int</SaveNoteResult>
    </SaveNoteResponse>
  </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 /AxWCC1474WS/AchademixWS.asmx HTTP/1.1
Host: wcccws.achademix.info
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>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap12:Header>
  <soap12:Body>
    <SaveNote xmlns="http://www.Achademix.com/">
      <TheNote>
        <Documents>
          <Document>
            <Data>base64Binary</Data>
            <ExpireDate>dateTime</ExpireDate>
            <FileExt>string</FileExt>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
            <DocumentID>int</DocumentID>
            <DocTypeListID>int</DocTypeListID>
          </Document>
          <Document>
            <Data>base64Binary</Data>
            <ExpireDate>dateTime</ExpireDate>
            <FileExt>string</FileExt>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
            <DocumentID>int</DocumentID>
            <DocTypeListID>int</DocTypeListID>
          </Document>
        </Documents>
        <NoteTypeId>int</NoteTypeId>
        <OwnerNoteID>int</OwnerNoteID>
        <OwnerType>string</OwnerType>
        <TypeCode>string</TypeCode>
        <TypeID>int</TypeID>
        <TypeTitle>string</TypeTitle>
        <ExpireDate>dateTime</ExpireDate>
        <HasResponse>boolean</HasResponse>
        <IsInvalid>boolean</IsInvalid>
        <MessageID>int</MessageID>
        <NoteDate>dateTime</NoteDate>
        <FormatData>string</FormatData>
        <HasAttachment>boolean</HasAttachment>
        <HasMessage>boolean</HasMessage>
        <NoteID>int</NoteID>
        <Image>string</Image>
        <ImportKey>int</ImportKey>
        <IsLock>boolean</IsLock>
        <IsPrivate>boolean</IsPrivate>
        <IsPublished>boolean</IsPublished>
        <IsSecure>boolean</IsSecure>
        <NoteLevel>int</NoteLevel>
        <Options>int</Options>
        <NoteSourceID>int</NoteSourceID>
        <Text>string</Text>
        <Title>string</Title>
        <VerifyDate>dateTime</VerifyDate>
        <VerifyStatus>short</VerifyStatus>
        <VerifyUser>int</VerifyUser>
      </TheNote>
    </SaveNote>
  </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:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap12:Header>
  <soap12:Body>
    <SaveNoteResponse xmlns="http://www.Achademix.com/">
      <SaveNoteResult>int</SaveNoteResult>
    </SaveNoteResponse>
  </soap12:Body>
</soap12:Envelope>