Resengo Web API ~ documentation

General Info:

Security
Xml or Json ?
C# example: a HTTP GET request
Validation Errors

Available Entities:

Module Entity
FI Transaction
PL Person
RES PartnerReservation
RES PartnerReservationContacts
RES PartnerReservations
SUB PersonSubscription
SUB Subscription
SUB SubscriptionTransaction
WS Order
WS OrderItem

Available Services for WS/Order:

DELETE
GET
POST
You can request information about all the orders in your network by issuing a GET request to http://api.resengo.com/WS/Order.

Parameters for WS/Order (GET):

Name C# DataType Description
LastUpdatedBySomeoneElseSince DateTime The list of Orders you receive will only contain those Orders that have been modified since the specified date.
Orders that were last modified by a POST request to http://api.resengo.com/WS/Order are excluded.
You can use this parameter to set up a heartbeat synchronisation application.
OrderID List<int> The list of Orders you receive will only contain the Orders with the specified OrderIDs.
Multiple values are possible using the notation &OrderID=123&OrderID=456&OrderID=...
Sorting string The field that should be used to sort the resulting list (this affects Paging also).
Currently possible values:
  • OrderIDAscending (default)
  • UpdateDateAscending
If you are using the response of this request to do updates to your system, expecially when using the parameter LastUpdatedBySomeoneElseSince, you should use OrderIDAscending to prevent concurrency problems.
IncludeOrderItems bool (default: false) If set to true, every Order in the response will also contain all its current OrderItems. Beware that this greatly increases response size and should preferably be used along with the OrderID parameter.
You can always request the OrderItems individually by issuing a GET request to http://api.resengo.com/WS/OrderItem.
NumberOfItemsPerPage int (default: 50) You will receive only this many results at a time.
You can request the rest of the items by re-issuing the call with another CurrentPageIndex parameter.
The default of 50 is also the maximum value.
CurrentPageIndex int (default: 1) See the description of NumberOfItemsPerPage

Response of WS/Order (GET):

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Orders>
    <Order>(fields)</Order>
    <Order>(fields)</Order>
    ...
  </Orders>
  <PagingInfo>(fields)</PagingInfo>
</Response>

Fields of <PagingInfo>:

FieldName C# DataType Description
CurrentPageIndex int This should be the same value as was specified in the request.
MaximumNumberOfItemsPerPage int Informational, always 50.
NumberOfItemsPerPage int This should be the same value as was specified in the request.
TotalNumberOfItems int The total number of items that matched the criteria in the request.
If this number is greater than MaximumNumberOfItemsPerPage, you can re-issue the request with a different CurrentPageIndex to get the rest of the results (if needed).

Fields of <Order>:

FieldName C# DataType Description
ClientGroupID int
Company_VAT string
ConditionsAccepted bool
CountryTo string
Currency string
CustomerML_PersonID int
CustomerPersonEmail string
CustomerPersonID int
CustomerPersonName string
CustomerPersonTelephone string
CY_CompanyID int
DeliveryAddressID int
DeliveryDate DateTime?
DeliveryTypeID int
Description string
FI_FidelityCardItemSelectionTypeID int
FI_InvoiceHeadID int
FI_PaymentTermID int
FI_TransactionID int
FI_VATCalculationTypeID int
FI_VoucherID int
FixedOrderValue bool
FreeTextField1 string
FreeTextField2 string
FreeTextField3 string
FreeTextField4 string
FreeTextField5 string
Frozen bool
Head_FI_CostCentreID int
Head_Ledger string
Head_VAT double?
HeadAdvance double
HeadDiscount_ExcVAT double
HeadDiscount_IncVAT double
HeadDiscount_Percentage double
HeadDiscount_VAT double
HeadValue_ExcVAT double?
HeadValue_IncVAT double?
HeadWeight double
InsertDate DateTime
InsertPersonID int
InvoiceAddressID int
InvoiceNumber string
InvoicePL_AddressID int
InvoiceRequested bool
LastMailType string
LastPaymentDate DateTime?
LastPaymentScheduleReminderDate DateTime?
LastPaymentScheduleReminderTypeID int
ModuleID string
NextPaymentScheduleReminderTypeID int
NONonEventItems int
OR_EventGroupID int
OR_VisitID int?
OrderAddressID int
OrderHeadUID Guid
OrderID int
OrderItems List<OrderItem>
OrderLanguage string
OwnerPersonID int
PaidDate DateTime?
PaymentDate DateTime?
PaymentScheduleAdvance double
PaymentScheduleID int
PaymentScheduleItemID int
PaymentStatusID int
PaymentUnitID int
PR_ProjectID int
Reference string
Remarks string
SessionID int?
SMS_Order string
SMS_OrderID int
StatusID int
SUB_PersonSubscriptionID int
SubscriptionRequested bool
TD_ToDoID int
TotalValueLeftToPay double
UpdateDate DateTime
UpdatePersonID int
Version int
VoucherRequested bool
WSClientID int