Eligibility Web Service

Eligibility

Click here for a complete list of operations.

DoInquiry

Executes an eligibility lookup with an external payer by constructing an EDI transaction from the key/value pairs received.

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 /eligibility/service.asmx HTTP/1.1
Host: services.gatewayedi.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "GatewayEDI.WebServices/DoInquiry"

<?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>
    <AuthSOAPHeader xmlns="GatewayEDI.WebServices">
      <User>string</User>
      <Password>string</Password>
    </AuthSOAPHeader>
  </soap:Header>
  <soap:Body>
    <DoInquiry xmlns="GatewayEDI.WebServices">
      <Inquiry>
        <Parameters>
          <MyNameValue>
            <Name>string</Name>
            <Value>string</Value>
          </MyNameValue>
          <MyNameValue>
            <Name>string</Name>
            <Value>string</Value>
          </MyNameValue>
        </Parameters>
        <ResponseDataType>Xml or RawPayerData</ResponseDataType>
      </Inquiry>
    </DoInquiry>
  </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>
    <DoInquiryResponse xmlns="GatewayEDI.WebServices">
      <DoInquiryResult>
        <ResponseAsRawString>string</ResponseAsRawString>
        <ResponseAsXml>string</ResponseAsXml>
        <ExtraProcessingInfo>
          <AllMessages>
            <string>string</string>
            <string>string</string>
          </AllMessages>
          <Failures>
            <ValidationFailure xsi:nil="true" />
            <ValidationFailure xsi:nil="true" />
          </Failures>
        </ExtraProcessingInfo>
        <SuccessCode>Success or ValidationFailure or PayerTimeout or PayerNotSupported or SystemError or PayerEnrollmentRequired or ProviderEnrollmentRequired or ProductRequired or QuantityExceeded</SuccessCode>
        <OriginalInquiry>
          <Parameters>
            <MyNameValue xsi:nil="true" />
            <MyNameValue xsi:nil="true" />
          </Parameters>
          <ResponseDataType>Xml or RawPayerData</ResponseDataType>
        </OriginalInquiry>
      </DoInquiryResult>
    </DoInquiryResponse>
  </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 /eligibility/service.asmx HTTP/1.1
Host: services.gatewayedi.com
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>
    <AuthSOAPHeader xmlns="GatewayEDI.WebServices">
      <User>string</User>
      <Password>string</Password>
    </AuthSOAPHeader>
  </soap12:Header>
  <soap12:Body>
    <DoInquiry xmlns="GatewayEDI.WebServices">
      <Inquiry>
        <Parameters>
          <MyNameValue>
            <Name>string</Name>
            <Value>string</Value>
          </MyNameValue>
          <MyNameValue>
            <Name>string</Name>
            <Value>string</Value>
          </MyNameValue>
        </Parameters>
        <ResponseDataType>Xml or RawPayerData</ResponseDataType>
      </Inquiry>
    </DoInquiry>
  </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>
    <DoInquiryResponse xmlns="GatewayEDI.WebServices">
      <DoInquiryResult>
        <ResponseAsRawString>string</ResponseAsRawString>
        <ResponseAsXml>string</ResponseAsXml>
        <ExtraProcessingInfo>
          <AllMessages>
            <string>string</string>
            <string>string</string>
          </AllMessages>
          <Failures>
            <ValidationFailure xsi:nil="true" />
            <ValidationFailure xsi:nil="true" />
          </Failures>
        </ExtraProcessingInfo>
        <SuccessCode>Success or ValidationFailure or PayerTimeout or PayerNotSupported or SystemError or PayerEnrollmentRequired or ProviderEnrollmentRequired or ProductRequired or QuantityExceeded</SuccessCode>
        <OriginalInquiry>
          <Parameters>
            <MyNameValue xsi:nil="true" />
            <MyNameValue xsi:nil="true" />
          </Parameters>
          <ResponseDataType>Xml or RawPayerData</ResponseDataType>
        </OriginalInquiry>
      </DoInquiryResult>
    </DoInquiryResponse>
  </soap12:Body>
</soap12:Envelope>