Imported data
Bearer apiKey | Resource | Description |
|---|---|
| Appointments | Appointment management API to be able to carry out the installation of resources to the client |
| Appointments Extension | It's an API extension to facilitate the creation of appointments |
Bearer apiKey | Resource | Description |
|---|---|
| Appointments | Appointment management API to be able to carry out the installation of resources to the client |
| Appointments Extension | It's an API extension to facilitate the creation of appointments |
Request to create appointment in FSM
PATH PARAMETERS
tenant name
{
"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": "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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | string | Used to categorize the order from a business perspective that can be useful for the OM system | ||||||||||||||||||||||||||||||||||||||||||||||||||||
contactMedium | object[] | contactMedium | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | free-text description firestorehe Appointment | ||||||||||||||||||||||||||||||||||||||||||||||||||||
externalId | string | ID given by the consumer (to facilitate searches afterwards) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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 | object[] | note | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedEntity | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||
validFor | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Appointment response
{
"category": "installation",
"contactMedium": [
{
"characteristic": {
"key": "mobile",
"value": 33650981065
},
"mediumType": "phoneNumber",
"preferred": true
},
{
"characteristic": {
"key": "mobile",
"value": 33650232065
},
"mediumType": "phoneNumber"
}
],
"creationDate": "2025-01-15T10:30:00Z",
"description": "Tarea para conseguir una cita",
"externalId": "MYSIM_391588",
"id": "MYSIM_391588",
"lastUpdate": "2025-01-15T10:30:00Z",
"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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | string | Used to categorize the order from a business perspective that can be useful for the OM system | ||||||||||||||||||||||||||||||||||||||||||||||||||||
contactMedium | object[] | contactMedium | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
creationDate | string (date-time) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | free-text description firestorehe Appointment | ||||||||||||||||||||||||||||||||||||||||||||||||||||
externalId | string | ID given by the consumer (to facilitate searches afterwards) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
note | object[] | note | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedEntity | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||
validFor | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Error response
{
"componentMsg": "ID MYSIM_6922893 not exists",
"id": "MM0000002",
"msg": "Resource not found",
"status": 404
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
componentMsg | string | Detailed error message | ||
id | string | Error identifier | ||
msg | string | Generic error message | ||
status | integer (int64) | HTTP error code |
curl -X POST 'https://appointments.sta.masstack.com/v1/orgs/masmovil/appointments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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": "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"
}
}'Request with information of period of installation
PATH PARAMETERS
tenant name
{
"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": "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"
}
]
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | 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 | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestedTimeSlot | object[] | requestedTimeSlot | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK SearchsTimeSlots response
{
"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": "2025-01-15T10:30:00Z",
"searchResult": "success",
"status": "created"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
availableTimeSlot | object[] | availableTimeSlot | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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 | object[] | related entity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestedTimeSlot | object[] | requestedTimeSlot | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
searchDate | string (date-time) | Date when the order was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
searchResult | string | Information on the result of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Error response
{
"componentMsg": "ID MYSIM_6922893 not exists",
"id": "MM0000002",
"msg": "Resource not found",
"status": 404
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
componentMsg | string | Detailed error message | ||
id | string | Error identifier | ||
msg | string | Generic error message | ||
status | integer (int64) | HTTP error code |
curl -X POST 'https://appointments.sta.masstack.com/v1/orgs/masmovil/appointments/searchTimeSlot' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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": "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"
}
]
}
}
]
}'Request to get appointment in FSM
PATH PARAMETERS
tenant name
a id
OK Appointment response
{
"category": "installation",
"contactMedium": [
{
"characteristic": {
"key": "mobile",
"value": 33650981065
},
"mediumType": "phoneNumber",
"preferred": true
},
{
"characteristic": {
"key": "mobile",
"value": 33650232065
},
"mediumType": "phoneNumber"
}
],
"creationDate": "2025-01-15T10:30:00Z",
"description": "Tarea para conseguir una cita",
"externalId": "MYSIM_391588",
"id": "MYSIM_391588",
"lastUpdate": "2025-01-15T10:30:00Z",
"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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | string | Used to categorize the order from a business perspective that can be useful for the OM system | ||||||||||||||||||||||||||||||||||||||||||||||||||||
contactMedium | object[] | contactMedium | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
creationDate | string (date-time) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | free-text description firestorehe Appointment | ||||||||||||||||||||||||||||||||||||||||||||||||||||
externalId | string | ID given by the consumer (to facilitate searches afterwards) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
note | object[] | note | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedEntity | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||
validFor | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Error response
{
"componentMsg": "ID MYSIM_6922893 not exists",
"id": "MM0000002",
"msg": "Resource not found",
"status": 404
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
componentMsg | string | Detailed error message | ||
id | string | Error identifier | ||
msg | string | Generic error message | ||
status | integer (int64) | HTTP error code |
curl -X GET 'https://appointments.sta.masstack.com/v1/orgs/masmovil/appointments/MYSIM_391588' \
-H 'Accept: application/json'Request to update appointment in FSM
PATH PARAMETERS
tenant name
a id
{
"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": "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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | string | Used to categorize the order from a business perspective that can be useful for the OM system | ||||||||||||||||||||||||||||||||||||||||||||||||||||
contactMedium | object[] | contactMedium | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | free-text description firestorehe Appointment | ||||||||||||||||||||||||||||||||||||||||||||||||||||
externalId | string | ID given by the consumer (to facilitate searches afterwards) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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 | object[] | note | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedEntity | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||
validFor | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Appointment response
{
"category": "installation",
"contactMedium": [
{
"characteristic": {
"key": "mobile",
"value": 33650981065
},
"mediumType": "phoneNumber",
"preferred": true
},
{
"characteristic": {
"key": "mobile",
"value": 33650232065
},
"mediumType": "phoneNumber"
}
],
"creationDate": "2025-01-15T10:30:00Z",
"description": "Tarea para conseguir una cita",
"externalId": "MYSIM_391588",
"id": "MYSIM_391588",
"lastUpdate": "2025-01-15T10:30:00Z",
"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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | string | Used to categorize the order from a business perspective that can be useful for the OM system | ||||||||||||||||||||||||||||||||||||||||||||||||||||
contactMedium | object[] | contactMedium | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
creationDate | string (date-time) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | free-text description firestorehe Appointment | ||||||||||||||||||||||||||||||||||||||||||||||||||||
externalId | string | ID given by the consumer (to facilitate searches afterwards) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
note | object[] | note | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedEntity | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||
validFor | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Error response
{
"componentMsg": "ID MYSIM_6922893 not exists",
"id": "MM0000002",
"msg": "Resource not found",
"status": 404
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
componentMsg | string | Detailed error message | ||
id | string | Error identifier | ||
msg | string | Generic error message | ||
status | integer (int64) | HTTP error code |
curl -X PATCH 'https://appointments.sta.masstack.com/v1/orgs/masmovil/appointments/MYSIM_391588' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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": "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"
}
}'PATH PARAMETERS
tenant name
create appointment request.
{
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
workOrderId* | string | 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 | used to categorize the order from a business perspective that can be useful for the OM system. | ||||||||||||||||||||||||||||||||||||||||||
sellChannel* | string | seller chanel. | ||||||||||||||||||||||||||||||||||||||||||
userRole* | string | role played by the user. | ||||||||||||||||||||||||||||||||||||||||||
userCode | string | user code. | ||||||||||||||||||||||||||||||||||||||||||
segment* | string | segment. | ||||||||||||||||||||||||||||||||||||||||||
tenantId | string | tenant identifier. | ||||||||||||||||||||||||||||||||||||||||||
customer* | object | |||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
scoringResult* | string
()
OKRELEASERISKAR | 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 | it is the risk level of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems. | pattern: ^[0-9]+$ | |||||||||||||||||||||||||||||||||||||||||
validFor* | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
gescalId | string | gescal 37 identifier. | ||||||||||||||||||||||||||||||||||||||||||
duration* | string | calculation duration. | pattern: ^\d+$ | |||||||||||||||||||||||||||||||||||||||||
ctoPoleDB | string
()
POSTEPOSTE HNO POSTE | cto database response. | ||||||||||||||||||||||||||||||||||||||||||
orderType | string | order type. | ||||||||||||||||||||||||||||||||||||||||||
connectionInstallationFlow | string | connection installation flow. | ||||||||||||||||||||||||||||||||||||||||||
donorOperator | string | donor operator. | ||||||||||||||||||||||||||||||||||||||||||
linkState | string | link state. | ||||||||||||||||||||||||||||||||||||||||||
Created appointment created successfully.
{
"category": "installation",
"contactMedium": [
{
"characteristic": {
"key": "mobile",
"value": 33650981065
},
"mediumType": "phoneNumber",
"preferred": true
},
{
"characteristic": {
"key": "mobile",
"value": 33650232065
},
"mediumType": "phoneNumber"
}
],
"creationDate": "2025-01-15T10:30:00Z",
"description": "Tarea para conseguir una cita",
"externalId": "MYSIM_391588",
"id": "MYSIM_391588",
"lastUpdate": "2025-01-15T10:30:00Z",
"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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | string | Used to categorize the order from a business perspective that can be useful for the OM system | ||||||||||||||||||||||||||||||||||||||||||||||||||||
contactMedium | object[] | contactMedium | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
creationDate | string (date-time) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | free-text description firestorehe Appointment | ||||||||||||||||||||||||||||||||||||||||||||||||||||
externalId | string | ID given by the consumer (to facilitate searches afterwards) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
note | object[] | note | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedEntity | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||
validFor | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request bad request
{
"code": 400,
"status": "BAD_REQUEST",
"message": "Bad Request",
"detailMsg": "The [category] attribute is required."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | error code. | ||
status | string | error status. | ||
message | string | error message. | ||
detailMsg | string | error message obtained in the response. |
Conflict conflict
{
"code": 400,
"status": "BAD_REQUEST",
"message": "Bad Request",
"detailMsg": "The [category] attribute is required."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | error code. | ||
status | string | error status. | ||
message | string | error message. | ||
detailMsg | string | error message obtained in the response. |
curl -X POST 'https://appointments.sta.masstack.com/v1/orgs/:org/ext/appointments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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"
}'PATH PARAMETERS
tenant name
update appointment request
{
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
tenantId | string | tenant identifier. | ||||||||||||||||||||||||||||||||||||||||||
workOrderId* | string | 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
()
OKRELEASERISKAR | scoring result. | ||||||||||||||||||||||||||||||||||||||||||
scoringLevel | string | it is the risk level of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems. | pattern: ^[0-9]+$ | |||||||||||||||||||||||||||||||||||||||||
sellChannel | string | sell channel. | ||||||||||||||||||||||||||||||||||||||||||
userRole | string | user role. | ||||||||||||||||||||||||||||||||||||||||||
userCode | string | user code. | ||||||||||||||||||||||||||||||||||||||||||
segment | string | apointment segment. | ||||||||||||||||||||||||||||||||||||||||||
duration* | string | calculation duration. | pattern: ^\d+$ | |||||||||||||||||||||||||||||||||||||||||
customer | object | |||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
validFor* | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
ctoPoleDB | string
()
POSTEPOSTE HNO POSTE | cto database response. | ||||||||||||||||||||||||||||||||||||||||||
orderType | string | order type. | ||||||||||||||||||||||||||||||||||||||||||
connectionInstallationFlow | string | connection installation flow. | ||||||||||||||||||||||||||||||||||||||||||
donorOperator | string | donor operator. | ||||||||||||||||||||||||||||||||||||||||||
linkState | string | link state. | ||||||||||||||||||||||||||||||||||||||||||
OK appointment updated successfully.
{
"category": "installation",
"contactMedium": [
{
"characteristic": {
"key": "mobile",
"value": 33650981065
},
"mediumType": "phoneNumber",
"preferred": true
},
{
"characteristic": {
"key": "mobile",
"value": 33650232065
},
"mediumType": "phoneNumber"
}
],
"creationDate": "2025-01-15T10:30:00Z",
"description": "Tarea para conseguir una cita",
"externalId": "MYSIM_391588",
"id": "MYSIM_391588",
"lastUpdate": "2025-01-15T10:30:00Z",
"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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | string | Used to categorize the order from a business perspective that can be useful for the OM system | ||||||||||||||||||||||||||||||||||||||||||||||||||||
contactMedium | object[] | contactMedium | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
creationDate | string (date-time) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | free-text description firestorehe Appointment | ||||||||||||||||||||||||||||||||||||||||||||||||||||
externalId | string | ID given by the consumer (to facilitate searches afterwards) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
note | object[] | note | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedEntity | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||
validFor | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request bad request
{
"code": 400,
"status": "BAD_REQUEST",
"message": "Bad Request",
"detailMsg": "The [category] attribute is required."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | error code. | ||
status | string | error status. | ||
message | string | error message. | ||
detailMsg | string | error message obtained in the response. |
Not Found Not found.
curl -X PUT 'https://appointments.sta.masstack.com/v1/orgs/:org/ext/appointments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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"
}'PATH PARAMETERS
tenant name
send to search time slots request
{
"action": "MODIFICARCITA",
"scoringLevel": 0,
"scoringResult": "OK",
"segment": "RESIDENTIAL",
"gescal": "28000010025000026 002D",
"category": "installation",
"orderWorkId": "MYSIM_123456",
"accessToken": "147hytr",
"relatedParty": {
"tenant": "masmovil",
"donorOperator": "00008",
"creationDate": "2025-01-15T10:30:00Z",
"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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
action | string | the two actions that the component allows are NUEVACITA | MODIFICARCITA. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
scoringLevel | string | It is the risk level of customer fraud | ||||||||||||||||||||||||||||||||||||||||||||||||||||
scoringResult | string | It is the overall risk value of customer fraud. Allowed values are: OK, RELEASE, RISK, A, R | ||||||||||||||||||||||||||||||||||||||||||||||||||||
segment | string | apointment segment. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
gescal | string | gescal 37. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
category* | string | used to categorize the order from a business perspective that can be useful for the OM system. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
orderWorkId* | string | order work identifier. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
accessToken | string | access token. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
productSpecification | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
contact | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK search time slots response
{
"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": "2025-01-15T10:30:00Z",
"searchResult": "success",
"status": "created"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
availableTimeSlot | object[] | availableTimeSlot | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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 | object[] | related entity. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestedTimeSlot | object[] | requestedTimeSlot | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
searchDate | string (date-time) | Date when the order was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
searchResult | string | Information on the result of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request bad request
{
"code": 400,
"status": "BAD_REQUEST",
"message": "Bad Request",
"detailMsg": "The [category] attribute is required."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | error code. | ||
status | string | error status. | ||
message | string | error message. | ||
detailMsg | string | error message obtained in the response. |
curl -X POST 'https://appointments.sta.masstack.com/v1/orgs/:org/ext/searchTimeSlots' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"action": "MODIFICARCITA",
"scoringLevel": 0,
"scoringResult": "OK",
"segment": "RESIDENTIAL",
"gescal": "28000010025000026 002D",
"category": "installation",
"orderWorkId": "MYSIM_123456",
"accessToken": "147hytr",
"relatedParty": {
"tenant": "masmovil",
"donorOperator": "00008",
"creationDate": "2025-01-15T10:30:00Z",
"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"
}
}'PATH PARAMETERS
tenant name
create task appointment request
{
"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": "string",
"endDate": "string",
"timeZone": "TIME_ZONE_1",
"gescalId": "01000500059400011 001B",
"note": [
{
"author": "string",
"date": "2025-01-15T10:30:00Z",
"id": "string",
"text": "string"
}
],
"duration": 80,
"ctoPoleDB": "POSTE",
"orderType": "Alta FTTH + VOIP",
"connectionInstallationFlow": "INSTALA MM",
"donorOperator": 833,
"linkState": "V"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
workOrderId* | string | 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 | sell channel. | ||||||||||||||||||||||||||||||||||||||||||
userRole* | string | user role. | ||||||||||||||||||||||||||||||||||||||||||
segment* | string | segment. | ||||||||||||||||||||||||||||||||||||||||||
tenantId | string | tenant identifier. | ||||||||||||||||||||||||||||||||||||||||||
customer* | object | |||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
scoringResult* | string
()
OKRELEASERISKAR | scoring result. | ||||||||||||||||||||||||||||||||||||||||||
scoringLevel* | string | it is the risk level of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems. | pattern: ^[0-9]+$ | |||||||||||||||||||||||||||||||||||||||||
startDate | string (date) | start date. The format is yyyy-MM-dd. | ||||||||||||||||||||||||||||||||||||||||||
endDate | string (date) | end date. The format is yyyy-MM-dd. | ||||||||||||||||||||||||||||||||||||||||||
timeZone | string
()
TIME_ZONE_1TIME_ZONE_2TIME_ZONE_3TIME_ZONE_4 | time zone. | ||||||||||||||||||||||||||||||||||||||||||
gescalId | string | gescal 37 identifier. | ||||||||||||||||||||||||||||||||||||||||||
note* | object[] | item to highlight certain aspects of the appointment. | ||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
duration | string | calculation duration. | pattern: ^\d+$ | |||||||||||||||||||||||||||||||||||||||||
ctoPoleDB | string
()
POSTEPOSTE HNO POSTE | cto database response. | ||||||||||||||||||||||||||||||||||||||||||
orderType | string | order type. | ||||||||||||||||||||||||||||||||||||||||||
connectionInstallationFlow | string | connection installation flow. | ||||||||||||||||||||||||||||||||||||||||||
donorOperator | string | donor operator. | ||||||||||||||||||||||||||||||||||||||||||
linkState | string | link state. | ||||||||||||||||||||||||||||||||||||||||||
OK Deployment province response
{
"category": "installation",
"contactMedium": [
{
"characteristic": {
"key": "mobile",
"value": 33650981065
},
"mediumType": "phoneNumber",
"preferred": true
},
{
"characteristic": {
"key": "mobile",
"value": 33650232065
},
"mediumType": "phoneNumber"
}
],
"creationDate": "2025-01-15T10:30:00Z",
"description": "Tarea para conseguir una cita",
"externalId": "MYSIM_391588",
"id": "MYSIM_391588",
"lastUpdate": "2025-01-15T10:30:00Z",
"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"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
category | string | Used to categorize the order from a business perspective that can be useful for the OM system | ||||||||||||||||||||||||||||||||||||||||||||||||||||
contactMedium | object[] | contactMedium | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
creationDate | string (date-time) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | free-text description firestorehe Appointment | ||||||||||||||||||||||||||||||||||||||||||||||||||||
externalId | string | ID given by the consumer (to facilitate searches afterwards) | ||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | 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) | Date when the appointment was created Format: time | ||||||||||||||||||||||||||||||||||||||||||||||||||||
note | object[] | note | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedEntity | object[] | related entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedParty | object[] | related party | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
relatedPlace | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
resourceOrderItem | object[] | resourceOrderItem | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string | The life cycle state of the resource | ||||||||||||||||||||||||||||||||||||||||||||||||||||
validFor | object | RangePeriod reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request bad request
{
"code": 400,
"status": "BAD_REQUEST",
"message": "Bad Request",
"detailMsg": "The [category] attribute is required."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | string | error code. | ||
status | string | error status. | ||
message | string | error message. | ||
detailMsg | string | error message obtained in the response. |
curl -X POST 'https://appointments.sta.masstack.com/v1/orgs/:org/ext/task' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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": "string",
"endDate": "string",
"timeZone": "TIME_ZONE_1",
"gescalId": "01000500059400011 001B",
"note": [
{
"author": "string",
"date": "2025-01-15T10:30:00Z",
"id": "string",
"text": "string"
}
],
"duration": 80,
"ctoPoleDB": "POSTE",
"orderType": "Alta FTTH + VOIP",
"connectionInstallationFlow": "INSTALA MM",
"donorOperator": 833,
"linkState": "V"
}'