BuildingBlockAPI/ExampleSchema.json at main · ingmarvali/BuildingBlockAPI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
    "$id": "http://example.com/example.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "default": {},
    "description": "The root schema comprises the entire JSON document.",
    "examples": [
        {
            "id": 1,
            "surname": "Dobalina",
            "firstName": "Bob",
            "birthdate": "1975-10-04T21:00:00.000Z",
            "phoneNumber": "+14155551212",
            "idNumber": 123456789
        }
    ],
    "required": [
        "id",
        "surname",
        "firstName",
        "phoneNumber"
    ],
    "title": "The root schema",
    "type": "object",
    "properties": {
        "id": {
            "$id": "#/properties/id",
            "default": 0,
            "description": "Unique identifier, generated by building block on creation",
            "examples": [
                1
            ],
            "title": "The id schema",
            "type": "integer"
        },
        "surname": {
            "$id": "#/properties/surname",
            "default": "",
            "description": "Family name",
            "examples": [
                "Dobalina"
            ],
            "title": "The surname schema",
            "type": "string"
        },
        "firstName": {
            "$id": "#/properties/firstName",
            "default": "",
            "description": "First name",
            "examples": [
                "Bob"
            ],
            "title": "The firstName schema",
            "type": "string"
        },
        "birthdate": {
            "$id": "#/properties/birthdate",
            "default": "",
            "description": "DOB",
            "examples": [
                "1975-10-04T21:00:00.000Z"
            ],
            "title": "The birthdate schema",
            "type": "string"
        },
        "phoneNumber": {
            "$id": "#/properties/phoneNumber",
            "default": "",
            "description": "Phone number (mobile) of user, in E.164 Mobile number standard format. Should include country code",
            "examples": [
                "+14155551212"
            ],
            "title": "The phoneNumber schema",
            "type": "string"
        },
        "idNumber": {
            "$id": "#/properties/idNumber",
            "default": 0,
            "description": "Government issued ID number, used when linking to global ID building block",
            "examples": [
                123456789
            ],
            "title": "The idNumber schema",
            "type": "integer"
        }
    },
    "additionalProperties": true
}