API:Inventory Locations

From Aligni Wiki

Contents 1 List 2 Show 3 Create 4 Update 5 Delete 6 Sample Record

List

Command: GET /inventory_location

Description: Retrieve the list of all inventory locations.

Request/Response:

<inventory_locations>
  <inventory_location>
    ...
  </inventory_location>
  <inventory_location>
    ...
  </inventory_location>
</inventory_locations>

Show

Command: GET /inventory_location/#{inventory_location_id}

Description: Retrieve one particular inventory location by its id.

Request/Response:

<inventory_location>
  ...
</inventory_location>

Create

Command: POST /inventory_location

Description: Create a new inventory location.

Request/Response:

<inventory_location>
  <name>#{name}</name>
  <shortname>#{shortname}</shortname>
  <description>#{description}</description>
</inventory_location>

<inventory_location>
  ...
</inventory_location>

Update

Command: PUT /inventory_location/#{inventory_location_id}

Description: Updates an inventory location record.

Request/Response:

<inventory_location>
  ...
</inventory_location>

<inventory_location>
  ...
</inventory_location>

Delete

Command: DELETE /inventory_location/#{inventory_location_id}

Description: Delete an inventory location by its id.

Request/Response: None

Sample Record

<inventory_location>
  <id>1</id>
  <name>Headquarters</name>
  <shortname>CDHQ</shortname>
  <description>Consolidated Diversified Headquarters</description>
  <phone1>908.687.5309</phone1>
  <phone2></phone2>
  <address1>123 Pollo del Mar</address1>
  <address2></address2>
  <city>Peoria</city>
  <state>IL</state>
  <postcode>61605</postcode>
  <country>USA</country>
  <created_on>Fri Mar 10 02:57:37 UTC 2006</created_on>
  <updated_on>Fri Mar 10 02:58:56 UTC 2006</updated_on>
  <inventory_sublocation>
    <id>5</id>
    <name>Bin 10</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>9</id>
    <name>Bin 12</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>3</id>
    <name>Bin 14</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>13</id>
    <name>Bin 2</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>14</id>
    <name>Bin 31</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>11</id>
    <name>Bin 34</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>8</id>
    <name>Bin 8</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>7</id>
    <name>Bin 9</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>2</id>
    <name>General Storage</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>6</id>
    <name>Robot monkey kit</name>
  </inventory_sublocation>
  <inventory_sublocation>
    <id>10</id>
    <name>Storage Room</name>
  </inventory_sublocation>
</inventory_location>