API:Parttypes

From Aligni Wiki

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

List

Command: GET /parttype

Description: Retrieve the list of all parttypes.

Request/Response:

<parttypes>
  <parttype>
    ...
  </parttype>
  <parttype>
    ...
  </parttype>
</parttypes>

Show

Command: GET /parttype/#{parttype_id}

Description: Retrieve one particular parttype by its id.

Request/Response:

<parttype>
  ...
</parttype>

Create

Command: POST /parttype

Description: Create a new parttype.

Request/Response:

<parttype>
  <name>#{name}</name>
  <is_non_material>#{is_non_material}</is_non_material>
  <has_value>#{is_non_material}</has_value>
</parttype>

<parttype>
  ...
</parttype>

Update

Command: PUT /parttype/#{parttype_id}

Description: Updates a parttype record.

Request/Response:

<parttype>
  ...
</parttype>

<parttype>
  ...
</parttype>

Delete

Command: DELETE /pattype/#{parttype_id}

Description: Delete a parttype by its id.

Request/Response: None

Sample Record

<parttype>
  <id>47</id>
  <name>Capacitor</name>
  <is_non_material>false</is_non_material>
  <has_value>true</has_value>
  <has_pcb_footprint>true</has_pcb_footprint>
  <has_schematic_symbol>true</has_schematic_symbol>
  <has_three_d_model>true</has_three_d_model>
</parttype>