API Overview Resources Schemas

Schemas

AppointmentRef

1
2
3
4
5


{
  "description": "string",
  "href": "string",
  "id": "string"
}

Name	Type	Required	Description
description	string	false	An explanatory text regarding the appointment made with a party
href	string	false	The reference of the appointment
id	string	true	The identifier of the referred appointment

AttachmentRefOrValue

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "attachmentType": "string",
  "description": "string",
  "href": "string",
  "id": "string",
  "isRef": true,
  "mimeType": "string",
  "name": "string",
  "size": {
    "amount": 0.1,
    "units": "string"
  },
  "url": "string",
  "validFor": {
    "endDateTime": "2019-08-24T14:15:22Z",
    "startDateTime": "2019-08-24T14:15:22Z"
  }
}

Name	Type	Required	Description
attachmentType	string	false	Attachment type such as video, picture
description	string	false	A narrative text describing the content of the attachment
href	string	false	URI for this Attachment
id	string	false	Unique identifier for this particular attachment
isRef	boolean	false	is ref
mimeType	string	false	Attachment mime type such as extension file for video, picture and document
name	string	false	The name of the attachment
size	Quantity	false	Quantity An amount in a given unit
url	string	false	Uniform Resource Locator, is a web page address (a subset of URI)
validFor	TimePeriod	false	TimePeriod A period of time, either as a deadline (endDateTime only) a startDateTime only, or both

CalculateInstallation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "category": "installation",
  "connectionInstallationFlow": "INSTALA_MM",
  "creationDate": "2019-08-24T14:15:22Z",
  "documentId": "B02214559",
  "donorOperator": "00008",
  "externalId": "MYSIM_123456",
  "linkState": "V",
  "orderType": "Alta FTTH + VOIP",
  "originAccessIsExternal": false,
  "poleInfo": false,
  "postalCode": "28860",
  "scoringLevel": 1,
  "scoringResult": "RISK",
  "userCode": "Code01",
  "userProfile": "Profile01"
}

Name	Type	Required	Description
category	string	true	Used to categorize the order from a business perspective that can be useful for the OM system
connectionInstallationFlow	string	false	Information of the commit installer (INSTALA_TESA, INSTALA_MM)
creationDate	string(date-time)	true	Provision start date information
documentId	string	false	Contract document identifier to identify if it’s a cableoperator
donorOperator	string	false	Donor operator information
externalId	string	true	ID given by the consumer (to facilitate searches afterwards)
linkState	string	false	Information on the Busy Pair (PO) of the NEBA fiber
orderType	string	true	Installation order type information
originAccessIsExternal	boolean	true	New numbering sales information with external access origin and without transfer of access
poleInfo	boolean	true	Pole information
postalCode	string	true	Information of the postal code of the order
scoringLevel	integer(int8)	true	It’s the risk level of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems
scoringResult	string	true	It’s the overall risk value of customer fraud. This value for TMS-YOIGO comes from ROVE interface, other CRM have differents fraud systems
userCode	string	false	User code information of who is requesting the appointment
userProfile	string	false	User profile information (only for redirects from FSM)

CalculateInstallationResponse

1
2
3
4
5


{
  "contract": "YMO/B2B",
  "delay": "14",
  "duration": "60"
}

Name	Type	Required	Description
contract	string	true	It is the result of the contract
delay	string	true	It is the result of the delay. Result expressed in number of fringes
duration	string	true	It is the result of the duration. Expressed in minutes

Characteristic

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "characteristicRelationship": [
    {
      "id": "string",
      "relationshipType": "string"
    }
  ],
  "id": "string",
  "name": "string",
  "value": "string"
}

Name	Type	Required	Description
characteristicRelationship	[CharacteristicRelationship]	false	characteristic relationship
id	string	false	Unique identifier of the characteristic
name	string	true	Name of the characteristic
value	string	true	The value of the characteristic

CharacteristicRelationship

1
2
3
4


{
  "id": "string",
  "relationshipType": "string"
}

