Integration Web Service

Integration

Click here for a complete list of operations.

CreateInduction

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

<?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>
    <CreateInduction xmlns="http://tempuri.org/">
      <InductShipmentAndParcels>
        <BatchIdentifier>string</BatchIdentifier>
        <ShipmentInfo>
          <ShippingNotes>string</ShippingNotes>
          <PrintDate>string</PrintDate>
          <HoldUntil>string</HoldUntil>
          <References>
            <ReferenceType>InvoiceNumber or CustomerReference or JobNumber or BatchNumber or LoadNumber or OfficeReference or TrackingNumber</ReferenceType>
            <Reference>string</Reference>
          </References>
          <References>
            <ReferenceType>InvoiceNumber or CustomerReference or JobNumber or BatchNumber or LoadNumber or OfficeReference or TrackingNumber</ReferenceType>
            <Reference>string</Reference>
          </References>
          <NumberOfParcels>int</NumberOfParcels>
          <TotalWeight>double</TotalWeight>
          <Flags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or Critical</FlagType>
          </Flags>
          <Flags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or Critical</FlagType>
          </Flags>
        </ShipmentInfo>
        <InHouseInfo>
          <InHouseId>string</InHouseId>
          <LastUpdatedAtInhouse>string</LastUpdatedAtInhouse>
        </InHouseInfo>
        <LoadsheetInfo>
          <LoadsheetNumber>string</LoadsheetNumber>
          <IsClosed>boolean</IsClosed>
        </LoadsheetInfo>
        <InsuranceInfo>
          <PolicyNumber>string</PolicyNumber>
          <InsuredValueInRands>double</InsuredValueInRands>
          <IsInsured>boolean</IsInsured>
        </InsuranceInfo>
        <SenderInfo>
          <Name>string</Name>
          <HomeNumber>string</HomeNumber>
          <OfficeNumber>string</OfficeNumber>
          <MobileNumber>string</MobileNumber>
          <EmailAddress>string</EmailAddress>
          <CompanyName>string</CompanyName>
        </SenderInfo>
        <RecipientInfo>
          <Name>string</Name>
          <HomeNumber>string</HomeNumber>
          <OfficeNumber>string</OfficeNumber>
          <MobileNumber>string</MobileNumber>
          <EmailAddress>string</EmailAddress>
          <CompanyName>string</CompanyName>
        </RecipientInfo>
        <DeliveryAddressInfo>
          <AddressClassification>HomeAddress or OfficeAddress or AlternateDelivery or InternalBranch or CustomerBranch or Unclassified</AddressClassification>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <StreetName>string</StreetName>
          <StreetNumber>string</StreetNumber>
          <Suburb>string</Suburb>
          <Province>string</Province>
          <Country>string</Country>
          <PostalCode>string</PostalCode>
          <City>string</City>
        </DeliveryAddressInfo>
        <CollectionAddressInfo>
          <AddressClassification>HomeAddress or OfficeAddress or AlternateDelivery or InternalBranch or CustomerBranch or Unclassified</AddressClassification>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <StreetName>string</StreetName>
          <StreetNumber>string</StreetNumber>
          <Suburb>string</Suburb>
          <Province>string</Province>
          <Country>string</Country>
          <PostalCode>string</PostalCode>
          <City>string</City>
        </CollectionAddressInfo>
        <ParcelsInfo>
          <UniqueParcelBarcode>string</UniqueParcelBarcode>
          <HeightInCentimeters>decimal</HeightInCentimeters>
          <WidthInCentimeters>decimal</WidthInCentimeters>
          <LengthInCentimeters>decimal</LengthInCentimeters>
          <WeightInKilograms>decimal</WeightInKilograms>
          <ApproximateHeightInCentimeters>double</ApproximateHeightInCentimeters>
          <ApproximateWidthInCentimeters>double</ApproximateWidthInCentimeters>
          <ApproximateLengthInCentimeters>double</ApproximateLengthInCentimeters>
          <ApproximateWeightInKilograms>double</ApproximateWeightInKilograms>
          <Description>string</Description>
          <ParcelReferences>
            <ReferenceType>SerialNumber or ProductCode or AdditionalBarcode</ReferenceType>
            <Reference>string</Reference>
          </ParcelReferences>
          <ParcelReferences>
            <ReferenceType>SerialNumber or ProductCode or AdditionalBarcode</ReferenceType>
            <Reference>string</Reference>
          </ParcelReferences>
          <ParcelFlags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or DangerousGoods</FlagType>
          </ParcelFlags>
          <ParcelFlags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or DangerousGoods</FlagType>
          </ParcelFlags>
          <ParcelStatus>Opened or Cancelled or InTransit or OutForDelivery or Delivered or IsPODed or Completed</ParcelStatus>
          <WeightsChanged>boolean</WeightsChanged>
          <Id>string</Id>
          <DisplayName>string</DisplayName>
          <WaybillNumber>string</WaybillNumber>
        </ParcelsInfo>
        <ParcelsInfo>
          <UniqueParcelBarcode>string</UniqueParcelBarcode>
          <HeightInCentimeters>decimal</HeightInCentimeters>
          <WidthInCentimeters>decimal</WidthInCentimeters>
          <LengthInCentimeters>decimal</LengthInCentimeters>
          <WeightInKilograms>decimal</WeightInKilograms>
          <ApproximateHeightInCentimeters>double</ApproximateHeightInCentimeters>
          <ApproximateWidthInCentimeters>double</ApproximateWidthInCentimeters>
          <ApproximateLengthInCentimeters>double</ApproximateLengthInCentimeters>
          <ApproximateWeightInKilograms>double</ApproximateWeightInKilograms>
          <Description>string</Description>
          <ParcelReferences>
            <ReferenceType>SerialNumber or ProductCode or AdditionalBarcode</ReferenceType>
            <Reference>string</Reference>
          </ParcelReferences>
          <ParcelReferences>
            <ReferenceType>SerialNumber or ProductCode or AdditionalBarcode</ReferenceType>
            <Reference>string</Reference>
          </ParcelReferences>
          <ParcelFlags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or DangerousGoods</FlagType>
          </ParcelFlags>
          <ParcelFlags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or DangerousGoods</FlagType>
          </ParcelFlags>
          <ParcelStatus>Opened or Cancelled or InTransit or OutForDelivery or Delivered or IsPODed or Completed</ParcelStatus>
          <WeightsChanged>boolean</WeightsChanged>
          <Id>string</Id>
          <DisplayName>string</DisplayName>
          <WaybillNumber>string</WaybillNumber>
        </ParcelsInfo>
        <WaybillInfo>
          <WaybillNumber>string</WaybillNumber>
          <UniqueCustomerReference>string</UniqueCustomerReference>
          <WaybillDate>string</WaybillDate>
        </WaybillInfo>
        <AccountInfo>
          <OrganisationName>string</OrganisationName>
          <CompanyRegistrationNumber>string</CompanyRegistrationNumber>
          <AccountCode>string</AccountCode>
          <WaybillPrefix>string</WaybillPrefix>
        </AccountInfo>
        <ServiceInfo>
          <DeliveryServiceName>string</DeliveryServiceName>
          <DeliveryServiceCode>string</DeliveryServiceCode>
        </ServiceInfo>
        <RouteInfo>
          <OriginatingHubName>string</OriginatingHubName>
          <OriginatingnHubCode>string</OriginatingnHubCode>
          <OriginatingHubId>string</OriginatingHubId>
          <DestinationHubName>string</DestinationHubName>
          <DestinationHubCode>string</DestinationHubCode>
          <DestinationHubId>string</DestinationHubId>
        </RouteInfo>
      </InductShipmentAndParcels>
    </CreateInduction>
  </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>
    <CreateInductionResponse xmlns="http://tempuri.org/">
      <InductParcelWithShipmentInfoCommandResult>
        <Id>string</Id>
        <IsError>boolean</IsError>
        <Message>string</Message>
      </InductParcelWithShipmentInfoCommandResult>
    </CreateInductionResponse>
  </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>
    <CreateInduction xmlns="http://tempuri.org/">
      <InductShipmentAndParcels>
        <BatchIdentifier>string</BatchIdentifier>
        <ShipmentInfo>
          <ShippingNotes>string</ShippingNotes>
          <PrintDate>string</PrintDate>
          <HoldUntil>string</HoldUntil>
          <References>
            <ReferenceType>InvoiceNumber or CustomerReference or JobNumber or BatchNumber or LoadNumber or OfficeReference or TrackingNumber</ReferenceType>
            <Reference>string</Reference>
          </References>
          <References>
            <ReferenceType>InvoiceNumber or CustomerReference or JobNumber or BatchNumber or LoadNumber or OfficeReference or TrackingNumber</ReferenceType>
            <Reference>string</Reference>
          </References>
          <NumberOfParcels>int</NumberOfParcels>
          <TotalWeight>double</TotalWeight>
          <Flags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or Critical</FlagType>
          </Flags>
          <Flags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or Critical</FlagType>
          </Flags>
        </ShipmentInfo>
        <InHouseInfo>
          <InHouseId>string</InHouseId>
          <LastUpdatedAtInhouse>string</LastUpdatedAtInhouse>
        </InHouseInfo>
        <LoadsheetInfo>
          <LoadsheetNumber>string</LoadsheetNumber>
          <IsClosed>boolean</IsClosed>
        </LoadsheetInfo>
        <InsuranceInfo>
          <PolicyNumber>string</PolicyNumber>
          <InsuredValueInRands>double</InsuredValueInRands>
          <IsInsured>boolean</IsInsured>
        </InsuranceInfo>
        <SenderInfo>
          <Name>string</Name>
          <HomeNumber>string</HomeNumber>
          <OfficeNumber>string</OfficeNumber>
          <MobileNumber>string</MobileNumber>
          <EmailAddress>string</EmailAddress>
          <CompanyName>string</CompanyName>
        </SenderInfo>
        <RecipientInfo>
          <Name>string</Name>
          <HomeNumber>string</HomeNumber>
          <OfficeNumber>string</OfficeNumber>
          <MobileNumber>string</MobileNumber>
          <EmailAddress>string</EmailAddress>
          <CompanyName>string</CompanyName>
        </RecipientInfo>
        <DeliveryAddressInfo>
          <AddressClassification>HomeAddress or OfficeAddress or AlternateDelivery or InternalBranch or CustomerBranch or Unclassified</AddressClassification>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <StreetName>string</StreetName>
          <StreetNumber>string</StreetNumber>
          <Suburb>string</Suburb>
          <Province>string</Province>
          <Country>string</Country>
          <PostalCode>string</PostalCode>
          <City>string</City>
        </DeliveryAddressInfo>
        <CollectionAddressInfo>
          <AddressClassification>HomeAddress or OfficeAddress or AlternateDelivery or InternalBranch or CustomerBranch or Unclassified</AddressClassification>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <StreetName>string</StreetName>
          <StreetNumber>string</StreetNumber>
          <Suburb>string</Suburb>
          <Province>string</Province>
          <Country>string</Country>
          <PostalCode>string</PostalCode>
          <City>string</City>
        </CollectionAddressInfo>
        <ParcelsInfo>
          <UniqueParcelBarcode>string</UniqueParcelBarcode>
          <HeightInCentimeters>decimal</HeightInCentimeters>
          <WidthInCentimeters>decimal</WidthInCentimeters>
          <LengthInCentimeters>decimal</LengthInCentimeters>
          <WeightInKilograms>decimal</WeightInKilograms>
          <ApproximateHeightInCentimeters>double</ApproximateHeightInCentimeters>
          <ApproximateWidthInCentimeters>double</ApproximateWidthInCentimeters>
          <ApproximateLengthInCentimeters>double</ApproximateLengthInCentimeters>
          <ApproximateWeightInKilograms>double</ApproximateWeightInKilograms>
          <Description>string</Description>
          <ParcelReferences>
            <ReferenceType>SerialNumber or ProductCode or AdditionalBarcode</ReferenceType>
            <Reference>string</Reference>
          </ParcelReferences>
          <ParcelReferences>
            <ReferenceType>SerialNumber or ProductCode or AdditionalBarcode</ReferenceType>
            <Reference>string</Reference>
          </ParcelReferences>
          <ParcelFlags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or DangerousGoods</FlagType>
          </ParcelFlags>
          <ParcelFlags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or DangerousGoods</FlagType>
          </ParcelFlags>
          <ParcelStatus>Opened or Cancelled or InTransit or OutForDelivery or Delivered or IsPODed or Completed</ParcelStatus>
          <WeightsChanged>boolean</WeightsChanged>
          <Id>string</Id>
          <DisplayName>string</DisplayName>
          <WaybillNumber>string</WaybillNumber>
        </ParcelsInfo>
        <ParcelsInfo>
          <UniqueParcelBarcode>string</UniqueParcelBarcode>
          <HeightInCentimeters>decimal</HeightInCentimeters>
          <WidthInCentimeters>decimal</WidthInCentimeters>
          <LengthInCentimeters>decimal</LengthInCentimeters>
          <WeightInKilograms>decimal</WeightInKilograms>
          <ApproximateHeightInCentimeters>double</ApproximateHeightInCentimeters>
          <ApproximateWidthInCentimeters>double</ApproximateWidthInCentimeters>
          <ApproximateLengthInCentimeters>double</ApproximateLengthInCentimeters>
          <ApproximateWeightInKilograms>double</ApproximateWeightInKilograms>
          <Description>string</Description>
          <ParcelReferences>
            <ReferenceType>SerialNumber or ProductCode or AdditionalBarcode</ReferenceType>
            <Reference>string</Reference>
          </ParcelReferences>
          <ParcelReferences>
            <ReferenceType>SerialNumber or ProductCode or AdditionalBarcode</ReferenceType>
            <Reference>string</Reference>
          </ParcelReferences>
          <ParcelFlags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or DangerousGoods</FlagType>
          </ParcelFlags>
          <ParcelFlags>
            <FlagType>Hazardous or Fragile or HighValue or Medical or RequiresRefrigeration or DangerousGoods</FlagType>
          </ParcelFlags>
          <ParcelStatus>Opened or Cancelled or InTransit or OutForDelivery or Delivered or IsPODed or Completed</ParcelStatus>
          <WeightsChanged>boolean</WeightsChanged>
          <Id>string</Id>
          <DisplayName>string</DisplayName>
          <WaybillNumber>string</WaybillNumber>
        </ParcelsInfo>
        <WaybillInfo>
          <WaybillNumber>string</WaybillNumber>
          <UniqueCustomerReference>string</UniqueCustomerReference>
          <WaybillDate>string</WaybillDate>
        </WaybillInfo>
        <AccountInfo>
          <OrganisationName>string</OrganisationName>
          <CompanyRegistrationNumber>string</CompanyRegistrationNumber>
          <AccountCode>string</AccountCode>
          <WaybillPrefix>string</WaybillPrefix>
        </AccountInfo>
        <ServiceInfo>
          <DeliveryServiceName>string</DeliveryServiceName>
          <DeliveryServiceCode>string</DeliveryServiceCode>
        </ServiceInfo>
        <RouteInfo>
          <OriginatingHubName>string</OriginatingHubName>
          <OriginatingnHubCode>string</OriginatingnHubCode>
          <OriginatingHubId>string</OriginatingHubId>
          <DestinationHubName>string</DestinationHubName>
          <DestinationHubCode>string</DestinationHubCode>
          <DestinationHubId>string</DestinationHubId>
        </RouteInfo>
      </InductShipmentAndParcels>
    </CreateInduction>
  </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>
    <CreateInductionResponse xmlns="http://tempuri.org/">
      <InductParcelWithShipmentInfoCommandResult>
        <Id>string</Id>
        <IsError>boolean</IsError>
        <Message>string</Message>
      </InductParcelWithShipmentInfoCommandResult>
    </CreateInductionResponse>
  </soap12:Body>
</soap12:Envelope>