API:Units

From Aligni Wiki

Contents 1 List 2 Show 3 Create 4 Update 5 Delete 6 Create Unit Conversion 7 Delete Unit Conversion 8 Sample Record

List

Command: GET /unit

Description: Retrieve the list of all units.

Request/Response:

<units>
  <unit>
    ...
  </unit>
  <unit>
    ...
  </unit>
</units>

Show

Command: GET /unit/#{unit_id}

Description: Retrieve one particular unit by its id.

Request/Response:

<unit>
  ...
</unit>

Create

Command: POST /unit

Description: Create a new unit.

Request/Response:

<unit>
  <name>#{name}</name>
  <description>#{description}</description>
</unit>

<unit>
  ...
</unit>

Update

Command: PUT /unit/#{unit_id}

Description: Updates a unit record.

Request/Response:

<unit>
  ...
</unit>

<unit>
  ...
</unit>

Delete

Command: DELETE /unit/#{unit_id}

Description: Delete a unit by its id.

Request/Response: None

Create Unit Conversion

Command: POST /unit_conversion

Description: Create a new unit conversion.

Request/Response:

<unit_conversion>
  <from_unit_id>#{from_unit_id}</from_unit_id>
  <to_unit_id>#{to_unit_id}</to_unit_id>
  <factor>#{factor}</factor>
</unit_conversion>

<unit_conversion>
  ...
</unit_conversion>

Delete Unit Conversion

Command: DELETE /unit_conversion/#{unit_conversion_id}

Description: Delete a unit conversion.

Request/Response: None

Sample Record

<unit>
  <id>3</id>
  <name>Inch</name>
  <description>US inch</description>
  <unit_conversions>
    <unit_conversion>
      <id>6</id>
      <to_unit_id>3</to_unit_id>
      <factor>12.0</factor>
    </unit_conversion>
    <unit_conversion>
      <id>8</id>
      <to_unit_id>3</to_unit_id>
      <factor>1200.0</factor>
    </unit_conversion>
    <unit_conversion>
      <id>10</id>
      <to_unit_id>3</to_unit_id>
      <factor>12000.0</factor>
    </unit_conversion>
  </unit_conversions>
</unit>