masstack

V1
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

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

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

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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262

{
  "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": [
    {
      "id": "MYSIM_391588",
      "role": "workorder"
    },
    {
      "id": "Alta FTTH + VOIP",
      "role": "orderType"
    },
    {
      "id": "INSTALA MM",
      "role": "connectionInstallationFlow"
    },
    {
      "id": "00833",
      "role": "donorOperator"
    },
    {
      "id": "V",
      "role": "linkState"
    },
    {
      "id": "NO POSTE",
      "role": "ctoPoleDB"
    }
  ],
  "relatedParty": [
    {
      "id": "mysim",
      "role": "sellchannel"
    },
    {
      "id": "14",
      "role": "user_role"
    },
    {
      "id": "C002",
      "role": "user_code"
    },
    {
      "id": "RESIDENCIAL",
      "role": "segment"
    },
    {
      "id": "12",
      "role": "tenant"
    },
    {
      "id": "installation",
      "role": "category"
    },
    {
      "id": "MANUEL",
      "role": "firstName"
    },
    {
      "id": "MARTINEZ MORANT",
      "role": "middleName"
    },
    {
      "id": "4XXXXXXXXJ",
      "role": "documentNumber"
    },
    {
      "id": "email@gmail.com",
      "role": "email"
    },
    {
      "id": "6XXXXXXXX",
      "role": "phoneNumber"
    },
    {
      "id": "50007",
      "role": "zipcode"
    },
    {
      "id": "es_ES",
      "role": "language"
    },
    {
      "id": "OK",
      "role": "scoring_result"
    },
    {
      "id": "0",
      "role": "scoring_level"
    },
    {
      "id": "CONTRACT_TO_DEFINE",
      "role": "contract"
    },
    {
      "id": "0",
      "role": "delay"
    },
    {
      "id": "85",
      "role": "duration"
    },
    {
      "id": "false",
      "role": "isNewAppointment"
    },
    {
      "id": "2023-10-03T15:00:00 - 2023-10-03T18:00:00",
      "role": "validForAppointment"
    }
  ],
  "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

CreateAppointment

 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

{
  "workOrderId": "MYSIM_391588",
  "category": "installation",
  "sellChannel": "mysim",
  "userRole": 10,
  "userCode": 12,
  "segment": "Residencial",
  "tenantId": 16,
  "customer": {
    "firstName": "Carmen",
    "middleName": "Pérez Medina",
    "documentNumber": "12345678T",
    "email": "test@pe.es",
    "phoneNumber": 686201221,
    "zipcode": 28036,
    "language": "es_ES"
  },
  "scoringResult": "RISK",
  "scoringLevel": 1,
  "validFor": {
    "endDateTime": "2020-08-18T15:00:00Z",
    "startDateTime": "2020-08-18T13:00:00Z"
  },
  "gescalId": "01000500059400011 001B",
  "duration": 80,
  "ctoPoleDB": "POSTE",
  "orderType": "Alta FTTH + VOIP",
  "connectionInstallationFlow": "INSTALA MM",
  "donorOperator": 833,
  "linkState": "V"
}
Name Type Required Description
workOrderId string true work order identifier. When the value is known for yoigo It is necessary to add letter “Y” in the orderWorkId, in entry parameters of iframe for example Y360852 for other CRM as MYSIM or HEOS (pepephone), the curent prefix already used as MYSIM_ , WD_ or PP.
category string true used to categorize the order from a business perspective that can be useful for the OM system.
sellChannel string true seller chanel.
userRole string true role played by the user.
userCode string false user code.
segment string true segment.
tenantId string false tenant identifier.
customer Customer true none
scoringResult string true it is the overall risk value of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems.
scoringLevel string true it is the risk level of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems.
validFor RangePeriod true RangePeriod reference
gescalId string false gescal 37 identifier.
duration string true calculation duration.
ctoPoleDB string false cto database response.
orderType string false order type.
connectionInstallationFlow string false connection installation flow.
donorOperator string false donor operator.
linkState string false link state.
Property Values
scoringResult one of [OK, RELEASE, RISK, A, R]
ctoPoleDB one of [POSTE, POSTE H, NO POSTE]

Customer

1
2
3
4
5
6
7
8
9

{
  "firstName": "Carmen",
  "middleName": "Pérez Medina",
  "documentNumber": "12345678T",
  "email": "test@pe.es",
  "phoneNumber": 686201221,
  "zipcode": 28036,
  "language": "es_ES"
}
Name Type Required Description
firstName string true user first name.
middleName string false user middle name.
documentNumber string true user document number. It can be NIF, NIE or PASSPORT.
email string false user email.
phoneNumber string true user phone number.
zipcode string true user zip code.
language string true language used by the user.

UpdateAppointment

 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

{
  "tenantId": 16,
  "workOrderId": "MYSIM_391588",
  "scoringResult": "RISK",
  "scoringLevel": 1,
  "sellChannel": "mysim",
  "userRole": 10,
  "userCode": 12,
  "segment": "RESIDENTIAL",
  "duration": 80,
  "customer": {
    "firstName": "Carmen",
    "middleName": "Pérez Medina",
    "documentNumber": "12345678T",
    "email": "test@pe.es",
    "phoneNumber": 686201221,
    "zipcode": 28036,
    "language": "es_ES"
  },
  "validFor": {
    "endDateTime": "2020-08-18T15:00:00Z",
    "startDateTime": "2020-08-18T13:00:00Z"
  },
  "ctoPoleDB": "POSTE",
  "orderType": "Alta FTTH + VOIP",
  "connectionInstallationFlow": "INSTALA MM",
  "donorOperator": 833,
  "linkState": "V"
}
Name Type Required Description
tenantId string false tenant identifier.
workOrderId string true work order identifier. When the value is known for yoigo It is necessary to add letter “Y” in the orderWorkId, in entry parameters of iframe for example Y360852 for other CRM as MYSIM or HEOS (pepephone), the curent prefix already used as MYSIM_ , WD_ or PP.
scoringResult string false scoring result.
scoringLevel string false it is the risk level of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems.
sellChannel string false sell channel.
userRole string false user role.
userCode string false user code.
segment string false apointment segment.
duration string true calculation duration.
customer Customer false none
validFor RangePeriod true RangePeriod reference
ctoPoleDB string false cto database response.
orderType string false order type.
connectionInstallationFlow string false connection installation flow.
donorOperator string false donor operator.
linkState string false link state.
Property Values
scoringResult one of [OK, RELEASE, RISK, A, R]
ctoPoleDB one of [POSTE, POSTE H, NO POSTE]

SearchTimeSlots

 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

{
  "action": "MODIFICARCITA",
  "scoringLevel": 0,
  "scoringResult": "OK",
  "segment": "RESIDENTIAL",
  "gescal": "28000010025000026         002D",
  "category": "installation",
  "orderWorkId": "MYSIM_123456",
  "accessToken": "147hytr",
  "relatedParty": {
    "tenant": "masmovil",
    "donorOperator": "00008",
    "creationDate": "2019-08-24T14:15:22Z",
    "territoryOwner": "BIDOR01",
    "connectionInstallationFlow": "INSTALA_TESA",
    "linkState": "V",
    "userCode": "Code01",
    "userProfile": "Profile01",
    "originAccessIsExternal": false
  },
  "productSpecification": {
    "schema": "id:Alta FTTH + VOIP__AGILETV"
  },
  "contact": {
    "emailAddress": "joao.parreira@rupeal.com",
    "postCode": 28033,
    "contactNumber": 666666444
  },
  "customer": {
    "firstName": "Carmen",
    "midName": "María",
    "documentId": "11111111H",
    "documentIdCif": "11111111H",
    "language": "es_ES"
  }
}
Name Type Required Description
action string false the two actions that the component allows are NUEVACITA
scoringLevel string false It is the risk level of customer fraud
scoringResult string false It is the overall risk value of customer fraud. Allowed values are: OK, RELEASE, RISK, A, R
segment string false apointment segment.
gescal string false gescal 37.
category string true used to categorize the order from a business perspective that can be useful for the OM system.
orderWorkId string true order work identifier.
accessToken string false access token.
relatedParty RelatedPartyExt false none
productSpecification Product false none
contact Contact false none
customer CustomerExt false none

RelatedPartyExt

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "tenant": "masmovil",
  "donorOperator": "00008",
  "creationDate": "2019-08-24T14:15:22Z",
  "territoryOwner": "BIDOR01",
  "connectionInstallationFlow": "INSTALA_TESA",
  "linkState": "V",
  "userCode": "Code01",
  "userProfile": "Profile01",
  "originAccessIsExternal": false
}
Name Type Required Description
tenant string false tenant.
donorOperator string false donor operator information
creationDate string(date-time) false date when the appointment was created. The format is yyyy-MM-dd’T’HH:mm:ssZ.
territoryOwner string false territory owner.
connectionInstallationFlow string false connection installation flow. Rush installer (INSTALA_TESA, INSTALA_MM).
linkState string false allowed values:
“linkState”: null, in case of not NEBA or VULA
“linkState”: “O”, in case of NEBA PO
“linkState”: “V”, in case of NEBA PV or VULA
userCode string false user code.
userProfile string false user profile information. CRM must use 14 for new appointment, 10 for updateAppointment. FSM must send other user profiles.
originAccessIsExternal boolean false new numbering sales information with external access origin and without transfer of access

