GET api/customermessage/{id}

Get a customer message.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/customermessage/{id}. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Customer's Id.

 integer

Required

Body Parameters

None.

Response Information

Response Codes

Success Status:

  • OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns customer's message.

CustomerMessageDto
NameDescriptionTypeAdditional information
CustomerID

Customer's Id.

 integer
CustomerMessage

Customer's message.

 string

Response Formats

application/json, text/json

Sample: 
{
  "customerID": 1,
  "customerMessage": "sample string 1"
}

application/xml, text/xml

Sample: 
<CustomerMessageDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <CustomerID>1</CustomerID>
  <CustomerMessage>sample string 1</CustomerMessage>
</CustomerMessageDto>