API:Manufacturers

From Aligni Wiki

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

List

Command: GET /manufacturer

Description: Retrieve the list of all manufacturers. Note that each record is abbreviated. You will need to retrieve a specific record for full details.

Request/Response:

<manufacturers>
  <manufacturer>
    ...
  </manufacturer>
  <manufacturer>
    ...
  </manufacturer>
</manufacturers>

Show

Command: GET /manufacturer/#{manufacturer_id}

Description: Retrieve one particular manufacturer by its id.

Request/Response:

<manufacturer>
  ...
</manufacturer>

Create

Command: POST /manufacturer

Description: Create a new manufacturer.

Request/Response:

<manufacturer>
  <name>#{name}</name>
  <website>#{website}</website>
</manufacturer>

<manufacturer>
  ...
</manufacturer>

Update

Command: PUT /manufacturer/#{manufacturer_id}

Description: Updates a manufacturer record.

Request/Response:

<manufacturer>
  ...
</manufacturer>

<manufacturer>
  ...
</manufacturer>

Delete

Command: DELETE /manufacturer/#{manufacturer_id}

Description: Delete a manufacturer by its id.

Request/Response: None

Sample Record

<manufacturer>
  <id>128</id>
  <name>Analog Devices</name>
  <website>www.analog.com</website>
  <address1>One Technology Way</address1>
  <address2>P. O. Box 9106</address2>
  <address3/>
  <city>Norwood</city>
  <state>MA</state>
  <postcode>02062-9106</postcode>
  <country>USA</country>
  <phone1>781.329.4700</phone1>
  <phone2/>
  <phone3/>
</manufacturer>