Product

1
2
3

{
  "schema": "id:Alta FTTH + VOIP__AGILETV"
}
Name Type Required Description
schema object false schema. This is a map.
» additionalProperties string false none

Contact

1
2
3
4
5

{
  "emailAddress": "joao.parreira@rupeal.com",
  "postCode": 28033,
  "contactNumber": 666666444
}
Name Type Required Description
emailAddress string false order contact email.
postCode string true order contact postal code.
contactNumber string true contact number of order contact.

CustomerExt

1
2
3
4
5
6
7

{
  "firstName": "Carmen",
  "midName": "María",
  "documentId": "11111111H",
  "documentIdCif": "11111111H",
  "language": "es_ES"
}
Name Type Required Description
firstName string true contact first name.
midName string false contact mid name.
documentId string true contact document identifier.
documentIdCif string false document identifier CIF if cutomer is a company.
language string false Client language. If not reported, by default it would be in Spanish (es_ES). ISO 639-1 Standard and ISO 3166-1 Standard

CreateTaskAppointment

 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

{
  "workOrderId": "MYSIM_391588",
  "sellChannel": "mysim",
  "userRole": 10,
  "segment": "Residencial",
  "tenantId": 16,
  "customer": {
    "firstName": "Carmen",
    "middleName": "Pérez Medina",
    "documentNumber": "12345678T",
    "email": "test@pe.es",
    "phoneNumber": 686201221,
    "zipcode": 28036,
    "language": "es_ES"
  },
  "scoringResult": "RISK",
  "scoringLevel": 1,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "timeZone": "TIME_ZONE_1",
  "gescalId": "01000500059400011 001B",
  "note": [
    {
      "author": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "text": "string"
    }
  ],
  "duration": 80,
  "ctoPoleDB": "POSTE",
  "orderType": "Alta FTTH + VOIP",
  "connectionInstallationFlow": "INSTALA MM",
  "donorOperator": 833,
  "linkState": "V"
}
Name Type Required Description
workOrderId string true work order identifier. When the value is known for yoigo It is necessary to add letter “Y” in the orderWorkId, in entry parameters of iframe for example Y360852 for other CRM as MYSIM or HEOS (pepephone), the curent prefix already used as MYSIM_ , WD_ or PP
sellChannel string true sell channel.
userRole string true user role.
segment string true segment.
tenantId string false tenant identifier.
customer Customer true none
scoringResult string true scoring result.
scoringLevel string true it is the risk level of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems.
startDate string(date) false start date. The format is yyyy-MM-dd.
endDate string(date) false end date. The format is yyyy-MM-dd.
timeZone string false time zone.
gescalId string false gescal 37 identifier.
note [Note] true item to highlight certain aspects of the appointment.
duration string false calculation duration.
ctoPoleDB string false cto database response.
orderType string false order type.
connectionInstallationFlow string false connection installation flow.
donorOperator string false donor operator.
linkState string false link state.
Property Values
scoringResult one of [OK, RELEASE, RISK, A, R]
timeZone one of [TIME_ZONE_1, TIME_ZONE_2, TIME_ZONE_3, TIME_ZONE_4]
ctoPoleDB one of [POSTE, POSTE H, NO POSTE]

BackendException

1
2
3
4
5
6

{
  "code": 400,
  "status": "BAD_REQUEST",
  "message": "Bad Request",
  "detailMsg": "The [category] attribute is required."
}
Name Type Required Description
code string false error code.
status string false error status.
message string false error message.
detailMsg string false error message obtained in the response.
Schemas