POST api/Appointment/CreateNewAppointment
Request Information
URI Parameters
None.
Body Parameters
NewAppointment| Name | Description | Type | Additional information |
|---|---|---|---|
| StoreId | integer |
None. |
|
| PropertyType | integer |
None. |
|
| CompanyName | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| SecondaryFirstName | string |
None. |
|
| SecondaryLastName | string |
None. |
|
| EmailAddress | string |
None. |
|
| PhoneDay | string |
None. |
|
| PhoneNight | string |
None. |
|
| PhoneCell | string |
None. |
|
| State | string |
None. |
|
| City | string |
None. |
|
| ZipCode | string |
None. |
|
| Street | string |
None. |
|
| Estimator | string |
None. |
|
| EmployeeId | integer |
None. |
|
| AppointmentDate | date |
None. |
|
| ParentAppointmentID | string |
None. |
|
| ParentSalesDocNo | string |
None. |
|
| ParentGPCustomerNo | string |
None. |
|
| IsExistingCommercial | integer |
None. |
|
| CompanyDepartment | integer |
None. |
|
| EstimatorId | integer |
None. |
|
| SalesReprensentativeId | integer |
None. |
|
| ClosetAddress | integer |
None. |
|
| ProjectName | string |
None. |
|
| JobSite | string |
None. |
|
| ProjectContactPersonFirstName | string |
None. |
|
| ProjectContactPersonLastName | string |
None. |
|
| ProjectContactPersonEmail | string |
None. |
|
| ProjectContactPersonPhone | string |
None. |
|
| ProjectAddress | string |
None. |
|
| ProjectCity | string |
None. |
|
| ProjectZipCode | string |
None. |
|
| IsSameAsAbove | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"StoreId": 1,
"PropertyType": 2,
"CompanyName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"SecondaryFirstName": "sample string 6",
"SecondaryLastName": "sample string 7",
"EmailAddress": "sample string 8",
"PhoneDay": "sample string 9",
"PhoneNight": "sample string 10",
"PhoneCell": "sample string 11",
"State": "sample string 12",
"City": "sample string 13",
"ZipCode": "sample string 14",
"Street": "sample string 15",
"Estimator": "sample string 16",
"EmployeeId": 17,
"AppointmentDate": "2026-01-10T15:55:35.3961453-05:00",
"ParentAppointmentID": "sample string 19",
"ParentSalesDocNo": "sample string 20",
"ParentGPCustomerNo": "sample string 21",
"IsExistingCommercial": 22,
"CompanyDepartment": 23,
"EstimatorId": 24,
"SalesReprensentativeId": 25,
"ClosetAddress": 26,
"ProjectName": "sample string 27",
"JobSite": "sample string 28",
"ProjectContactPersonFirstName": "sample string 29",
"ProjectContactPersonLastName": "sample string 30",
"ProjectContactPersonEmail": "sample string 31",
"ProjectContactPersonPhone": "sample string 32",
"ProjectAddress": "sample string 33",
"ProjectCity": "sample string 34",
"ProjectZipCode": "sample string 35",
"IsSameAsAbove": 36
}
multipart/form-data, text/plain
Sample:
{"StoreId":1,"PropertyType":2,"CompanyName":"sample string 3","FirstName":"sample string 4","LastName":"sample string 5","SecondaryFirstName":"sample string 6","SecondaryLastName":"sample string 7","EmailAddress":"sample string 8","PhoneDay":"sample string 9","PhoneNight":"sample string 10","PhoneCell":"sample string 11","State":"sample string 12","City":"sample string 13","ZipCode":"sample string 14","Street":"sample string 15","Estimator":"sample string 16","EmployeeId":17,"AppointmentDate":"2026-01-10T15:55:35.3961453-05:00","ParentAppointmentID":"sample string 19","ParentSalesDocNo":"sample string 20","ParentGPCustomerNo":"sample string 21","IsExistingCommercial":22,"CompanyDepartment":23,"EstimatorId":24,"SalesReprensentativeId":25,"ClosetAddress":26,"ProjectName":"sample string 27","JobSite":"sample string 28","ProjectContactPersonFirstName":"sample string 29","ProjectContactPersonLastName":"sample string 30","ProjectContactPersonEmail":"sample string 31","ProjectContactPersonPhone":"sample string 32","ProjectAddress":"sample string 33","ProjectCity":"sample string 34","ProjectZipCode":"sample string 35","IsSameAsAbove":36}
application/xml, text/xml
Sample:
<FO_API_Utilities_GLOBAL_Class.NewAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FO_API_Utilities"> <AppointmentDate>2026-01-10T15:55:35.3961453-05:00</AppointmentDate> <City>sample string 13</City> <ClosetAddress>26</ClosetAddress> <CompanyDepartment>23</CompanyDepartment> <CompanyName>sample string 3</CompanyName> <EmailAddress>sample string 8</EmailAddress> <EmployeeId>17</EmployeeId> <Estimator>sample string 16</Estimator> <EstimatorId>24</EstimatorId> <FirstName>sample string 4</FirstName> <IsExistingCommercial>22</IsExistingCommercial> <IsSameAsAbove>36</IsSameAsAbove> <JobSite>sample string 28</JobSite> <LastName>sample string 5</LastName> <ParentAppointmentID>sample string 19</ParentAppointmentID> <ParentGPCustomerNo>sample string 21</ParentGPCustomerNo> <ParentSalesDocNo>sample string 20</ParentSalesDocNo> <PhoneCell>sample string 11</PhoneCell> <PhoneDay>sample string 9</PhoneDay> <PhoneNight>sample string 10</PhoneNight> <ProjectAddress>sample string 33</ProjectAddress> <ProjectCity>sample string 34</ProjectCity> <ProjectContactPersonEmail>sample string 31</ProjectContactPersonEmail> <ProjectContactPersonFirstName>sample string 29</ProjectContactPersonFirstName> <ProjectContactPersonLastName>sample string 30</ProjectContactPersonLastName> <ProjectContactPersonPhone>sample string 32</ProjectContactPersonPhone> <ProjectName>sample string 27</ProjectName> <ProjectZipCode>sample string 35</ProjectZipCode> <PropertyType>2</PropertyType> <SalesReprensentativeId>25</SalesReprensentativeId> <SecondaryFirstName>sample string 6</SecondaryFirstName> <SecondaryLastName>sample string 7</SecondaryLastName> <State>sample string 12</State> <StoreId>1</StoreId> <Street>sample string 15</Street> <ZipCode>sample string 14</ZipCode> </FO_API_Utilities_GLOBAL_Class.NewAppointment>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, multipart/form-data, text/plain, application/xml, text/xml
Sample:
Sample not available.