masstack

V0
API Overview Resources Schemas

Schemas

Appointment

  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
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

{
  "category": "installation",
  "contactMedium": [
    {
      "characteristic": {
        "key": "mobile",
        "value": 33650981065
      },
      "mediumType": "phoneNumber",
      "preferred": true
    },
    {
      "characteristic": {
        "key": "mobile",
        "value": 33650232065
      },
      "mediumType": "phoneNumber"
    }
  ],
  "description": "Tarea para conseguir una cita",
  "externalId": "MYSIM_391588",
  "id": "MYSIM_391588",
  "note": [
    {
      "author": "Ludovic Robert",
      "date": "2020-08-12T11:00:18.071Z",
      "text": "Problem explained to the back-office"
    }
  ],
  "relatedEntity": [
    {
      "href": "https://mysim/MYSIM_12411",
      "id": "MYSIM_12411",
      "name": "ID of OT",
      "role": "workorder"
    }
  ],
  "relatedParty": [
    {
      "id": "RISK",
      "role": "scoring_result"
    },
    {
      "id": "1",
      "role": "scoring_level"
    },
    {
      "id": "Raúl",
      "role": "firstName"
    },
    {
      "id": "Garcia Garcia",
      "role": "middleName"
    },
    {
      "id": "12345678T",
      "role": "documentNumber"
    },
    {
      "id": "test@pe.es",
      "role": "email"
    },
    {
      "id": "686201221",
      "role": "phoneNumber"
    },
    {
      "id": "28036",
      "role": "zipcode"
    },
    {
      "id": "mysim",
      "role": "sellchannel"
    },
    {
      "id": "10",
      "role": "user_role"
    },
    {
      "id": "Residencial",
      "role": "segment"
    },
    {
      "id": "eu_ES",
      "role": "language"
    },
    {
      "id": "16",
      "role": "tenant"
    },
    {
      "id": "80",
      "role": "duration"
    }
  ],
  "relatedPlace": {
    "href": "https://gescal37/geographicAddress/01000500059400011",
    "id": "01000500059400011 001B",
    "name": "Reyes de Navarra 11, 1B, Vitoria, Alava",
    "role": "interventionAddress"
  },
  "resourceOrderItem": [
    {
      "id": "6545",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "FTTH"
          },
          {
            "name": "territoryOwner",
            "value": "NEBA"
          }
        ]
      }
    },
    {
      "id": "6546",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "MOBILE_LINE"
          },
          {
            "name": "msisdn",
            "value": "666777888"
          },
          {
            "name": "tariff",
            "value": "3GB Ilimitada"
          }
        ]
      }
    }
  ],
  "status": "accepted",
  "validFor": {
    "endDateTime": "2020-08-18T15:00:00Z",
    "startDateTime": "2020-08-18T13:00:00Z"
  }
}
Name Type Required Description
category string false Used to categorize the order from a business perspective that can be useful for the OM system
contactMedium [ContactMedium] false contactMedium
description string false free-text description firestorehe Appointment
externalId string false ID given by the consumer (to facilitate searches afterwards)
id string false Identifier of an instance of the Appointment. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type
note [Note] false note
relatedEntity [RelatedEntity] false related entity
relatedParty [RelatedParty] false related party
relatedPlace RelatedPlace false none
resourceOrderItem [ResourceOrderItem] false resourceOrderItem
status string false The life cycle state of the resource
validFor RangePeriod false RangePeriod reference

AppointmentResponse

  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
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

