POST api/SetupSaiPYEmployeeMaster/Onboarding/AddTechnicianWithEmployee
Request Information
URI Parameters
None.
Body Parameters
EmployeeOnboardingDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| IsTechnician | boolean |
None. |
|
| IsActive | boolean |
None. |
|
| IsSalesman | boolean |
None. |
|
| EmployeeNum | string |
None. |
|
| FirstName | string |
None. |
|
| MiddleName | string |
None. |
|
| LastName | string |
None. |
|
| LocationMasterId | integer |
None. |
|
| AddressLine1 | string |
None. |
|
| AddressLine2 | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| Country | string |
None. |
|
| SSN | string |
None. |
|
| HomePhone | string |
None. |
|
| WorkPhone | string |
None. |
|
| CellPhone1 | string |
None. |
|
| CellPhone2 | string |
None. |
|
| EmpNameOnCheck | string |
None. |
|
| DriverLicenseNumber | string |
None. |
|
| EmpDOB | date |
None. |
|
| EmpHireDate | date |
None. |
|
| EmpStatus | string |
None. |
|
| EmpSex | string |
None. |
|
| EEO | string |
None. |
|
| OverheadType | string |
None. |
|
| OverheadAmount | decimal number |
None. |
|
| IsPurchaser | boolean |
None. |
|
| TechNum | string |
None. |
|
| SalesmanNum | string |
None. |
|
| EmployeePicture | string |
None. |
|
| BreakType1 | integer |
None. |
|
| BreakCode1 | string |
None. |
|
| BreakName1 | string |
None. |
|
| BreakType2 | integer |
None. |
|
| BreakCode2 | string |
None. |
|
| BreakName2 | string |
None. |
|
| RegularRate | decimal number |
None. |
|
| OvertimeRate | decimal number |
None. |
|
| DoubleTimeRate | decimal number |
None. |
|
| TagId | integer |
None. |
|
| IsProjectManager | boolean |
None. |
|
| PersonalEmail | string |
None. |
|
| WorkEmail | string |
None. |
|
| AccountId | integer |
None. |
|
| CompanyId | string |
None. |
|
| CreatedOn | date |
None. |
|
| CreatedBy | string |
None. |
|
| UpdatedOn | date |
None. |
|
| UpdatedBy | string |
None. |
|
| IsLockedForEditing | boolean |
None. |
|
| LockedBy | string |
None. |
|
| Id | string |
None. |
|
| FieldPermissions | Collection of DTOFieldPermission |
None. |
|
| Technician | SetupSaiSDTechMaster |
None. |
|
| Salesman | SetupSMSalesman |
None. |
Request Formats
application/json, text/json
Sample:
{
"Technician": {
"TechNum": "sample string 1",
"TechNameInternal": "sample string 2",
"TechNameExternal": "sample string 3",
"SetupSDTechTradeId": "sample string 4",
"TechTradeDescription": "sample string 5",
"SetupSDTechLevelId": "sample string 6",
"TechLevelDescription": "sample string 7",
"JCTrade": "sample string 8",
"JCLevel": "sample string 9",
"BeginTime": "00:00:00.1234567",
"AvailableHrs": 11.0,
"Zone": "sample string 12",
"ZoneDescr": "sample string 13",
"GPSVehicleLabel": "sample string 14",
"CrewCode": "sample string 15",
"CrewName": "sample string 16",
"EmployeeNum": "sample string 17",
"StartWorkFromHomeOrOffice": "sample string 18",
"TechOnRemote": true,
"IsEligibleForFirstCall": true,
"ShowOnDispatchBoard": true,
"IsActive": true,
"EntityType": "sample string 23",
"EntityCode": "sample string 24",
"TagId": 1,
"TruckWarehouseNum": "sample string 25",
"Biodata": "sample string 26",
"TechStatus": "sample string 27",
"CustomerFacingPhone": "sample string 28",
"TechProfilePictureUrl": "sample string 29",
"AccountId": 30,
"CompanyId": "sample string 31",
"CreatedOn": "2025-12-16T21:58:30.8853571+00:00",
"CreatedBy": "sample string 33",
"UpdatedOn": "2025-12-16T21:58:30.8853571+00:00",
"UpdatedBy": "sample string 34",
"IsLockedForEditing": true,
"LockedBy": "sample string 36"
},
"Salesman": {
"SalesmanNum": "sample string 1",
"SalesmanName": "sample string 2",
"InternalName": "sample string 3",
"ExternalName": "sample string 4",
"EnableSalesman": true,
"EstimateWorkHrs": 6.0,
"StartFromOfficeOrHome": "sample string 7",
"EmployeeNum": "sample string 8",
"TechNameInternal": "sample string 9",
"OnDuty": true,
"CardTagId": 1,
"CardTag": "sample string 10",
"SalesmanTagId": 1,
"SalesmanSetupTagName": "sample string 11",
"AccountId": 12,
"CompanyId": "sample string 13",
"CreatedBy": "sample string 14",
"CreatedOn": "2025-12-16T21:58:30.9144321+00:00"
},
"IsTechnician": true,
"IsActive": true,
"IsSalesman": true,
"EmployeeNum": "sample string 4",
"FirstName": "sample string 5",
"MiddleName": "sample string 6",
"LastName": "sample string 7",
"LocationMasterId": 1,
"AddressLine1": "sample string 8",
"AddressLine2": "sample string 9",
"City": "sample string 10",
"State": "sample string 11",
"Zip": "sample string 12",
"Country": "sample string 13",
"SSN": "sample string 14",
"HomePhone": "sample string 15",
"WorkPhone": "sample string 16",
"CellPhone1": "sample string 17",
"CellPhone2": "sample string 18",
"EmpNameOnCheck": "sample string 19",
"DriverLicenseNumber": "sample string 20",
"EmpDOB": "2025-12-16T21:58:30.8853571+00:00",
"EmpHireDate": "2025-12-16T21:58:30.8853571+00:00",
"EmpStatus": "sample string 23",
"EmpSex": "sample string 24",
"EEO": "sample string 25",
"OverheadType": "sample string 26",
"OverheadAmount": 27.0,
"IsPurchaser": true,
"TechNum": "sample string 29",
"SalesmanNum": "sample string 30",
"EmployeePicture": "sample string 31",
"BreakType1": 1,
"BreakCode1": "sample string 32",
"BreakName1": "sample string 33",
"BreakType2": 1,
"BreakCode2": "sample string 34",
"BreakName2": "sample string 35",
"RegularRate": 1.0,
"OvertimeRate": 1.0,
"DoubleTimeRate": 1.0,
"TagId": 1,
"IsProjectManager": true,
"PersonalEmail": "sample string 37",
"WorkEmail": "sample string 38",
"AccountId": 39,
"CompanyId": "sample string 40",
"CreatedOn": "2025-12-16T21:58:30.8853571+00:00",
"CreatedBy": "sample string 42",
"UpdatedOn": "2025-12-16T21:58:30.8853571+00:00",
"UpdatedBy": "sample string 43",
"IsLockedForEditing": true,
"LockedBy": "sample string 45",
"Id": "sample string 46",
"FieldPermissions": []
}
application/xml, text/xml
Sample:
<EmployeeOnboardingDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Setup">
<Id xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 46</Id>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 42</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T21:58:30.8853571+00:00</CreatedOn>
<IsLockedForEditing xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">true</IsLockedForEditing>
<LockedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 45</LockedBy>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 43</UpdatedBy>
<UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T21:58:30.8853571+00:00</UpdatedOn>
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">39</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 40</CompanyId>
<AddressLine1>sample string 8</AddressLine1>
<AddressLine2>sample string 9</AddressLine2>
<BreakCode1>sample string 32</BreakCode1>
<BreakCode2>sample string 34</BreakCode2>
<BreakName1>sample string 33</BreakName1>
<BreakName2>sample string 35</BreakName2>
<BreakType1>1</BreakType1>
<BreakType2>1</BreakType2>
<CellPhone1>sample string 17</CellPhone1>
<CellPhone2>sample string 18</CellPhone2>
<City>sample string 10</City>
<Country>sample string 13</Country>
<DoubleTimeRate>1</DoubleTimeRate>
<DriverLicenseNumber>sample string 20</DriverLicenseNumber>
<EEO>sample string 25</EEO>
<EmpDOB>2025-12-16T21:58:30.8853571+00:00</EmpDOB>
<EmpHireDate>2025-12-16T21:58:30.8853571+00:00</EmpHireDate>
<EmpNameOnCheck>sample string 19</EmpNameOnCheck>
<EmpSex>sample string 24</EmpSex>
<EmpStatus>sample string 23</EmpStatus>
<EmployeeNum>sample string 4</EmployeeNum>
<EmployeePicture>sample string 31</EmployeePicture>
<FirstName>sample string 5</FirstName>
<HomePhone>sample string 15</HomePhone>
<IsProjectManager>true</IsProjectManager>
<IsPurchaser>true</IsPurchaser>
<LastName>sample string 7</LastName>
<LocationMasterId>1</LocationMasterId>
<MiddleName>sample string 6</MiddleName>
<OverheadAmount>27</OverheadAmount>
<OverheadType>sample string 26</OverheadType>
<OvertimeRate>1</OvertimeRate>
<PersonalEmail>sample string 37</PersonalEmail>
<RegularRate>1</RegularRate>
<SSN>sample string 14</SSN>
<SalesmanNum>sample string 30</SalesmanNum>
<State>sample string 11</State>
<TagId>1</TagId>
<TechNum>sample string 29</TechNum>
<WorkEmail>sample string 38</WorkEmail>
<WorkPhone>sample string 16</WorkPhone>
<Zip>sample string 12</Zip>
<IsActive>true</IsActive>
<IsSalesman>true</IsSalesman>
<IsTechnician>true</IsTechnician>
<Salesman>
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">12</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 13</CompanyId>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 14</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T21:58:30.9144321+00:00</CreatedOn>
<CardTag>sample string 10</CardTag>
<CardTagId>1</CardTagId>
<EmployeeNum>sample string 8</EmployeeNum>
<EnableSalesman>true</EnableSalesman>
<EstimateWorkHrs>6</EstimateWorkHrs>
<ExternalName>sample string 4</ExternalName>
<InternalName>sample string 3</InternalName>
<OnDuty>true</OnDuty>
<SalesmanName>sample string 2</SalesmanName>
<SalesmanNum>sample string 1</SalesmanNum>
<SalesmanSetupTagName>sample string 11</SalesmanSetupTagName>
<SalesmanTagId>1</SalesmanTagId>
<StartFromOfficeOrHome>sample string 7</StartFromOfficeOrHome>
<TechNameInternal>sample string 9</TechNameInternal>
</Salesman>
<Technician>
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">30</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 31</CompanyId>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 33</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T21:58:30.8853571+00:00</CreatedOn>
<IsLockedForEditing xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">true</IsLockedForEditing>
<LockedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 36</LockedBy>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 34</UpdatedBy>
<UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T21:58:30.8853571+00:00</UpdatedOn>
<AvailableHrs>11</AvailableHrs>
<BeginTime>PT0.1234567S</BeginTime>
<Biodata>sample string 26</Biodata>
<CrewCode>sample string 15</CrewCode>
<CrewName>sample string 16</CrewName>
<CustomerFacingPhone>sample string 28</CustomerFacingPhone>
<EmployeeNum>sample string 17</EmployeeNum>
<EntityCode>sample string 24</EntityCode>
<EntityType>sample string 23</EntityType>
<GPSVehicleLabel>sample string 14</GPSVehicleLabel>
<IsActive>true</IsActive>
<IsEligibleForFirstCall>true</IsEligibleForFirstCall>
<JCLevel>sample string 9</JCLevel>
<JCTrade>sample string 8</JCTrade>
<SetupSDTechLevelId>sample string 6</SetupSDTechLevelId>
<SetupSDTechTradeId>sample string 4</SetupSDTechTradeId>
<ShowOnDispatchBoard>true</ShowOnDispatchBoard>
<StartWorkFromHomeOrOffice>sample string 18</StartWorkFromHomeOrOffice>
<TagId>1</TagId>
<TechLevelDescription>sample string 7</TechLevelDescription>
<TechNameExternal>sample string 3</TechNameExternal>
<TechNameInternal>sample string 2</TechNameInternal>
<TechNum>sample string 1</TechNum>
<TechOnRemote>true</TechOnRemote>
<TechProfilePictureUrl>sample string 29</TechProfilePictureUrl>
<TechStatus>sample string 27</TechStatus>
<TechTradeDescription>sample string 5</TechTradeDescription>
<TruckWarehouseNum>sample string 25</TruckWarehouseNum>
<Zone>sample string 12</Zone>
<ZoneDescr>sample string 13</ZoneDescr>
</Technician>
</EmployeeOnboardingDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ObjectNone.
Response Formats
application/json, text/json
Sample:
{}
application/xml, text/xml
Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />