Device Insurance

Device Insurance new contract

Request a new insurance contract

POST /device-insurance/orgs/{organization}/request

Parameters

Name	In	Type	Required	Description
organization	path	string	true	Organization name
body	body	InsuranceCreationRequestDTO	true	Device Insurance DTO request

Request body - instance of InsuranceCreationRequestDTO

 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


{
  "documentId": "00000000F",
  "firstName": "juan",
  "lastName1": "perez",
  "lastName2": "perez",
  "msisdn": "666666666",
  "address": "paseo de castellana, 4, 002B",
  "email": "d@g.com",
  "zipCode": "28000",
  "locality": "madrid",
  "province": "madrid",
  "language": "allowed values: es => castellano, eu=> euskera, ga=>gallego, ca=>catalán",
  "sfid": "1234",
  "telcoBrand": "Masmovil",
  "brand": "string",
  "model": "string",
  "price": 2.2,
  "clientType": "Autónomo",
  "invoicePayment": true,
  "productType": "Móvil",
  "imei": "string",
  "terminalSaleDate": "2022-01-31T23:00:00Z",
  "entity": "string",
  "officeCode": "string",
  "dc": "string",
  "accountNumber": "string"
}

Name	Type	Required	Description
documentId	string	false	none
firstName	string	false	none
lastName1	string	false	none
lastName2	string	false	none
msisdn	string	false	none
address	string	false	none
email	string	false	none
zipCode	string	false	none
locality	string	false	none
province	string	false	none
language	string	false	none
sfid	string	false	none
telcoBrand	string	false	none
brand	string	false	none
model	string	false	none
price	number	false	none
clientType	string	false	none
invoicePayment	boolean	false	none
productType	string	false	none
imei	string	false	none
terminalSaleDate	string(date)	false	none
entity	string	false	none
officeCode	string	false	none
dc	string	false	none
accountNumber	string	false	none

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



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/device-insurance/orgs/masmovil/request \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'documentId': '00000000F',
  'firstName': 'juan',
  'lastName1': 'perez',
  'lastName2': 'perez',
  'msisdn': '666666666',
  'address': 'paseo de castellana, 4, 002B',
  'email': 'd@g.com',
  'zipCode': '28000',
  'locality': 'madrid',
  'province': 'madrid',
  'language': 'allowed values: es => castellano, eu=> euskera, ga=>gallego, ca=>catalán',
  'sfid': '1234',
  'telcoBrand': 'Masmovil',
  'brand': 'string',
  'model': 'string',
  'price': 2.2,
  'clientType': 'Autónomo',
  'invoicePayment': true,
  'productType': 'Móvil',
  'imei': 'string',
  'terminalSaleDate': '2022-01-31T23:00:00Z',
  'entity': 'string',
  'officeCode': 'string',
  'dc': 'string',
  'accountNumber': 'string'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Order created	InsuranceCreationResponseDTO
