isopruefi-frontend / api/api-client / LocationClient

Class: LocationClient¶

Defined in: api/api-client.ts:189

Constructors¶

Constructor¶

new LocationClient(baseUrl?, http?): LocationClient

Defined in: api/api-client.ts:194

Parameters¶

baseUrl?¶

string

http?¶

fetch¶

Returns¶

LocationClient

Properties¶

jsonParseReviver¶

protected jsonParseReviver: undefined | (key, value) => any = undefined

Defined in: api/api-client.ts:192

Methods¶

getAllPostalcodes()¶

getAllPostalcodes(): Promise\<FileResponse>

Defined in: api/api-client.ts:203

Retrieves all saved locations.

Returns¶

Promise\<FileResponse>

A list of all postalcodes; otherwise, NotFound.

insertLocation()¶

insertLocation(postalcode?): Promise\<FileResponse>

Defined in: api/api-client.ts:246

Checks for existence of location and if necessary inserts new location.

Parameters¶

postalcode?¶

number

(optional) Defines the location.

Returns¶

Promise\<FileResponse>

Ok if successful; otherwise, an error response.

processGetAllPostalcodes()¶

protected processGetAllPostalcodes(response): Promise\<FileResponse>

Defined in: api/api-client.ts:219

Parameters¶

response¶

Response

Returns¶

Promise\<FileResponse>

processInsertLocation()¶

protected processInsertLocation(response): Promise\<FileResponse>

Defined in: api/api-client.ts:266

Parameters¶

response¶

Response

Returns¶

Promise\<FileResponse>

processRemovePostalcode()¶

protected processRemovePostalcode(response): Promise\<void>

Defined in: api/api-client.ts:312

Parameters¶

response¶

Response

Returns¶

Promise\<void>

removePostalcode()¶

removePostalcode(postalCode?): Promise\<void>

Defined in: api/api-client.ts:293

Deletes location from the database.

Parameters¶

postalCode?¶

number

(optional) Postalcode

Returns¶

Promise\<void>

Ok if successful; otherwise, an error response.