justmovein/reapit-client

RESTful API that allows the retrieval of data from a Reapit Client's system. To get the full list of the methods available to you, add your API key in the query string when requesting the Swagger documentation, e.g. https://path.to.service/swagger.json?ApiKey=YOUR-API-KEY. Use the same API Key to authorize access to the service.


Keywords
php, rest, api, sdk, openapi, openapitools, openapi-generator
License
Unlicense

Documentation

ReapitWeb REST API Client

RESTful API that allows the retrieval of data from a Reapit Client's system. To get the full list of the methods available to you, add your API key in the query string when requesting the Swagger documentation, e.g. https://path.to.service/swagger.json?ApiKey=YOUR-API-KEY. Use the same API Key to authorize access to the service.

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 4.36.1
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 7.1 and later

Installation & Usage

Composer

To install the bindings via Composer, run the following:

composer require justmovein/reapit-client

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ApplianceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | The ID of the appliance
$entity_document_input = new \OpenAPI\Client\Model\EntityDocumentInput(); // \OpenAPI\Client\Model\EntityDocumentInput | An entity document input object. The data attribute should be a base 64 encoded string.

try {
    $result = $apiInstance->appliancesIDDocumentPost($id, $entity_document_input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplianceApi->appliancesIDDocumentPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to http://webservice.reapit.net/par/rest

Class Method HTTP request Description
ApplianceApi appliancesIDDocumentPost POST /appliances/{ID}/document
ApplicantApi applicantPost POST /applicant
ApplicantApi applicantsGet GET /applicants
ApplicantApi applicantsIDGet GET /applicants/{ID}
ApplicantApi applicantsIDMatchDelete DELETE /applicants/{ID}/match
ApplicantApi applicantsIDMatchPost POST /applicants/{ID}/match
ApplicantApi applicantsIDOffersGet GET /applicants/{ID}/offers
ApplicantApi applicantsIDPatch PATCH /applicants/{ID}
ApplicantApi applicantsIDPropertiesMatchedGet GET /applicants/{ID}/properties/matched
ApplicantApi applicantsIDPropertiesPropertyIDDelete DELETE /applicants/{ID}/properties/{PropertyID}
ApplicantApi applicantsIDPropertiesPropertyIDPost POST /applicants/{ID}/properties/{PropertyID}
ApplicantApi applicantsIDPropertiesSavedGet GET /applicants/{ID}/properties/saved
ApplicantApi applicantsIDPropertiesViewedGet GET /applicants/{ID}/properties/viewed
ApplicantApi applicantsIDPut PUT /applicants/{ID}
ApplicantApi applicantsIDViewingsGet GET /applicants/{ID}/viewings
ApplicantApi matchAreasGet GET /matchAreas
ApplicantApi offerPost POST /offer
ApplicantApi propertiesIDBuyerGet GET /properties/{ID}/buyer
ApplicantApi propertiesIDBuyerSolicitorGet GET /properties/{ID}/buyer/solicitor
ApplicantApi propertiesIDEnquiryPost POST /properties/{ID}/enquiry
AuctionApi auctionsGet GET /auctions
AuctionApi auctionsIDLotsGet GET /auctions/{ID}/lots
AuctionApi propertiesIDAuctionGet GET /properties/{ID}/auction
CompanyApi departmentsGet GET /departments
CompanyApi negotiatorsIDGet GET /negotiators/{ID}
CompanyApi negotiatorsIDMessagePost POST /negotiators/{ID}/message
CompanyApi officesGet GET /offices
CompanyApi officesIDGet GET /offices/{ID}
CompanyApi officesIDMessagePost POST /offices/{ID}/message
CompanyApi officesIDNegotiatorsGet GET /offices/{ID}/negotiators
CompanyApi postcodesPostcodeOfficesGet GET /postcodes/{Postcode}/offices
ContactApi contactsGet GET /contacts
ContactApi contactsIDGet GET /contacts/{ID}
ContactApi contactsIDMarketingDelete DELETE /contacts/{ID}/marketing
ContactApi contactsIDMarketingPost POST /contacts/{ID}/marketing
ContactApi contactsIDNotePost POST /contacts/{ID}/note
ContactApi contactsIDPatch PATCH /contacts/{ID}
ContactApi contactsIDPut PUT /contacts/{ID}
ContactApi contactsIDSearchPost POST /contacts/{ID}/search
ContactApi erasedContactsGet GET /erasedContacts
DiaryApi appointmentPost POST /appointment
DiaryApi appointmentsGet GET /appointments
DiaryApi appointmentsIDDelete DELETE /appointments/{ID}
DiaryApi availabilityGet GET /availability
DiaryApi negotiatorsIDAppointmentsGet GET /negotiators/{ID}/appointments
DiaryApi negotiatorsIDAvailabilityGet GET /negotiators/{ID}/availability
DiaryApi valuationAppointmentsGet GET /valuationAppointments
DiaryApi viewingAppointmentsGet GET /viewingAppointments
DocumentApi appliancesIDDocumentPost POST /appliances/{ID}/document
DocumentApi propertiesIDDocumentPost POST /properties/{ID}/document
DocumentApi tenanciesIDDocumentPost POST /tenancies/{ID}/document
DocumentApi tenancyChecksIDDocumentPost POST /tenancyChecks/{ID}/document
DocumentApi worksOrdersIDImagePost POST /worksOrders/{ID}/image
EventApi eventsGet GET /events
LandlordApi landlordDocumentsIDGet GET /landlord/documents/{ID}
LandlordApi landlordPropertiesIDDocumentsGet GET /landlord/properties/{ID}/documents
LandlordApi landlordPropertiesIDTransactionsGet GET /landlord/properties/{ID}/transactions
LandlordApi landlordTenanciesIDDocumentsGet GET /landlord/tenancies/{ID}/documents
LandlordApi landlordsIDDocumentsGet GET /landlords/{ID}/documents
LandlordApi landlordsIDGet GET /landlords/{ID}
LandlordApi landlordsIDPropertiesGet GET /landlords/{ID}/properties
LandlordApi landlordsIDTransactionsGet GET /landlords/{ID}/transactions
LandlordApi propertiesIDInspectionsGet GET /properties/{ID}/inspections
LandlordApi propertiesIDLandlordGet GET /properties/{ID}/landlord
LandlordApi propertiesIDRentReviewsGet GET /properties/{ID}/rentReviews
LandlordApi propertiesIDTenanciesGet GET /properties/{ID}/tenancies
LandlordApi propertiesIDTenancyCurrentGet GET /properties/{ID}/tenancy/current
LandlordApi tenanciesIDWorksOrdersGet GET /tenancies/{ID}/worksOrders
LandlordApi worksOrdersIDNotePost POST /worksOrders/{ID}/note
MailingApi applicantsIDMatchDelete DELETE /applicants/{ID}/match
MailingApi applicantsIDMatchPost POST /applicants/{ID}/match
MailingApi categoriesGet GET /categories
MailingApi categoriesIDContactPost POST /categories/{ID}/contact
MailingApi categoriesIDContactsContactIDDelete DELETE /categories/{ID}/contacts/{ContactID}
MailingApi categoriesIDGet GET /categories/{ID}
MailingApi contactsIDMarketingDelete DELETE /contacts/{ID}/marketing
MailingApi contactsIDMarketingPost POST /contacts/{ID}/marketing
MailingApi mailingListsGet GET /mailingLists
MailingApi mailingListsIDContactPost POST /mailingLists/{ID}/contact
MailingApi mailingListsIDContactsContactIDDelete DELETE /mailingLists/{ID}/contacts/{ContactID}
MailingApi mailingListsIDGet GET /mailingLists/{ID}
MailingApi unsubscribePost POST /unsubscribe
MarketingApi propertiesIDInteractionUserGet GET /properties/{ID}/interaction/user
MarketingApi propertiesIDMarketingAdvertisementsGet GET /properties/{ID}/marketing/advertisements
MarketingApi propertiesIDMarketingStatsGet GET /properties/{ID}/marketing/stats
MarketingApi propertiesIDViewingsGet GET /properties/{ID}/viewings
MarketingApi viewingsIDGet GET /viewings/{ID}
OfferApi offersIDGet GET /offers/{ID}
OfferApi offersIDNotePost POST /offers/{ID}/note
OfferApi propertiesIDNotesOfInterestGet GET /properties/{ID}/notesOfInterest
OfferApi propertiesIDOffersGet GET /properties/{ID}/offers
OpenHouseApi propertiesIDViewingsOpenhouseGet GET /properties/{ID}/viewings/openhouse
OpenHouseApi viewingsOpenhousePropertiesGet GET /viewings/openhouse/properties
PropertyApi offerPost POST /offer
PropertyApi propertiesApproveBrochureIDPatch PATCH /properties/approveBrochure/{ID}
PropertyApi propertiesGeneralGet GET /properties/general
PropertyApi propertiesGeneralTotalGet GET /properties/general/total
PropertyApi propertiesIDAuctionGet GET /properties/{ID}/auction
PropertyApi propertiesIDBuyerGet GET /properties/{ID}/buyer
PropertyApi propertiesIDBuyerSolicitorGet GET /properties/{ID}/buyer/solicitor
PropertyApi propertiesIDDocumentPost POST /properties/{ID}/document
PropertyApi propertiesIDEnquiryPost POST /properties/{ID}/enquiry
PropertyApi propertiesIDGet GET /properties/{ID}
PropertyApi propertiesIDInteractionUserGet GET /properties/{ID}/interaction/user
PropertyApi propertiesIDLandlordGet GET /properties/{ID}/landlord
PropertyApi propertiesIDNotesOfInterestGet GET /properties/{ID}/notesOfInterest
PropertyApi propertiesIDOffersGet GET /properties/{ID}/offers
PropertyApi propertiesIDThumbnailGet GET /properties/{ID}/thumbnail
PropertyApi propertiesIDVendorGet GET /properties/{ID}/vendor
PropertyApi propertiesIDVendorSolicitorGet GET /properties/{ID}/vendor/solicitor
PropertyApi propertiesIDViewingsGet GET /properties/{ID}/viewings
SystemApi departmentsGet GET /departments
SystemApi versionGet GET /version
TenancyApi tenanciesCompletePreTenancyCheckIDPatch PATCH /tenancies/completePreTenancyCheck/{ID}
TenancyApi tenanciesGet GET /tenancies
TenancyApi tenanciesIDDocumentPost POST /tenancies/{ID}/document
TenancyApi tenanciesIDFaultPost POST /tenancies/{ID}/fault
TenancyApi tenanciesIDGet GET /tenancies/{ID}
TenancyApi tenanciesIDInspectionsGet GET /tenancies/{ID}/inspections
TenancyApi tenanciesIDRentReviewsGet GET /tenancies/{ID}/rentReviews
TenancyApi tenanciesIDTenantGet GET /tenancies/{ID}/tenant
TenancyApi tenanciesIDWorksOrdersGet GET /tenancies/{ID}/worksOrders
TenancyApi tenanciesIssuesFixfloPost POST /tenancies/issues/fixflo
TenancyApi tenancyChecksIDDocumentPost POST /tenancyChecks/{ID}/document
TenancyApi worksOrdersIDGet GET /worksOrders/{ID}
TenancyApi worksOrdersIDImagePost POST /worksOrders/{ID}/image
TenantApi tenanciesIDFaultPost POST /tenancies/{ID}/fault
TenantApi tenanciesIDGet GET /tenancies/{ID}
TenantApi tenanciesIDInspectionsGet GET /tenancies/{ID}/inspections
TenantApi tenanciesIDRentReviewsGet GET /tenancies/{ID}/rentReviews
TenantApi tenanciesIDTenantGet GET /tenancies/{ID}/tenant
TenantApi tenanciesIDWorksOrdersGet GET /tenancies/{ID}/worksOrders
TenantApi tenanciesIssuesFixfloPost POST /tenancies/issues/fixflo
TenantApi tenantDocumentsIDGet GET /tenant/documents/{ID}
TenantApi tenantTenanciesIDDocumentsGet GET /tenant/tenancies/{ID}/documents
TenantApi tenantTenanciesIDTransactionsGet GET /tenant/tenancies/{ID}/transactions
TenantApi tenantsIDDocumentsGet GET /tenants/{ID}/documents
TenantApi tenantsIDGet GET /tenants/{ID}
TenantApi tenantsIDTenanciesGet GET /tenants/{ID}/tenancies
VendorApi developmentsIDReportGet GET /developments/{ID}/report
VendorApi propertiesIDVendorGet GET /properties/{ID}/vendor
VendorApi propertiesIDVendorSolicitorGet GET /properties/{ID}/vendor/solicitor
VendorApi vendorDocumentsIDGet GET /vendor/documents/{ID}
VendorApi vendorPropertiesIDDocumentsGet GET /vendor/properties/{ID}/documents
VendorApi vendorsIDDocumentsGet GET /vendors/{ID}/documents
VendorApi vendorsIDPropertiesGet GET /vendors/{ID}/properties
ViewingApi propertiesIDViewingsOpenhouseGet GET /properties/{ID}/viewings/openhouse
ViewingApi viewingsIDFeedbackPost POST /viewings/{ID}/feedback
ViewingApi viewingsOpenhousePropertiesGet GET /viewings/openhouse/properties

Documentation For Models

Documentation For Authorization

ApiKey

  • Type: API key
  • API key parameter name: ApiKey
  • Location: HTTP header

Author

bruno@justmovein.co