AchademixWS


Click here for a complete list of operations.

SendMessage

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

<?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>
    <SendMessage xmlns="http://www.Achademix.com/">
      <TheMessage>
        <InqRunSegment>
          <DisplayedStartTime>string</DisplayedStartTime>
          <DisplayedStopTime>string</DisplayedStopTime>
          <RunSunday>boolean</RunSunday>
          <RunMonday>boolean</RunMonday>
          <RunTuesday>boolean</RunTuesday>
          <RunWednesday>boolean</RunWednesday>
          <RunThursday>boolean</RunThursday>
          <RunFriday>boolean</RunFriday>
          <RunSaturday>boolean</RunSaturday>
          <EndTime>int</EndTime>
          <Interval>int</Interval>
          <Type>int</Type>
          <IsActive>boolean</IsActive>
          <Code>string</Code>
          <IsSystem>boolean</IsSystem>
          <SchWeekDays>string</SchWeekDays>
          <Title>string</Title>
          <StartTime>int</StartTime>
          <InqRunSegmentListID>int</InqRunSegmentListID>
          <Order>string</Order>
        </InqRunSegment>
        <MergeText>
          <MergeData>
            <MergeKey>string</MergeKey>
            <MergeText>string</MergeText>
          </MergeData>
          <MergeData>
            <MergeKey>string</MergeKey>
            <MergeText>string</MergeText>
          </MergeData>
        </MergeText>
        <MessagePersons>
          <MessagePerson>
            <MsgRef>string</MsgRef>
            <Person xsi:nil="true" />
            <Prefname>string</Prefname>
            <ValRef>int</ValRef>
            <CcList>string</CcList>
            <RespondMin>int</RespondMin>
            <Method>int</Method>
            <IsPrimary>boolean</IsPrimary>
            <MessagePersonID>int</MessagePersonID>
            <PersonID>int</PersonID>
            <MessageID>int</MessageID>
          </MessagePerson>
          <MessagePerson>
            <MsgRef>string</MsgRef>
            <Person xsi:nil="true" />
            <Prefname>string</Prefname>
            <ValRef>int</ValRef>
            <CcList>string</CcList>
            <RespondMin>int</RespondMin>
            <Method>int</Method>
            <IsPrimary>boolean</IsPrimary>
            <MessagePersonID>int</MessagePersonID>
            <PersonID>int</PersonID>
            <MessageID>int</MessageID>
          </MessagePerson>
        </MessagePersons>
        <AttachData>
          <base64Binary>base64Binary</base64Binary>
          <base64Binary>base64Binary</base64Binary>
        </AttachData>
        <AttachDataNames>
          <string>string</string>
          <string>string</string>
        </AttachDataNames>
        <ReplyEmail>string</ReplyEmail>
        <ReplyNumber>string</ReplyNumber>
        <SenderEmail>string</SenderEmail>
        <SendChkEmailText>boolean</SendChkEmailText>
        <InqRunSegmentListID>int</InqRunSegmentListID>
        <MessageID>int</MessageID>
        <Action>int</Action>
        <AllowSchedule>boolean</AllowSchedule>
        <Category>int</Category>
        <Descript>string</Descript>
        <DocumentType>int</DocumentType>
        <MsgEmail>string</MsgEmail>
        <Level>int</Level>
        <TheMessage>string</TheMessage>
        <MethodDefault>int</MethodDefault>
        <Name>string</Name>
        <Payload>string</Payload>
        <Source>int</Source>
        <MsgText>string</MsgText>
        <Title>string</Title>
        <TriggerLimit>int</TriggerLimit>
        <Type>int</Type>
        <IsSystem>boolean</IsSystem>
      </TheMessage>
    </SendMessage>
  </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>
    <SendMessageResponse xmlns="http://www.Achademix.com/">
      <SendMessageResult>boolean</SendMessageResult>
    </SendMessageResponse>
  </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>
    <SendMessage xmlns="http://www.Achademix.com/">
      <TheMessage>
        <InqRunSegment>
          <DisplayedStartTime>string</DisplayedStartTime>
          <DisplayedStopTime>string</DisplayedStopTime>
          <RunSunday>boolean</RunSunday>
          <RunMonday>boolean</RunMonday>
          <RunTuesday>boolean</RunTuesday>
          <RunWednesday>boolean</RunWednesday>
          <RunThursday>boolean</RunThursday>
          <RunFriday>boolean</RunFriday>
          <RunSaturday>boolean</RunSaturday>
          <EndTime>int</EndTime>
          <Interval>int</Interval>
          <Type>int</Type>
          <IsActive>boolean</IsActive>
          <Code>string</Code>
          <IsSystem>boolean</IsSystem>
          <SchWeekDays>string</SchWeekDays>
          <Title>string</Title>
          <StartTime>int</StartTime>
          <InqRunSegmentListID>int</InqRunSegmentListID>
          <Order>string</Order>
        </InqRunSegment>
        <MergeText>
          <MergeData>
            <MergeKey>string</MergeKey>
            <MergeText>string</MergeText>
          </MergeData>
          <MergeData>
            <MergeKey>string</MergeKey>
            <MergeText>string</MergeText>
          </MergeData>
        </MergeText>
        <MessagePersons>
          <MessagePerson>
            <MsgRef>string</MsgRef>
            <Person xsi:nil="true" />
            <Prefname>string</Prefname>
            <ValRef>int</ValRef>
            <CcList>string</CcList>
            <RespondMin>int</RespondMin>
            <Method>int</Method>
            <IsPrimary>boolean</IsPrimary>
            <MessagePersonID>int</MessagePersonID>
            <PersonID>int</PersonID>
            <MessageID>int</MessageID>
          </MessagePerson>
          <MessagePerson>
            <MsgRef>string</MsgRef>
            <Person xsi:nil="true" />
            <Prefname>string</Prefname>
            <ValRef>int</ValRef>
            <CcList>string</CcList>
            <RespondMin>int</RespondMin>
            <Method>int</Method>
            <IsPrimary>boolean</IsPrimary>
            <MessagePersonID>int</MessagePersonID>
            <PersonID>int</PersonID>
            <MessageID>int</MessageID>
          </MessagePerson>
        </MessagePersons>
        <AttachData>
          <base64Binary>base64Binary</base64Binary>
          <base64Binary>base64Binary</base64Binary>
        </AttachData>
        <AttachDataNames>
          <string>string</string>
          <string>string</string>
        </AttachDataNames>
        <ReplyEmail>string</ReplyEmail>
        <ReplyNumber>string</ReplyNumber>
        <SenderEmail>string</SenderEmail>
        <SendChkEmailText>boolean</SendChkEmailText>
        <InqRunSegmentListID>int</InqRunSegmentListID>
        <MessageID>int</MessageID>
        <Action>int</Action>
        <AllowSchedule>boolean</AllowSchedule>
        <Category>int</Category>
        <Descript>string</Descript>
        <DocumentType>int</DocumentType>
        <MsgEmail>string</MsgEmail>
        <Level>int</Level>
        <TheMessage>string</TheMessage>
        <MethodDefault>int</MethodDefault>
        <Name>string</Name>
        <Payload>string</Payload>
        <Source>int</Source>
        <MsgText>string</MsgText>
        <Title>string</Title>
        <TriggerLimit>int</TriggerLimit>
        <Type>int</Type>
        <IsSystem>boolean</IsSystem>
      </TheMessage>
    </SendMessage>
  </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>
    <SendMessageResponse xmlns="http://www.Achademix.com/">
      <SendMessageResult>boolean</SendMessageResult>
    </SendMessageResponse>
  </soap12:Body>
</soap12:Envelope>