Authenticate Guest
Authenticates that the guest is part of the system
zapiGuests_Authenticate
GET https://{yourdomainname}.zaui.net/zapi/
Request Body
Name
Type
Description
zapiToken*
integer
Token that must be used for a reseller to communicate with the supplier system.
zapiAccountId*
integer
Generated by the supplier system.
zapiUserId*
integer
Generated by the supplier system when a new contact is created.
methodName*
string
The method being called.
username*
string
Username of the guest.
password*
string
Password of the guest.
bookingId*
integer
Confirmation number assigned once booking is confirmed.
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGuests_Authenticate</methodName>
<guestDetails>
<guestID>1237</guestID>
<guestHashKey>d6b0722c0c267370aed1d4a89609daff4afb75e9</guestHashKey>
<accountId>
<![CDATA[0]]>
</accountId>
<expiryDate>
<![CDATA[2022-11-17]]>
</expiryDate>
<username>
<![CDATA[hergra]]>
</username>
<firstName>
<![CDATA[Hermione]]>
</firstName>
<lastName>
<![CDATA[Granger]]>
</lastName>
<gender>
<![CDATA[F]]>
</gender>
<mobilePhone>
<![CDATA[6045669284]]>
</mobilePhone>
<email>
<![CDATA[support@zaui.com]]>
</email>
<addressLine1>
<![CDATA[]]>
</addressLine1>
<addressLine2>
<![CDATA[]]>
</addressLine2>
<city>
<![CDATA[]]>
</city>
<state>
<![CDATA[]]>
</state>
<country>
<![CDATA[]]>
</country>
<zipCode>
<![CDATA[]]>
</zipCode>
<birthDate>N/A</birthDate>
<dateCreated>2021-11-17 08:54:43</dateCreated>
<userCustomFields>
<customField>
<customFieldId>1</customFieldId>
<customFieldRequired>true</customFieldRequired>
<customFieldLabel>
<![CDATA[Test Custom Field ]]>
</customFieldLabel>
<customFieldValue>
<![CDATA[]]>
</customFieldValue>
</customField>
</userCustomFields>
<relatedBookings>
<totalNumberOfBookings>1</totalNumberOfBookings>
<totalPurchases>$1.00</totalPurchases>
<mostRecentBookingCount>1</mostRecentBookingCount>
<allBookings>
<booking>
<bookingNumber>40235</bookingNumber>
<dateCreated>2021-11-17 08:54:43</dateCreated>
<total>$52.50</total>
<activities>
<activity>
<packageId>0</packageId>
<activityId>128</activityId>
<activityName>
<![CDATA[Electric Bike Rentals]]>
</activityName>
<activityDate>2021-12-16</activityDate>
<activityTime/>
<activityTotal>50.000000</activityTotal>
<passengers>
<seniors>0</seniors>
<adults>2</adults>
<students>0</students>
<children>0</children>
<infants>0</infants>
<passengersAsString>
<![CDATA[2 (ad)]]>
</passengersAsString>
</passengers>
</activity>
</activities>
<products/>
</booking>
</allBookings>
</relatedBookings>
</guestDetails>
<methodErrorCode>0</methodErrorCode>
<methodErrorMessage>
<![CDATA[Guest account found]]>
</methodErrorMessage>
</methodResponse>
</response><request>
<zapiToken></zapiToken>
<zapiAccountId></zapiAccountId>
<zapiUserId></zapiUserId>
<zapiMethod>
<methodName>zapiGuests_Authenticate</methodName>
<username></username>
<password></password>
<bookingId></bookingId>
</zapiMethod>
</request><?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGuests_Authenticate</methodName>
<guestDetails>
<guestID></guestID>
<guestHashKey></guestHashKey>
<accountId></accountId>
<expiryDate></expiryDate>
<username></username>
<firstName></firstName>
<lastName></lastName>
<gender></gender>
<mobilePhone></mobilePhone>
<email></email>
<addressLine1></addressLine1>
<addressLine2></addressLine2>
<city></city>
<state></state>
<country></country>
<zipCode></zipCode>
<birthDate></birthDate>
<dateCreated></dateCreated>
<userCustomFields>
<customField>
<customFieldId></customFieldId>
<customFieldRequired></customFieldRequired>
<customFieldLabel></customFieldLabel>
<customFieldValue></customFieldValue>
</customField>
</userCustomFields>
<relatedBookings>
<totalNumberOfBookings></totalNumberOfBookings>
<totalPurchases></totalPurchases>
<mostRecentBookingCount></mostRecentBookingCount>
<allBookings>
<booking>
<bookingNumber></bookingNumber>
<dateCreated></dateCreated>
<total></total>
<activities>
<activity>
<packageId></packageId>
<activityId></activityId>
<activityName></activityName>
<activityDate></activityDate>
<activityTime/>
<activityTotal></activityTotal>
<passengers>
<seniors></seniors>
<adults></adults>
<students></students>
<children></children>
<infants></infants>
<passengersAsString></passengersAsString>
</passengers>
</activity>
</activities>
<products/>
</booking>
</allBookings>
</relatedBookings>
</guestDetails>
<methodErrorCode>0</methodErrorCode>
<methodErrorMessage></methodErrorMessage>
</methodResponse>
</response>Last updated