POST api/Jobs/PostJobAppointmentEngineer?userId={userId}&password={password}&version={version}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId | integer |
Required |
|
| password | string |
Required |
|
| version | string |
Required |
Body Parameters
Job_Appointment_Engineer| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| JobID | integer |
None. |
|
| JobNo | string |
None. |
|
| Job_AppointmentID | integer |
None. |
|
| ClientName | string |
None. |
|
| FullAddress | string |
None. |
|
| ResidentName | string |
None. |
|
| ContactNumber | string |
None. |
|
| AccessNote | string |
None. |
|
| NoLoneWorker | boolean |
None. |
|
| HasAsbestos | boolean |
None. |
|
| Client_WO | string |
None. |
|
| JobDescription | string |
None. |
|
| JobPriority | string |
None. |
|
| JobType | string |
None. |
|
| RequestedDate | date |
None. |
|
| ScheduledStartDate | date |
None. |
|
| AppointmentDate | date |
None. |
|
| AppointmentTimeslot | string |
None. |
|
| EnRouteDate | date |
None. |
|
| ArrivedDate | date |
None. |
|
| WorkStartedDate | date |
None. |
|
| WorkCompletedDate | date |
None. |
|
| AppointmentStatus | string |
None. |
|
| TaskDescription | string |
None. |
|
| TaskTrade | string |
None. |
|
| ClientID | integer |
None. |
|
| Client_PropertyID | integer |
None. |
|
| Job_TypeID | integer |
None. |
|
| AppointmentStatusID | integer |
None. |
|
| CompletedWorkDescription | string |
None. |
|
| TenantSignature | string |
None. |
|
| EngineerSignature | string |
None. |
|
| IsEnRouteSynced | boolean |
None. |
|
| IsArrivedSynced | boolean |
None. |
|
| IsInProgressSynced | boolean |
None. |
|
| IsWorkCompletedSynced | boolean |
None. |
|
| Job_Appointment_Engineers_OnHold_ReasonID | integer |
None. |
|
| Latitude | decimal number |
None. |
|
| Longitude | decimal number |
None. |
|
| Remedial_Actions | string |
None. |
|
| EngineerID | integer |
None. |
|
| Materials_Used | boolean |
None. |
|
| Material_Source | string |
None. |
|
| Material_Detail | string |
None. |
|
| ReceivedBy | string |
None. |
|
| TenantName | string |
None. |
|
| Gas_Capped | boolean |
None. |
|
| Temp_Heaters_Left | boolean |
None. |
|
| TenantDamage | boolean |
None. |
|
| TenantDamageDescription | string |
None. |
|
| UnsanitaryProperty | boolean |
None. |
|
| UnsanitaryPropertyDescription | string |
None. |
|
| SafeguardingIssues | boolean |
None. |
|
| SafeguardingIssuesDescription | string |
None. |
|
| DampIssues | boolean |
None. |
|
| DampIssuesDescription | string |
None. |
|
| RefusedReason | string |
None. |
|
| SatisfactionRefused | string |
None. |
|
| SatisfactionValue | integer |
None. |
|
| Tightness_Result | string |
None. |
|
| LogDate | date |
None. |
|
| ResponseDate | date |
None. |
|
| RequireCustSat | integer |
None. |
|
| Document_Field_Results | Collection of Document_Field_Result |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": 1,
"JobID": 2,
"JobNo": "sample string 3",
"Job_AppointmentID": 4,
"ClientName": "sample string 5",
"FullAddress": "sample string 6",
"ResidentName": "sample string 7",
"ContactNumber": "sample string 8",
"AccessNote": "sample string 9",
"NoLoneWorker": true,
"HasAsbestos": true,
"Client_WO": "sample string 12",
"JobDescription": "sample string 13",
"JobPriority": "sample string 14",
"JobType": "sample string 15",
"RequestedDate": "2026-09-01T19:30:04.2426934+01:00",
"ScheduledStartDate": "2026-09-01T19:30:04.2426934+01:00",
"AppointmentDate": "2026-09-01T19:30:04.2426934+01:00",
"AppointmentTimeslot": "sample string 16",
"EnRouteDate": "2026-09-01T19:30:04.2426934+01:00",
"ArrivedDate": "2026-09-01T19:30:04.2426934+01:00",
"WorkStartedDate": "2026-09-01T19:30:04.2426934+01:00",
"WorkCompletedDate": "2026-09-01T19:30:04.2426934+01:00",
"AppointmentStatus": "sample string 17",
"TaskDescription": "sample string 18",
"TaskTrade": "sample string 19",
"ClientID": 20,
"Client_PropertyID": 21,
"Job_TypeID": 22,
"AppointmentStatusID": 23,
"CompletedWorkDescription": "sample string 24",
"TenantSignature": "sample string 25",
"EngineerSignature": "sample string 26",
"IsEnRouteSynced": true,
"IsArrivedSynced": true,
"IsInProgressSynced": true,
"IsWorkCompletedSynced": true,
"Job_Appointment_Engineers_OnHold_ReasonID": 31,
"Latitude": 32.0,
"Longitude": 33.0,
"Remedial_Actions": "sample string 34",
"EngineerID": 35,
"Materials_Used": true,
"Material_Source": "sample string 37",
"Material_Detail": "sample string 38",
"ReceivedBy": "sample string 39",
"TenantName": "sample string 40",
"Gas_Capped": true,
"Temp_Heaters_Left": true,
"TenantDamage": true,
"TenantDamageDescription": "sample string 44",
"UnsanitaryProperty": true,
"UnsanitaryPropertyDescription": "sample string 46",
"SafeguardingIssues": true,
"SafeguardingIssuesDescription": "sample string 48",
"DampIssues": true,
"DampIssuesDescription": "sample string 50",
"RefusedReason": "sample string 51",
"SatisfactionRefused": "sample string 52",
"SatisfactionValue": 53,
"Tightness_Result": "sample string 54",
"LogDate": "2026-09-01T19:30:04.2447035+01:00",
"ResponseDate": "2026-09-01T19:30:04.2447035+01:00",
"RequireCustSat": 55,
"Document_Field_Results": [
{
"ID": 1,
"GUID": "67874cad-d324-4a13-bf28-76f36929453a",
"DocumentID": 3,
"FieldID": 4,
"ResultValue": "sample string 5",
"Job_FilesGUID": "432b3318-5e1a-4d43-83bb-17f8283d8679",
"JobPhotoGUID": "c85a5eb4-a141-4961-8268-5dd2d02a899a",
"NewDocumentFieldResult": true,
"SequenceGUID": "f1aa714f-cbf5-43ee-b451-6cb07690f750",
"Job_Appointment_EngineerID": 9
},
{
"ID": 1,
"GUID": "67874cad-d324-4a13-bf28-76f36929453a",
"DocumentID": 3,
"FieldID": 4,
"ResultValue": "sample string 5",
"Job_FilesGUID": "432b3318-5e1a-4d43-83bb-17f8283d8679",
"JobPhotoGUID": "c85a5eb4-a141-4961-8268-5dd2d02a899a",
"NewDocumentFieldResult": true,
"SequenceGUID": "f1aa714f-cbf5-43ee-b451-6cb07690f750",
"Job_Appointment_EngineerID": 9
}
]
}
application/xml, text/xml
Sample:
<Job_Appointment_Engineer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models">
<AccessNote>sample string 9</AccessNote>
<AppointmentDate>2026-09-01T19:30:04.2426934+01:00</AppointmentDate>
<AppointmentStatus>sample string 17</AppointmentStatus>
<AppointmentStatusID>23</AppointmentStatusID>
<AppointmentTimeslot>sample string 16</AppointmentTimeslot>
<ArrivedDate>2026-09-01T19:30:04.2426934+01:00</ArrivedDate>
<ClientID>20</ClientID>
<ClientName>sample string 5</ClientName>
<Client_PropertyID>21</Client_PropertyID>
<Client_WO>sample string 12</Client_WO>
<CompletedWorkDescription>sample string 24</CompletedWorkDescription>
<ContactNumber>sample string 8</ContactNumber>
<DampIssues>true</DampIssues>
<DampIssuesDescription>sample string 50</DampIssuesDescription>
<Document_Field_Results>
<Document_Field_Result>
<DocumentID>3</DocumentID>
<FieldID>4</FieldID>
<GUID>67874cad-d324-4a13-bf28-76f36929453a</GUID>
<ID>1</ID>
<JobPhotoGUID>c85a5eb4-a141-4961-8268-5dd2d02a899a</JobPhotoGUID>
<Job_Appointment_EngineerID>9</Job_Appointment_EngineerID>
<Job_FilesGUID>432b3318-5e1a-4d43-83bb-17f8283d8679</Job_FilesGUID>
<NewDocumentFieldResult>true</NewDocumentFieldResult>
<ResultValue>sample string 5</ResultValue>
<SequenceGUID>f1aa714f-cbf5-43ee-b451-6cb07690f750</SequenceGUID>
</Document_Field_Result>
<Document_Field_Result>
<DocumentID>3</DocumentID>
<FieldID>4</FieldID>
<GUID>67874cad-d324-4a13-bf28-76f36929453a</GUID>
<ID>1</ID>
<JobPhotoGUID>c85a5eb4-a141-4961-8268-5dd2d02a899a</JobPhotoGUID>
<Job_Appointment_EngineerID>9</Job_Appointment_EngineerID>
<Job_FilesGUID>432b3318-5e1a-4d43-83bb-17f8283d8679</Job_FilesGUID>
<NewDocumentFieldResult>true</NewDocumentFieldResult>
<ResultValue>sample string 5</ResultValue>
<SequenceGUID>f1aa714f-cbf5-43ee-b451-6cb07690f750</SequenceGUID>
</Document_Field_Result>
</Document_Field_Results>
<EnRouteDate>2026-09-01T19:30:04.2426934+01:00</EnRouteDate>
<EngineerID>35</EngineerID>
<EngineerSignature>sample string 26</EngineerSignature>
<FullAddress>sample string 6</FullAddress>
<Gas_Capped>true</Gas_Capped>
<HasAsbestos>true</HasAsbestos>
<ID>1</ID>
<IsArrivedSynced>true</IsArrivedSynced>
<IsEnRouteSynced>true</IsEnRouteSynced>
<IsInProgressSynced>true</IsInProgressSynced>
<IsWorkCompletedSynced>true</IsWorkCompletedSynced>
<JobDescription>sample string 13</JobDescription>
<JobID>2</JobID>
<JobNo>sample string 3</JobNo>
<JobPriority>sample string 14</JobPriority>
<JobType>sample string 15</JobType>
<Job_AppointmentID>4</Job_AppointmentID>
<Job_Appointment_Engineers_OnHold_ReasonID>31</Job_Appointment_Engineers_OnHold_ReasonID>
<Job_TypeID>22</Job_TypeID>
<Latitude>32</Latitude>
<LogDate>2026-09-01T19:30:04.2447035+01:00</LogDate>
<Longitude>33</Longitude>
<Material_Detail>sample string 38</Material_Detail>
<Material_Source>sample string 37</Material_Source>
<Materials_Used>true</Materials_Used>
<NoLoneWorker>true</NoLoneWorker>
<ReceivedBy>sample string 39</ReceivedBy>
<RefusedReason>sample string 51</RefusedReason>
<Remedial_Actions>sample string 34</Remedial_Actions>
<RequestedDate>2026-09-01T19:30:04.2426934+01:00</RequestedDate>
<RequireCustSat>55</RequireCustSat>
<ResidentName>sample string 7</ResidentName>
<ResponseDate>2026-09-01T19:30:04.2447035+01:00</ResponseDate>
<SafeguardingIssues>true</SafeguardingIssues>
<SafeguardingIssuesDescription>sample string 48</SafeguardingIssuesDescription>
<SatisfactionRefused>sample string 52</SatisfactionRefused>
<SatisfactionValue>53</SatisfactionValue>
<ScheduledStartDate>2026-09-01T19:30:04.2426934+01:00</ScheduledStartDate>
<TaskDescription>sample string 18</TaskDescription>
<TaskTrade>sample string 19</TaskTrade>
<Temp_Heaters_Left>true</Temp_Heaters_Left>
<TenantDamage>true</TenantDamage>
<TenantDamageDescription>sample string 44</TenantDamageDescription>
<TenantName>sample string 40</TenantName>
<TenantSignature>sample string 25</TenantSignature>
<Tightness_Result>sample string 54</Tightness_Result>
<UnsanitaryProperty>true</UnsanitaryProperty>
<UnsanitaryPropertyDescription>sample string 46</UnsanitaryPropertyDescription>
<WorkCompletedDate>2026-09-01T19:30:04.2426934+01:00</WorkCompletedDate>
<WorkStartedDate>2026-09-01T19:30:04.2426934+01:00</WorkStartedDate>
</Job_Appointment_Engineer>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.