POST api/buildings/{buildingId}/builders

Insert a new builder

Request Information

URI Parameters

Name	Description	Type	Additional information
buildingId	Building Id	integer	Required

Body Parameters

InsertBuilderViewModel

Name	Description	Type	Additional information
Address	Address	SaveAddressViewModel	None.
BuilderCode	BuilderCode	string	Required Matching regular expression pattern: ^[a-zA-Z0-9]{4}$
BuilderName	BuilderName	string	Required Matching regular expression pattern: ^[a-zA-Z0-9' ']*$ Max length: 50
ContactName	ContactName	string	Required Matching regular expression pattern: ^[a-zA-Z' ']*$ Max length: 50
PhoneNumber	PhoneNumber	string	Matching regular expression pattern: (^$)\|(^\d{3}-\d{3}-\d{4})

Request Formats

application/json, text/json

Sample:

{
  "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"
  },
  "builderCode": "sample string 1",
  "builderName": "sample string 2",
  "contactName": "sample string 3",
  "phoneNumber": "sample string 4"
}

application/xml, text/xml

Sample:

<InsertBuilderViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BuilderCode>sample string 1</BuilderCode>
  <BuilderName>sample string 2</BuilderName>
  <ContactName>sample string 3</ContactName>
  <PhoneNumber>sample string 4</PhoneNumber>
  <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>
</InsertBuilderViewModel>

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

Response Information

Resource Description

BuilderViewModel

Name	Description	Type	Additional information
BuilderId	BuilderId	integer	None.
BuildingId	BuildingId	integer	None.
InUse	Builder is in use by Unit or other instance	boolean	None.
Address	Address	AddressViewModel	None.
BuilderCode	BuilderCode	string	Required Matching regular expression pattern: ^[a-zA-Z0-9]{4}$
BuilderName	BuilderName	string	Required Matching regular expression pattern: ^[a-zA-Z0-9' ']*$ Max length: 50
ContactName	ContactName	string	Required Matching regular expression pattern: ^[a-zA-Z' ']*$ Max length: 50
PhoneNumber	PhoneNumber	string	Matching regular expression pattern: (^$)\|(^\d{3}-\d{3}-\d{4})

Response Formats

application/json, text/json

Sample:

{
  "builderId": 1,
  "buildingId": 2,
  "inUse": true,
  "address": {
    "addressId": 1,
    "address1": "sample string 2",
    "address2": "sample string 3",
    "city": "sample string 4",
    "state": "sample string 5",
    "zipCode": "sample string 6",
    "country": "sample string 7"
  },
  "builderCode": "sample string 4",
  "builderName": "sample string 5",
  "contactName": "sample string 6",
  "phoneNumber": "sample string 7"
}

application/xml, text/xml

Sample:

<BuilderViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BuilderCode>sample string 4</BuilderCode>
  <BuilderName>sample string 5</BuilderName>
  <ContactName>sample string 6</ContactName>
  <PhoneNumber>sample string 7</PhoneNumber>
  <Address>
    <Address1 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 2</Address1>
    <Address2 xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 3</Address2>
    <City xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 4</City>
    <Country xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 7</Country>
    <State xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 5</State>
    <ZipCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">sample string 6</ZipCode>
    <AddressId>1</AddressId>
  </Address>
  <BuilderId>1</BuilderId>
  <BuildingId>2</BuildingId>
  <InUse>true</InUse>
</BuilderViewModel>