README

**# TRACK Property Management System PHP SDK Track Pulse API的PHP SDK库**

此SDK不是由Track创建或支持的

需求

需要Composer进行安装
需要 >=PHP 8

安装

composer require elite42/trackpms

示例用法

$apiSettings = new \elite42\trackpms\trackApiSettings( 
    url          : '{url}',
    key          : '{key}',
    secret       : '{secret}',
    enableCaching: true,
    cachePath    : 'C:/inetpub/cache',
    debugLogging : true,
    debugLogPath : 'C:/inetpub/logs'
);

$api         = new \elite42\trackpms\trackApi( $apiSettings );

try {
    $unit            = $api->getUnit( 145 );
    $unitCollections = $api->getUnitCollections( );
    $units           = $api->getUnits( [ 'size'=>100 ] );

    $reservation            = $api->getReservation( 1 );
    $reservations           = $api->getReservations( [ 'size' => 100 ] );
    $reservationCollections = $api->getReservationCollections( [ 'size' => 100 ] );
    
    $reservationFee = $api->getReservationFee( 1, 2 );
    $reservationFees = $api->getReservationFees( 1 );
    $reservationFeeCollections = $api->getReservationFeeCollections( 1 );
    
    $reservationNote = $api->getReservationNote( 1, 15 );
    $reservationNotes = $api->getReservationNotes( 1 );
    $reservationNoteCollections = $api->getReservationNoteCollections( 1 );
    
    $reservationRates = $api->getReservationRates( 1 );
    
    $amenity = $api->getAmenity( 1 );
    $amenities = $api->getAmenities( [ 'size' => 100 ] );
    $amenityCollections = $api->getAmenityCollections( [ 'size' => 100 ] );
    
    $amenityGroup            = $api->getAmenityGroup( 1 );
    $amenityGroups           = $api->getAmenityGroups( [ 'size' => 100 ] );
    $amenityGroupCollections = $api->getAmenityGroupCollections( [ 'size' => 100 ] );
    
    $customField            = $api->getCustomField( 1 );
    $customFields           = $api->getCustomFields( [ 'size' => 100 ] );
    $customFieldCollections = $api->getCustomFieldCollections( [ 'size' => 100 ] );
	
    $maintenanceWorkOrder            = $api->getMaintenanceWorkOrder( 3 );
    $maintenanceWorkOrders           = $api->getMaintenanceWorkOrders( [ 'size' => 100 ] );
    $maintenanceWorkOrderCollections = $api->getMaintenanceWorkOrderCollections( [ 'size' => 100 ] );
    
    $owner            = $api->getOwner( 1000 );
    $owners           = $api->getOwners( [ 'size' => 100 ] );
    $ownerCollections = $api->getOwnerCollections( [ 'size' => 100 ] );
    $ownerUnits       = $api->getOwnerUnits( 1000 );
    
    $contract            = $api->getContract( 1 );
    $contracts           = $api->getContracts( [ 'size' => 100 ] );
    $contractCollections = $api->getContractCollections( [ 'size' => 100 ] );
    
    $unitRole            = $api->getUnitRole( 1000 );
    $unitRoles           = $api->getUnitRoles( [ 'size' => 100 ] );
    $unitRoleCollections = $api->getUnitRoleCollections( [ 'size' => 100 ] );
    
    $user            = $api->getUser( 1000 );
    $users           = $api->getUsers( [ 'size' => 100 ] );
    $userCollections = $api->getUserCollections( [ 'size' => 100 ] );
    
    
    $role            = $api->getRole( 1000 );
    $roles           = $api->getRoles( [ 'size' => 100 ] );
    $roleCollections = $api->getRoleCollections( [ 'size' => 100 ] );
}
catch( \elite42\trackpms\trackException $e ) {
    throw new controllerException( 'Error while running API command: '.$e->getMessage(), 400, $e);
}

方法

单位

在https://developer.trackhs.com/reference/getunits查看可用于$queryParams的可用查询参数

预订类型

未由Track API记录

单位区域

查看https://developer.trackhs.com/reference/getunitblock

设施

在https://developer.trackhs.com/reference/getunitamenities查看可用于$queryParams的可用查询参数

设施组

在https://developer.trackhs.com/reference/getunitamenitygroups查看可用于$queryParams的可用查询参数

自定义字段

在https://developer.trackhs.com/reference/getcustomfields查看可用于$queryParams的可用查询参数

维护工作单

在https://developer.trackhs.com/reference/getmaintworkorders查看可用于$queryParams的可用查询参数

客房服务工作单

在https://developer.trackhs.com/reference/getworkorders查看可用于$queryParams的可用查询参数

业主

在https://developer.trackhs.com/reference/getownercollection查看可用于$queryParams的可用查询参数

公司（供应商）

在https://developer.trackhs.com/reference/getcompany查看可用于$queryParams的可用查询参数

公司（和业主）附件

在https://developer.trackhs.com/reference/getcompanyattachments查看可用于$queryParams的可用查询参数

公司（和业主）联系人

在https://developer.trackhs.com/reference/getcompanycontacts查看可用于$queryParams的可用查询参数

合同

请参阅 $queryParams 可用查询参数，详情见 https://developer.trackhs.com/reference/getownercontractcollection

用户

在Track中未记录。请参阅本讨论中的一些示例 $queryParams，详情见 https://developer.trackhs.com/discuss/61fd3729f5da3f029bb47f4c

角色

未由Track API记录

单位角色

请参阅 $queryParams 可用查询参数，详情见 https://developer.trackhs.com/reference/getunitrolescollection

会计

项目

请参阅 $queryParams 可用查询参数，详情见 https://developer.trackhs.com/reference/getitemscollection

项目类别

请参阅 $queryParams 可用查询参数，详情见 https://developer.trackhs.com/reference/getitemcateogires

账户

请参阅 $queryParams 可用查询参数，详情见 https://developer.trackhs.com/reference/getledgeraccounts

交易

请参阅 $queryParams 可用查询参数，详情见 https://developer.trackhs.com/reference/getowneridtransactionscollection

所有者交易

请参阅 $queryParams 可用查询参数，详情见 https://developer.trackhs.com/reference/getowneridtransactionscollection-1

对于未实现的方法，手动调用Track API

请参阅可用的API URL，详情见 https://developer.trackhs.com/reference/ 注意，手动调用不会被解析成模型。函数将返回默认输出 json_decode( $responseBody, false, 512, JSON_THROW_ON_ERROR )

elite42 / trackpms

维护者

详细信息