The person API allows client applications to maintain person data including any part of its demographic record sets.
This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.
Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us. We appreciate your help.
To place any request in QBOS API application from third party application you need to authenticate user account and set/calculate values for the following request headers:
x-qbos-id, x-qbos-nonce, x-qbos-date-utc, x-qbos-hash-version, x-qbos-auth
See details in Authentication Documentation.
Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.
| Name | Type | Max length | Numeric | Required For POST |
Filterable | Description |
|---|---|---|---|---|---|---|
id |
bigint |
|
|
|
Required for GET(by id),PUT,DELETE |
|
parent_id |
bigint |
|
yes |
|
||
parent_type |
nvarchar |
50 |
|
yes |
|
|
type |
nvarchar |
50 |
|
|
|
Value is "person" |
gender |
varchar |
1 |
|
|
|
F=Femail; M=Male; U=Unknown |
date_of_birth |
varchar |
10 |
|
|
|
|
social_security_number |
varchar |
15 |
yes |
|
|
|
name_first |
nvarchar |
50 |
|
|
|
|
name_middle |
nvarchar |
20 |
|
|
|
|
name_last |
nvarchar |
50 |
|
yes |
yes |
|
language_id |
int |
|
|
|
0=Unknown, 1=English, 13=Spanish, 14=Dutch, 15=French, 16=German, 17=Greek, 18=Italian, 19=Japanese, 20=Korean, 21=Portuguese, 22=Russian, 23=Chinese-simp, 24=Chinese-trad, 25=British English, 26=El Salvador Spanish, 27=Hong Kong English |
|
_example_utc_datetime |
char |
20 |
|
|
|
|
name_prefix |
nvarchar |
20 |
|
|
|
|
name_suffix |
nvarchar |
20 |
|
|
|
|
nickname |
nvarchar |
20 |
|
|
|
Request data [See properties]:
Response codes:
Request data [See properties]:
Response codes:
The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe
Response codes: