POST api/entities/createDraftEntity
Create an Entity
Request Information
URI Parameters
None.
Body Parameters
Entity View Model
CreateDraftEntityViewModelName | Description | Type | Additional information |
---|---|---|---|
Name |
Name |
string |
None. |
Number |
Entity Number |
string |
None. |
FederalIdNumber |
Federal Id Number |
string |
None. |
Phone |
Phone |
string |
None. |
IrsName |
Irs Name |
string |
None. |
NameForChecks |
Entity Name For Checks |
string |
None. |
NumberOfUnits |
Number Of Units |
integer |
Required Range: inclusive between 0 and 2147483647 |
SuperEntity |
Super Entity |
SuperEntityDraftViewModel |
None. |
Address |
Address |
SaveAddressViewModel |
None. |
Request Formats
application/json, text/json
{ "name": "sample string 1", "number": "sample string 2", "federalIdNumber": "sample string 3", "phone": "sample string 4", "irsName": "sample string 5", "nameForChecks": "sample string 6", "numberOfUnits": 1, "superEntity": { "name": "sample string 1", "managementCompanyId": 2 }, "address": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zipCode": "sample string 5", "country": "sample string 6" } }
application/xml, text/xml
<CreateDraftEntityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels"> <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address"> <d2p1:Address1>sample string 1</d2p1:Address1> <d2p1:Address2>sample string 2</d2p1:Address2> <d2p1:City>sample string 3</d2p1:City> <d2p1:Country>sample string 6</d2p1:Country> <d2p1:State>sample string 4</d2p1:State> <d2p1:ZipCode>sample string 5</d2p1:ZipCode> </Address> <FederalIdNumber>sample string 3</FederalIdNumber> <IrsName>sample string 5</IrsName> <Name>sample string 1</Name> <NameForChecks>sample string 6</NameForChecks> <Number>sample string 2</Number> <NumberOfUnits>1</NumberOfUnits> <Phone>sample string 4</Phone> <SuperEntity> <ManagementCompanyId>2</ManagementCompanyId> <Name>sample string 1</Name> </SuperEntity> </CreateDraftEntityViewModel>
application/x-www-form-urlencoded
Response Information
Resource Description
bool
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.