Bring

Service BringAPI

Synopsis

This service exposes the interaction between Warta and the BRING parcel service API.

Service Data structures

TBringConfirm

Used in GetLetterConfirmList and LetterConfirmList calls. The following properties exist: * OrderID Warta order code (Table out, AVIZ) * PackageNumber Package number as returned by the BRING label call. * Confirmed On return, this will indicate whether the BRING API confirmed this order.

TBringFiles

Used in the BookAndGetFiles call. The structure contains the files returned by the BRING API. The following properties exist: * PDF: a PDF file for printing a label. * ZPL: a ZPL file for printing a RFID label on a Zebra printer.

Service Calls

ConvertOrderTo

Declaration

procedure ConvertOrderTo(const OrderID: ROAnsiString; const OrderType: TOrderType); virtual;

BookAndGetFiles

This method will book a parcel/letter order using booking, label or Mailbox API depending on service code and settings. For a 432 service code, a parcel is booked, for a 3570 code a letter is booked (labels call). The call will update the database with the package number returned by the BRING API.

Declaration

function BookAndGetFiles(const aCode: ROAnsiString; const AOrderType : TOrderType): TBringFiles; virtual;

If a PDF or ZPL fiel was returned by the bring system, their contents is returned in the streams in TBringFiles.

GetLetterConfirmList

Get a list of 3570 service code orders that must be confirmed on the given date.

Declaration

function GetLetterConfirmList(const aDate: DateTime; var aList: TBringConfirmList): Integer; virtual;

The function returns the number of orders, aList contains a list of IDs and package numbers (as returned by the booking call)

LetterConfirmOnDate

This call combines the GetLettersConfirmList and LetterConfirmList calls, executing the second if the first returned a non-empty list.

Declaration

Function LetterConfirmOnDate(const aDate: DateTime) : integer; virtual;

LetterConfirmList

Confirm the letter orders in the list using the Bring API. The database is updated with the Bring order ID.

Declaration

function LetterConfirmList(const aList: TBringConfirmList): Integer; virtual;