POST api/customerdocument

Create a customer document.

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/customerdocument. 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

None.

Response Information

Response Codes

Success Status:

Created (201), the HTTP response location header field contains the Uri of the newely created resource. Please see resource description below.

Failed Status(es):

Resource Description

Returns created customer document.

CustomerDocumentDto

Name	Description	Type
CustomerID	Customer's unique identifier.	integer
Document	Customer's document.	DocumentDto
CUAccountID	Unique Identifier of a Customer's Account.	integer

Response Formats

application/json, text/json

Sample:

{
  "customerID": 1,
  "document": {
    "documentID": 1,
    "documentByte": "QEA=",
    "title": "sample string 1",
    "blobDescriptionID": 1,
    "type": 1,
    "documentType": "sample string 2",
    "creationDate": "sample string 3"
  },
  "cuAccountID": 1
}

application/xml, text/xml

Sample:

<CustomerDocumentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <CUAccountID>1</CUAccountID>
  <CustomerID>1</CustomerID>
  <Document>
    <BlobDescriptionID>1</BlobDescriptionID>
    <CreationDate>sample string 3</CreationDate>
    <DocumentByte>QEA=</DocumentByte>
    <DocumentID>1</DocumentID>
    <DocumentType>sample string 2</DocumentType>
    <Title>sample string 1</Title>
    <Type>JPEG</Type>
  </Document>
</CustomerDocumentDto>