POST api/v1/corporate-affairs/update-annual-return-detail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CorpAffairs	ClientARInfoDetailModel	None.
Title	string	None.
CompanyName	string	None.
Activity	string	None.
ShareIssues	Collection of ShareIssueModel	None.
ClientId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CorpAffairs": {
    "ClientId": 1,
    "CompanyNumber": "sample string 2",
    "AnnualReturnMonth": 1,
    "RegDate": "2025-04-28T10:08:02.8396208Z",
    "AGMDate": "2025-04-28T10:08:02.8396208Z",
    "LastAnnualReturnDate": "2025-04-28T10:08:02.8396208Z",
    "WeAreRegOffice": true,
    "WeAreAddressForService": true,
    "RegisteredOffice": "sample string 3",
    "AddressForService": "sample string 4",
    "AnnualReturnNoApprovalRequired": true,
    "CompanyType": 1,
    "Nzbn": "sample string 5"
  },
  "Title": "sample string 1",
  "CompanyName": "sample string 2",
  "Activity": "sample string 3",
  "ShareIssues": [
    {
      "SIId": 1,
      "ClientId": 2,
      "ShareClass": "sample string 3",
      "Description": "sample string 4",
      "Shares": 5
    },
    {
      "SIId": 1,
      "ClientId": 2,
      "ShareClass": "sample string 3",
      "Description": "sample string 4",
      "Shares": 5
    }
  ],
  "ClientId": 4
}

application/xml, text/xml

Sample:

<AnnualReturnDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iPMS.Models.CorporateAffairs">
  <Activity>sample string 3</Activity>
  <ClientId>4</ClientId>
  <CompanyName>sample string 2</CompanyName>
  <CorpAffairs xmlns:d2p1="http://schemas.datacontract.org/2004/07/iPMS.Models.ClientDetail.ClientARInfo">
    <d2p1:AGMDate>2025-04-28T10:08:02.8396208Z</d2p1:AGMDate>
    <d2p1:AddressForService>sample string 4</d2p1:AddressForService>
    <d2p1:AnnualReturnMonth>1</d2p1:AnnualReturnMonth>
    <d2p1:AnnualReturnNoApprovalRequired>true</d2p1:AnnualReturnNoApprovalRequired>
    <d2p1:ClientId>1</d2p1:ClientId>
    <d2p1:CompanyNumber>sample string 2</d2p1:CompanyNumber>
    <d2p1:CompanyType>1</d2p1:CompanyType>
    <d2p1:LastAnnualReturnDate>2025-04-28T10:08:02.8396208Z</d2p1:LastAnnualReturnDate>
    <d2p1:Nzbn>sample string 5</d2p1:Nzbn>
    <d2p1:RegDate>2025-04-28T10:08:02.8396208Z</d2p1:RegDate>
    <d2p1:RegisteredOffice>sample string 3</d2p1:RegisteredOffice>
    <d2p1:WeAreAddressForService>true</d2p1:WeAreAddressForService>
    <d2p1:WeAreRegOffice>true</d2p1:WeAreRegOffice>
  </CorpAffairs>
  <ShareIssues>
    <ShareIssueModel>
      <ClientId>2</ClientId>
      <Description>sample string 4</Description>
      <SIId>1</SIId>
      <ShareClass>sample string 3</ShareClass>
      <Shares>5</Shares>
    </ShareIssueModel>
    <ShareIssueModel>
      <ClientId>2</ClientId>
      <Description>sample string 4</Description>
      <SIId>1</SIId>
      <ShareClass>sample string 3</ShareClass>
      <Shares>5</Shares>
    </ShareIssueModel>
  </ShareIssues>
  <Title>sample string 1</Title>
</AnnualReturnDetailModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.