> For the complete documentation index, see [llms.txt](https://docs.zaui.com/zapi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zaui.com/zapi/zapi-calls/activity-calls/rental-equipment-calls/zapi_getequipmentavailability.md).

# Equipment Availability

## zapi\_GetEquipmentAvailability

<mark style="color:blue;">`GET`</mark> `https://{yourdomain}.zaui.net/zapi/`

#### Request Body

| Name                                            | Type    | Description                                                                     |
| ----------------------------------------------- | ------- | ------------------------------------------------------------------------------- |
| zapiToken<mark style="color:red;">\*</mark>     | integer | Token that must be used for a reseller to communicate with the supplier system. |
| zapiAccountId<mark style="color:red;">\*</mark> | integer | Generated by the supplier system.                                               |
| zapiUserId<mark style="color:red;">\*</mark>    | integer | Generated by the supplier system when a new contact is created.                 |
| methodName<mark style="color:red;">\*</mark>    | string  | The method being called.                                                        |
| activityId<mark style="color:red;">\*</mark>    | integer | ID of the activity.                                                             |
| startDate<mark style="color:red;">\*</mark>     | integer | The start date of the rental activity.  Format: YYYY:MM:DD.                     |
| startTime<mark style="color:red;">\*</mark>     | integer | The start time of the rental activity.  Format: HH:MM:SS.                       |
| equipmentQuantity                               | integer | The number of pieces of equipment requested.                                    |
| endDate<mark style="color:red;">\*</mark>       | integer | The end date of the rental activity.  Format: YYYY:MM:DD.                       |
| endTime<mark style="color:red;">\*</mark>       | integer | The end time of the rental activity.  Format: HH:MM:SS.                         |

{% tabs %}
{% tab title="200 " %}

```
<?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>
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Request" %}

```xml
<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>
```

{% endtab %}

{% tab title="Response" %}

```xml
<?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>
```

{% endtab %}
{% endtabs %}