Name	Type	Required	Description
id	string	false	Unique identifier of the characteristic
relationshipType	string	false	The type of relationship

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": "user@masmovil.com",
  "date": "2019-08-24T14:15:22Z",
  "id": "0181b9de-2a43-40cb-a2fc-ca58b62f4658",
  "text": "A comment"
}

Name	Type	Required	Description
author	string	true	Author of the note
date	string(date-time)	true	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	true	Text of the note

OrderRelationship

1
2
3
4
5


{
  "id": "string",
  "name": "string",
  "type": "string"
}

Name	Type	Required	Description
id	string	true	Unique identifier of a related entity.
name	string	false	Name of the related entity.
type	string	false	Role played by the related party

Quantity

1
2
3
4


{
  "amount": 0.1,
  "units": "string"
}

Name	Type	Required	Description
amount	number(float)	false	Numeric value in a given unit
units	string	false	Unit

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

Resource

  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


{
  "attachment": [
    {
      "attachmentType": "string",
      "description": "string",
      "href": "string",
      "id": "string",
      "isRef": true,
      "mimeType": "string",
      "name": "string",
      "size": {
        "amount": 0.1,
        "units": "string"
      },
      "url": "string",
      "validFor": {
        "endDateTime": "2019-08-24T14:15:22Z",
        "startDateTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "category": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "note": [
    {
      "author": "user@masmovil.com",
      "date": "2019-08-24T14:15:22Z",
      "id": "0181b9de-2a43-40cb-a2fc-ca58b62f4658",
      "text": "A comment"
    }
  ],
  "resourceCharacteristic": [
    {
      "characteristicRelationship": [
        {
          "id": "string",
          "relationshipType": "string"
        }
      ],
      "id": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "resourceRelationship": [
    {
      "resource": {
        "action": "string",
        "appointment": {
          "description": "string",
          "href": "string",
          "id": "string"
        },
        "description": "string",
        "href": "string",
        "id": "string",
        "resource": {
          "attachment": [
            {
              "attachmentType": "string",
              "description": "string",
              "href": "string",
              "id": "string",
              "isRef": true,
              "mimeType": "string",
              "name": "string",
              "size": {
                "amount": 0.1,
                "units": "string"
              },
              "url": "string",
              "validFor": {
                "endDateTime": "2019-08-24T14:15:22Z",
                "startDateTime": "2019-08-24T14:15:22Z"
              }
            }
          ],
          "category": "string",
          "description": "string",
          "id": "string",
          "name": "string",
          "note": [
            {
              "author": "user@masmovil.com",
              "date": "2019-08-24T14:15:22Z",
              "id": "0181b9de-2a43-40cb-a2fc-ca58b62f4658",
              "text": "A comment"
            }
          ],
          "resourceCharacteristic": [
            {
              "characteristicRelationship": [
                {
                  "id": "string",
                  "relationshipType": "string"
                }
              ],
              "id": "string",
              "name": "string",
              "value": "string"
            }
          ],
          "resourceRelationship": [],
          "resourceVersion": "string"
        },
        "state": "string",
        "ticketingSection": {
          "category": "Datos",
          "process": "Incidencia",
          "subcategory": "Dirección Incorrecta"
        }
      },
      "type": "string"
    }
  ],
  "resourceVersion": "string"
}

Name	Type	Required	Description
attachment	[AttachmentRefOrValue]	false	attachment
category	string	false	Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource
description	string	false	free-text description of the resource
id	string	false	Identifier of the resource
name	string	false	A string used to give a name to the resource
note	[Note]	false	note
resourceCharacteristic	[Characteristic]	false	resource characteristic
resourceRelationship	[ResourceRelationship]	false	resource relationship
resourceVersion	string	false	A field that identifies the specific version of an instance of a resource.

ResourceOrder

  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


{
  "category": "installation",
  "completionDate": "2019-08-24T14:15:22Z",
  "description": "Mysim Resources",
  "externalId": "MYSIM_XXXX",
  "id": "MYSIM_XXXX",
  "name": "MIG_COM",
  "note": [
    {
      "author": "name",
      "date": "2023-04-12T16:42:23Z",
      "text": "A free text detailing the note"
    }
  ],
  "orderDate": "2019-08-24T14:15:22Z",
  "orderRelationship": [
    {
      "id": "MYSIM_AGILETV_TEST",
      "type": "cross-ref"
    }
  ],
  "priority": 2,
  "relatedParty": [
    {
      "id": "Jose Maria",
      "role": "firstName"
    },
    {
      "id": "Pérez Martínez",
      "role": "middleName"
    },
    {
      "id": "08946786Q",
      "role": "documentNumber"
    },
    {
      "id": "jose1965@gmail.com",
      "role": "email"
    },
    {
      "id": "626666666",
      "role": "phoneNumber"
    },
    {
      "id": "28013",
      "role": "zipcode"
    },
    {
      "id": "mysim",
      "role": "sellchannel"
    },
    {
      "id": "mysim",
      "role": "seller"
    },
    {
      "id": "Residencial",
      "role": "segment"
    },
    {
      "id": "2",
      "role": "tenant"
    },
    {
      "id": "es_ES",
      "role": "language"
    }
  ],
  "resourceOrderItem": [
    {
      "action": "add",
      "id": "02e82ded-5b94-ea11-a811-000d3ab9bba9",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "FTTH"
          },
          {
            "name": "territoryOwner",
            "value": "NEBA"
          }
        ]
      },
      "state": "InProgress"
    },
    {
      "action": "add",
      "id": "f7e72ded-5b94-ea11-a811-000d3ab9bba9",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "STB"
          },
          {
            "name": "model",
            "value": "Oxygen 101 S"
          }
        ]
      },
      "state": "InProgress"
    },
    {
      "action": "add",
      "id": "ffe72ded-5b94-ea11-a811-000d3ab9bba9",
      "resource": {
        "resourceCharacteristic": [
          {
            "name": "type",
            "value": "MOBILE_LINE"
          },
          {
            "name": "sim_type",
            "value": "SIM"
          },
          {
            "name": "tariff",
            "value": "2003"
          },
          {
            "name": "line",
            "value": "new_number"
          }
        ]
      },
      "state": "InProgress"
    }
  ],
  "startDate": "2019-08-24T14:15:22Z",
  "state": "Acknowledged",
  "substate": "A definir por FSM",
  "ticketingSection": {
    "category": "Datos",
    "process": "Incidencia",
    "subcategory": "Dirección Incorrecta"
  },
  "type": "Alta FTTH + VOIP"
}

