POST api/entities/{id}/addSubEntities
Add Sub Entity
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Consolidated Entity Id |
integer |
Required |
Body Parameters
Sub Entity View Model
CreateSubEntityViewModelName | Description | Type | Additional information |
---|---|---|---|
ConsolidatedName |
Name |
string |
None. |
ConsolidatedNumber |
Entity Number |
string |
None. |
SubEntities |
|
Collection of SubEntityViewModel |
None. |
CreateSubEntityOptions |
|
CreateSubEntityOptions |
None. |
Request Formats
application/json, text/json
Sample:
{ "consolidatedName": "sample string 1", "consolidatedNumber": "sample string 2", "subEntities": [ { "id": 1, "name": "sample string 2", "number": "sample string 3" }, { "id": 1, "name": "sample string 2", "number": "sample string 3" } ], "createSubEntityOptions": { "funds": true, "periodClose": true, "payableReceivables": true, "loanMortgage": true, "notes": true } }
application/xml, text/xml
Sample:
<CreateSubEntityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Controllers.Entities.Models"> <ConsolidatedName>sample string 1</ConsolidatedName> <ConsolidatedNumber>sample string 2</ConsolidatedNumber> <CreateSubEntityOptions> <Funds>true</Funds> <LoanMortgage>true</LoanMortgage> <Notes>true</Notes> <PayableReceivables>true</PayableReceivables> <PeriodClose>true</PeriodClose> </CreateSubEntityOptions> <SubEntities> <SubEntityViewModel> <Id>1</Id> <Name>sample string 2</Name> <Number>sample string 3</Number> </SubEntityViewModel> <SubEntityViewModel> <Id>1</Id> <Name>sample string 2</Name> <Number>sample string 3</Number> </SubEntityViewModel> </SubEntities> </CreateSubEntityViewModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Entities
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.