GET api/customersms/search?CustomerID={CustomerID}&SMSMessageOutID={SMSMessageOutID}&ResultsLimit={ResultsLimit}

Search text messages based on search parameters.

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/customersms/search. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerID	Customer ID.	integer
SMSMessageOutID	Text message out ID.	integer
ResultsLimit	Limit the number of results found.	integer	If no value is passed then it will return all the results. If 0 is passed, then no results will be returned.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns text messages that matches the search paramenters.

Collection of SmsDto

Name	Description	Type
TelephoneNumber	Telephone Number.	string
Message	Text Message.	string
CustomerID	Customer Id.	integer
PersonID	Customer's Person Id.	integer

Response Formats

application/json, text/json

Sample:

[
  {
    "telephoneNumber": "sample string 1",
    "message": "sample string 2",
    "customerID": 1,
    "personID": 1
  },
  {
    "telephoneNumber": "sample string 1",
    "message": "sample string 2",
    "customerID": 1,
    "personID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfSmsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <SmsDto>
    <CustomerID>1</CustomerID>
    <Message>sample string 2</Message>
    <PersonID>1</PersonID>
    <TelephoneNumber>sample string 1</TelephoneNumber>
  </SmsDto>
  <SmsDto>
    <CustomerID>1</CustomerID>
    <Message>sample string 2</Message>
    <PersonID>1</PersonID>
    <TelephoneNumber>sample string 1</TelephoneNumber>
  </SmsDto>
</ArrayOfSmsDto>