Default

Get contacts

This service returns all contacts. Always return empty dealers.

GET /contacts

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/contacts \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Contacts have been found.	[ContactResponse]
401	Unauthorized	Unauthorized	string
404	Not Found	Dealer not found	ApiErrorResponse

200 - instance of ContactResponse

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57


[
  {
    "id": 0,
    "name": "string",
    "email": "test@test.es",
    "phoneNumber": "987654321",
    "purposes": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "dealers": [
      {
        "id": 0,
        "code": "string",
        "commercialName": "string",
        "level": 0,
        "levelDescription": "string",
        "status": "string",
        "parentId": 0,
        "parentCode": "string",
        "subchannelCode": "string",
        "internalManagerFullName": "string",
        "externalManagerFullName": "string",
        "internalManagerCode": "string",
        "externalManagerCode": "string",
        "commissioningSection": "string",
        "storeType": "string",
        "address": "string",
        "city": "string",
        "province": "string",
        "country": "string",
        "postalCode": "string",
        "startDate": "string",
        "endDate": "string",
        "userCreated": "string",
        "userUpdated": "string",
        "creationDate": "string",
        "updateDate": "string",
        "channelType": "string",
        "channelCode": "string",
        "channelName": "string",
        "sellType": "string",
        "subchannelGroup": "string",
        "segment": "string",
        "ine": "string",
        "migratedFromDealerId": 0,
        "migratedFromDealerCode": "string",
        "migratedToDealerId": 0,
        "migratedToDealerCode": "string",
        "storeDelivery": true,
        "deviceReturn": true
      }
    ]
  }
]

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[PurposeResponse]	false	none
dealers	[SimpleDealerResponse]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[PurposeResponse]	false	none
dealers	[SimpleDealerResponse]	false	none

404 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


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

Name	Type	Required	Description
restErrors	[ApiError]	false	none

Create contact

This service returns all contacts.

POST /contacts

Parameters

Name	In	Type	Required	Description
body	body	ContactRequest	false	‘none’

Request body - instance of ContactRequest

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


{
  "name": "string",
  "email": "test@test.es",
  "phoneNumber": "987654321",
  "purposes": [
    {
      "id": 0
    }
  ],
  "dealers": [
    {
      "id": 0
    }
  ]
}

Name	Type	Required	Description
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[IntegerList]	false	none
dealers	[IntegerList]	false	none

Request example

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



