Integration Web Service

Integration

Click here for a complete list of operations.

GetCollectionModels

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /rest/Integration.asmx HTTP/1.1
Host: services.fnf.co.za
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetCollectionModels"

<?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>
    <GetCollectionModels xmlns="http://tempuri.org/">
      <accountId>string</accountId>
    </GetCollectionModels>
  </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>
    <GetCollectionModelsResponse xmlns="http://tempuri.org/">
      <GetCollectionModelsResult>
        <WaybillCollectionModel>
          <Id>int</Id>
          <CollectionNumber>string</CollectionNumber>
          <AccountReference>string</AccountReference>
          <CollectionContactPerson>string</CollectionContactPerson>
          <ConsignorName>string</ConsignorName>
          <ConsignorCode>string</ConsignorCode>
          <CollectionBuilding>string</CollectionBuilding>
          <CollectionStreet>string</CollectionStreet>
          <CollectionSuburb>string</CollectionSuburb>
          <CollectionCity>string</CollectionCity>
          <CollectionPostalCode>string</CollectionPostalCode>
          <CollectionEmail>string</CollectionEmail>
          <CollectionContactNumber>string</CollectionContactNumber>
          <CollectionCell>string</CollectionCell>
          <CollectionInstructions>string</CollectionInstructions>
          <ConsigneeCode>string</ConsigneeCode>
          <ConsigneeName>string</ConsigneeName>
          <DeliveryBuilding>string</DeliveryBuilding>
          <DeliveryStreet>string</DeliveryStreet>
          <DeliverySuburb>string</DeliverySuburb>
          <DeliveryCity>string</DeliveryCity>
          <DeliveryPostalCode>string</DeliveryPostalCode>
          <DeliveryContactPerson>string</DeliveryContactPerson>
          <DeliveryContactNumber>string</DeliveryContactNumber>
          <DeliveryCell>string</DeliveryCell>
          <ServiceTypeCode>string</ServiceTypeCode>
          <CollectionDate>dateTime</CollectionDate>
          <CollectionTime>string</CollectionTime>
          <ContentDescription>string</ContentDescription>
          <DeliveryInstructions>string</DeliveryInstructions>
          <UserName>string</UserName>
          <NumberOfParcels>int</NumberOfParcels>
          <ManifestReference>string</ManifestReference>
          <ProductCode>string</ProductCode>
          <ParcelDescription>string</ParcelDescription>
          <Status>int</Status>
        </WaybillCollectionModel>
        <WaybillCollectionModel>
          <Id>int</Id>
          <CollectionNumber>string</CollectionNumber>
          <AccountReference>string</AccountReference>
          <CollectionContactPerson>string</CollectionContactPerson>
          <ConsignorName>string</ConsignorName>
          <ConsignorCode>string</ConsignorCode>
          <CollectionBuilding>string</CollectionBuilding>
          <CollectionStreet>string</CollectionStreet>
          <CollectionSuburb>string</CollectionSuburb>
          <CollectionCity>string</CollectionCity>
          <CollectionPostalCode>string</CollectionPostalCode>
          <CollectionEmail>string</CollectionEmail>
          <CollectionContactNumber>string</CollectionContactNumber>
          <CollectionCell>string</CollectionCell>
          <CollectionInstructions>string</CollectionInstructions>
          <ConsigneeCode>string</ConsigneeCode>
          <ConsigneeName>string</ConsigneeName>
          <DeliveryBuilding>string</DeliveryBuilding>
          <DeliveryStreet>string</DeliveryStreet>
          <DeliverySuburb>string</DeliverySuburb>
          <DeliveryCity>string</DeliveryCity>
          <DeliveryPostalCode>string</DeliveryPostalCode>
          <DeliveryContactPerson>string</DeliveryContactPerson>
          <DeliveryContactNumber>string</DeliveryContactNumber>
          <DeliveryCell>string</DeliveryCell>
          <ServiceTypeCode>string</ServiceTypeCode>
          <CollectionDate>dateTime</CollectionDate>
          <CollectionTime>string</CollectionTime>
          <ContentDescription>string</ContentDescription>
          <DeliveryInstructions>string</DeliveryInstructions>
          <UserName>string</UserName>
          <NumberOfParcels>int</NumberOfParcels>
          <ManifestReference>string</ManifestReference>
          <ProductCode>string</ProductCode>
          <ParcelDescription>string</ParcelDescription>
          <Status>int</Status>
        </WaybillCollectionModel>
      </GetCollectionModelsResult>
    </GetCollectionModelsResponse>
  </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 /rest/Integration.asmx HTTP/1.1
