Equipment Availability
Availability for a specific piece of equipment, equipment within a category or equipment used by the activity
zapi_GetEquipmentAvailability
GET https://{yourdomain}.zaui.net/zapi/
Request Body
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.
activityId*
integer
ID of the activity.
startDate*
integer
The start date of the rental activity. Format: YYYY:MM:DD.
startTime*
integer
The start time of the rental activity. Format: HH:MM:SS.
equipmentQuantity
integer
The number of pieces of equipment requested.
endDate*
integer
The end date of the rental activity. Format: YYYY:MM:DD.
endTime*
integer
The end time of the rental activity. Format: HH:MM:SS.
<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapi_GetEquipmentAvailability</methodName>
        <methodErrorCode/>
        <methodErrorMessage/>
        <eventCount>##</eventCount>
        <startTime>YYYY-MM-DD HH:ii:ss</startTime>
        <endTime>YYYY-MM-DD HH:ii:ss</endTime>
        <rentalDuration>HH:ii:ss</rentalDuration>
        <requestTime>##.###############</requestTime>
        <activityName>XXXXXXX</activityName>
        <equipmentAvailable>
            <equipmentCategories>
                <equipmentCategory>
                    <equipmentCategoryId>###</equipmentCategoryId>
                    <equipmentCategoryName>XXXXXX</equipmentCategoryName>
                    <equipment>##</equipment>
                    ...
                </equipmentCategory>
                ...
            </equipmentCategories>
        </equipmentAvailable>
    </methodResponse>
</response><request>
   <zapiToken></zapiToken>
   <zapiAccountId></zapiAccountId>
   <zapiUserId></zapiUserId>
        <zapiMethod>
            <methodName>zapi_GetEquipmentAvailability</methodName>
            <activityId></activityId>
            <startDate></startDate>
            <startTime></startTime>
            <equipmentQuantity></equipmentQuantity>
            <endDate></endDate>
            <endTime></endTime>
        </zapiMethod>
</request><?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapi_GetEquipmentAvailability</methodName>
        <methodErrorCode/>
        <methodErrorMessage/>
        <eventCount></eventCount>
        <startTime></startTime>
        <endTime></endTime>
        <rentalDuration></rentalDuration>
        <requestTime></requestTime>
        <activityName></activityName>
        <equipmentAvailable>
            <equipmentCategories>
                <equipmentCategory>
                    <equipmentCategoryId></equipmentCategoryId>
                    <equipmentCategoryName></equipmentCategoryName>
                    <equipment>
                        <equipment>
                            <id></id>
                            <name></name>
                        </equipment>
                    </equipment>
                </equipmentCategory>
                <equipmentCategory>
                    <equipmentCategoryId></equipmentCategoryId>
                    <equipmentCategoryName></equipmentCategoryName>
                    <equipment>
                        <equipment>
                            <id></id>
                            <name></name>
                        </equipment>
                    </equipment>
                </equipmentCategory>
                <equipmentCategory>
                    <equipmentCategoryId></equipmentCategoryId>
                    <equipmentCategoryName></equipmentCategoryName>
                    <equipment>
                        <equipment>
                            <id></id>
                            <name></name>
                        </equipment>
                        <equipment>
                            <id></id>
                            <name></name>
                        </equipment>
                    </equipment>
                </equipmentCategory>
            </equipmentCategories>
        </equipmentAvailable>
    </methodResponse>
</response>Last updated
Was this helpful?
