Units

Units defines the standards for scores to be used. A Unit is used when defining an Indicator. Examples are Percent, Rate, Hours, Dollar, etc.

Show

GET /units/#{id}.xml

Returns a single unit.

Request

curl -u TOKEN:x -X GET https://dashboard.kpilibrary.com/api/v2/units/UNIT_ID.xml

Response

Status: 200

<?xml version="1.0" encoding="UTF-8"?>
<unit>
  <id type="integer">98</id>
  <name>Euro</name>
  <sortorder>2</sortorder>
</unit>

Create

POST /units.xml

Creates a new unit.

Request

curl -u TOKEN:x -X POST -H "Content-Type: application/xml; charset=utf-8" \
  -d "<unit><name>Euro</name></unit>" \
  https://dashboard.kpilibrary.com/api/v2/units.xml

Response

Status: 201
Location: https://dashboard.kpilibrary.com/api/v2/units/NEW_UNIT_ID.xml

<?xml version="1.0" encoding="UTF-8"?>
<unit>
  <id type="integer">NEW_UNIT_ID</id>
</unit>

Update

PUT /units/#{id}.xml

Updates an existing unit with a new name.

Request

curl -u TOKEN:x -X PUT -H "Content-Type: application/xml; charset=utf-8" \
  -d "<unit><name>Yen</name></unit>" \
  https://dashboard.kpilibrary.com/api/v2/units/UNIT_ID.xml

Response

Status: 200

Delete

DELETE /units/#{id}.xml

Destroys the unit at the referenced URL.

Request

curl -u TOKEN:x -X DELETE https://dashboard.kpilibrary.com/api/v2/units/UNIT_ID.xml

Response

Status: 200

List

GET /units.xml

Returns the list of units.

Request

curl -u TOKEN:x -X GET https://dashboard.kpilibrary.com/api/v2/units.xml

Response

Status: 200

<?xml version="1.0" encoding="UTF-8"?>
<units type="array">
  <unit>
    <id type="integer">98</id>
    <name>Euro</name>
    <sortorder>1</sortorder>
  </unit>
  <unit>
    <id type="integer">102</id>
    <name>Rate</name>
    <sortorder>2</sortorder>
  </unit>
  <unit>
    ...
  </unit>
</units>