Custom information

Get custom information.

This service returns custom information.

GET /custom-information

Request example

1
2
3
4



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

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Custom information has been found.	[CustomInfoResponse]
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

200 - instance of CustomInfoResponse

Custom schema example

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


[
  {
    "id": 0,
    "values": "string",
    "userCreated": "string",
    "userUpdated": "string",
    "creationDate": "2020-05-21T12:00:00Z",
    "updateDate": "2020-05-21T12:00:00Z",
    "fieldName": "string",
    "fieldDescription": "string",
    "fieldType": "string"
  }
]

Name	Type	Required	Description
id	integer	false	none
values	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	false	none

401 - JsonObject

Custom schema example

1
2
3
4
5
6


{
  "code": "0003",
  "status": "UNAUTHORIZED",
  "message": "Unauthorized",
  "detailMsg": "Audience not found to access URI /example-uri"
}

Name	Type	Required	Description
id	integer	false	none
values	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	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 a new custom information.

.

POST /custom-information

Parameters

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

Request body - JsonObject

1
2
3
4
5


{
  "fieldName": "string",
  "fieldDescription": "string",
  "fieldType": "string"
}

None

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://dealers.masstack.com/v1/custom-information \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'fieldName': 'string',
  'fieldDescription': 'string',
  'fieldType': 'string'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successful response. Custom information has been created.	[CustomInfoResponse]
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string

201 - JsonObject

Custom schema example

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


[
  {
    "id": 0,
    "values": "string",
    "userCreated": "string",
    "userUpdated": "string",
    "creationDate": "2020-05-21T12:00:00Z",
    "updateDate": "2020-05-21T12:00:00Z",
    "fieldName": "string",
    "fieldDescription": "string",
    "fieldType": "string"
  }
]

Name	Type	Required	Description
id	integer	false	none
values	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	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
2
3
4
5
6


{
  "code": "0003",
  "status": "UNAUTHORIZED",
  "message": "Unauthorized",
  "detailMsg": "Audience not found to access URI /example-uri"
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

Update custom information from received customInfo.

This service receives customInfoId and body with fields to update.

PATCH /custom-information/{custom_info_id}

Parameters

Name	In	Type	Required	Description
custom_info_id	path	integer	true	‘none’
body	body	CustomInfoRequest	false	‘none’

Request body - JsonObject

1
2
3
4
5


{
  "fieldName": "string",
  "fieldDescription": "string",
  "fieldType": "string"
}

None

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X PATCH https://dealers.masstack.com/v1/custom-information/{custom_info_id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'fieldName': 'string',
  'fieldDescription': 'string',
  'fieldType': 'string'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Custom information has been updated.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Delete custom information from received customInfo.

.

DELETE /custom-information/{custom_info_id}

Parameters

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

Request example

1
2
3
4



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

Responses

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