www.sunsoft.gr

External Connection Web API

HTTP method POST

Try calls using method HTTP POST

URL Endpoint

/api/FO

Login

Call example: http://localhost:5600/api/FO/Login?SerialFormat=json&ClientVersion=2.01.000&DevInfo=sunsoft-12345&userName=sunsoft&password=sun$0ft
or http://localhost:5600/api/FO/Login?SerialFormat=json&ClientVersion=2.01.000&DevInfo=sunsoft-12345&userName=sunsoft&password=sun$0ft&locale=el

Summary

Executes user login to the web service. Service response containing Countries, Nationalities, Professions and the DeviceTicketInfo. DevInfo is provided by Sunsoft.

Method Parameters

NAME TYPE REQUIRED EXAMPLE NOTES
SerialFormat string yes json Form of the serialized data. (only json)
ClientVersion string yes 2.01.000 FrontOffice WebService Version Compatibility
DevInfo long yes sunsoft-12345 Device info
userName string yes sunsoft Username for login
password string yes sunsoft Password for login
locale string no el/en Optional parameter for Nationalities localization (el for Greek, en for English). Returns tο Json the nationalities in Greek/English. Without this parameter Login call returns the nationalities in Greek.


Success Response

HTTP 200 OK

or

HTTP 200 OK

Error Response

HTTP 500 Internal Server Error
Error Message
Go to top...

GetCustomer

Call example: http://localhost:5600/api/FO/GetCustomer?SerialFormat=json&ClientVersion=2.01.000&CustomerId=47181&DeviceTicket=57101

Summary

Gets a single customer record from database using database Id. Service response containing the customer record. Empty customer record if not found.

Method Parameters

NAME TYPE REQUIRED EXAMPLE NOTES
SerialFormat string yes json Form of the serialized data. (only json)
ClientVersion string yes 2.01.000 FrontOffice WebService Version Compatibility
DeviceTicket long yes 57101 Ticket for user. Returned from login
CustomerId int yes 1 Search customer id


Success Response

HTTP 200 OK

Error Response

HTTP 500 Internal Server Error
Error Message
Go to top...

UpdateCustomer

Call example: http://localhost:5600/api/FO/UpdateCustomer?SerialFormat=json&ClientVersion=2.01.000&DeviceTicket=57101
CustomerData: Body raw parameter with json data in string

'{"CustCode":0,"Email":"ikechagias@sunsoft.gr","LastName":"ΚΕΧΑΓΙΑΣ","FirstName":"ΗΛΙΑΣ", "Address":"ΜΑΧΗΣ ΑΝΑΛΑΤΟΥ","City":"ΑΘΗΝΑ","Zip":"11744","CouCode":"GR","Phone1":"658471239", "Phone2":"56464564564","Fax":"145445","Fax2":"411212","Nationality":"EL", "BirthDate":"1990-01-01T00:00:00", "CustIdNum":"AZ771141","Tier":0,"Comments":"","HotelCode":""}'

Summary

Creates or updates a customer record in the database. If CustCode set to 0 then creates new customer. If CustCode is a real CustCode then Updates the customer. Service response containing the new or updated customer record.

Method Parameters

NAME TYPE REQUIRED EXAMPLE NOTES
SerialFormat string yes json Form of the serialized data. (only json)
ClientVersion string yes 2.01.000 FrontOffice WebService Version Compatibility
DeviceTicket long yes 57101 Ticket for user. Returned from login
CustomerData string yes Body raw parameter
'{"CustCode":0,"Email":"ikechagias@sunsoft.gr","LastName":"ΚΕΧΑΓΙΑΣ","FirstName":"ΗΛΙΑΣ", "Address":"ΜΑΧΗΣ ΑΝΑΛΑΤΟΥ","City":"ΑΘΗΝΑ","Zip":"11744","CouCode":"GR","Phone1":"658471239", "Phone2":"56464564564","Fax":"145445","Fax2":"411212", "Nationality":"EL", "BirthDate":"1990-01-01T00:00:00","CustIdNum":"AZ771141","Tier":0,"Comments":"","HotelCode":""}'
Serialized customer data


Success Response

HTTP 200 OK

Error Response

HTTP 500 Internal Server Error
Error Message
Go to top...

GetReservations

Call example: http://localhost:5600/api/FO/GetReservations?SerialFormat=json&ClientVersion=2.01.000&AskDate=2018/06/05&DeviceTicket=57101

Summary

Get reservations from specific date. Service response containing the specific date reservations (in all statuses). Status: 'Empty' or 'Request' or 'tentative' or 'confirmed' or 'Check In' or 'Check Out' or 'Wbe Ammentment' or 'CANCELED'.

Method Parameters

NAME TYPE REQUIRED EXAMPLE NOTES
SerialFormat string yes json Form of the serialized data. (only json)
ClientVersion string yes 2.01.000 FrontOffice WebService Version Compatibility
AskDate DateTime yes 2018/06/25 Date with format "yyyy/mm/dd"
DeviceTicket long yes 57101 Ticket for user. Returned from login


Success Response

HTTP 200 OK

Error Response

HTTP 500 Internal Server Error
Error Message
Go to top...

GetRegistrationCards

Call example: http://localhost:5600/api/FO/GetRegistrationCards?SerialFormat=json&ClientVersion=2.3.1.0&roomNo=&reference=&reservationId=0&reservationName=&DeviceTicket=57101&locale=

Summary

Get registration cards. All with reservationId = 0 or specific.

Method Parameters

NAME TYPE REQUIRED EXAMPLE NOTES
SerialFormat string yes json Form of the serialized data. (only json)
ClientVersion string yes 2.3.1.0 FrontOffice WebService Version Compatibility
reference string no JGJ8M-1 Unique reference number.
reservationId int yes 0 Can not be empty.
reservationName string no Ilias Kechagias Name of reservation.
DeviceTicket long yes 57101 Ticket for user. Returned from login
locale string no el el/en or empty. Default is en.


Success Response

HTTP 200 OK

Error Response

HTTP 500 Internal Server Error
Error Message
Go to top...