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 PL/Person:

DELETE
GET
POST
You can request information about all the persons subscribed in your network by issuing a GET request to http://api.resengo.com/PL/Person.

Parameters for PL/Person (GET):

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

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

FieldName C# DataType Description
Address string
AdminChecked bool
AdminRemarks string
Associations string
BirthCountry string
BirthDay DateTime?
BirthPlace string
BlockAdmin bool
BranchID int?
CanSendEmail bool
CanSendOffLinePopUp bool
CanSendPopUp bool
CardID string
Categories string
Children string
City string
ClientInsertDate DateTime
ClientInsertPersonID int
ClientLoginID Guid
ClientUpdateDate DateTime
ClientUpdatePersonID int
Company string
Company_Activity string
Company_Address string
Company_City string
Company_Country string
Company_EMail string
Company_Fax string
Company_NOEmployees int?
Company_PostalCode string
Company_Telephone string
Company_VAT string
Company_Website string
Country string 2-letter Country Code (BE, NL, FR, GE, ...)
CY_CompanyID int
Deceased bool
DeceasedDate DateTime?
Diplomas string
DisciplineID int?
DisclaimerAccepted bool
EIDValidated bool
Email string
Email2 string
Fax string
FI_VATCalculationTypeID int
FirstLogin bool
FirstLogon DateTime?
FirstName string
First_Name_Initial string
FreeBitField1 bool
FreeBitField2 bool
FreeBitField3 bool
FreeBitField4 bool
FreeDateField1 DateTime?
FreeDateField2 DateTime?
FreeDateField3 DateTime?
FreeDateField4 DateTime?
FreeDateField5 DateTime?
FreeField string
FreeFloatField1 double?
FreeFloatField2 double?
FreeFloatField3 double?
FreeFloatField4 double?
FreeIntegerField1 int?
FreeIntegerField10 int?
FreeIntegerField2 int?
FreeIntegerField3 int?
FreeIntegerField4 int?
FreeIntegerField5 int?
FreeIntegerField6 int?
FreeIntegerField7 int?
FreeIntegerField8 int?
FreeIntegerField9 int?
FreeLongTextField1 string
FreeLongTextField2 string
FreeLongTextField3 string
FreeTextField1 string
FreeTextField10 string
FreeTextField2 string
FreeTextField3 string
FreeTextField4 string
FreeTextField5 string
FreeTextField6 string
FreeTextField7 string
FreeTextField8 string
FreeTextField9 string
FullBlockAdmin bool
Gender string M/F or null if n/a
Group1 string
Group10 string
Group2 string
Group3 string
Group4 string
Group5 string
Group6 string
Group7 string
Group8 string
Group9 string
Groups string
HelpdeskUser bool
HideAdmin bool
Hobbies string
HouseNumber string
IDGateValidationDate DateTime?
Incomplete bool
InsertDate DateTime
InsertPersonID int
InsertSubClientID int
Language string 2-letter Language Code (NL, FR, EN, ES, ...)
LastName_Main string
LastName_Prefix string
LastActivityDate DateTime?
LastLogon DateTime?
LastName string
LastPageViewed string
LastPageViewTime DateTime?
Latitude double?
Length int?
LocalPicture string
LoginSent bool
LogonTimes int?
Longitude double?
MaritalStatusID int
Member string
MemberID int?
MembExpDate DateTime?
Mobile string
Nationality string
NationalNumber string
Newsletter bool
OR_PersonalDelay int?
PartnerName string
PartnerPersonID int?
PassportID string
PC_Login string
PC_PersonTypeID int
Permission bool
Personal_Website string
PersonID int
PersonSubClientID int?
PersonTypeID int
Position string
PostalCode string
PostboxNumber string
PreferredPostAddressTypeID int
Promotion int?
Remarks string
RF1ID int?
RF2ID int?
RF3ID int?
RF4ID int?
RF5ID int?
RF6ID int?
RF7ID int?
RF8ID int?
SC_AdminRemarks string
SC_CardID string
SC_Categories string
SC_FirstLogin bool?
SC_FirstLogon DateTime?
SC_FreeBitField1 bool?
SC_FreeBitField2 bool?
SC_FreeBitField3 bool?
SC_FreeBitField4 bool?
SC_FreeDateField1 DateTime?
SC_FreeDateField2 DateTime?
SC_FreeDateField3 DateTime?
SC_FreeDateField4 DateTime?
SC_FreeDateField5 DateTime?
SC_FreeFloatField1 double?
SC_FreeFloatField2 double?
SC_FreeFloatField3 double?
SC_FreeFloatField4 double?
SC_FreeIntegerField1 int?
SC_FreeIntegerField2 int?
SC_FreeIntegerField3 int?
SC_FreeIntegerField4 int?
SC_FreeLongTextField1 string
SC_FreeLongTextField2 string
SC_FreeTextField1 string
SC_FreeTextField2 string
SC_FreeTextField3 string
SC_FreeTextField4 string
SC_FreeTextField5 string
SC_Group1 string
SC_Group10 string
SC_Group2 string
SC_Group3 string
SC_Group4 string
SC_Group5 string
SC_Group6 string
SC_Group7 string
SC_Group8 string
SC_Group9 string
SC_Groups string
SC_HideAdmin bool?
SC_LastLogon DateTime?
SC_LogonTimes int?
SC_Member string
SC_MemberID int?
SC_MembExpDate DateTime?
SC_NewsLetter bool?
SC_SecurityLevel int?
SC_SessionID string
SC_SMS bool?
SC_SubscriptionStatusID int?
SC_SyncDate DateTime?
SC_Synchronise bool?
SC_Visible bool?
SearchName string
SecurityLevel int?
SelectForMailing bool
SessionID string
Short_Name string
ShowFields string
ShowInMySites bool
ShowOnPublicSite bool
SiteLanguage string
SMS bool
StartPage string
StateID int
SUB_LastPersonSubscriptionValidTill DateTime?
SubClientInsertDate DateTime?
SubClientInsertPersonID int?
SubClients string
SubClientUpdateDate DateTime?
SubClientUpdatePersonID int?
SubscriptionStatusID int?
SyncDate DateTime?
Synchronise bool
Telephone string
TimeOut int?
TitleID int 0 = n/a
1 = Mevrouw
2 = Mijnheer
3 = Juffrouw
4 = Familie
5 = Dhr. en Mevr.
UpdateDate DateTime
UpdatePersonID int
Visible bool