{
  "category": "installation",
  "contactMedium": [
    {
      "characteristic": {
        "key": "mobile",
        "value": 33650981065
      },
      "mediumType": "phoneNumber",
      "preferred": true
    },
    {
      "characteristic": {
        "key": "mobile",
        "value": 33650232065
      },
      "mediumType": "phoneNumber"
    }
  ],
  "creationDate": "2019-08-24T14:15:22Z",
  "description": "Tarea para conseguir una cita",
  "externalId": "MYSIM_391588",
  "id": "MYSIM_391588",
  "lastUpdate": "2019-08-24T14:15:22Z",
  "note": [
    {
      "author": "Ludovic Robert",
      "date": "2020-08-12T11:00:18.071Z",
      "text": "Problem explained to the back-office"
    }
  ],
  "relatedEntity": [
    {
      "href": "https://mysim/MYSIM_12411",
      "id": "MYSIM_12411",
      "name": "ID of OT",
      "role": "workorder"
    }
  ],
  "relatedParty": [
    {
      "id": "RISK",
      "role": "scoring_result"
    },
    {
      "id": "1",
      "role": "scoring_level"
    },
    {
      "id": "Raúl",
      "role": "firstName"
    },
    {
      "id": "Garcia Garcia",
      "role": "middleName"
    },
    {
      "id": "12345678T",
      "role": "documentNumber"
    },
    {
      "id": "test@pe.es",
      "role": "email"
    },
    {
      "id": "686201221",
      "role": "phoneNumber"
    },
    {
      "id": "28036",
      "role": "zipcode"
    },
    {
      "id": "mysim",
      "role": "sellchannel"
    },
    {
      "id": "10",
      "role": "user_role"
    },
    {
      "id": "Residencial",
      "role": "segment"
    },
    {
      "id": "eu_ES",
      "role": "language"
    },
    {
      "id": "16",
      "role": "tenant"
    },
    {
      "id": "80",
      "role": "duration"
    }
  ],
  "relatedPlace": {
    "href": "https://gescal37/geographicAddress/01000500059400011",
    "id": "01000500059400011 001B",
    "name": "Reyes de Navarra 11, 1B, Vitoria, Alava",
    "role": "interventionAddress"
  },
  "resourceOrderItem": [
    {
      "id": "6545",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "FTTH"
          },
          {
            "name": "territoryOwner",
            "value": "NEBA"
          }
        ]
      }
    },
    {
      "id": "6546",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "MOBILE_LINE"
          },
          {
            "name": "msisdn",
            "value": "666777888"
          },
          {
            "name": "tariff",
            "value": "3GB Ilimitada"
          }
        ]
      }
    }
  ],
  "status": "accepted",
  "validFor": {
    "endDateTime": "2020-08-18T15:00:00Z",
    "startDateTime": "2020-08-18T13:00:00Z"
  }
}
Name Type Required Description
category string false Used to categorize the order from a business perspective that can be useful for the OM system
contactMedium [ContactMedium] false contactMedium
creationDate string(date-time) false Date when the appointment was created
Format: time
description string false free-text description firestorehe Appointment
externalId string false ID given by the consumer (to facilitate searches afterwards)
id string false Identifier of an instance of the Appointment. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type
lastUpdate string(date-time) false Date when the appointment was created
Format: time
note [Note] false note
relatedEntity [RelatedEntity] false related entity
relatedParty [RelatedParty] false related party
relatedPlace RelatedPlace false none
resourceOrderItem [ResourceOrderItem] false resourceOrderItem
status string false The life cycle state of the resource
validFor RangePeriod false RangePeriod reference

Attachment

1
2
3
4
5
6
7

{
  "isRef": true,
  "referredType": "defaultSms",
  "smsBody": "Hola, ¿Cómo ha ido la instalación de tu fibra? Puedes darnos tu opinión y descargar el parte de instalación aquí...",
  "smsSender": "MasMovil",
  "tenant": 2
}
Name Type Required Description
isRef boolean true none
referredType string true Type of communication channel
smsBody string false Message body
smsSender string false Message subject
tenant integer(int64) false Brand identifier

