Unit conversion

Endpoints

Create new unit conversion

/unit-conversions

Description

Returns created unit conversion.

Parameters

Type Name Schema

Body

body
required

UnitConversionDTO

Responses

HTTP Code Description Schema

201

Successfully created

UnitConversionDTO

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/unit-conversions

Description

Returns entities.

Parameters

Type Name Description Schema

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< UnitConversionDTO > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/unit-conversions/import

Parameters

Type Name Schema

Body

body
required

ImportUnitConversionList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get one unit conversion

/unit-conversions/{unitCode1}/{unitCode2}

operation.deprecated

Description

Returns retrieved unit conversion.

Parameters

Type Name Description Schema Business Rules

Path

unitCode1
required

First unit code

string

5 characters max

Path

unitCode2
required

Second unit ode

string

5 characters max

Responses

HTTP Code Description Schema

200

Successful

UnitConversionDTO

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete unit conversion

/unit-conversions/{unitCode1}/{unitCode2}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

unitCode1
required

First unit public uuid code

string

5 characters max

Path

unitCode2
required

Second unit public uuid code

string

5 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

UnitConversionDTO

Name Description Value Business Rules

quantity1
required

First unit quantity

double

quantity2
required

Second unit quantity

double

unit1
required

First unit code

string

5 characters max

unit2
required

Second unit code

string

5 characters max

ImportUnitConversionList

Name Value

callback
optional

string

data
optional

UnitConversionDTO list