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 SUB/Subscription:

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

Parameters for SUB/Subscription (GET):

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

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

FieldName C# DataType Description
Active bool
CreditLimit double
DefaultAutoRenew bool
DefaultNoPeriods int
DESCR string
Description string
DFieldID int?
ForSales bool
FreeIntegerField1 int?
FreeTextField1 string
InsertDate DateTime
InsertPersonID int
IsPublic bool
LinkedToSiteAccess bool
LinkToWS_Asset bool
MaxNOOpenTransactions int
MaxNOOpentransactionsSlackNOMinutes int
MaxNOTransactionsPerWeek int
MaxNOTransactionsPerDay int
Modules string
OR_ResourceTypeIDs string
PaymentUnitID int
Period string
PeriodStartDate DateTime?
PeriodStartTypeID int
PeriodTypeID int
PL_Categories string
PriceExcVAT double
PriceIncVAT double
SMS_Subscription string
SMS_SubscriptionID int
StartDate DateTime?
StartNOUnits double
SubscriptionID int
SubscriptionTypeID int
UpdateDate DateTime
UpdatePersonID int
UsageSequence int
UserGroups string
ValidUntilSlack int
ValuePerUnit double
VAT double
VATPercentage double
WS_AssetID int
WS_ClientGroupID int