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 Add and Update PersonSubscriptions in your network by issuing a POST request to http://api.resengo.com/SUB/PersonSubscription.
The PersonSubscriptionIDs returned in the response should be saved in your database.
If possible, always use a PersonSubscriptionID when updating a PersonSubscription in the network.
If you do not have a PersonSubscriptionID yet (because you are uploading the PersonSubscription for the first time) and you are sending multiple PersonSubscriptions at once, you can differentiate between the results by specifying a SMS_PersonSubscriptionID or SMS_PersonSubscription for each posted PersonSubscription. These should correspond to the primary key of your local database.

Request to SUB/PersonSubscription (POST):

<?xml version="1.0" encoding="utf-8"?>
<Request>
  <PersonSubscriptions>
    <PersonSubscription>(fields)</PersonSubscription>
    <PersonSubscription>(fields)</PersonSubscription>
    ...
  </PersonSubscriptions>
</Request>

Fields of <PersonSubscription>:

FieldName C# DataType Description
AutoRenew bool
CreditLimit double?
FI_TransactionID int
FreeBitField1 bool?
LastTransactionDate DateTime?
LastTransactionPersonID 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>
ValidFrom DateTime
ValidUntil DateTime?
WS_OrderHeadID int
WS_OrderItemID int?

Response of SUB/PersonSubscription (POST):

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <PersonSubscriptions>
    <PersonSubscription>(fields)</PersonSubscription>
    <PersonSubscription>(fields)</PersonSubscription>
    ...
  </PersonSubscriptions>
</Response>

Fields of <PersonSubscription>:

FieldName C# DataType Description
PersonSubscriptionID int
SMS_PersonSubscription string
SMS_PersonSubscriptionID int?
Errors List<ValidationError>