Request

Create request

Create a record of the requested request

POST /requests

Parameters

Name	In	Type	Required	Description
body	body	RequestsRequest	true	‘none’

Request body - instance of RequestsRequest

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


{
  "dealerId": 0,
  "platform": "JIRA",
  "issue": "string",
  "requestType": "DEALER_CREATION",
  "status": "PENDING",
  "requestDetail": {
    "email": "string",
    "pass": "string",
    "recoveryPhone": "string",
    "orgUnitId": 0,
    "orgUnit": "string",
    "salesRole": "string",
    "commercialProfile": [
      "string"
    ],
    "SIMReplacement": true,
    "eSIMReplacement": true
  }
}

Name	Type	Required	Description
dealerId	integer	true	none
platform	string	true	none
issue	string	false	none
requestType	string	true	none
status	string	true	none
requestDetail	any	false	none

Name	Type	Required	Description
» anonymous	RequestDetailIamCreateDealer	false	none

Name	Type	Required	Description
» anonymous	RequestDetailIamChangeCampaign	false	none

Property	Values
platform	one of [JIRA, IAM]
requestType	one of [DEALER_CREATION]
status	one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR]

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



curl -X POST https://dealers.masstack.com/v1/requests \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'dealerId': 0,
  'platform': 'JIRA',
  'issue': 'string',
  'requestType': 'DEALER_CREATION',
  'status': 'PENDING',
  'requestDetail': {
    'email': 'string',
    'pass': 'string',
    'recoveryPhone': 'string',
    'orgUnitId': 0,
    'orgUnit': 'string',
    'salesRole': 'string',
    'commercialProfile': [
      'string'
    ],
    'SIMReplacement': true,
    'eSIMReplacement': true
  }
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Created.	RequestCreatedResponse
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Approves and processes requests.

Approves the given requests and includes the users in the groups indicated in the detail of each request. If the users do not exist, they will be created and if there is any incompatibility with the groups, the existing incompatible groups will be deleted and the user will be included in those indicated in the request.

POST /requests/approve

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	‘none’

Request body - JsonObject

1

{}

None

Request example

1
2
3
4
5
6
7
8



curl -X POST https://dealers.masstack.com/v1/requests/approve \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "[
  '1234,123'
]" 

Responses

Code	Meaning	Description	Schema
200	OK	No content.	None
207	Multi-Status	Some request couldn’t be processed.	[RequestResponse]
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

207 - instance of RequestResponse

Custom schema example

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


{
  "id": 43,
  "dealerId": 28,
  "dealerCode": "MDEA_TEST",
  "platform": "IAM",
  "status": "ERROR",
  "userCreated": "juan.nadie",
  "comment": "Invalid Bearer token",
  "creationDate": "2023-06-19T21:31:26.272975+02:00",
  "requestDetails": {
    "email": "mdeatest15@asesormasmovil.es",
    "orgUnit": "/1.Otras/Energia",
    "salesRole": "pruebasmasdealers",
    "commercialProfile": [
      "perfil_comercial.ecare"
    ],
    "simReplacement": true,
    "eSIMReplacement": false
  }
}

Name	Type	Required	Description
id	integer	false	none
dealerId	integer	true	none
dealerCode	string	false	none
platform	string	true	none
status	string	true	none
userCreated	string	false	none
creationDate	string	false	none
requestDetails	object	false	none
» email	string	false	none
» orgUnit	string	false	none
» salesRole	string	false	none
» commercialProfile	[string]	false	none
» simReplacement	boolean	false	none
» eSIMReplacement	boolean	false	none

Property	Values
platform	one of [JIRA, IAM]
status	one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR]

400 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
restErrors	[ApiError]	false	none

500 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

Update status request or comment request

The only data that will be modified from the request entity will be status and comment, the other data if sent will be ignored.

PATCH /requests/{requestId}

Parameters

Name	In	Type	Required	Description
requestId	path	integer	true	‘none’
body	body	RequestModificationBody	false	‘none’

Request body - instance of RequestModificationBody

1
2
3
4


{
  "status": "PENDING",
  "comment": "string"
}

Name	Type	Required	Description
status	string	false	none
comment	string	false	none

Property	Values
status	one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR]

Request example

1
2
3
4
5
6
7
8
9



curl -X PATCH https://dealers.masstack.com/v1/requests/{requestId} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'status': 'PENDING',
  'comment': 'string'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse