customer_portal:integration:iwashcloudbookingsapi [Imagatec Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======iWash Cloud Online Bookings API======

This is a SERVER Side API. Who is supporting your website at the moment?
If you do not have the ability to make server side API, we can provide this as a CLIENT side script to be copied onto your page.

This is a JSON API.
   * URL = /core/sales/bookings/booking_api.asp
   * LIVE = http://xxxx.iposwarehouse.com/core/sales/bookings/booking_api.asp

===== Headers =====
<code html>
Accept: application/json\\
Content-Type: application/json\\
Authorization: Basic {user}:{password}
</code>

{user}:{password} is Base64 Encoded. See librarires for your server side language.
===== Body =====
<code AppleScript>
{"Booking":{
	"BookingDteTme":"01-Jan-2018 16:00",
	"BookingRego":"ABC123",
	"BookingPhone":"0410123456",
	"BookingEmail":"john@gmail.com",
	"BookingName":"John",
	"BookingSite":"1",
	"BookingTags":"WEB",
	"BookingNotes":"Extra Dirty, Could you quote on Steam Clean"
	}
}
</code>

==== Regos ====
need to be stripped of all spaces and symbols and will be converted to upper case.

==== Dates ==== 
need to be in unambiguous format of DD-MON-YYYY HH:MM

==== Tags ====

Use Booking Tags, this can be used in reports to work out where booking might be generated from.
If you want to add extra tags like a campaign that generated them, comma separate the tags words.

<code AppleScript>
"BookingTags":"WEB,FACEBOOK"
</code>

==== Notes ====

The Booking Notes field is text but can also be used to store custom fields that you can read back and use in the API. Insert text or send JSON and it will be stored in the Notes field

As Text

<code AppleScript>
"BookingNotes":"This is a text sample"
</code>

As JSON

<code AppleScript>
"BookingNotes":{"Colour":"Red","Size":"Small","Make":"Ford"}
</code>

==== Site ====

The API has some smarts and the BookingSite can be sent as either a string which matches the name of the store in the Sites Tabe, or you can send an integer which matches the record in the Sites Table. The API will take any string and try to match it to the a Site Name.

<code AppleScript>
"BookingSite":1
</code>

<code AppleScript>
"BookingSite":"Weeribee"
</code>


===== Return =====
You get back extra fields such as BookingKey and CreatedDteTme.
<code AppleScript>
{"Booking":{
	"BookingKey":1,
	"BookingDteTme":"01-Jan-2018 16:00",
	"BookingRego":"ABC123",
	"BookingPhone":"0410123456",
	"BookingEmail":"john@gmail.com",
	"BookingName":"John",
	"BookingTags":"WEB",
        "BookingNotes":"Extra Dirty, Could you quote on Steam Clean",
	"SiteKey":"1",
	"SiteName":"Weeribee",
	"CreatedDteTme":"01-Jan-2018 11:00"
	}
}
</code>

===== Read =====
Reading an existing Booking, you only need to supply part of the data such as the Booking Key.
<code AppleScript>
{"Booking":{
	"BookingKey":1
	}
}
</code>

If the customer has come to the store then it will return extra data such as the orderkey and orderdtetme
<code AppleScript>
{"Booking":{
	"BookingKey":1,
	"BookingDteTme":"01-Jan-2018 16:00",
	"BookingRego":"ABC123",
	"BookingPhone":"0410123456",
	"BookingEmail":"john@gmail.com",
	"BookingName":"John",
	"BookingTags":"WEB",
        "BookingNotes":"Extra Dirty, Could you quote on Steam Clean",
	"SiteKey":"1",
	"SiteName":"Weeribee",
	"OrderKey":358210,
	"OrderDteTme":"01-Jan-2018 16:04",
	"CreatedDteTme":"01-Jan-2018 11:00"
	}
}
</code>

===== Cancel =====
Cancel an existing Booking, you only need to supply part of the data such as the Booking Key and the CancelDteTme.
<code AppleScript>
{"Booking":{
	"BookingKey":1
	"CancelDteTme":"01-Jan-2018 11:00"
	}
}
</code>