AvailableTimeSlot

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "relatedParty": [
    {
      "id": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "validFor": {
    "endDateTime": "2020-08-18T15:00:00Z",
    "startDateTime": "2020-08-18T13:00:00Z"
  }
}
Name Type Required Description
relatedParty [RelatedParty] false related party
validFor RangePeriod false RangePeriod reference

Characteristic

1
2
3
4

{
  "name": "string",
  "value": "string"
}
Name Type Required Description
name string true Name of the characteristic
value string true The value of the characteristic

ContactMedium

1
2
3
4
5
6
7
8

{
  "characteristic": {
    "name": "string",
    "value": "string"
  },
  "mediumType": "string",
  "preferred": true
}
Name Type Required Description
characteristic Characteristic true none
mediumType string true MediumType of contact
preferred boolean false Check if this medium is preferred

ContactMediumEvent

1
2
3
4
5
6
7
8

{
  "characteristic": {
    "phoneNumber": "626666666",
    "type": "mobile"
  },
  "mediumType": "phoneNumber",
  "preferred": true
}
Name Type Required Description
characteristic object true Characteristics of the type of media
» phoneNumber string true Phone number
» type string true Fixed or mobile
mediumType string true Type of media
preferred boolean true Preferred medium

ErrorDto

1
2
3
4
5
6

{
  "componentMsg": "ID MYSIM_6922893 not exists",
  "id": "MM0000002",
  "msg": "Resource not found",
  "status": 404
}
Name Type Required Description
componentMsg string false Detailed error message
id string false Error identifier
msg string false Generic error message
status integer(int64) false HTTP error code

InboundEvent

 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

{
  "event": {
    "appointment": {
      "attachment": [
        {
          "isRef": true,
          "referredType": "defaultSms",
          "smsBody": "Hola, ¿Cómo ha ido la instalación de tu fibra? Puedes darnos tu opinión y descargar el parte de instalación aquí...",
          "smsSender": "MasMovil",
          "tenant": 2
        }
      ],
      "category": "installation",
      "contactMedium": [
        {
          "characteristic": {
            "phoneNumber": "626666666",
            "type": "mobile"
          },
          "mediumType": "phoneNumber",
          "preferred": true
        }
      ],
      "dateTimeEnd": "2023-10-02T11:00:00Z",
      "dateTimeStart": "2023-10-02T09:00:00Z",
      "formerDateTimeEnd": "2023-09-28T11:00:00Z",
      "formerDateTimeStart": "2023-09-28T09:00:00Z",
      "id": "MYSIM_6872429",
      "status": "reminded"
    }
  },
  "eventId": "00001",
  "eventTime": "2023-10-02T11:30:16Z",
  "eventType": "AppointmentStateChangeEventNotification"
}
Name Type Required Description
event object true Event information to send
» appointment object true Appointment information
»» attachment [Attachment] true Message body
»» category string true Appointment category type
»» contactMedium [ContactMediumEvent] true Contact information
»» dateTimeEnd string true End date
»» dateTimeStart string true Start date
»» formerDateTimeEnd string false Previous end date
»» formerDateTimeStart string true Previous start date
»» id string true Appointment identifier
»» status string true Appointment status
eventId string true Event identifier
eventTime string true Event date
eventType string true Event type

Note

1
2
3
4
5
6

{
  "author": "string",
  "date": "2019-08-24T14:15:22Z",
  "id": "string",
  "text": "string"
}
Name Type Required Description
author string false Author of the note
date string(date-time) false Date of the note
Format: time
id string false Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
text string false Text of the note

RangePeriod

1
2
3
4

{
  "endDateTime": "2020-08-18T15:00:00Z",
  "startDateTime": "2020-08-18T13:00:00Z"
}
Name Type Required Description
endDateTime string(date-time) false EndDateTime of the period
startDateTime string(date-time) false StartDateTime of the period

RelatedEntity

1
2
3
4
5
6

{
  "href": "string",
  "id": "string",
  "name": "string",
  "role": "string"
}
Name Type Required Description
href string false Name of the related entity.
id string true Unique identifier of a related entity.
name string false Name of the related entity.
role string false Role played by the related party

RelatedParty

1
2
3
4
5

{
  "id": "string",
  "name": "string",
  "role": "string"
}
Name Type Required Description
id string true Unique identifier of a related entity.
name string false Name of the related entity.
role string false Role played by the related party

RelatedPlace

1
2
3
4
5
6

{
  "href": "https://gescal37/geographicAddress/01000500059400011",
  "id": "01000500059400011 001B",
  "name": "Reyes de Navarra 11, 1B, Vitoria, Alava",
  "role": "interventionAddress"
}
Name Type Required Description
href string false Name of the related entity.
id string true Unique identifier of a related entity.
name string false Name of the related entity.
role string false Role played by the related party

Resource

1
2
3
4
5
6
7
8

{
  "resourceCharacteristic": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}
Name Type Required Description
resourceCharacteristic [Characteristic] false resource characteristic

ResourceOrderItem

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "id": "string",
  "resource": {
    "resourceCharacteristic": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }
}
Name Type Required Description
id string false Identifier of the line item (generally it is a sequence number 01, 02, 03, …)
resource Resource false Resource Resource is an abstract entity that describes the common set of attributes shared by all concrete resources. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Resource entity and not the related ResourceRefOrValue class itself

