CompraFacilWS


Click here for a complete list of operations.

GetReferencesInfo

Get information about references. Returns list of references and IDs. Input parameters type=P returns lists of references paid between the dates specified; type=R returns list of references created (not necessarily paid yet) between the dates specified. Method returns true/false and if false output parameter contains error description, the lists are in output parameters referencesList and IDsList(Important: dates are in format dd-MM-yyyy hh:mm:ss Ex: 24-02-2007 14:35:22)

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 /SIBSClick2/webservice/comprafacilWS.asmx HTTP/1.1
Host: hm.comprafacil.pt
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.comprafacil.pt/GetReferencesInfo"

<?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>
    <GetReferencesInfo xmlns="http://www.comprafacil.pt/">
      <username>string</username>
      <password>string</password>
      <dateStartStr>string</dateStartStr>
      <dataEndStr>string</dataEndStr>
      <type>string</type>
    </GetReferencesInfo>
  </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>
    <GetReferencesInfoResponse xmlns="http://www.comprafacil.pt/">
      <GetReferencesInfoResult>boolean</GetReferencesInfoResult>
      <referencesList>string</referencesList>
      <IDsList>string</IDsList>
      <error>string</error>
    </GetReferencesInfoResponse>
  </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 /SIBSClick2/webservice/comprafacilWS.asmx HTTP/1.1
Host: hm.comprafacil.pt
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>
    <GetReferencesInfo xmlns="http://www.comprafacil.pt/">
      <username>string</username>
      <password>string</password>
      <dateStartStr>string</dateStartStr>
      <dataEndStr>string</dataEndStr>
      <type>string</type>
    </GetReferencesInfo>
  </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>
    <GetReferencesInfoResponse xmlns="http://www.comprafacil.pt/">
      <GetReferencesInfoResult>boolean</GetReferencesInfoResult>
      <referencesList>string</referencesList>
      <IDsList>string</IDsList>
      <error>string</error>
    </GetReferencesInfoResponse>
  </soap12:Body>
</soap12:Envelope>