Name	Type	Required	Description
category	string	false	Used to categorize the order from a business perspective that can be useful for the OM system
completionDate	string(date-time)	false	Date when the order was completed Format: time
description	string	false	free-text description firestorehe Resource Order
externalId	string	false	ID given by the consumer (to facilitate searches afterwards)
id	string	false	Identifier of an instance of the Resource Order. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type
name	string	false	A string used to give a name to the Resource Order
note	[Note]	false	note
orderDate	string(date-time)	false	Date when the order was created Format: time
orderRelationship	[OrderRelationship]	false	orderRelationship
priority	integer(int64)	false	A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)
relatedParty	[RelatedParty]	false	related party
resourceOrderItem	[ResourceOrderItem]	false	resourceOrderItem
startDate	string(date-time)	false	Date when the order was actually started Format: time
state	string	false	The life cycle state of the resource
substate	string	false	The life cycle substate of the resource
ticketingSection	TicketingSection	false	TicketingSection information for managing the opening of incidents in +Ticketing
type	string	false	Name of the Resource Order type

ResourceOrderItem

 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


{
  "action": "string",
  "appointment": {
    "description": "string",
    "href": "string",
    "id": "string"
  },
  "description": "string",
  "href": "string",
  "id": "string",
  "resource": {
    "attachment": [
      {
        "attachmentType": "string",
        "description": "string",
        "href": "string",
        "id": "string",
        "isRef": true,
        "mimeType": "string",
        "name": "string",
        "size": {
          "amount": 0.1,
          "units": "string"
        },
        "url": "string",
        "validFor": {
          "endDateTime": "2019-08-24T14:15:22Z",
          "startDateTime": "2019-08-24T14:15:22Z"
        }
      }
    ],
    "category": "string",
    "description": "string",
    "id": "string",
    "name": "string",
    "note": [
      {
        "author": "user@masmovil.com",
        "date": "2019-08-24T14:15:22Z",
        "id": "0181b9de-2a43-40cb-a2fc-ca58b62f4658",
        "text": "A comment"
      }
    ],
    "resourceCharacteristic": [
      {
        "characteristicRelationship": [
          {
            "id": "string",
            "relationshipType": "string"
          }
        ],
        "id": "string",
        "name": "string",
        "value": "string"
      }
    ],
    "resourceRelationship": [
      {
        "resource": {
          "action": "string",
          "appointment": {
            "description": "string",
            "href": "string",
            "id": "string"
          },
          "description": "string",
          "href": "string",
          "id": "string",
          "resource": {},
          "state": "string",
          "ticketingSection": {
            "category": "Datos",
            "process": "Incidencia",
            "subcategory": "Dirección Incorrecta"
          }
        },
        "type": "string"
      }
    ],
    "resourceVersion": "string"
  },
  "state": "string",
  "ticketingSection": {
    "category": "Datos",
    "process": "Incidencia",
    "subcategory": "Dirección Incorrecta"
  }
}

Name	Type	Required	Description
action	string	false	Can be “add” / “modify” / “no_change”/ “delete”/ “picking”/ “picked”/ “unpicking”/ “unpicked”
appointment	AppointmentRef	false	AppointmentRef Refers an appointment, such as a Customer presentation or internal meeting or site visit
description	string	false	free-text description of the Resource Order Item
href	string	false	The URI for the object itself.
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
state	string	false	State of the order item : described in the state machine diagram
ticketingSection	TicketingSection	false	TicketingSection information for managing the opening of incidents in +Ticketing

ResourceRelationship

 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


{
  "resource": {
    "action": "string",
    "appointment": {
      "description": "string",
      "href": "string",
      "id": "string"
    },
    "description": "string",
    "href": "string",
    "id": "string",
    "resource": {
      "attachment": [
        {
          "attachmentType": "string",
          "description": "string",
          "href": "string",
          "id": "string",
          "isRef": true,
          "mimeType": "string",
          "name": "string",
          "size": {
            "amount": 0.1,
            "units": "string"
          },
          "url": "string",
          "validFor": {
            "endDateTime": "2019-08-24T14:15:22Z",
            "startDateTime": "2019-08-24T14:15:22Z"
          }
        }
      ],
      "category": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "note": [
        {
          "author": "user@masmovil.com",
          "date": "2019-08-24T14:15:22Z",
          "id": "0181b9de-2a43-40cb-a2fc-ca58b62f4658",
          "text": "A comment"
        }
      ],
      "resourceCharacteristic": [
        {
          "characteristicRelationship": [
            {
              "id": "string",
              "relationshipType": "string"
            }
          ],
          "id": "string",
          "name": "string",
          "value": "string"
        }
      ],
      "resourceRelationship": [
        {
          "resource": {},
          "type": "string"
        }
      ],
      "resourceVersion": "string"
    },
    "state": "string",
    "ticketingSection": {
      "category": "Datos",
      "process": "Incidencia",
      "subcategory": "Dirección Incorrecta"
    }
  },
  "type": "string"
}

Name	Type	Required	Description
resource	ResourceOrderItem	true	none
type	string	true	relationship type

TicketingSection

1
2
3
4
5


{
  "category": "Datos",
  "process": "Incidencia",
  "subcategory": "Dirección Incorrecta"
}

Name	Type	Required	Description
category	string	true	Appointment, installation, data, commercial and closing will be indicated, these are the 5 types of incident that can be opened and that affect the installation
process	string	true	Process information. For now there will always be incidence
subcategory	string	true	Multiple values will arrive in this field. They are what we call opening reasons, which are drop-down that are shown to the technician at the installation and depend on the category, that is, each category has its own reasons and they are the ones that will arrive in this field

TimePeriod

1
2
3
4


{
  "endDateTime": "2019-08-24T14:15:22Z",
  "startDateTime": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Description
endDateTime	string(date-time)	false	End of the time period, using IETC-RFC-3339 format Format: time
startDateTime	string(date-time)	false	Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end Format: time