POST api/ESB/AddFacilityLetter

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Header	AddHeader	None.
FacilityUniqueIdentifier	string	None.
DateOfLetter	string	None.
EntityType	string	None.
EntityName	string	None.
AccountNumber	string	None.
CIFNumber	string	None.
FacilityAddress	FacilityAddress	None.
PreviousFacilityLetterDate	string	None.
ExpiryDate	string	None.
RenewalFee	decimal number	None.
FacilitySigner	FacilitySigner	None.
SigningInfo	Signinginfo	None.

Request Formats

application/json, text/json

Sample:

{
  "Header": {
    "TransactionID": "sample string 1",
    "Organisation": "sample string 2",
    "UserID": "sample string 3",
    "SystemID": "sample string 4",
    "Timestamp": "2025-12-10T01:37:31.9323844+00:00"
  },
  "FacilityUniqueIdentifier": "sample string 1",
  "DateOfLetter": "sample string 2",
  "EntityType": "sample string 3",
  "EntityName": "sample string 4",
  "AccountNumber": "sample string 5",
  "CIFNumber": "sample string 6",
  "FacilityAddress": {
    "AddressLine_1": "sample string 1",
    "AddressLine_2": "sample string 2",
    "AddressLine_3": "sample string 3",
    "AddressLine_4": "sample string 4"
  },
  "PreviousFacilityLetterDate": "sample string 7",
  "ExpiryDate": "sample string 8",
  "RenewalFee": 9.0,
  "FacilitySigner": {
    "Surname": "sample string 1",
    "Name": "sample string 2"
  },
  "SigningInfo": {
    "SigningRequired": true,
    "Signers": [
      {
        "RSAResident": true,
        "OnBehalfOf": "sample string 2",
        "Capacity": "sample string 3",
        "Surname": "sample string 4",
        "Name": "sample string 5",
        "IdentityNo": "sample string 6",
        "MobileNumber": "sample string 7",
        "Email": "sample string 8",
        "SignerType": "sample string 9"
      },
      {
        "RSAResident": true,
        "OnBehalfOf": "sample string 2",
        "Capacity": "sample string 3",
        "Surname": "sample string 4",
        "Name": "sample string 5",
        "IdentityNo": "sample string 6",
        "MobileNumber": "sample string 7",
        "Email": "sample string 8",
        "SignerType": "sample string 9"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<FacilityLetterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <AccountNumber>sample string 5</AccountNumber>
  <CIFNumber>sample string 6</CIFNumber>
  <DateOfLetter>sample string 2</DateOfLetter>
  <EntityName>sample string 4</EntityName>
  <EntityType>sample string 3</EntityType>
  <ExpiryDate>sample string 8</ExpiryDate>
  <FacilityAddress>
    <AddressLine_1>sample string 1</AddressLine_1>
    <AddressLine_2>sample string 2</AddressLine_2>
    <AddressLine_3>sample string 3</AddressLine_3>
    <AddressLine_4>sample string 4</AddressLine_4>
  </FacilityAddress>
  <FacilitySigner>
    <Name>sample string 2</Name>
    <Surname>sample string 1</Surname>
  </FacilitySigner>
  <FacilityUniqueIdentifier>sample string 1</FacilityUniqueIdentifier>
  <Header>
    <Organisation>sample string 2</Organisation>
    <SystemID>sample string 4</SystemID>
    <Timestamp>2025-12-10T01:37:31.9323844+00:00</Timestamp>
    <TransactionID>sample string 1</TransactionID>
    <UserID>sample string 3</UserID>
  </Header>
  <PreviousFacilityLetterDate>sample string 7</PreviousFacilityLetterDate>
  <RenewalFee>9</RenewalFee>
  <SigningInfo>
    <Signers>
      <Signer>
        <Capacity>sample string 3</Capacity>
        <Email>sample string 8</Email>
        <IdentityNo>sample string 6</IdentityNo>
        <MobileNumber>sample string 7</MobileNumber>
        <Name>sample string 5</Name>
        <OnBehalfOf>sample string 2</OnBehalfOf>
        <RSAResident>true</RSAResident>
        <SignerType>sample string 9</SignerType>
        <Surname>sample string 4</Surname>
      </Signer>
      <Signer>
        <Capacity>sample string 3</Capacity>
        <Email>sample string 8</Email>
        <IdentityNo>sample string 6</IdentityNo>
        <MobileNumber>sample string 7</MobileNumber>
        <Name>sample string 5</Name>
        <OnBehalfOf>sample string 2</OnBehalfOf>
        <RSAResident>true</RSAResident>
        <SignerType>sample string 9</SignerType>
        <Surname>sample string 4</Surname>
      </Signer>
    </Signers>
    <SigningRequired>true</SigningRequired>
  </SigningInfo>
</FacilityLetterRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FacilityLetterRequest'.

Response Information

Resource Description

FacilityResponse

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
FacilityId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "FacilityId": "sample string 3"
}

application/xml, text/xml

Sample:

<FacilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels">
  <FacilityId>sample string 3</FacilityId>
  <Message>sample string 2</Message>
  <Success>true</Success>
</FacilityResponse>