API:Vendors

From Aligni Wiki

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

List

Command: GET /vendor

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

Request/Response:

<vendors>
  <vendor>
    ...
  </vendor>
  <vendor>
    ...
  </vendor>
</vendors>

Show

Command: GET /vendor/#{vendor_id}

Description: Retrieve one particular vendor by its id.

Request/Response:

<vendor>
  ...
</vendor>

Create

Command: POST /vendor

Description: Create a new vendor.

Request/Response:

<vendor>
  <name>#{name}</name>
  <phone1>#{phone1}</phone1>
  <phone2>#{phone2}</phone2>
  <phone3>#{phone3}</phone3>
</vendor>

<vendor>
  ...
</vendor>

Update

Command: PUT /vendor/#{vendor_id}

Description: Updates a vendor record.

Request/Response:

<vendor>
  ...
</vendor>

<vendor>
  ...
</vendor>

Delete

Command: DELETE /vendor/#{vendor_id}

Description: Delete a vendor by its id.

Request/Response: None

Sample Record

<vendor>
  <id>40</id>
  <name>Digi-Key</name>
  <address1>701 Brooks Avenue South</address1>
  <address2/>
  <address3/>
  <city>Thief River Falls</city>
  <state>MN</state>
  <postcode>56701</postcode>
  <country>USA</country>
  <phone1>800.344.4539</phone1>
  <phone2/>
  <phone3/>
</vendor>