Get list of users by reservation ID

getUsersByReservationId(p_companyID, p_ReservationId)

 

You can use this endpoint to retrieve a list of users from our software.

Parameters

Name Type Required Description
p_companyID string Yes The security code you have been provided with, string (32)
p_ReservationId string Yes The infofield set as wsAltUserId on which we will make the search to retrieve the users

Return values

getUsersByReservationIdObject (array), containing structs (arrays) of getUsersByReservationId with the following keys:

UserId – the Id of the user, string - this field is also used to return possible error message when the case

TapkeyUserId - the Tapkey id assigned to the user, string

StartDate - start date of the user, string

StartTime - start time of the user, string

EndDate - end date of the user, string

EndTime - end time of the user, string

ModuleIds - list of module ids used, string

ModuleNames - list of module names used, string

TapkeyLockIds – list of module TapkeyIds used, string

'NO_USER_ID_FOUND' - No user id found based on the infofield provided.

Sample

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uen="uen:esws">
<soapenv:Header/>
<soapenv:Body>
<uen:Esws.getUsersByReservationId soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<p_companyID xsi:type="xsd:string">^4p;tU0Q+#dEIhTWkuj5FnLD^aKWqVu0</p_companyID>
<p_ReservationId xsi:type="xsd:string">NL123456789B01</p_ReservationId>
</uen:Esws.getUsersByReservationId>
</soapenv:Body>
</soapenv:Envelope>

Response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="uen:esws">
<SOAP-ENV:Body>
<ns1:Esws.getUsersByReservationId xmlns:ns1="uen:esws">
<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:getUsersByReservationId[22]">
<item xsi:type="tns:getUsersByReservationIdObject">
<UserId xsi:type="xsd:string">2110</UserId>
<TapkeyUserId xsi:type="xsd:string">127bc187-b0f7-467d-ab2f-f23753824825</TapkeyUserId>
<StartDate xsi:type="xsd:string">03-05-2023</StartDate>
<EndDate xsi:type="xsd:string">06-06-2023</EndDate>
<StartTime xsi:type="xsd:string">08:00</StartTime>
<EndTime xsi:type="xsd:string">17:00</EndTime>
<ModuleIds xsi:type="xsd:string">["4"]</ModuleIds>
<ModuleNames xsi:type="xsd:string">["BioStation 3"]</ModuleNames>
<TapkeyLockIds xsi:type="xsd:string">["2e9620be-7c56-4c7e-a2de-cb9645cd9g37"]</TapkeyLockIds>
</item>
<item xsi:type="tns:getUsersByReservationIdObject">
<UserId xsi:type="xsd:string">2111</UserId>
<TapkeyUserId xsi:type="xsd:string">986db147-b0f7-467d-aa2e-f19753824827</TapkeyUserId>
<StartDate xsi:type="xsd:string">09-05-2023</StartDate>
<EndDate xsi:type="xsd:string">19-06-2023</EndDate>
<StartTime xsi:type="xsd:string">08:00</StartTime>
<EndTime xsi:type="xsd:string">17:00</EndTime>
<ModuleIds xsi:type="xsd:string">["5", "6"]</ModuleIds>
<ModuleNames xsi:type="xsd:string">["BioStation L2", "Loq 1"]</ModuleNames>
<TapkeyLockIds xsi:type="xsd:string">["8e9620be-7c44-4c7e-a2de-db5625cd9g26", "76tfc34-28ab-43c5-a4df-dbg625xe9g98"]</TapkeyLockIds>
</item>
</return>
</ns1:Esws.getUsersByReservationId>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>