File: xml_api.txt

package info (click to toggle)
pcb-rnd 3.1.7b-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,108 kB
  • sloc: ansic: 213,400; yacc: 6,241; sh: 4,698; awk: 3,016; makefile: 2,254; lex: 1,166; python: 519; xml: 261; lisp: 154; tcl: 67; perl: 34; javascript: 6; ruby: 5
file content (21 lines) | stat: -rw-r--r-- 737 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
The xml API has a few design choices that might be regarded as unusual.

1. order of fields

The quotation request, <PcbQuotationRequest>, is a flat list of mostly
independent children. However, it is very strict about the order
of those children. Fortunately the order matches the one in PCBWay_API.xml.
The ruleset seems to be:
  - divide the children into two groups: board-specific and shipping
  - output board first, shipping next
  - nodes within a group must be alphabetically ordered

2. case sensitivity

Every tag name and enum text fields are case sensitive. The parser will
not accept "no" if the enum value is said to be "No".


3. computer readable API spec

The API is at http://api-partner.pcbway.com/xml/PCBWay_Api.xml