SearchsTimeSlots

  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
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

{
  "id": "MYSIM_391588",
  "relatedEntity": [
    {
      "href": "https://mysim/MYSIM_12411",
      "id": "MYSIM_12411",
      "name": "ID of OT",
      "role": "workorder"
    }
  ],
  "relatedParty": [
    {
      "id": "RISK",
      "role": "scoring_result"
    },
    {
      "id": "1",
      "role": "scoring_level"
    },
    {
      "id": "Raúl",
      "role": "firstName"
    },
    {
      "id": "Garcia Garcia",
      "role": "middleName"
    },
    {
      "id": "12345678T",
      "role": "documentNumber"
    },
    {
      "id": "test@pe.es",
      "role": "email"
    },
    {
      "id": "686201221",
      "role": "phoneNumber"
    },
    {
      "id": "28036",
      "role": "zipcode"
    },
    {
      "id": "mysim",
      "role": "sellchannel"
    },
    {
      "id": "10",
      "role": "user_role"
    },
    {
      "id": "Residencial",
      "role": "segment"
    },
    {
      "id": "eu_ES",
      "role": "language"
    },
    {
      "id": "16",
      "role": "tenant"
    },
    {
      "id": "80",
      "role": "duration"
    }
  ],
  "relatedPlace": {
    "href": "https://gescal37/geographicAddress/01000500059400011",
    "id": "01000500059400011 001B",
    "name": "Reyes de Navarra 11, 1B, Vitoria, Alava",
    "role": "interventionAddress"
  },
  "requestedTimeSlot": [
    {
      "validFor": {
        "endDateTime": "2020-08-18T15:00:00Z",
        "startDateTime": "2020-08-18T13:00:00Z"
      }
    }
  ],
  "resourceOrderItem": [
    {
      "id": "6545",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "FTTH"
          },
          {
            "name": "territoryOwner",
            "value": "NEBA"
          }
        ]
      }
    },
    {
      "id": "6546",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "MOBILE_LINE"
          },
          {
            "name": "msisdn",
            "value": "666777888"
          },
          {
            "name": "tariff",
            "value": "3GB Ilimitada"
          }
        ]
      }
    }
  ]
}
Name Type Required Description
id string false Identifier of an instance of the Appointment. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type
relatedEntity [RelatedEntity] false related entity
relatedParty [RelatedParty] false related party
relatedPlace RelatedPlace false none
requestedTimeSlot [ValidFor] false requestedTimeSlot
resourceOrderItem [ResourceOrderItem] false resourceOrderItem

SearchsTimeSlotsResponse

  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
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

