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/SubscriptionTransaction:

The SubscriptionTransaction entities describe the movement of credits to and from a PersonSubscription.
The total value of all SubscriptionTransactions for any PersonSubscription is the amount of credits left on that PersonSubscription.
Do not confuse with FI/Transaction, which are payments with money.

Available Services for SUB/SubscriptionTransaction:

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

Parameters for SUB/SubscriptionTransaction (GET):

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

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

Documentation on fields is not yet available.