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

Description for SUB/PersonSubscription:

The PersonSubscription entity, as the name implies, is the combination of a Person and a Subscription.
This is what the end user usually simply refers to as a "Subscription" : Mr X. "has" a subscription.

Available Services for SUB/PersonSubscription:

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

Parameters for SUB/PersonSubscription (GET):

Name C# DataType Description
LastUpdatedBySomeoneElseSince DateTime The list of PersonSubscriptions you receive will only contain those PersonSubscriptions that have been modified since the specified date.
PersonSubscriptions that were last modified by a POST request to http://api.resengo.com/SUB/PersonSubscription are excluded.
You can use this parameter to set up a heartbeat synchronisation application.
PersonSubscriptionID List<int> The list of PersonSubscriptions you receive will only contain the PersonSubscriptions with the specified PersonSubscriptionID.
Multiple values are possible using the notation &PersonSubscriptionID=123&PersonSubscriptionID=456&PersonSubscriptionID=...
Sorting string The field that should be used to sort the resulting list (this affects Paging also).
Currently possible values:
  • PersonSubscriptionIDAscending (default)
If you are using the response of this request to do updates to your system, expecially when using the parameter LastUpdatedBySomeoneElseSince, you should use PersonSubscriptionIDAscending to prevent concurrency problems.
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 SUB/PersonSubscription (GET):

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <PagingInfo>(fields)</PagingInfo>
  <PersonSubscriptions>
    <PersonSubscription>(fields)</PersonSubscription>
    <PersonSubscription>(fields)</PersonSubscription>
    ...
  </PersonSubscriptions>
</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 <PersonSubscription>:

FieldName C# DataType Description
AutoRenew bool
CreditLimit double?
FI_TransactionID int
FreeBitField1 bool?
InsertDate DateTime
InsertPersonID int
InsertSubClientID int
LastTransactionDate DateTime?
LastTransactionPersonID int?
MainPersonSubscriptionID int
ML_PersonID int
ModuleID string
NOUnits double
Paid bool?
PersonID int
PersonSubscriptionID int
Remarks string
RenewedFromPersonSubscriptionID int
SMS_PersonSubscription string
SMS_PersonSubscriptionID int?
Subscription Subscription
SubscriptionID int
TransactionLog string
Transactions List<SubscriptionTransaction>
UpdateDate DateTime
UpdatePersonID int
ValidFrom DateTime
ValidUntil DateTime?
WS_OrderHeadID int
WS_OrderItemID int?