POST api/ESB/SharePortfolio

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
header	ShareHeader	None.
PortfolioID	string	None.
SendNotification	boolean	None.
Shares	Collection of Share	None.
EmaillName	string	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:36:53.1954395+00:00"
  },
  "PortfolioID": "sample string 1",
  "SendNotification": true,
  "Shares": [
    {
      "RSAResident": true,
      "Surname": "sample string 2",
      "Name": "sample string 3",
      "IdentityNo": "sample string 4",
      "MobileNumber": "sample string 5",
      "Email": "sample string 6"
    },
    {
      "RSAResident": true,
      "Surname": "sample string 2",
      "Name": "sample string 3",
      "IdentityNo": "sample string 4",
      "MobileNumber": "sample string 5",
      "Email": "sample string 6"
    }
  ],
  "EmaillName": "sample string 3"
}

application/xml, text/xml

Sample:

<ShareDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <EmaillName>sample string 3</EmaillName>
  <PortfolioID>sample string 1</PortfolioID>
  <SendNotification>true</SendNotification>
  <Shares>
    <Share>
      <Email>sample string 6</Email>
      <IdentityNo>sample string 4</IdentityNo>
      <MobileNumber>sample string 5</MobileNumber>
      <Name>sample string 3</Name>
      <RSAResident>true</RSAResident>
      <Surname>sample string 2</Surname>
    </Share>
    <Share>
      <Email>sample string 6</Email>
      <IdentityNo>sample string 4</IdentityNo>
      <MobileNumber>sample string 5</MobileNumber>
      <Name>sample string 3</Name>
      <RSAResident>true</RSAResident>
      <Surname>sample string 2</Surname>
    </Share>
  </Shares>
  <header>
    <Organisation>sample string 2</Organisation>
    <SystemID>sample string 4</SystemID>
    <Timestamp>2025-12-10T01:36:53.1954395+00:00</Timestamp>
    <TransactionID>sample string 1</TransactionID>
    <UserID>sample string 3</UserID>
  </header>
</ShareDetailsRequest>

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 'ShareDetailsRequest'.

Response Information

Resource Description

ServiceResponse

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

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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