POST api/firms/modifyfirm

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Firm		Firm	None.
Header		RequestHeader	None.

Request Formats

application/json, text/json

Sample:

{
  "Firm": {
    "FirmName": "sample string 1",
    "FirmCode": "sample string 2",
    "FirmAddress": "sample string 3",
    "CreatedOn": "2025-12-05T20:27:09.056497-08:00",
    "CreatedBy": 5,
    "ModifiedOn": "2025-12-05T20:27:09.056497-08:00",
    "ModifiedBy": 7,
    "IsActive": true,
    "FirmID": 9,
    "CreatedByName": "sample string 10",
    "ModifiedByName": "sample string 11"
  },
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<ModifyFirmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Firms.Integration">
  <Header xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <IPAddress>sample string 2</IPAddress>
    <Token>sample string 1</Token>
  </Header>
  <Firm xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Firms">
    <d2p1:CreatedBy>5</d2p1:CreatedBy>
    <d2p1:CreatedByName>sample string 10</d2p1:CreatedByName>
    <d2p1:CreatedOn>2025-12-05T20:27:09.056497-08:00</d2p1:CreatedOn>
    <d2p1:FirmAddress>sample string 3</d2p1:FirmAddress>
    <d2p1:FirmCode>sample string 2</d2p1:FirmCode>
    <d2p1:FirmID>9</d2p1:FirmID>
    <d2p1:FirmName>sample string 1</d2p1:FirmName>
    <d2p1:IsActive>true</d2p1:IsActive>
    <d2p1:ModifiedBy>7</d2p1:ModifiedBy>
    <d2p1:ModifiedByName>sample string 11</d2p1:ModifiedByName>
    <d2p1:ModifiedOn>2025-12-05T20:27:09.056497-08:00</d2p1:ModifiedOn>
  </Firm>
</ModifyFirmRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ModifyFirmResponse

Name	Description	Type	Additional information
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ModifyFirmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Firms.Integration">
  <Result xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Result>1</Result>
    <TechnicalMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </TechnicalMessages>
  </Result>
</ModifyFirmResponse>