Host: services.fnf.co.za
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>
    <GetCollectionModels xmlns="http://tempuri.org/">
      <accountId>string</accountId>
    </GetCollectionModels>
  </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>
    <GetCollectionModelsResponse xmlns="http://tempuri.org/">
      <GetCollectionModelsResult>
        <WaybillCollectionModel>
          <Id>int</Id>
          <CollectionNumber>string</CollectionNumber>
          <AccountReference>string</AccountReference>
          <CollectionContactPerson>string</CollectionContactPerson>
          <ConsignorName>string</ConsignorName>
          <ConsignorCode>string</ConsignorCode>
          <CollectionBuilding>string</CollectionBuilding>
          <CollectionStreet>string</CollectionStreet>
          <CollectionSuburb>string</CollectionSuburb>
          <CollectionCity>string</CollectionCity>
          <CollectionPostalCode>string</CollectionPostalCode>
          <CollectionEmail>string</CollectionEmail>
          <CollectionContactNumber>string</CollectionContactNumber>
          <CollectionCell>string</CollectionCell>
          <CollectionInstructions>string</CollectionInstructions>
          <ConsigneeCode>string</ConsigneeCode>
          <ConsigneeName>string</ConsigneeName>
          <DeliveryBuilding>string</DeliveryBuilding>
          <DeliveryStreet>string</DeliveryStreet>
          <DeliverySuburb>string</DeliverySuburb>
          <DeliveryCity>string</DeliveryCity>
          <DeliveryPostalCode>string</DeliveryPostalCode>
          <DeliveryContactPerson>string</DeliveryContactPerson>
          <DeliveryContactNumber>string</DeliveryContactNumber>
          <DeliveryCell>string</DeliveryCell>
          <ServiceTypeCode>string</ServiceTypeCode>
          <CollectionDate>dateTime</CollectionDate>
          <CollectionTime>string</CollectionTime>
          <ContentDescription>string</ContentDescription>
          <DeliveryInstructions>string</DeliveryInstructions>
          <UserName>string</UserName>
          <NumberOfParcels>int</NumberOfParcels>
          <ManifestReference>string</ManifestReference>
          <ProductCode>string</ProductCode>
          <ParcelDescription>string</ParcelDescription>
          <Status>int</Status>
        </WaybillCollectionModel>
        <WaybillCollectionModel>
          <Id>int</Id>
          <CollectionNumber>string</CollectionNumber>
          <AccountReference>string</AccountReference>
          <CollectionContactPerson>string</CollectionContactPerson>
          <ConsignorName>string</ConsignorName>
          <ConsignorCode>string</ConsignorCode>
          <CollectionBuilding>string</CollectionBuilding>
          <CollectionStreet>string</CollectionStreet>
          <CollectionSuburb>string</CollectionSuburb>
          <CollectionCity>string</CollectionCity>
          <CollectionPostalCode>string</CollectionPostalCode>
          <CollectionEmail>string</CollectionEmail>
          <CollectionContactNumber>string</CollectionContactNumber>
          <CollectionCell>string</CollectionCell>
          <CollectionInstructions>string</CollectionInstructions>
          <ConsigneeCode>string</ConsigneeCode>
          <ConsigneeName>string</ConsigneeName>
          <DeliveryBuilding>string</DeliveryBuilding>
          <DeliveryStreet>string</DeliveryStreet>
          <DeliverySuburb>string</DeliverySuburb>
          <DeliveryCity>string</DeliveryCity>
          <DeliveryPostalCode>string</DeliveryPostalCode>
          <DeliveryContactPerson>string</DeliveryContactPerson>
          <DeliveryContactNumber>string</DeliveryContactNumber>
          <DeliveryCell>string</DeliveryCell>
          <ServiceTypeCode>string</ServiceTypeCode>
          <CollectionDate>dateTime</CollectionDate>
          <CollectionTime>string</CollectionTime>
          <ContentDescription>string</ContentDescription>
          <DeliveryInstructions>string</DeliveryInstructions>
          <UserName>string</UserName>
          <NumberOfParcels>int</NumberOfParcels>
          <ManifestReference>string</ManifestReference>
          <ProductCode>string</ProductCode>
          <ParcelDescription>string</ParcelDescription>
          <Status>int</Status>
        </WaybillCollectionModel>
      </GetCollectionModelsResult>
    </GetCollectionModelsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /rest/Integration.asmx/GetCollectionModels?accountId=string HTTP/1.1
