API

Click here for a complete list of operations.

GetProducts

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.asmx HTTP/1.1
Host: uat.api.emandates.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.emandates.co.uk/v3/GetProducts"

<?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>
    <UserAuthenticateHeader xmlns="https://www.emandates.co.uk/v3/">
      <UserName>string</UserName>
      <Password>string</Password>
    </UserAuthenticateHeader>
  </soap:Header>
  <soap:Body>
    <GetProducts xmlns="https://www.emandates.co.uk/v3/">
      <clientSUN>string</clientSUN>
    </GetProducts>
  </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>
    <GetProductsResponse xmlns="https://www.emandates.co.uk/v3/">
      <GetProductsResult>
        <OverallStatus>boolean</OverallStatus>
        <AuthStatus>boolean</AuthStatus>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <Products>
          <ProductAPIResponse>
            <Id>string</Id>
            <Title>string</Title>
            <ReferencingMethod>string</ReferencingMethod>
            <ReferencePrefix>string</ReferencePrefix>
            <LastReferenceUsed>string</LastReferenceUsed>
            <ReferenceRangeStart>string</ReferenceRangeStart>
            <ReferenceRangeEnd>string</ReferenceRangeEnd>
            <Plans xsi:nil="true" />
          </ProductAPIResponse>
          <ProductAPIResponse>
            <Id>string</Id>
            <Title>string</Title>
            <ReferencingMethod>string</ReferencingMethod>
            <ReferencePrefix>string</ReferencePrefix>
            <LastReferenceUsed>string</LastReferenceUsed>
            <ReferenceRangeStart>string</ReferenceRangeStart>
            <ReferenceRangeEnd>string</ReferenceRangeEnd>
            <Plans xsi:nil="true" />
          </ProductAPIResponse>
        </Products>
      </GetProductsResult>
    </GetProductsResponse>
  </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.asmx HTTP/1.1
Host: uat.api.emandates.co.uk
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>
    <UserAuthenticateHeader xmlns="https://www.emandates.co.uk/v3/">
      <UserName>string</UserName>
      <Password>string</Password>
    </UserAuthenticateHeader>
  </soap12:Header>
  <soap12:Body>
    <GetProducts xmlns="https://www.emandates.co.uk/v3/">
      <clientSUN>string</clientSUN>
    </GetProducts>
  </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>
    <GetProductsResponse xmlns="https://www.emandates.co.uk/v3/">
      <GetProductsResult>
        <OverallStatus>boolean</OverallStatus>
        <AuthStatus>boolean</AuthStatus>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <Products>
          <ProductAPIResponse>
            <Id>string</Id>
            <Title>string</Title>
            <ReferencingMethod>string</ReferencingMethod>
            <ReferencePrefix>string</ReferencePrefix>
            <LastReferenceUsed>string</LastReferenceUsed>
            <ReferenceRangeStart>string</ReferenceRangeStart>
            <ReferenceRangeEnd>string</ReferenceRangeEnd>
            <Plans xsi:nil="true" />
          </ProductAPIResponse>
          <ProductAPIResponse>
            <Id>string</Id>
            <Title>string</Title>
            <ReferencingMethod>string</ReferencingMethod>
            <ReferencePrefix>string</ReferencePrefix>
            <LastReferenceUsed>string</LastReferenceUsed>
            <ReferenceRangeStart>string</ReferenceRangeStart>
            <ReferenceRangeEnd>string</ReferenceRangeEnd>
            <Plans xsi:nil="true" />
          </ProductAPIResponse>
        </Products>
      </GetProductsResult>
    </GetProductsResponse>
  </soap12:Body>
</soap12:Envelope>