Field type response formats
Depending on the field type set within Collection settings, the 'parsed' response will change in structure. The below provides information on the expected response for each supported field type.
Field Type | Annotation Parsed Type |
---|---|
text | type: string nullable: true example: 'hello' |
enum | type: object nullable: true properties: value: type: string label: type: string example: {value: "my_value", label: "My Value"} |
integer | type: integer nullable: true example: 1 |
float | type: number nullable: true example: 1.23 |
decimal | type: string nullable: true example: "1.23" description: A string representation of decimal, useful for currency value |
date | type: string format: date nullable: true example: '2022-02-09' |
daterange | type: object nullable: true properties: start: type: object nullable: true properties: date: type: string format: date example: '2022-02-09' isCurrent: type: boolean day: type: integer nullable: true month: type: integer nullable: true year: type: integer nullable: true end: type: object nullable: true properties: date: type: string format: date example: '2022-02-09' isCurrent: type: boolean day: type: integer nullable: true month: type: integer nullable: true year: type: integer nullable: true |
boolean | type: boolean nullable: true example: true |
location | type: object nullable: true properties: formatted: type: string nullable: true readOnly: true example: Blacksburg, VA, USA postalCode: type: string readOnly: true example: '3124' nullable: true state: type: string readOnly: true nullable: true example: Virginia stateCode: type: string nullable: true readOnly: true example: TX country: type: string readOnly: true nullable: true example: United States countryCode: type: string nullable: true readOnly: true example: US description: Two letter country code (ISO 3166-1 alpha-2) rawInput: type: string example: Blacksburg, VA streetNumber: type: string nullable: true readOnly: true example: '1' street: type: string nullable: true readOnly: true example: Smith St apartmentNumber: type: string nullable: true readOnly: true example: '12' city: type: string nullable: true readOnly: true example: Blacksburg latitude: type: number nullable: true readOnly: true example: '67.0124' longitude: type: number nullable: true readOnly: true example: '67.0124' poBox: type: string nullable: true readOnly: true example: P.O. Box 123 |
phonenumber | type: object nullable: true properties: parsed: type: object properties: rawText: type: string nullable: false example: '+61412632636' deprecated: true formattedNumber: type: string nullable: true example: +61 412 632 636 countryCode: type: string nullable: true example: AU internationalCountryCode: type: integer nullable: true example: 61 minimum: 1 nationalNumber: type: string nullable: true example: 0412 632 636 |
url | type: object nullable: true properties: url: type: string nullable: true example: https://2nb9s.com/hello/world?foo=bar#baz domain: type: string nullable: true example: 2nb9s.com |
image | type: string nullable: true description: URL to the image |
table | type: object nullable: true properties: parsed: type: object properties: rows: type: array items: type: object nullable: true allOf: - $ref: '#/components/schemas/Annotation' - type: object properties: parsed: type: object properties: itemCode: $ref: '#/components/schemas/TextAnnotation' itemDate: $ref: '#/components/schemas/DateAnnotation' itemDescription: $ref: '#/components/schemas/TextAnnotation' itemUnit: $ref: '#/components/schemas/TextAnnotation' itemUnitPrice: $ref: '#/components/schemas/FloatAnnotation' itemQuantity: $ref: '#/components/schemas/FloatAnnotation' itemDiscount: $ref: '#/components/schemas/TextAnnotation' itemBaseTotal: $ref: '#/components/schemas/FloatAnnotation' itemTaxRate: $ref: '#/components/schemas/TextAnnotation' itemTaxTotal: $ref: '#/components/schemas/FloatAnnotation' itemTotal: $ref: '#/components/schemas/FloatAnnotation' itemOther: $ref: '#/components/schemas/TextAnnotation' |
group | Free-form dynamic object |
Updated 4 months ago