400	Bad Request	Invalid body supplied	errorResponseDtoDeviceInsurance
401	Unauthorized	Unauthorized	errorResponseDtoDeviceInsurance
403	Forbidden	Forbidden	errorResponseDtoDeviceInsurance
404	Not Found	Data not found	errorResponseDtoDeviceInsurance
406	Not Acceptable	Not Acceptable	errorResponseDtoDeviceInsurance
500	Internal Server Error	Something was wrong :(	errorResponseDtoDeviceInsurance

Device Insurance issue a contract

Request a new insurance issue

POST /device-insurance/orgs/{organization}/issue

Parameters

Name	In	Type	Required	Description
organization	path	string	true	Organization name
body	body	InsuranceIssueRequestDTO	true	Device Insurance DTO request

Request body - instance of InsuranceIssueRequestDTO

1
2
3
4
5
6
7
8


{
  "requestId": "00000000JIUSCS",
  "policyNumber": "87912HDH",
  "imei": "imei",
  "msisdn": "666666666",
  "document": "000000000K",
  "subscriptionId": "SNMC893CNIE"
}

Name	Type	Required	Description
requestId	string	false	none
policyNumber	string	false	none
imei	string	false	none
msisdn	string	false	none
document	string	false	none
subscriptionId	string	false	none

Request example

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



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/device-insurance/orgs/masmovil/issue \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'requestId': '00000000JIUSCS',
  'policyNumber': '87912HDH',
  'imei': 'imei',
  'msisdn': '666666666',
  'document': '000000000K',
  'subscriptionId': 'SNMC893CNIE'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Order created	InsuranceIssueResponseDTO
400	Bad Request	Invalid body supplied	errorResponseDtoDeviceInsurance
401	Unauthorized	Unauthorized	errorResponseDtoDeviceInsurance
403	Forbidden	Forbidden	errorResponseDtoDeviceInsurance
404	Not Found	Data not found	errorResponseDtoDeviceInsurance
406	Not Acceptable	Not Acceptable	errorResponseDtoDeviceInsurance
500	Internal Server Error	Something was wrong :(	errorResponseDtoDeviceInsurance

Device Insurance cancellation a contract

Request a new insurance cancellation

POST /device-insurance/orgs/{organization}/cancellation

Parameters

Name	In	Type	Required	Description
organization	path	string	true	Organization name
body	body	InsuranceCancellationRequestDTO	true	Device Insurance DTO request

Request body - instance of InsuranceCancellationRequestDTO

1
2
3
4
5


{
  "policyNumber": "87912HDH",
  "document": "000000000K",
  "reason": "Reason is..."
}

Name	Type	Required	Description
policyNumber	string	false	none
document	string	false	none
reason	string	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/device-insurance/orgs/masmovil/cancellation \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'policyNumber': '87912HDH',
  'document': '000000000K',
  'reason': 'Reason is...'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Order created	InsuranceCancellationResponseDTO
400	Bad Request	Invalid body supplied	errorResponseDtoDeviceInsurance
401	Unauthorized	Unauthorized	errorResponseDtoDeviceInsurance
403	Forbidden	Forbidden	errorResponseDtoDeviceInsurance
404	Not Found	Data not found	errorResponseDtoDeviceInsurance
406	Not Acceptable	Not Acceptable	errorResponseDtoDeviceInsurance
500	Internal Server Error	Something was wrong :(	errorResponseDtoDeviceInsurance

Request info about insurance contract

GET /device-insurance/orgs/{organization}/requestinfo

Parameters

Name	In	Type	Required	Description
organization	path	string	true	Organization name
document	query	string	false	Document Id
phoneNumber	query	string	false	Phone Number
insuranceNumber	query	string	false	Insurance Number

Request example

1
2
3
4



curl -X GET https://provision-master.private.dev.k8s.masmovil.com/v1/device-insurance/orgs/masmovil/requestinfo?document='string'&phoneNumber='string'&insuranceNumber='string' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Order created	[InsuranceInfoResponseDTO]
400	Bad Request	Invalid body supplied	errorResponseDtoDeviceInsurance
401	Unauthorized	Unauthorized	errorResponseDtoDeviceInsurance
403	Forbidden	Forbidden	errorResponseDtoDeviceInsurance
404	Not Found	Data not found	errorResponseDtoDeviceInsurance
406	Not Acceptable	Not Acceptable	errorResponseDtoDeviceInsurance
500	Internal Server Error	Something was wrong :(	errorResponseDtoDeviceInsurance

200 - instance of InsuranceInfoResponseDTO

Custom schema 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


[
  {
    "certificateNumber": "string",
    "imei": "string",
    "brand": {
      "name": "string"
    },
    "model": {
      "description": "string"
    },
    "phoneNumber": "string",
    "document": "string",
    "firstName": "string",
    "lastName1": "string",
    "lastName2": "string",
    "address": "string",
    "number": "string",
    "city": "string",
    "zipCode": "string",
    "policyNumber": "string",
    "province": "string",
    "effectiveDate": "2022-01-31T23:00:00Z",
    "email": "string",
    "sold": true,
    "cancelled": true,
    "cancellationDate": "2022-01-31T23:00:00Z",
    "serialNumber": "string",
    "paymentMethod": {
      "description": "string"
    },
    "clientType": {
      "name": "string"
    },
    "billPayment": true,
    "withdrawal": true,
    "withdrawalDate": "2022-01-31T23:00:00Z",
    "emitted": true,
    "language": {
      "name": "string"
    },
    "accident": true
  }
]

Name	Type	Required	Description
certificateNumber	string	false	none
imei	string	false	none
brand	NameDTO	false	none
model	DescriptionDTO	false	none
phoneNumber	string	false	none
document	string	false	none
firstName	string	false	none
lastName1	string	false	none
lastName2	string	false	none
address	string	false	none
number	string	false	none
city	string	false	none
zipCode	string	false	none
policyNumber	string	false	none
province	string	false	none
effectiveDate	string(date)	false	none
email	string	false	none
sold	boolean	false	none
cancelled	boolean	false	none
cancellationDate	string(date)	false	none
serialNumber	string	false	none
paymentMethod	DescriptionDTO	false	none
clientType	NameDTO	false	none
billPayment	boolean	false	none
withdrawal	boolean	false	none
withdrawalDate	string(date)	false	none
emitted	boolean	false	none
language	NameDTO	false	none
accident	boolean	false	none

400 - instance of errorResponseDtoDeviceInsurance

Custom schema example

1
2
3
4
5


{
  "code": "EMPTY_BODY",
  "title": "Empty body",
  "description": null
}

Name	Type	Required	Description
code	string	false	none
message	string	false	none

401 - instance of errorResponseDtoDeviceInsurance

Custom schema example

1
2
3
4
5


{
  "code": "UNAUTHORIZED_REQUEST",
  "title": "Unauthorized request",
  "description": null
}

Name	Type	Required	Description
code	string	false	none
message	string	false	none

403 - instance of errorResponseDtoDeviceInsurance

Custom schema example

1
2
3
4
5


{
  "code": "FORBIDDEN_RESOURCE",
  "title": "Forbidden resource",
  "description": null
}

Name	Type	Required	Description
code	string	false	none
message	string	false	none

404 - instance of errorResponseDtoDeviceInsurance

Custom schema example

1
2
3
4
5


{
  "code": "NOT_FOUND_WOKRFLOW_TYPE",
  "title": "Not found workflow type",
  "description": null
}

Name	Type	Required	Description
code	string	false	none
message	string	false	none

406 - instance of errorResponseDtoDeviceInsurance

Custom schema example

1
2
3
4
5


{
  "code": "NOT_ACCEPTABLE",
  "title": "Not acceptable",
  "description": null
}

Name	Type	Required	Description
code	string	false	none
message	string	false	none

500 - instance of errorResponseDtoDeviceInsurance

Custom schema example

1
2
3
4
5


{
  "code": "INTERNAL_SERVER_ERROR",
  "title": "Server is not working due to some error",
  "description": "Something went wrong"
}

Name	Type	Required	Description
code	string	false	none
message	string	false	none