|
Rest API
1.1
|
|
|
Rest API
1.1
|
Public Member Functions | |
| addagenda ($p_sPublicKey) | |
| addagendaservice ($p_sPublicKey) | |
| addclient ($p_sPublicKey, $p_sWebaccess) | |
| addcompany ($p_sPublicKey) | |
| addcompanycustomfield ($p_sPublicKey) | |
| addevent ($p_sPublicKey) | |
| addextraservice ($p_sPublicKey) | |
| addholidays ($p_sPublicKey) | |
| addorder ($p_sPublicKey) | |
| addservice ($p_sPublicKey) | |
| addsocialevent ($p_sPublicKey, $p_sPublickeyNormalCompany) | |
| addsocialuser ($p_sPublicKey) | |
| addtrial () | |
| adduser ($p_sPublicKey) | |
| auth ($p_sPublicKey, $p_sAccountType) | |
| checkifcompanyemailexist ($p_sPublicKey, $p_sCompanyEmail) | |
| confirmemail ($p_sPublicKey) | |
| confirmevent ($p_sPublicKey) | |
| confirmphone ($p_sPublicKey) | |
| deleteagenda ($p_sPublicKey) | |
| deleteagendaservice ($p_sPublicKey) | |
| deleteclient ($p_sPublicKey) | |
| deletecompany ($p_sPublicKey) | |
| deletecompanyschedule ($p_sPublicKey) | |
| deleteevent ($p_sPublicKey) | |
| deleteservice ($p_sPublicKey) | |
| getagendaconfiguration ($p_sPublicKey, $p_sAgendaID) | |
| getagendas ($p_sPublicKey, $p_sServiceID=null) | |
| getagendasbycategory ($p_sPublicKey, $p_sCategoryId) | |
| getagendasservices ($p_sPublicKey) | |
| getcategories ($p_sPublicKey) | |
| getcities ($p_sPublicKey, $p_sLanguageID, $p_sRegionID) | |
| getclient ($p_sPublicKey, $p_sIdClientId) | |
| getclientbyvalidationfield ($p_sPublicKey) | |
| getclientevents ($p_sPublicKey, $p_iClientId, $p_sDateFrom="", $p_sDateTo="") | |
| getclients ($p_sPublicKey, $p_sDateFrom, $p_sDateTo, $p_sType=null) | |
| getclientsbyeventid ($p_sPublicKey, $p_sEventID) | |
| getcompanies ($p_sPublicKey) | |
| getcompanydata ($p_sPublicKey) | |
| getcountries ($p_sPublicKey, $p_sLanguageID) | |
| geteventbyid ($p_sPublicKey, $p_sEventID=null, $p_sLocator=null) | |
| getevents ($p_sPublicKey, $p_sDateFrom, $p_sDateTo, $p_sAgendaID=null) | |
| getextraservices ($p_sPublicKey) | |
| getfreeslots ($p_sPublicKey, $p_sServiceID, $p_sAgendaID, $p_sDate, $p_bAlsoFullSlots="false") | |
| getgroups ($p_sPublicKey) | |
| getholidays ($p_sPublicKey) | |
| getlanguages ($p_sPublicKey) | |
| getorders ($p_sPublicKey) | |
| getregions ($p_sPublicKey, $p_sLanguageID, $p_sCountryID) | |
| getschedule ($p_sPublicKey) | |
| getservices ($p_sPublicKey, $p_sGroupId=null) | |
| getuser ($p_sPublicKey, $p_sUserID) | |
| getuserevents ($p_sPublicKey, $p_iIdUser, $p_sDateFrom, $p_sDateTo) | |
| setagendatocompanyschedule ($p_sPublicKey) | |
| setphoneandsendvalidate ($p_sPublicKey) | |
| testconnection ($p_sEchoValue) | |
| updateagenda ($p_sPublicKey) | |
| updateagendacommunications ($p_sPublicKey) | |
| updateagendaconfiguration ($p_sPublicKey) | |
| updateagendaservice ($p_sPublicKey) | |
| updateclient ($p_sPublicKey) | |
| updatecompany ($p_sPublicKey) | |
| updatecompanycustomfield ($p_sPublicKey) | |
| updatecompanyscheduleday ($p_sPublicKey) | |
| updateevent ($p_sPublicKey) | |
| updateeventstatus ($p_sPublicKey) | |
| updateorder ($p_sPublicKey) | |
| updateservice ($p_sPublicKey) | |
| updatesocialuser ($p_sPublicKey) | |
| updateuser ($p_sPublicKey) | |
| uservalidate ($p_sUserMail, $p_sPassword, $p_sType=null) | |
| validateorder ($p_sPublicKey) | |
The most recent version of the Bookitit REST API.
Version 1 of the REST API is now deprecated.
| addagenda | ( | $p_sPublicKey | ) |
This function adds an agenda for your company.
URL to call this function: http://app.bookitit.com/api/11/addagenda/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| name | agenda name |
| phone | agenda phone (optional) |
| agenda email (optional) | |
| public | (optional) indicates if the agenda is "public" or "private". Default is "public" |
| synchroid | (optional) id of the agenda in your software (MUST USE in case of an integration or synchronization between your software and Bookitit) |
| serviceid | (optional) id of a previously created service, which associate with this agenda (format bktXXXXXXX) |
| addagendaservice | ( | $p_sPublicKey | ) |
This function connects an agenda and a service for your company. Both must be already created, and its IDs supplied. It can be the IDs of the agenda and the service in Bookitit or, if you are synchronizing/integrating services between your software and Bookitit, the ID of the agenda and the service in your software (we call it Synchro IDs). If both IDs are provided, the Synchro IDs have preference.
URL to call this function: http://app.bookitit.com/api/11/addagendaservice/$p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sAgendaID | agenda ID (format bktXXXXXXX) |
| p_sServiceID | service ID (format bktXXXXXXX) |
| p_sAgendaSynchroID | agenda ID in your software (use in case of software integration) |
| p_sServiceSynchroID | service ID in your software (use in case of software integration) |
| p_iDuration | (optional) Duration of the service specific for this agenda, in minutes. |
| p_dPrice | (optional) Price of the service specific for this agenda, in your currency |
| addclient | ( | $p_sPublicKey, | |
| $p_sWebaccess | |||
| ) |
This function adds a client with or without web access
URL to call this function: http://app.bookitit.com/api/11/addclient/p_sPublicKey
A client with web access can login from widget. With this action the client can create new appointments without register again, or delete pending appointments. This client registration requires some mandatory fields.
A client without web access can't login at widget. This type of client only contains its data that allow to center create new appointment This client registration only requires to fill some fields (one field at least)
| $p_sPublicKey | Your public key |
| $p_sWebaccess | If the client has web access or not (string with "true" or "false") |
POST PARAMETERS
| $p_sPassword | (optional) Encrypted (md5) password for the client. If you don't want to send this parameter set it as "". |
| $p_sEmail | (optional) Email of the client. If you don't want to send this parameter set it as "". |
| $p_sCellphone | (optional) Cellphone of the client without international code. If you don't want to send this parameter set it as "". |
| $p_sInternationalCode | (optional) The country international code (Ex: +34), if you don't set this value the default value inserted will be the international code of the company. If you don't want to send this parameter set it as "". |
| $p_sDocument | (optional) Document of the client. If you don't want to send this parameter set it as "". |
| $p_sName | (optional) Name of the client. If you don't want to send this parameter set it as "". |
| $p_sAddress | (optional) Address of the client. If you don't want to send this parameter set it as "". |
| $p_sPhone | (optional) Phone of the client. If you don't want to send this parameter set it as "". |
| $p_someCustomFields | (optional) If your company account is using custom fields for the users, you can set it there. |
$p_someCustomFields param example: array( "customvalidate1" => "data in text format", "customvalidate2"=> "data in text format", "custom1"=> "data in text format", "custom2"=> "data in text format", "custom3"=> "data in text format", "custom4"=> "data in text format", "custom5"=> "data in text format" )
| addcompany | ( | $p_sPublicKey | ) |
This function is used to add a new company to Bookitit.
URL to call this function: http://app.bookitit.com/api/11/addcompany/p_sPublicKey
| $p_sPublicKey | Public key of the administrator user |
POST PARAMETERS
| p_sEmail | email of the company |
| p_sPassword | Encrypted password (md5) of the company. You have to use an md5 library to encrypt. |
| p_sName | Name of the company |
| p_sCellPhone | Cellphone of the company (optional) |
| p_sPhone | Phone of the company (optional) |
| p_sAddress | Address of the company (optional) |
| p_sPostalCode | Postal code of the company (optional) |
| p_sWeb | Website of the company (optional) |
| p_sExpirationDate | the expiration date of the account (format YYYY-MM-DD). Optional, default is one year from today. |
| p_sShowWizard | (optional) indicates if the company administrator will have to complete the first-time wizard. Options are "yes" or "no", default is "yes". |
| addcompanycustomfield | ( | $p_sPublicKey | ) |
This function adds a custom field for the company whose public key is given.
URL to call this function: http://app.bookitit.com/api/11/addcompanycustomfield/p_sPublicKey
| $p_sPublicKey | Public key of the administrator user |
POST PARAMETERS
| p_sPublicKeyToAdd | public key of the company to add the field to |
| p_sInputType | the kind of the custom field, current options are "text", "checkbox" |
| p_sInputLabel | the label that will precede the field wherever it is shown |
| p_sInputName | the name of the field form html and DOM purposes |
| p_sInputValue | the value of the field |
| p_sShowInMyCenter | (optional) indicates if the custom field has to be shown in the "my center" section of bookitit. Options are "yes" or "no", default is "no". |
| p_sLanguageID | (optional) (format bktXXXXX) indicates the language of the field, as they can be multilanguage. Must add one field per language. |
| addevent | ( | $p_sPublicKey | ) |
This function creates an event.
URL to call this function: http://app.bookitit.com/api/11/addevent/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sAgendaID | ID of the agenda (format bktXXXXXXXX) |
| p_sServiceID | ID of the service (format bktXXXXXXXX) |
| p_dStartDate | start date of the event (YYYY-MM-DD), if date doesn't exist, date will be 0000-00-00 |
| p_dEndDate | end date of the event (YYYY-MM-DD), if date doesn't exist, date will be 0000-00-00 |
| p_iStartTime | start time of the event (in minutes, since 00:00): 01:00 am = 60, 02:00 am = 120 ... |
| p_iEndTime | end time of the event (in minutes, since 00:00): 01:00 am = 60, 02:00 am = 120 ... |
| p_sTitle | (optional) title of the event, if it's set p_sServiceID the title will get automatically the name of the service. DEPRECATED the p_sServiceID is allways needed. |
| p_sDescription | (optional) description of the event DEPRECATED, use p_sComments |
| p_sComments | (optional) comments of the event |
| p_sEventSynchroID | (optional) In case you are synchronizing your software with Bookitit, provide your event ID. |
| p_sAgendaSynchroID | (optional) (mandatory if $p_sAgendaID is not set) In case you are synchronizing your software with Bookitit, provide your agenda ID. |
| p_sServiceSynchroID | (optional) (mandatory if $p_sServiceID is not set) In case you are synchronizing your software with Bookitit, provide your service ID. |
| p_sUserID | (optional) ID of the final user who makes the event (format bktXXXXXXXX) DEPRECATED, use p_sClientID |
| p_sUserPhone | (optional) a phone number of the final user who makes the event. DEPRECATED |
| p_sClientID | (optional) ID of the client who makes the event (format bktXXXXXXXX) |
| p_sClientName | (optional) name of the client, to create the new client if p_sUserID or p_sClientID is not set |
| p_sClientPhone | (optional) phone of the client, to create the new client if p_sUserID or p_sClientID is not set |
| p_sClientEmail | (optional) email of the client, to create the new client if p_sUserID or p_sClientID is not set |
| $p_someCustomFields | (optional) If your company account is using custom fields for the users, you can set it there. |
$p_someCustomFields param example: array( "customevent1" => "data in text format", "customevent2"=> "data in text format", "customevent3"=> "data in text format", "customevent4"=> "data in text format", "customevent5"=> "data in text format" )
| addextraservice | ( | $p_sPublicKey | ) |
This function adds an extra service for your company. An extra service is separated from the rest of services for some reason, i.e. temporary offers. They can't be associated with an agenda, only with an event.
URL to call this function: http://app.bookitit.com/api/11/addextraservice/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sName | name of the extra service |
| addholidays | ( | $p_sPublicKey | ) |
This function adds an array of holidays
URL to call this function: http://app.bookitit.com/api/11/addholidays/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| $p_someHolidays | the array of holidays will have this format: myarray["2012-01-01"] = "title 1";myarray["2012-01-02"] = "title 2"; ... |
| addorder | ( | $p_sPublicKey | ) |
This function creates an order for your company when a client intends to book a prepay service. The order is created in an initial state (not paid).
URL to call this function: http://app.bookitit.com/api/11/addorder/p_sPublicKey
| p_sPublicKey | Your public key |
| addservice | ( | $p_sPublicKey | ) |
This function adds a service for your company.
URL to call this function: http://app.bookitit.com/api/11/addservice/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sName | name of the service |
| p_iTime | duration of the service in minutes |
| p_dPrice | price of the service (only numbers in format XX.XX) |
| p_sCurrency | in which currency would be the service the price, accepted values are "EUR" for euro "GBP" for british pound and "USD" for United States dollar. Default is euro. |
| p_sPublic | (optional) service marked as "public" or "private". Default is "public". |
| p_iPrepay | (optional) "prepay" or "not_prepay". Default is "not_prepay". |
| p_sSynchroID | (optional) id of the service in your software (MUST USE in case of an integration or synchronization between your software and Bookitit) |
| addsocialevent | ( | $p_sPublicKey, | |
| $p_sPublickeyNormalCompany | |||
| ) |
This function creates a "social" event. The user must be a "social" user. A social event is like an event but linked to a social user.
A "social" event will always show for a user in different companies of the same social network.
URL to call this function: http://app.bookitit.com/api/11/addsocialevent/p_sPublicKey
| p_sPublicKey | The public key of an Administrator API KEY |
| p_sPublickeyNormalCompany | The public key of the company for which the user is going to booking |
POST
| p_sEmail | The email of the user-client that is booking the event (format bktXXXXX) |
| p_sAgendaID | id of the agenda (format bktXXXXXXXX) |
| p_sServiceID | id of the service (format bktXXXXXXXX) |
| p_dStartDate | start date of the event (YYYY-MM-DD) |
| p_dEndDate | end date of the event (YYYY-MM-DD) |
| p_iStartTime | start time of the event (in minutes, since 00:00), 01:00 am = 60, 02:00 am = 120 ... |
| p_iEndTime | end time of the event (in minutes, since 00:00), optional if not set it will use the duration of the service |
| p_sTitle | title of the event, optional if not set it will use the title of the service |
| p_sComments | description of the event, optional if not set it will be void |
| p_sState | (optional) The state of the event. The possible states are: "completed", "inpayment" |
| p_sCreatedBy | (optional) set "client" if it is created by the client or set "company" if it is created by the company (default value "client") |
| addsocialuser | ( | $p_sPublicKey | ) |
This function adds a "social" user given his basic data. The social user can book in any company of a social network, in our case, all the companies of a multicenter account. This social user is the same for all the companies of a multicenter account. A social user has to sign in its social network before the developer call this method to create an account in Bookitit because Bookitit will not check anything.
URL to call this function: http://app.bookitit.com/api/11/addsocialuser/p_sPublicKey
| p_sPublicKey | your public key (administrator key) |
POST PARAMETERS
| p_sName | Name of the user |
| p_sPhone | Phone number of the user |
| p_sEmail | email of the user |
| p_sPassword | (optional) the password of the user in md5 |
| addtrial | ( | ) |
This function is used to add a new trial company account to Bookitit.
URL to call this function: http://app.bookitit.com/api/11/addtrial/p_sPublicKey
POST PARAMETERS
| p_sName | Name of the company |
| p_iCellPhone | Cellphone of the company |
| p_iCountry | Country id of the company |
| p_sEmail | Email of the company |
| p_sLanguageCode | Language code ('en', 'es', 'XX'), default 'es' (optional) |
| p_sSignUpUrl | Account created from (optional) |
</errors>
| adduser | ( | $p_sPublicKey | ) |
DEPRECATED use addclient This function adds a user with its basic data.
URL to call this function: http://app.bookitit.com/api/11/adduser/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sName | Name of the user |
| p_sEmail | email of the user |
| p_sPassword | Encrypted (md5) password for the user |
| p_sPhone | (optional) CellPhone number of the user. If you don't want to send this parameter set it as "". |
| p_sDocument | (optional) Document of the user. If you don't want to send this parameter set it as "". |
| p_sAddress | (optional) The address of the user. If you don't want to send this parameter set it as "". |
| p_someCustomFields | (optional) If your company account is using custom fields for the users, you can set it there. array( "customvalidate1" => "data in text format", "customvalidate2"=> "data in text format", "custom1"=> "data in text format", "custom2"=> "data in text format", "custom3"=> "data in text format", "custom4"=> "data in text format", "custom5"=> "data in text format" ) |
| auth | ( | $p_sPublicKey, | |
| $p_sAccountType | |||
| ) |
This function authenticates a professional account into system. After that, the function will return a url where the client software will redirect.
URL to call this function: http://app.bookitit.com/api/11/auth/p_sAccountType
| p_sPublicKey | the api public key of the company |
| p_sAccountType | the account of the company single or multiple |
| checkifcompanyemailexist | ( | $p_sPublicKey, | |
| $p_sCompanyEmail | |||
| ) |
This function gets checks if the company email exists.
Only for multicenter
URL to call this function: http://app.bookitit.com/api/checkifcompanyemailexist/$p_sPublicKey/$p_sCompanyEmail
| $p_sPublicKey | Your public key |
| $p_sCompanyEmail | Company email. |
| confirmemail | ( | $p_sPublicKey | ) |
This function changes the email of one of your users (if a user's ID is given) or the email of your company (if no ID is given). Also marks the user or company as ACTIVE. It should be used after the user or company enters the activation code received in a cellphone.
URL to call this function: http://app.bookitit.com/api/11/confirmemail/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sEmail | email of the user |
| p_sUserID | the id of the user (format bktXXXXXXXXX) |
| confirmevent | ( | $p_sPublicKey | ) |
This function is used to set an event of your company to status CONFIRMED. If synchronization is activated for your company, it will try to send the event to your local software.
URL to call this function: http://app.bookitit.com/api/11/confirmevent/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sEventID | the id of the event (format "bktXXXXXXXX") |
| confirmphone | ( | $p_sPublicKey | ) |
This function changes the phone of one of your users (if a user's ID is given) or the phone of your company (if no ID is given). Also marks the user or company as ACTIVE. It should be used after the user or company enters the activation code received in a cellphone.
URL to call this function: http://app.bookitit.com/api/11/confirmphone/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sPhone | Phone number of the user |
| p_sUserID | the id of the user (optional, format bktXXXXXXXXX) |
| deleteagenda | ( | $p_sPublicKey | ) |
This function deletes an agenda of your company. An agenda ID must be provided. It can be the ID of the agenda in Bookitit or, if you are synchronizing or integrating agendas between your software and Bookitit, the ID of the agenda in your software (we call it Synchro ID). If both are provided, the Synchro ID has preference.
URL to call this function: http://app.bookitit.com/api/11/deleteagenda/p_sPublicKey
| type | p_sPublicKey Your public key |
POST PARAMETERS
| type | p_sAgendaID ID of the agenda (format bktXXXXXXX) |
| type | p_sSynchroID ID of the agenda in your software |
| deleteagendaservice | ( | $p_sPublicKey | ) |
This function deletes an agenda-service connection of your company. Agenda ID and service ID must be provided. They can be the IDs in Bookitit or, if you are synchronizing or integrating agendas between your software and Bookitit, the IDs of your software (we call it Synchro ID). If both are given, Synchro IDs have preference.
URL to call this function: http://app.bookitit.com/api/11/deleteagendaservice/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sAgendaID | agenda ID (format bktXXXXXXX) |
| p_sServiceID | service ID (format bktXXXXXXX) |
| p_sAgendaSynchroID | agenda ID in your software (use in case of software integration) |
| p_sServiceSynchroID | service ID in your software (use in case of software integration) |
| deleteclient | ( | $p_sPublicKey | ) |
This function deletes a client of your company.
URL to call this function: http://app.bookitit.com/api/11/deleteclient/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sClientId | id of the client to be deleted (format bktXXXXXXX) |
| deletecompany | ( | $p_sPublicKey | ) |
This function is used to delete a company in Bookitit. Only administrator users, who have an administrator api key, can delete companies with this function. Moreover, an administrator can only delete the companies created by himself.
URL to call this function: http://app.bookitit.com/api/11/deletecompany/p_sPublicKey
| p_sPublicKey | Public key of the administrator user |
POST PARAMETERS
| (optional) | p_sPublicKeyToDelete Public key of the company to delete |
| (optional) | p_sCompanyId the id of the company in bkt format (BKTXXXXXXX) At least you need one of these parameters. |
| deletecompanyschedule | ( | $p_sPublicKey | ) |
This function updates the schedule of your company for a single weekday. That is, at which time your company is open or closed. Should be called once per day you want to update.
URL to call this function: http://app.bookitit.com/api/deletecompanyschedule/$p_sPublicKey/
| $p_sPublicKey | Your public key |
| deleteevent | ( | $p_sPublicKey | ) |
This function deletes an event of your company.
URL to call this function: http://app.bookitit.com/api/11/deleteevent/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_iEventID | id of the event to delete (format bktXXXXXXX) |
| p_sEventSynchroID | id of the event in your software (use in case of software integration) |
| p_bSendNotification | (optional) Indicates if an email will be sent to notify the client |
| p_sDeletedBy | (optional) "client" if the client deletes the event or "company" if the company deletes the event |
| deleteservice | ( | $p_sPublicKey | ) |
This function deletes a service of your company. A service ID must be provided. It can be the ID of the service in Bookitit or, if you are synchronizing or integrating services between your software and Bookitit, the ID of the service in your software (we call it Synchro ID). If both are provided, the Synchro ID has preference.
URL to call this function: http://app.bookitit.com/api/11/deleteservice/p_sPublicKey
| type | p_sPublicKey Your public key |
POST PARAMETERS
| type | p_sServiceID ID of the service (format bktXXXXXXX) |
| type | p_sSynchroID ID of the service in your software |
| getagendaconfiguration | ( | $p_sPublicKey, | |
| $p_sAgendaID | |||
| ) |
This function gets the configuration of one agenda of your company.
URL to call this function: http://app.bookitit.com/api/11/getagendaconfiguration/p_sPublicKey/p_sServiceID
| p_sPublicKey | Your public key |
| p_sAgendaID | Id of the agenda (format "bktXXXXXXX") |
| getagendas | ( | $p_sPublicKey, | |
$p_sServiceID = null |
|||
| ) |
This function gets the agendas of your company. Optionally, if a service ID is given, it will filter the agendas that offer that service.
URL to call this function: http://app.bookitit.com/api/11/getagendas/p_sPublicKey/p_sServiceID
| p_sPublicKey | Your public key |
| p_sServiceID | optional, a service id (format "bktXXXXXXX") |
| getagendasbycategory | ( | $p_sPublicKey, | |
| $p_sCategoryId | |||
| ) |
This function gets the agendas inside of a category of your company.
URL to call this function: http://app.bookitit.com/api/11/getagendasbycategory/p_sPublicKey/$p_sCategoryId
| p_sPublicKey | Your public key |
| $p_sCategoryId | The category id (format "bktXXXXXXX") |
| getagendasservices | ( | $p_sPublicKey | ) |
This function gets the agenda-service relationships for your company.
URL to call this function: http://app.bookitit.com/api/11/getagendasservices/p_sPublicKey
| p_sPublicKey | Your public key |
| getcategories | ( | $p_sPublicKey | ) |
This function gets the categories of your company. One agenda belongs to zero or one categories.
URL to call this function: http://app.bookitit.com/api/11/getcategories/p_sPublicKey
| p_sPublicKey | Your public key |
| getcities | ( | $p_sPublicKey, | |
| $p_sLanguageID, | |||
| $p_sRegionID | |||
| ) |
This function gets the cities of a given region, in a given language, from the Bookitit city database
URL to call this function: http://app.bookitit.com/api/11/getcities/p_sPublicKey/p_sLanguageID/p_sRegionID
| p_sPublicKey | Your public key |
| p_sLanguageID | ID of the chosen language (format bktXXXXXX) |
| p_sRegionID | ID of the chosen region (format bktXXXXXX) |
| getclient | ( | $p_sPublicKey, | |
| $p_sIdClientId | |||
| ) |
This function gets one client from its client id. The format is bktXXXXX
| $p_sIdClient | the id of the client in bktXXXXXXXXX format |
| $p_sMode | xml or json |
| $p_bSecure | true for https, false for http |
| getclientbyvalidationfield | ( | $p_sPublicKey | ) |
This function gets some client data by a validation field. URL to call this function: http://app.bookitit.com/api/getclientbyvalidationfield/$p_sPublicKey
| $p_sPublicKey | Your public key |
POST PARAMETERS
| $p_sFieldType | the field type text ("email", "cellphone", "document", "customvalidate1", ... ). If not value is set (empty sring "") the search will be do for all validation fields configured |
| $p_sFieldvalue | the field value to search |
| getclientevents | ( | $p_sPublicKey, | |
| $p_iClientId, | |||
$p_sDateFrom = "", |
|||
$p_sDateTo = "" |
|||
| ) |
This function gets a list of events of a client between two dates or all events. URL to call this function: http://app.bookitit.com/api/getclientevents/$p_sPublicKey/$p_iClientId/$p_sDateFrom/$p_sDateTo
| $p_sPublicKey | Your public key |
| $p_iClientId | the id of the client with format bktXXXXX |
| $p_sDateFrom | the start day to get the events |
| $p_sDateTo | the end day to get the events. |
| getclients | ( | $p_sPublicKey, | |
| $p_sDateFrom, | |||
| $p_sDateTo, | |||
$p_sType = null |
|||
| ) |
This function gets the data for all clients of your company. (limit to max 30 days)
| $p_sMode | xml or json |
| $p_bSecure | true for https, false for http |
| p_sStartDate | the start day to get the clients (when the client was registered) |
| p_sEndDate | the end day to get the clients (when the client was registered) |
| getclientsbyeventid | ( | $p_sPublicKey, | |
| $p_sEventID | |||
| ) |
This function gets a client of one event. If you have an event and you want to know who went to the appointment, you must use this function.
| p_sPublicKey | Your public key |
| $p_sEventID | the identifier of one event (format bktXXXXX) |
| getcompanies | ( | $p_sPublicKey | ) |
This function is used to get the companies of an account multicenter.
URL to call this function: http://app.bookitit.com/api/11/getcompanies/p_sPublicKey
| $p_sPublicKey | Public key of the multicenter/administrator account |
| getcompanydata | ( | $p_sPublicKey | ) |
This function is used to get data of your company in Bookitit.
URL to call this function: http://app.bookitit.com/api/11/getcompanydata/p_sPublicKey
| p_sPublicKey | Public key of the company user |
| getcountries | ( | $p_sPublicKey, | |
| $p_sLanguageID | |||
| ) |
This function gets the countries of the Bookitit city database, in a given language
URL to call this function: http://app.bookitit.com/api/11/getcountries/p_sPublicKey/p_sLanguageID
| p_sPublicKey | Your public key |
| p_sLanguageID | ID of the language (format bktXXXXXX) |
| geteventbyid | ( | $p_sPublicKey, | |
$p_sEventID = null, |
|||
$p_sLocator = null |
|||
| ) |
This function gets an event by id, locator or both.
| p_sPublicKey | Your public key |
| $p_sEventID | the identifier of one event (format bktXXXXX) |
| $p_sLocator | the locator of one event |
id: id of the event (format "bktXXXXXXX")
}
| getevents | ( | $p_sPublicKey, | |
| $p_sDateFrom, | |||
| $p_sDateTo, | |||
$p_sAgendaID = null |
|||
| ) |
This function gets a list of events between two dates. (limit to max 30 days) If no agenda ID is given, it will get the events of all the agendas. If an agenda ID is supplied, it will only get the events for that agenda. For the second option it will be ordered by the id of the agenda. If you want to get the events of a client you must use method "getclientevents" instead.
| p_sPublicKey | Your public key |
| p_sStartDate | the start day to get the events |
| p_sEndDate | the end day to get the events |
| p_sAgendaID | (optional) ID of the agenda. If no ID is given, you will get all the events of your company. |
| getextraservices | ( | $p_sPublicKey | ) |
This function gets the extra services of your company. An extra service is separated from the rest of services for some reason, i.e. temporary offers. They can't be associated with an agenda, only with an event.
URL to call this function: http://app.bookitit.com/api/11/getextraservices/p_sPublicKey
| p_sPublicKey | Your public key |
| getfreeslots | ( | $p_sPublicKey, | |
| $p_sServiceID, | |||
| $p_sAgendaID, | |||
| $p_sDate, | |||
$p_bAlsoFullSlots = "false" |
|||
| ) |
This function gets the free minutes for a service of an agenda
URL to call this function: http://app.bookitit.com/api/11/getfreeslots/p_sPublicKey/p_sServiceID/p_sAgendaID/p_sDate
| p_sPublicKey | Your public key |
| p_sServiceID | service id (format bktXXXXXXX) |
| p_sAgendaID | agenda id (format bktXXXXXXX) |
| p_sDate | the date to show the slots of (format YYYY-MM-DD) |
| p_bAlsoFullSlots | (optional, default to "false") If set to true, slots that are already picked and unavailable will also be returned |
| getgroups | ( | $p_sPublicKey | ) |
This function gets the groups of your company. One service belongs to zero or one group.
URL to call this function: http://app.bookitit.com/api/11/getgroups/p_sPublicKey
| p_sPublicKey | Your public key |
| getholidays | ( | $p_sPublicKey | ) |
This function gets the holidays of your company
URL to call this function: http://app.bookitit.com/api/11/getholidays/p_sPublicKey
| p_sPublicKey | Your public key |
| getlanguages | ( | $p_sPublicKey | ) |
This function gets the languages of the Bookitit city database
URL to call this function: http://app.bookitit.com/api/11/getlanguages/p_sPublicKey
| p_sPublicKey | Your public key |
international code of the language| getorders | ( | $p_sPublicKey | ) |
This function gets the orders of a company
URL to call this function: http://app.bookitit.com/api/11/getorders/p_sPublicKey
| p_sPublicKey | Your public key |
| getregions | ( | $p_sPublicKey, | |
| $p_sLanguageID, | |||
| $p_sCountryID | |||
| ) |
This function gets the regions of a given country, in a given language, from the Bookitit city database
URL to call this function: http://app.bookitit.com/api/11/getregions/p_sPublicKey/p_sLanguageID/p_sCountryID
| p_sPublicKey | Your public key |
| p_sLanguageID | ID of the chosen language (format bktXXXXXX) |
| p_sCountryID | ID of the chosen country (format bktXXXXXX) |
| getschedule | ( | $p_sPublicKey | ) |
This function gets the schedule of your company
URL to call this function: http://app.bookitit.com/api/11/getschedule/p_sPublicKey
| p_sPublicKey | Your public key |
| getservices | ( | $p_sPublicKey, | |
$p_sGroupId = null |
|||
| ) |
This function gets the services of your company
URL to call this function: http://app.bookitit.com/api/11/getservices/p_sPublicKey
| p_sPublicKey | Your public key |
| getuser | ( | $p_sPublicKey, | |
| $p_sUserID | |||
| ) |
This function gets the data of a user of your company.
URL to call this function: http://app.bookitit.com/api/11/getuser/p_sPublicKey/$p_sUserID
| $p_sPublicKey | Your public key |
| $p_sUserID | Identifier of the user to retrieve data of. The format is bktXXXXXXXXX. |
| getuserevents | ( | $p_sPublicKey, | |
| $p_iIdUser, | |||
| $p_sDateFrom, | |||
| $p_sDateTo | |||
| ) |
DEPRECATED please use getclientevents This function gets a list of events of a user between two dates. It will get the events of the user for the given company URL to call this function: http://app.bookitit.com/api/getuserevents/$p_sPublicKey/$p_iIdUser/$p_sStartDate/$p_sEndDate
| $p_sPublicKey | Your public key |
| $p_iIdUser | the id of the user with format bktXXXXX |
| $p_sStartDate | the start day to get the events |
| $p_sEndDate | the end day to get the events. |
</event>
| setagendatocompanyschedule | ( | $p_sPublicKey | ) |
This function makes an agenda schedule to be the same as the previously set company general schedule.
URL to call this function: http://app.bookitit.com/api/11/setagendatocompanyschedule/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sAgendaID | id of the agenda (format bktXXXXXXX) |
| setphoneandsendvalidate | ( | $p_sPublicKey | ) |
This function sets the cellphone of one of your company's users (if a user's ID is given) or the cellphone of your company (if no ID is given).
Since cellphone numbers have to be always confirmed, the user or company will be set as INACTIVE, and a new confirmation code will be returned by the function and sent to the user's or company's cellphone. Please store that code for later confirmation of the phone.
URL to call this function: http://app.bookitit.com/api/11/setphoneandsendvalidate/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sPhone | new phone number |
| p_sUserID | optional, id of your user (format bktXXXXXXXXX) |
| testconnection | ( | $p_sEchoValue | ) |
This function tests the connection. The sent value is just echoed by the server.
URL to call this function: http://app.bookitit.com/api/11/testconnection/p_sEchoValue
| p_sEchoValue | A value defined by the user. |
| updateagenda | ( | $p_sPublicKey | ) |
This function updates data of an agenda of your company. An agenda ID must be provided. It can be the ID of the agenda in Bookitit or, if you are synchronizing or integrating agendas between your software and Bookitit, the ID of the agenda in your software (we call it Synchro ID).
URL to call this function: http://app.bookitit.com/api/11/updateagenda/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sAgendaID | ID of the agenda (format bktXXXXXXX) |
| p_sSynchroID | ID of the agenda in your software |
| p_sName | agenda name (optional) |
| p_sPhone | agenda phone (optional) |
| p_sEmail | agenda email (optional) |
| p_sPublic | (optional) indicates if the agenda is "public" or "private". Default is "public" |
| updateagendacommunications | ( | $p_sPublicKey | ) |
This function sets or updates agenda communications
URL to call this function: http://app.bookitit.com/api/11/updateagendacommunications/p_sPublicKey
| p_sPublicKey | Your public key |
AVAILABLE VALUES "email" for email communication "sms" for sms communication "both" for email and sms communication "none" for none communication
POST PARAMETERS
| $p_sAgendaID | id of the agenda (format bktXXXXXXX) |
| $p_sClient_event_add_admin | (optional) Send to admin when client adds an event. "email" / "sms" / "both" / "none" |
| $p_sAdmin_event_add_admin | (optional) Sent to admin when an event its added from calendar. "email" / "sms" / "both" / "none" |
| $p_sUser_event_confirm_admin | (optional) Sent to admin when agenda/admin confirms an event. "email" / "sms" / "both" / "none" |
| $p_sUser_event_unconfirm_admin | (optional) Sent to admin when agenda/admin unconfirms an event. "email" / "sms" / "both" / "none" |
| $p_sUser_event_delete_admin | (optional) Sent to admin when client deletes an event. "email" / "sms" / "both" / "none" |
| $p_sClient_event_add | (optional) Sent to agenda when client adds an event. "email" / "sms" / "both" / "none" |
| $p_sUser_event_add_admin | (optional) Sent to agenda when an event its added from calendar. "email" / "sms" / "both" / "none" |
| $p_sUser_event_confirm_agenda | (optional) Sent to agenda when agenda/admin confirms an event. "email" / "sms" / "both" / "none" |
| $p_sUser_event_unconfirm_agenda | (optional) Sent to agenda when agenda/admin unconfirms an event. "email" / "sms" / "both" / "none" |
| $p_sUser_event_delete_agenda | (optional) Sent to agenda when client deletes an event . "email" / "sms" / "both" / "none" |
| $p_sUser_event_add | (optional) Sent to client when an event is added from calendar. "email" / "sms" / "both" / "none" |
| $p_sUser_event_modify | (optional) Sent to client when an event is modify from calendar. "email" / "sms" / "both" / "none" |
| $p_sUser_event_delete | (optional) Sent to client when an event is deleted from calendar. "email" / "sms" / "both" / "none" |
| $p_sUser_event_confirm | (optional) Sent to client when an event is confirmed. "email" / "sms" / "both" / "none" |
| $p_sUser_event_uncofirm | (optional) Sent to client when an event is unconfirmed. "email" / "sms" / "both" / "none" |
| $p_sClient_event_remember | (optional) Sent reminder to client. "email" / "sms" / "both" / "none" |
| $p_iClient_event_remember_min | (optional) Minutes before the event to send the reminder to the client. "email" / "sms" / "both" / "none" |
| $p_sUser_event_remember | (optional) Sent reminder to agenda. "email" / "sms" / "both" / "none" |
| $p_iUser_event_remember_min | (optional) Minutes before the event to send the reminder to the agenda. "email" / "sms" / "both" / "none" |
| updateagendaconfiguration | ( | $p_sPublicKey | ) |
This function updates the configuration for an agenda of your company.
URL to call this function: http://app.bookitit.com/api/11/updateagendaconfiguration/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sAgendaID | id of the agenda (format bktXXXXXXX) |
| p_iMinAdvanceMakeEvent | integer, the minimum advance that users can make reservations with (in days) |
| p_iMinAdvanceSeeAgenda | integer, the maximum anticipation that users can see the free hours with (in days) |
| p_iMinAdvanceCancelEvent | integer, the minimum advance that users can cancel reservations with (in days) |
| p_sConfirmEvents | indicates if the company has to manually confirm the reservations. Options are "yes" or "no", default is "no". |
| p_sUserValidate | indicates if the users need to validate before making reservations. Options are "yes" or "no", default is "no". |
| p_sKeySendMethod | indicates how to send the activation keys to users. Options are "sms" and "email", default is "email". |
| p_iWidgetIntervalSize | how to set the interval between reservation hours in the widget. Options are:
|
| p_iShiftNumber | (optional) integer, number of users that can make a reservation for the same service at the same time. Used when p_iWidgetIntervalSize is set to "shifts". |
| p_iShiftStep | (optional) if you select the interval size as "shifts" you will have to select an step for each shift. 5, 10, 15, 30, 60, 90, 120, 240 minutes. |
| updateagendaservice | ( | $p_sPublicKey | ) |
This function updates an agenda-service connection of your company. Agenda ID and service ID must be provided. They can be the IDs in Bookitit or, if you are synchronizing or integrating agendas between your software and Bookitit, the IDs of your software (we call it Synchro ID). If both are given, Synchro IDs have preference.
URL to call this function: http://app.bookitit.com/api/11/updateagendaservice/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sAgendaID | agenda ID (format bktXXXXXXX) |
| p_sServiceID | service ID (format bktXXXXXXX) |
| p_sAgendaSynchroID | agenda ID in your software (use in case of software integration) |
| p_sServiceSynchroID | service ID in your software (use in case of software integration) |
| p_iDuration | (optional) New duration of the service specific for this agenda, in minutes. |
| p_dPrice | (optional) New price of the service specific for this agenda, in your currency |
| updateclient | ( | $p_sPublicKey | ) |
This function updates a client of your company. You can modify different fields, name, cellphone,... as well as change the web access of the client
URL to call this function: http://app.bookitit.com/api/11/updateclient/p_sPublicKey
A client with web access can login from widget. With this action the client can create new appointments without register again, or delete pending appointments. This client registration requires some mandatory fields.
A client without web access can't login at widget. This type of client only contains its data and allows the center create new appointments to him. This client registration only requires to fill some fields (one field at least)
| $p_sPublicKey | Your public key |
POST PARAMETERS
| $p_sClientId | (mandatory) The id of the client that will be updated. (format bktXXXXXXXXX) |
| $p_sWebaccess | (optional). If you want to modify the web access set "true" or "false" state otherwise it will do nothing. |
| $p_sPassword | (optional). If you are changing a client from without webaccess to webaccess it will be mandatory. Encrypted (md5) password for the client if has webaccess. If you don't want to modify this parameter set it as "". |
| $p_sEmail | (optional) Email of the client. If you don't want to modify this parameter set it as "". |
| $p_sCellphone | (optional) Cellphone of the client without international code. If you don't want to modify this parameter set it as "". |
| $p_sInternationalCode | (optional) The country international code (Ex: +34), if you don't set this value the default value inserted will be the international code of the company. If you don't want to modify this parameter set it as "". |
| $p_sDocument | (optional) Document of the client. If you don't want to modify this parameter set it as "". If you want to delete this field send a "null" string. |
| $p_sName | (optional) Name of the client. If you don't want to modify this parameter set it as "". If you want to delete this field send a "null" string. |
| $p_sAddress | (optional) Address of the client. If you don't want to modify this parameter set it as "". If you want to delete this field send a "null" string. |
| $p_sPhone | (optional) Phone of the client. If you don't want to modify this parameter set it as "". If you want to delete this field send a "null" string. |
| $p_sBlocked | (optional) If you want to block a client you will have to set it as "true" otherwise "false". |
| $p_someCustomFields | (optional) If your company account is using custom fields for the users, you can set it there. If you want to delete this field send a "null" string in the correct position of the array. |
$p_someCustomFields param example: array( "customvalidate1" => "data in text format", "customvalidate2"=> "data in text format", "custom1"=> "data in text format", "custom2"=> "data in text format", "custom3"=> "data in text format", "custom4"=> "data in text format", "custom5"=> "data in text format" )
| updatecompany | ( | $p_sPublicKey | ) |
This function is used to update data of a company in Bookitit. Only administrator users, who have an administrator api key, can update companies with this function. Moreover, an administrator can only update the companies created by himself.
URL to call this function: http://app.bookitit.com/api/11/updatecompany/p_sPublicKey
| p_sPublicKey | Public key of the administrator user |
POST PARAMETERS If you don't want to change the value in Bookitit of an optional parameter you can set it as a void string "". If you want unset or delete a value in Bookitit set the parameter as string with "null" value
| p_sPublicKeyToModify | Public key of the company to modify |
| $p_sMode | xml or json |
| $p_bSecure | true for https, false for http |
| p_sName | (optional) Name of the company, can't be unset or delete |
| p_sCellPhone | (optional) Cellphone of the company |
| p_sPhone | (optional) Phone of the company |
| p_sPassword | (optional) Encrypted password (md5) of the company, can't be unset or delete |
| p_sAddress | (optional) Address of the company |
| p_sPostalCode | (optional) Postal code of the company |
| p_sWeb | (optional) Url of the company |
| $p_iCountryId | (optional) the id of the country for the company in bktXXXX format, can't be unset or delete |
| $p_iRegionId | (optional) the id of the region for the company in bktXXXX format, can't be unset or delete |
| $p_iCityId | (optional) the id of the city for the company in bktXXXX format, can't be unset or delete |
| $p_sDocument | (optional) Document of the company |
| updatecompanycustomfield | ( | $p_sPublicKey | ) |
This function updates a custom field for the company whose public key is given.
| p_sPublicKeyToAdd | public key of the company to add the field to |
| p_sCustomFieldID | the id of the custom field to update (format bktXXXXXX) |
| p_sInputType | the kind of the custom field, current options are "text", "checkbox" |
| p_sInputLabel | the label that will precede the field wherever it is shown |
| p_sInputName | the name of the field form html and DOM purposes |
| p_sInputValue | the value of the field |
| p_sShowInMyCenter | indicates if the custom field has to be shown in the "my center" section of bookitit. Options are "yes" or "no", default is "no". |
| p_sLanguageID | (optional) (format bktXXXXX) indicates the language of the field, as it can be multilanguage. Must add one field per language. |
| updatecompanyscheduleday | ( | $p_sPublicKey | ) |
This function updates the schedule of your company for a single weekday. That is, at which time your company is open or closed. Should be called once per day you want to update. Only works for standard companies.
URL to call this function: http://app.bookitit.com/api/11/updatecompanyscheduleday/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| You | must build a string with 97 variables with the format "var0=[1 to 7]&var1=0&var2=['c' or 'o']&var3=30&var4=['c' or 'o']"... until ... "var95=1410&var96=['c' or 'o']" The meaning of the variables of this string is as follows:
|
| updateevent | ( | $p_sPublicKey | ) |
This function updates an event.
URL to call this function: http://app.bookitit.com/api/11/updateevent/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS If you don't want to change the value in Bookitit of an optional parameter you can set it as a void string "". If you want unset or delete a value in Bookitit set the parameter as string with "null" value
| p_sEventID | id of the event (format bktXXXXXXXX) |
| p_sAgendaID | id of the agenda (format bktXXXXXXXX) |
| p_dStartDate | start date of the event (YYYY-MM-DD) |
| p_dEndDate | end date of the event (YYYY-MM-DD) |
| p_iStartTime | start time of the event (in minutes, since 00:00) |
| p_iEndTime | end time of the event (in minutes, since 00:00) |
| p_sServiceID | (optional) id of the service (format bktXXXXXXXX), To unset or delete this data the array field must be a "null" value |
| p_sEventSynchroID | (optional) synchro ID of the event |
| p_sAgendaSynchroID | (optional) synchro ID of the agenda |
| p_sServiceSynchroID | (optional) synchro ID of the service |
| p_sTitle | (optional) title of the event, To unset or delete this data the array field must be a "null" value |
| p_sDescription | (optional) description of the event, To unset or delete this data the array field must be a "null" value |
| $p_sMode | xml or json |
| $p_bSecure | true for https, false for http |
| $p_bSendNotification | (optional) Indicates if an email will be sent to notify the client "true": send email "false": don't send email default is "false" |
| updateeventstatus | ( | $p_sPublicKey | ) |
This function updates an previously created order of a prepay service. URL to call this function: http://app.bookitit.com/api/11/endorder/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sOrderID | id of the order (format bktXXXXXXX) |
| p_sServiceID | id of the related service (format bktXXXXXXX) |
| p_sEventID | id of the related event (format bktXXXXXXX) |
| p_sStatus | new status of the order. Options are:
|
| p_iBankID | id of the bank. Current options are:
|
| p_sStore | id of the store to which the payment is made (more concrete than the bank) |
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sEventID | id of the event (format bktXXXXXXX) |
| p_sStatus | the new status of the event, options are "canceled", "completed", "pending", "pending_accepted", "pending_rejected", "in_payment", "wiretransfer" and "time_block" |
| updateorder | ( | $p_sPublicKey | ) |
This function updates an previously created order of a prepay service. URL to call this function: http://app.bookitit.com/api/11/updateorder/$p_sPublicKey/$p_sOrderID/$p_sServiceID/$p_sEventID/$p_sStatus/$p_iBankID/$p_sStore
| $p_sPublicKey | Your public key |
| $p_sOrderID | id of the order (format bktXXXXXXX) |
| $p_sServiceID | id of the related service (format bktXXXXXXX) |
| $p_sEventID | id of the related event (format bktXXXXXXX) |
| $p_sStatus | new status of the order. Options are:
|
| $p_sBank | name of the bank. Current options are:
|
| $p_sStore | id of the store to which the payment is made (more concrete than the bank) |
| updateservice | ( | $p_sPublicKey | ) |
This function updates data of a service of your company. A service ID must be provided. It can be the ID of the service in Bookitit or, if you are synchronizing or integrating services between your software and Bookitit, the ID of the service in your software (we call it Synchro ID).
URL to call this function: http://app.bookitit.com/api/11/updateservice/p_sPublicKey
| p_sPublicKey | Your public key |
| p_sServiceID | ID of the service (format bktXXXXXXX) |
| p_sSynchroID | ID of the service in your local software |
| p_sName | service name (optional) |
| p_sDuration | service duration in minutes (optional) |
| p_sPrice | service price (format XX.XX)(optional) |
| p_sPublic | (optional) indicates if the service is "public" or "private". Default is "public" |
| p_sPrepay | (optional) indicates is the services is "prepay" or "not_prepay". Default is "not_prepay" |
| p_sCurrency | (optional) in which currency is the price, accepted values are "EUR" for euro "GBP" for british pound and "USD" for United States dollar. Default is euro. |
| updatesocialuser | ( | $p_sPublicKey | ) |
This function updates a social user given his basic data.
URL to call this function: http://app.bookitit.com/api/11/updatesocialuser/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sUserID | The id of the user you want to update (format bktXXXXXXX) |
| p_sName | Name of the user |
| p_sPhone | Phone number of the user |
| p_sEmail | email of the user |
| $p_iCountryId | (optional) the id of the country for the company in bktXXXX format |
| $p_iRegionId | (optional) the id of the region for the company in bktXXXX format |
| $p_iCityId | (optiona) the id of the city for the company in bktXXXX format |
| updateuser | ( | $p_sPublicKey | ) |
This function updates a user given his basic data.
URL to call this function: http://app.bookitit.com/api/11/updateuser/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sUserID | The id of the user you want to update (format bktXXXXXXX) |
| p_sName | (optional) Name of the user. If you don't want to send this parameter set it as "". |
| p_sEmail | (optional) email of the user. If you don't want to send this parameter set it as "". |
| p_sPassword | (optional) Encrypted (md5) password for the user. If you don't want to send this parameter set it as "". |
| p_sPhone | (optional) CellPhone number of the user. If you don't want to send this parameter set it as "". |
| p_sDocument | (optional) Document of the user. If you don't want to send this parameter set it as "". |
| p_sAddress | (optional) The address of the user. If you don't want to send this parameter set it as "". |
| $p_sBlocked | (optional) If you want to block a client you will have to set it as "true" otherwise "false". |
| $p_someCustomFields | (optional) If your company account is using custom fields for the users, you can set it there. array( "customvalidate1" => "data in text format", "customvalidate2"=> "data in text format", "custom1"=> "data in text format", "custom2"=> "data in text format", "custom3"=> "data in text format", "custom4"=> "data in text format", "custom5"=> "data in text format" ) |
| uservalidate | ( | $p_sUserMail, | |
| $p_sPassword, | |||
$p_sType = null |
|||
| ) |
This function validates (checks) if user's (or company's) credentials are correct. Company Phone API keys are returned (they are generated if they don't exist).
URL to call this function: http://app.bookitit.com/api/11/uservalidate/p_sUserMail/p_sPassword/p_sType
| p_sUserMail | User's email |
| p_sPassword | User's enrypted (md5) password |
| p_sType | The type of user, can be "administrator", "client", "company, "social". Default is "client"; |
| validateorder | ( | $p_sPublicKey | ) |
This function checks if the amount of an order is valid URL to call this function: http://app.bookitit.com/api/11/validateorder/p_sPublicKey
| p_sPublicKey | Your public key |
POST PARAMETERS
| p_sOrderID | id of the order (format bktXXXXXXX) |
| p_iAmount | id of the related service (format bktXXXXXXX) |