API Overview Resources Schemas

ResourceOrder

API for managing installation resource orders

Creates a ResourceOrder

This operation creates a ResourceOrder entity.

POST /orgs/{org}/resourceOrder

Parameters

Name	In	Type	Required	Description
org	path	string	true	tenant name
body	body	ResourceOrder	true	‘none’

Request body - instance of 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

Request example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145



curl -X POST https://installations.sta.masstack.com/v1/orgs/masmovil/resourceOrder \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: API_KEY" \
 --data-raw "{
  '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'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	ResourceOrder response	ResourceOrder
default	Default	Error response	ErrorDto

Callback of Picking, UnPicking and Swap a ResourceOrder

This operation picking, unpicking and swap a ResourceOrder entity.

POST /orgs/{org}/resourceOrder/callbackPicking

Parameters

Name	In	Type	Required	Description
org	path	string	true	tenant name
body	body	ResourceOrder	true	‘none’

Request body - instance of 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

Request example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145



curl -X POST https://installations.sta.masstack.com/v1/orgs/masmovil/resourceOrder/callbackPicking \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: API_KEY" \
 --data-raw "{
  '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'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	ResourceOrder response	ResourceOrder
default	Default	Error response	ErrorDto

Retrieves a ResourceOrder by ID

This operation retrieves a ResourceOrder entity. Attribute selection is enabled for all first level attributes.

GET /orgs/{org}/resourceOrder/{id}

Parameters

Name	In	Type	Required	Description
org	path	string	true	tenant name
id	path	string	true	a id of Resource Order

Request example

1
2
3
4
5



curl -X GET https://installations.sta.masstack.com/v1/orgs/masmovil/resourceOrder/MYSIM_XXXX \
  -H "Accept: application/json" \
  -H "Authorization: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	ResourceOrder response	ResourceOrder
default	Default	Error response	ErrorDto

Updates totally a ResourceOrder

This operation updates totally a ResourceOrder entity.

PUT /orgs/{org}/resourceOrder/{id}

Parameters

Name	In	Type	Required	Description
body	body	ResourceOrder	true	‘none’
org	path	string	true	tenant name
id	path	string	true	a id of Resource Order

Request body - instance of 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

Request example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145



curl -X PUT https://installations.sta.masstack.com/v1/orgs/masmovil/resourceOrder/MYSIM_XXXX \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: API_KEY" \
 --data-raw "{
  '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'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	ResourceOrder response	ResourceOrder
default	Default	Error response	ErrorDto

Remove work order by ID in external systems

This operation to delete fake work orders due to fraud and other issues.

DELETE /orgs/{org}/resourceOrder/{id}

Parameters

Name	In	Type	Required	Description
org	path	string	true	tenant name
id	path	string	true	a id of Resource Order

Request example

1
2
3
4
5



curl -X DELETE https://installations.sta.masstack.com/v1/orgs/masmovil/resourceOrder/MYSIM_XXXX \
  -H "Accept: application/json" \
  -H "Authorization: API_KEY"

Responses

Code	Meaning	Description	Schema
204	No Content	No Content	None
default	Default	Error response	ErrorDto

Updates partially a ResourceOrder

This operation updates partially a ResourceOrder entity.

PATCH /orgs/{org}/resourceOrder/{id}

Parameters

Name	In	Type	Required	Description
body	body	ResourceOrder	true	‘none’
org	path	string	true	tenant name
id	path	string	true	a id of Resource Order

Request body - instance of 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

Request example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145



curl -X PATCH https://installations.sta.masstack.com/v1/orgs/masmovil/resourceOrder/MYSIM_XXXX \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: API_KEY" \
 --data-raw "{
  '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'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	ResourceOrder response	ResourceOrder
default	Default	Error response	ErrorDto

Sending notes to the technician

This operation adds notes using the Note entity.

POST /orgs/{org}/resourceOrder/{id}/notes

Parameters

Name	In	Type	Required	Description
org	path	string	true	tenant name
id	path	string	true	a id of Resource Order
body	body	Note	true	‘none’

Request body - instance of 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

Request example

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



curl -X POST https://installations.sta.masstack.com/v1/orgs/masmovil/resourceOrder/MYSIM_XXXX/notes \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: API_KEY" \
 --data-raw "{
  'author': 'user@masmovil.com',
  'date': '2019-08-24T14:15:22Z',
  'id': '0181b9de-2a43-40cb-a2fc-ca58b62f4658',
  'text': 'A comment'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	No Content	None
default	Default	Error response	ErrorDto

Endpoints

ResourceOrder

CalculateInstallation