{
  "availableTimeSlot": [
    {
      "relatedParty": [
        {
          "id": "11",
          "role": "freeSlots"
        },
        {
          "id": "0",
          "role": "ocuppiedSlots"
        }
      ],
      "validFor": {
        "endDateTime": "2020-08-15T09:00:00.000Z",
        "startDateTime": "2020-08-15T07:00:00.000Z"
      }
    },
    {
      "relatedParty": [
        {
          "id": "11",
          "role": "freeSlots"
        },
        {
          "id": "0",
          "role": "ocuppiedSlots"
        }
      ],
      "validFor": {
        "endDateTime": "2020-08-15T11:00:00.000Z",
        "startDateTime": "2020-08-15T09:00:00.000Z"
      }
    },
    {
      "relatedParty": [
        {
          "id": "11",
          "role": "freeSlots"
        },
        {
          "id": "0",
          "role": "ocuppiedSlots"
        }
      ],
      "validFor": {
        "endDateTime": "2020-08-16T09:00:00.000Z",
        "startDateTime": "2020-08-16T07:00:00.000Z"
      }
    },
    {
      "relatedParty": [
        {
          "id": "11",
          "role": "freeSlots"
        },
        {
          "id": "0",
          "role": "ocuppiedSlots"
        }
      ],
      "validFor": {
        "endDateTime": "2020-08-16T11:00:00.000Z",
        "startDateTime": "2020-08-16T09:00:00.000Z"
      }
    },
    {
      "relatedParty": [
        {
          "id": "11",
          "role": "freeSlots"
        },
        {
          "id": "0",
          "role": "ocuppiedSlots"
        }
      ],
      "validFor": {
        "endDateTime": "2020-08-17T09:00:00.000Z",
        "startDateTime": "2020-08-17T07:00:00.000Z"
      }
    },
    {
      "relatedParty": [
        {
          "id": "7",
          "role": "freeSlots"
        },
        {
          "id": "4",
          "role": "ocuppiedSlots"
        }
      ],
      "validFor": {
        "endDateTime": "2020-08-18T15:00:00.000Z",
        "startDateTime": "2020-08-18T13:00:00.000Z"
      }
    }
  ],
  "id": "MYSIM_391588",
  "relatedEntity": [
    {
      "href": "https://mysim/MYSIM_12411",
      "id": "MYSIM_12411",
      "name": "ID of OT",
      "role": "workorder"
    }
  ],
  "relatedParty": [
    {
      "id": "RISK",
      "role": "scoring_result"
    },
    {
      "id": "1",
      "role": "scoring_level"
    },
    {
      "id": "Raúl",
      "role": "firstName"
    },
    {
      "id": "Garcia Garcia",
      "role": "middleName"
    },
    {
      "id": "12345678T",
      "role": "documentNumber"
    },
    {
      "id": "test@pe.es",
      "role": "email"
    },
    {
      "id": "686201221",
      "role": "phoneNumber"
    },
    {
      "id": "28036",
      "role": "zipcode"
    },
    {
      "id": "mysim",
      "role": "sellchannel"
    },
    {
      "id": "10",
      "role": "user_role"
    },
    {
      "id": "Residencial",
      "role": "segment"
    },
    {
      "id": "eu_ES",
      "role": "language"
    },
    {
      "id": "16",
      "role": "tenant"
    },
    {
      "id": "80",
      "role": "duration"
    }
  ],
  "relatedPlace": {
    "href": "https://gescal37/geographicAddress/01000500059400011",
    "id": "01000500059400011 001B",
    "name": "Reyes de Navarra 11, 1B, Vitoria, Alava",
    "role": "interventionAddress"
  },
  "requestedTimeSlot": [
    {
      "validFor": {
        "endDateTime": "2020-08-18T15:00:00Z",
        "startDateTime": "2020-08-18T13:00:00Z"
      }
    }
  ],
  "resourceOrderItem": [
    {
      "id": "6545",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "FTTH"
          },
          {
            "name": "territoryOwner",
            "value": "NEBA"
          }
        ]
      }
    },
    {
      "id": "6546",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "MOBILE_LINE"
          },
          {
            "name": "msisdn",
            "value": "666777888"
          },
          {
            "name": "tariff",
            "value": "3GB Ilimitada"
          }
        ]
      }
    }
  ],
  "searchDate": "2019-08-24T14:15:22Z",
  "searchResult": "success",
  "status": "created"
}
Name Type Required Description
availableTimeSlot [AvailableTimeSlot] false availableTimeSlot
id string false Identifier of an instance of the Appointment. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type
relatedEntity [RelatedEntity] false related entity
relatedParty [RelatedParty] false related party
relatedPlace RelatedPlace false none
requestedTimeSlot [ValidFor] false requestedTimeSlot
resourceOrderItem [ResourceOrderItem] false resourceOrderItem
searchDate string(date-time) false Date when the order was created
Format: time
searchResult string false Information on the result of the resource
status string false The life cycle state of the resource

ValidFor

1
2
3
4
5
6

{
  "validFor": {
    "endDateTime": "2020-08-18T15:00:00Z",
    "startDateTime": "2020-08-18T13:00:00Z"
  }
}
Name Type Required Description
validFor RangePeriod false RangePeriod reference
Schemas