masstack

V1
API Overview Resources Schemas

CalculateInstallation

API for calculating the contract, delay and duration of an installation

Parameters

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

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

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


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

Responses

Code Meaning Description Schema
200 OK CalculateInstallation response CalculateInstallationResponse
400 Bad Request Error response ErrorDto
401 Unauthorized Error response ErrorDto
403 Forbidden Error response ErrorDto
405 Method Not Allowed Error response ErrorDto
409 Conflict Error response ErrorDto
500 Internal Server Error Error response ErrorDto

Endpoints

ResourceOrder

    CalculateInstallation