POST api/ESB/AddContributor

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Header	AddHeader	None.
PortfolioID	string	None.
RequiredDocumentNames	Collection of string	None.
Users	Collection of NewUser	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:39:32.0793835+00:00"
  },
  "PortfolioID": "sample string 1",
  "RequiredDocumentNames": [
    "sample string 1",
    "sample string 2"
  ],
  "Users": [
    {
      "Surname": "sample string 1",
      "Name": "sample string 2",
      "IdentityNo": "sample string 3",
      "EmailAddresses": "sample string 4",
      "MobileNumber": "sample string 5"
    },
    {
      "Surname": "sample string 1",
      "Name": "sample string 2",
      "IdentityNo": "sample string 3",
      "EmailAddresses": "sample string 4",
      "MobileNumber": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<AddContributorRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <Header>
    <Organisation>sample string 2</Organisation>
    <SystemID>sample string 4</SystemID>
    <Timestamp>2025-12-10T01:39:32.0793835+00:00</Timestamp>
    <TransactionID>sample string 1</TransactionID>
    <UserID>sample string 3</UserID>
  </Header>
  <PortfolioID>sample string 1</PortfolioID>
  <RequiredDocumentNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </RequiredDocumentNames>
  <Users>
    <NewUser>
      <EmailAddresses>sample string 4</EmailAddresses>
      <IdentityNo>sample string 3</IdentityNo>
      <MobileNumber>sample string 5</MobileNumber>
      <Name>sample string 2</Name>
      <Surname>sample string 1</Surname>
    </NewUser>
    <NewUser>
      <EmailAddresses>sample string 4</EmailAddresses>
      <IdentityNo>sample string 3</IdentityNo>
      <MobileNumber>sample string 5</MobileNumber>
      <Name>sample string 2</Name>
      <Surname>sample string 1</Surname>
    </NewUser>
  </Users>
</AddContributorRequest>

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

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>