Skip to content

Commit 40a5e15

Browse files
author
Vítězslav Dvořák
committed
Readme update
1 parent 11d1769 commit 40a5e15

File tree

1 file changed

+9
-71
lines changed

1 file changed

+9
-71
lines changed

README.md

Lines changed: 9 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ Example call in cURL:
2929

3030
```php
3131
<?php
32-
\Ease\Shared::init(['REALPAD_USERNAME','REALPAD_PASSWORD'], '../.env');
3332

34-
$client = new \SpojeNet\Realpad\ApiClient();
33+
// You can also specifi the credentials in constructor call:
34+
$client = new \SpojeNet\Realpad\ApiClient('login','password);
3535
$responseCode = $client->doCurlRequest($client->baseEndpoint . 'ws/v10/list-resources', 'POST');
3636
$dataObtained = $client->lastCurlResponse;
3737
```
@@ -90,14 +90,13 @@ the best guess).
9090

9191
This endpoint will always return all the resources. It’s up to your system to determine which
9292
ones you haven’t downloaded yet. You may rely on UID as the unique identifier to distinguish
93-
between the files. You can fetch resources using HTTP GET by retrieving a URL in the following
94-
form: `<https://cms.realpad.eu/resource/><UID>`
95-
Example call in cURL:
93+
between the files.
94+
95+
You can fetch resources using HTTP GET by retrieving a URL in the following
9696

97-
```shell
98-
curl \
99-
--output cached_resource \
100-
https://cms.realpad.eu/resource/bd5563ae-abc...
97+
```php
98+
$client = new \SpojeNet\Realpad\ApiClient();
99+
$resources = $client->getResource(RESOURCE_UID);
101100
```
102101

103102
## Endpoints
@@ -235,6 +234,7 @@ recorded.
235234

236235
**list-excel-invoices**
237236
Accepts several additional optional parameters:
237+
238238
`filter_status` - if left empty, invoices in all statuses are sent. 1 - new invoices. 2 -
239239
invoices in Review #1. 3 - invoices in Review #2. 4 - invoices in approval. 5 - fully
240240
approved invoices. 6 - fully rejected invoices.
@@ -250,65 +250,3 @@ issues after that date.
250250
before that date.
251251
The initial set of columns describes the Invoice itself, and the last set of columns contains the
252252
data of its Lines.
253-
254-
## Appendix
255-
256-
Unit status enumeration
257-
258-
● 0 - free.
259-
260-
● 1 - pre-reserved.
261-
262-
● 2 - reserved.
263-
264-
● 3 - sold.
265-
266-
● 4 - not for sale.
267-
268-
● 5 - delayed.
269-
270-
Unit type enumeration
271-
272-
● 1 - flat.
273-
274-
● 2 - parking.
275-
276-
● 3 - cellar.
277-
278-
● 4 - outdoor parking.
279-
280-
● 5 - garage.
281-
282-
● 6 - commercial space.
283-
284-
● 7 - family house.
285-
286-
● 8 - land.
287-
288-
● 9 - atelier.
289-
290-
● 10 - office.
291-
292-
● 11 - art workshop.
293-
294-
● 12 - non-residential unit.
295-
296-
● 13 - motorbike parking.
297-
298-
● 14 - creative workshop.
299-
300-
● 15 - townhouse.
301-
302-
● 16 - utility room.
303-
304-
● 17 - condominium.
305-
306-
● 18 - storage.
307-
308-
● 19 - apartment.
309-
310-
● 20 - accommodation unit.
311-
312-
● 21 - bike stand.
313-
314-
● 22 - communal area.

0 commit comments

Comments
 (0)