POST api/customerblacklisting

Create a new Customer blacklisting.

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

Request Information

URI Parameters

None.

Body Parameters

Customer blacklisting data.

CustomerBlacklistingDto

Name	Description	Type	Additional information
CustomerBlacklistingID	Unique Identifier of Customer Blacklisting.	integer	Read-Only.
CustomerID	Unique Identifier of Customer Id.	integer	Required.
AddDate	Date when customer is added to Blacklist.	string
AddUserID	User Id who added the customer to Blacklist.	integer
CUBlacklistStatus	Status of Customer added to Blacklist.	BlacklistStatus
CUBlacklistingReasonID	Blacklisting Reason Id for the Customer.	integer	Required.

Request Formats

application/json, text/json

Sample:

{
  "customerBlacklistingID": 1,
  "customerID": 1,
  "addDate": "sample string 1",
  "addUserID": 1,
  "cuBlacklistStatus": 0,
  "cuBlacklistingReasonID": 1
}

application/xml, text/xml

Sample:

<CustomerBlacklistingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <AddDate>sample string 1</AddDate>
  <AddUserID>1</AddUserID>
  <CUBlacklistStatus>None</CUBlacklistStatus>
  <CUBlacklistingReasonID>1</CUBlacklistingReasonID>
  <CustomerBlacklistingID>1</CustomerBlacklistingID>
  <CustomerID>1</CustomerID>
</CustomerBlacklistingDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Success Status:

Created (201), please see resource description below.

Failed Status(es):

Resource Description

Returns created Customerblacklisting.

CustomerBlacklistingDto

Name	Description	Type	Additional information
CustomerBlacklistingID	Unique Identifier of Customer Blacklisting.	integer	Read-Only.
CustomerID	Unique Identifier of Customer Id.	integer	Required.
AddDate	Date when customer is added to Blacklist.	string
AddUserID	User Id who added the customer to Blacklist.	integer
CUBlacklistStatus	Status of Customer added to Blacklist.	BlacklistStatus
CUBlacklistingReasonID	Blacklisting Reason Id for the Customer.	integer	Required.

Response Formats

application/json, text/json

Sample:

{
  "customerBlacklistingID": 1,
  "customerID": 1,
  "addDate": "sample string 1",
  "addUserID": 1,
  "cuBlacklistStatus": 0,
  "cuBlacklistingReasonID": 1
}

application/xml, text/xml

Sample:

<CustomerBlacklistingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <AddDate>sample string 1</AddDate>
  <AddUserID>1</AddUserID>
  <CUBlacklistStatus>None</CUBlacklistStatus>
  <CUBlacklistingReasonID>1</CUBlacklistingReasonID>
  <CustomerBlacklistingID>1</CustomerBlacklistingID>
  <CustomerID>1</CustomerID>
</CustomerBlacklistingDto>