AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SelectContactsQuick

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

<?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>
    <SelectContactsQuick xmlns="http://www.Achademix.com/">
      <SearchDirective>string</SearchDirective>
    </SelectContactsQuick>
  </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>
    <SelectContactsQuickResponse xmlns="http://www.Achademix.com/">
      <SelectContactsQuickResult>
        <Contact>
          <CarrierName>string</CarrierName>
          <CarrierSMS>string</CarrierSMS>
          <RelationTitle>string</RelationTitle>
          <TypeTitle>string</TypeTitle>
          <AddressID>int</AddressID>
          <Active>boolean</Active>
          <ActiveDate>dateTime</ActiveDate>
          <CellCarrierID>int</CellCarrierID>
          <Emergency>boolean</Emergency>
          <ImportKey>int</ImportKey>
          <InActiveDate>dateTime</InActiveDate>
          <Method>int</Method>
          <Name>string</Name>
          <Note>string</Note>
          <Notify>boolean</Notify>
          <Parent>boolean</Parent>
          <Primary>boolean</Primary>
          <Publish>boolean</Publish>
          <Reference>string</Reference>
          <ConRelationListID>int</ConRelationListID>
          <ContactID>int</ContactID>
          <Textable>boolean</Textable>
          <ConTypeListID>int</ConTypeListID>
          <PersonID>int</PersonID>
          <VerifyStatus>int</VerifyStatus>
        </Contact>
        <Contact>
          <CarrierName>string</CarrierName>
          <CarrierSMS>string</CarrierSMS>
          <RelationTitle>string</RelationTitle>
          <TypeTitle>string</TypeTitle>
          <AddressID>int</AddressID>
          <Active>boolean</Active>
          <ActiveDate>dateTime</ActiveDate>
          <CellCarrierID>int</CellCarrierID>
          <Emergency>boolean</Emergency>
          <ImportKey>int</ImportKey>
          <InActiveDate>dateTime</InActiveDate>
          <Method>int</Method>
          <Name>string</Name>
          <Note>string</Note>
          <Notify>boolean</Notify>
          <Parent>boolean</Parent>
          <Primary>boolean</Primary>
          <Publish>boolean</Publish>
          <Reference>string</Reference>
          <ConRelationListID>int</ConRelationListID>
          <ContactID>int</ContactID>
          <Textable>boolean</Textable>
          <ConTypeListID>int</ConTypeListID>
          <PersonID>int</PersonID>
          <VerifyStatus>int</VerifyStatus>
        </Contact>
      </SelectContactsQuickResult>
    </SelectContactsQuickResponse>
  </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>
    <SelectContactsQuick xmlns="http://www.Achademix.com/">
      <SearchDirective>string</SearchDirective>
    </SelectContactsQuick>
  </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>
    <SelectContactsQuickResponse xmlns="http://www.Achademix.com/">
      <SelectContactsQuickResult>
        <Contact>
          <CarrierName>string</CarrierName>
          <CarrierSMS>string</CarrierSMS>
          <RelationTitle>string</RelationTitle>
          <TypeTitle>string</TypeTitle>
          <AddressID>int</AddressID>
          <Active>boolean</Active>
          <ActiveDate>dateTime</ActiveDate>
          <CellCarrierID>int</CellCarrierID>
          <Emergency>boolean</Emergency>
          <ImportKey>int</ImportKey>
          <InActiveDate>dateTime</InActiveDate>
          <Method>int</Method>
          <Name>string</Name>
          <Note>string</Note>
          <Notify>boolean</Notify>
          <Parent>boolean</Parent>
          <Primary>boolean</Primary>
          <Publish>boolean</Publish>
          <Reference>string</Reference>
          <ConRelationListID>int</ConRelationListID>
          <ContactID>int</ContactID>
          <Textable>boolean</Textable>
          <ConTypeListID>int</ConTypeListID>
          <PersonID>int</PersonID>
          <VerifyStatus>int</VerifyStatus>
        </Contact>
        <Contact>
          <CarrierName>string</CarrierName>
          <CarrierSMS>string</CarrierSMS>
          <RelationTitle>string</RelationTitle>
          <TypeTitle>string</TypeTitle>
          <AddressID>int</AddressID>
          <Active>boolean</Active>
          <ActiveDate>dateTime</ActiveDate>
          <CellCarrierID>int</CellCarrierID>
          <Emergency>boolean</Emergency>
          <ImportKey>int</ImportKey>
          <InActiveDate>dateTime</InActiveDate>
          <Method>int</Method>
          <Name>string</Name>
          <Note>string</Note>
          <Notify>boolean</Notify>
          <Parent>boolean</Parent>
          <Primary>boolean</Primary>
          <Publish>boolean</Publish>
          <Reference>string</Reference>
          <ConRelationListID>int</ConRelationListID>
          <ContactID>int</ContactID>
          <Textable>boolean</Textable>
          <ConTypeListID>int</ConTypeListID>
          <PersonID>int</PersonID>
          <VerifyStatus>int</VerifyStatus>
        </Contact>
      </SelectContactsQuickResult>
    </SelectContactsQuickResponse>
  </soap12:Body>
</soap12:Envelope>