curl -X POST https://dealers.masstack.com/v1/contacts \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'name': 'string',
  'email': 'test@test.es',
  'phoneNumber': '987654321',
  'purposes': [
    {
      'id': 0
    }
  ],
  'dealers': [
    {
      'id': 0
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Contact has been created.	ContactResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Dealer not found	ApiErrorResponse

Get information from received contact.

This service receives contactId and returns contact detail.

GET /contacts/{contactId}

Parameters

Name	In	Type	Required	Description
contactId	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/contacts/{contactId} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Contact has been found.	[ContactResponse]
401	Unauthorized	Unauthorized	string

200 - instance of ContactResponse

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57


[
  {
    "id": 0,
    "name": "string",
    "email": "test@test.es",
    "phoneNumber": "987654321",
    "purposes": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "dealers": [
      {
        "id": 0,
        "code": "string",
        "commercialName": "string",
        "level": 0,
        "levelDescription": "string",
        "status": "string",
        "parentId": 0,
        "parentCode": "string",
        "subchannelCode": "string",
        "internalManagerFullName": "string",
        "externalManagerFullName": "string",
        "internalManagerCode": "string",
        "externalManagerCode": "string",
        "commissioningSection": "string",
        "storeType": "string",
        "address": "string",
        "city": "string",
        "province": "string",
        "country": "string",
        "postalCode": "string",
        "startDate": "string",
        "endDate": "string",
        "userCreated": "string",
        "userUpdated": "string",
        "creationDate": "string",
        "updateDate": "string",
        "channelType": "string",
        "channelCode": "string",
        "channelName": "string",
        "sellType": "string",
        "subchannelGroup": "string",
        "segment": "string",
        "ine": "string",
        "migratedFromDealerId": 0,
        "migratedFromDealerCode": "string",
        "migratedToDealerId": 0,
        "migratedToDealerCode": "string",
        "storeDelivery": true,
        "deviceReturn": true
      }
    ]
  }
]

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[PurposeResponse]	false	none
dealers	[SimpleDealerResponse]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[PurposeResponse]	false	none
dealers	[SimpleDealerResponse]	false	none

Partial update from contactId.

This service receives contactId and body with fields to update. The fields that are specified will be overwritten. In the case of the fields of purposes and distributors, they require a list of IDs. If they are empty, they will overwrite the previous empty.

PATCH /contacts/{contactId}

Parameters

Name	In	Type	Required	Description
contactId	path	integer	true	‘none’
body	body	ContactRequest	false	‘none’

Request body - instance of ContactRequest

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


{
  "name": "string",
  "email": "test@test.es",
  "phoneNumber": "987654321",
  "purposes": [
    {
      "id": 0
    }
  ],
  "dealers": [
    {
      "id": 0
    }
  ]
}

Name	Type	Required	Description
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[IntegerList]	false	none
dealers	[IntegerList]	false	none

Request example

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



curl -X PATCH https://dealers.masstack.com/v1/contacts/{contactId} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'name': 'string',
  'email': 'test@test.es',
  'phoneNumber': '987654321',
  'purposes': [
    {
      'id': 0
    }
  ],
  'dealers': [
    {
      'id': 0
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Contact has been updated.	[ContactResponse]
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Dealer not found	ApiErrorResponse

200 - instance of ContactResponse

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57


[
  {
    "id": 0,
    "name": "string",
    "email": "test@test.es",
    "phoneNumber": "987654321",
    "purposes": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "dealers": [
      {
        "id": 0,
        "code": "string",
        "commercialName": "string",
        "level": 0,
        "levelDescription": "string",
        "status": "string",
        "parentId": 0,
        "parentCode": "string",
        "subchannelCode": "string",
        "internalManagerFullName": "string",
        "externalManagerFullName": "string",
        "internalManagerCode": "string",
        "externalManagerCode": "string",
        "commissioningSection": "string",
        "storeType": "string",
        "address": "string",
        "city": "string",
        "province": "string",
        "country": "string",
        "postalCode": "string",
        "startDate": "string",
        "endDate": "string",
        "userCreated": "string",
        "userUpdated": "string",
        "creationDate": "string",
        "updateDate": "string",
        "channelType": "string",
        "channelCode": "string",
        "channelName": "string",
        "sellType": "string",
        "subchannelGroup": "string",
        "segment": "string",
        "ine": "string",
        "migratedFromDealerId": 0,
        "migratedFromDealerCode": "string",
        "migratedToDealerId": 0,
        "migratedToDealerCode": "string",
        "storeDelivery": true,
        "deviceReturn": true
      }
    ]
  }
]

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[PurposeResponse]	false	none
dealers	[SimpleDealerResponse]	false	none

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

Delete from contactId.

This service receives contactId to delete.

DELETE /contacts/{contactId}

Parameters

Name	In	Type	Required	Description
contactId	path	integer	true	‘none’

Request example

1
2
3
4



curl -X DELETE https://dealers.masstack.com/v1/contacts/{contactId} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	Successful response. Contact has been deleted.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Dealer not found	ApiErrorResponse

Delete a dealer's contact

This service receives dealerId and contactId and delete this relationship.

DELETE /contacts/{contactId}/dealers/{dealerId}

Parameters

Name	In	Type	Required	Description
contactId	path	integer	true	‘none’
dealerId	path	integer	true	‘none’

Request example

1
2
3
4



curl -X DELETE https://dealers.masstack.com/v1/contacts/{contactId}/dealers/{dealerId} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	Successful response.	None
401	Unauthorized	Unauthorized	string
404	Not Found	Dealer not found	ApiErrorResponse

Get managers

This service returns all managers, regardless if it receives the filter by manager type.

GET /managers

Parameters

Name	In	Type	Required	Description
type	query	string	false	filter by manager type

Enumerated Values

Property	Values
type	one of [INT, EXT]

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/managers?type='INT' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Managers has been found.	[ManagerResponse]
401	Unauthorized	Unauthorized	string

200 - instance of ManagerResponse

Custom schema example

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


[
  {
    "name": "Test",
    "surname": "Test",
    "type": "INT",
    "parent": {
      "id": 0,
      "code": "t.test"
    },
    "id": 0,
    "code": "t.test"
  }
]

Name	Type	Required	Description
name	string	false	none
surname	string	false	none
type	string	false	INT -> Interno EXT -> Externo
parent	ManagerBase1	false	Contact generic info simplified object.

Property	Values
type	one of [INT, EXT]

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
name	string	false	none
surname	string	false	none
type	string	false	INT -> Interno EXT -> Externo
parent	ManagerBase1	false	Contact generic info simplified object.

Property	Values
type	one of [INT, EXT]