Host: services.fnf.co.za

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfWaybillCollectionModel xmlns="http://tempuri.org/">
  <WaybillCollectionModel>
    <Id>int</Id>
    <CollectionNumber>string</CollectionNumber>
    <AccountReference>string</AccountReference>
    <CollectionContactPerson>string</CollectionContactPerson>
    <ConsignorName>string</ConsignorName>
    <ConsignorCode>string</ConsignorCode>
    <CollectionBuilding>string</CollectionBuilding>
    <CollectionStreet>string</CollectionStreet>
    <CollectionSuburb>string</CollectionSuburb>
    <CollectionCity>string</CollectionCity>
    <CollectionPostalCode>string</CollectionPostalCode>
    <CollectionEmail>string</CollectionEmail>
    <CollectionContactNumber>string</CollectionContactNumber>
    <CollectionCell>string</CollectionCell>
    <CollectionInstructions>string</CollectionInstructions>
    <ConsigneeCode>string</ConsigneeCode>
    <ConsigneeName>string</ConsigneeName>
    <DeliveryBuilding>string</DeliveryBuilding>
    <DeliveryStreet>string</DeliveryStreet>
    <DeliverySuburb>string</DeliverySuburb>
    <DeliveryCity>string</DeliveryCity>
    <DeliveryPostalCode>string</DeliveryPostalCode>
    <DeliveryContactPerson>string</DeliveryContactPerson>
    <DeliveryContactNumber>string</DeliveryContactNumber>
    <DeliveryCell>string</DeliveryCell>
    <ServiceTypeCode>string</ServiceTypeCode>
    <CollectionDate>dateTime</CollectionDate>
    <CollectionTime>string</CollectionTime>
    <ContentDescription>string</ContentDescription>
    <DeliveryInstructions>string</DeliveryInstructions>
    <UserName>string</UserName>
    <NumberOfParcels>int</NumberOfParcels>
    <ManifestReference>string</ManifestReference>
    <ProductCode>string</ProductCode>
    <ParcelDescription>string</ParcelDescription>
    <Status>int</Status>
  </WaybillCollectionModel>
  <WaybillCollectionModel>
    <Id>int</Id>
    <CollectionNumber>string</CollectionNumber>
    <AccountReference>string</AccountReference>
    <CollectionContactPerson>string</CollectionContactPerson>
    <ConsignorName>string</ConsignorName>
    <ConsignorCode>string</ConsignorCode>
    <CollectionBuilding>string</CollectionBuilding>
    <CollectionStreet>string</CollectionStreet>
    <CollectionSuburb>string</CollectionSuburb>
    <CollectionCity>string</CollectionCity>
    <CollectionPostalCode>string</CollectionPostalCode>
    <CollectionEmail>string</CollectionEmail>
    <CollectionContactNumber>string</CollectionContactNumber>
    <CollectionCell>string</CollectionCell>
    <CollectionInstructions>string</CollectionInstructions>
    <ConsigneeCode>string</ConsigneeCode>
    <ConsigneeName>string</ConsigneeName>
    <DeliveryBuilding>string</DeliveryBuilding>
    <DeliveryStreet>string</DeliveryStreet>
    <DeliverySuburb>string</DeliverySuburb>
    <DeliveryCity>string</DeliveryCity>
    <DeliveryPostalCode>string</DeliveryPostalCode>
    <DeliveryContactPerson>string</DeliveryContactPerson>
    <DeliveryContactNumber>string</DeliveryContactNumber>
    <DeliveryCell>string</DeliveryCell>
    <ServiceTypeCode>string</ServiceTypeCode>
    <CollectionDate>dateTime</CollectionDate>
    <CollectionTime>string</CollectionTime>
    <ContentDescription>string</ContentDescription>
    <DeliveryInstructions>string</DeliveryInstructions>
    <UserName>string</UserName>
    <NumberOfParcels>int</NumberOfParcels>
    <ManifestReference>string</ManifestReference>
    <ProductCode>string</ProductCode>
    <ParcelDescription>string</ParcelDescription>
    <Status>int</Status>
  </WaybillCollectionModel>
</ArrayOfWaybillCollectionModel>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /rest/Integration.asmx/GetCollectionModels HTTP/1.1
Host: services.fnf.co.za
Content-Type: application/x-www-form-urlencoded
Content-Length: length

accountId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfWaybillCollectionModel xmlns="http://tempuri.org/">
  <WaybillCollectionModel>
    <Id>int</Id>
    <CollectionNumber>string</CollectionNumber>
    <AccountReference>string</AccountReference>
    <CollectionContactPerson>string</CollectionContactPerson>
    <ConsignorName>string</ConsignorName>
    <ConsignorCode>string</ConsignorCode>
    <CollectionBuilding>string</CollectionBuilding>
    <CollectionStreet>string</CollectionStreet>
    <CollectionSuburb>string</CollectionSuburb>
    <CollectionCity>string</CollectionCity>
    <CollectionPostalCode>string</CollectionPostalCode>
    <CollectionEmail>string</CollectionEmail>
    <CollectionContactNumber>string</CollectionContactNumber>
    <CollectionCell>string</CollectionCell>
    <CollectionInstructions>string</CollectionInstructions>
    <ConsigneeCode>string</ConsigneeCode>
    <ConsigneeName>string</ConsigneeName>
    <DeliveryBuilding>string</DeliveryBuilding>
    <DeliveryStreet>string</DeliveryStreet>
    <DeliverySuburb>string</DeliverySuburb>
    <DeliveryCity>string</DeliveryCity>
    <DeliveryPostalCode>string</DeliveryPostalCode>
    <DeliveryContactPerson>string</DeliveryContactPerson>
    <DeliveryContactNumber>string</DeliveryContactNumber>
    <DeliveryCell>string</DeliveryCell>
    <ServiceTypeCode>string</ServiceTypeCode>
    <CollectionDate>dateTime</CollectionDate>
    <CollectionTime>string</CollectionTime>
    <ContentDescription>string</ContentDescription>
    <DeliveryInstructions>string</DeliveryInstructions>
    <UserName>string</UserName>
    <NumberOfParcels>int</NumberOfParcels>
    <ManifestReference>string</ManifestReference>
    <ProductCode>string</ProductCode>
    <ParcelDescription>string</ParcelDescription>
    <Status>int</Status>
  </WaybillCollectionModel>
  <WaybillCollectionModel>
    <Id>int</Id>
    <CollectionNumber>string</CollectionNumber>
    <AccountReference>string</AccountReference>
    <CollectionContactPerson>string</CollectionContactPerson>
    <ConsignorName>string</ConsignorName>
    <ConsignorCode>string</ConsignorCode>
    <CollectionBuilding>string</CollectionBuilding>
    <CollectionStreet>string</CollectionStreet>
    <CollectionSuburb>string</CollectionSuburb>
    <CollectionCity>string</CollectionCity>
    <CollectionPostalCode>string</CollectionPostalCode>
    <CollectionEmail>string</CollectionEmail>
    <CollectionContactNumber>string</CollectionContactNumber>
    <CollectionCell>string</CollectionCell>
    <CollectionInstructions>string</CollectionInstructions>
    <ConsigneeCode>string</ConsigneeCode>
    <ConsigneeName>string</ConsigneeName>
    <DeliveryBuilding>string</DeliveryBuilding>
    <DeliveryStreet>string</DeliveryStreet>
    <DeliverySuburb>string</DeliverySuburb>
    <DeliveryCity>string</DeliveryCity>
    <DeliveryPostalCode>string</DeliveryPostalCode>
    <DeliveryContactPerson>string</DeliveryContactPerson>
    <DeliveryContactNumber>string</DeliveryContactNumber>
    <DeliveryCell>string</DeliveryCell>
    <ServiceTypeCode>string</ServiceTypeCode>
    <CollectionDate>dateTime</CollectionDate>
    <CollectionTime>string</CollectionTime>
    <ContentDescription>string</ContentDescription>
    <DeliveryInstructions>string</DeliveryInstructions>
    <UserName>string</UserName>
    <NumberOfParcels>int</NumberOfParcels>
    <ManifestReference>string</ManifestReference>
    <ProductCode>string</ProductCode>
    <ParcelDescription>string</ParcelDescription>
    <Status>int</Status>
  </WaybillCollectionModel>
</ArrayOfWaybillCollectionModel>

Parameter	Value
accountId: