POST Api/Employees/Add

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EmailAddress	EmailAddress	None.
Name	PersonName	None.
Address	AddressVm	None.
Title	string	None.
FirstName	string	None.
MiddleName	string	None.
LastName	string	None.
Suffix	string	None.
PhoneNumber	string	None.
CellNumber	string	None.
Fax	string	None.
Email	string	None.
HireDate	date	None.
TermDate	date	None.
FinalCheckDate	date	None.
CanRehire	boolean	None.
HourlyRate	decimal number	None.
Salary	decimal number	None.
ExternalId	string	None.
FullPartTime	string	None.
Is1099	boolean	None.
ShiftMinimum	integer	None.
ExtraShiftRate	decimal number	None.
IsZoneManager	boolean	None.
IssuedKeys	boolean	None.
IssuedEmail	boolean	None.
IssuedEmrAccess	boolean	None.
IssuedApothecaAccess	boolean	None.
IssuedFormSiteAccess	boolean	None.
IsOnLeave	boolean	None.
IsEmployed	boolean	None.
IsNewHire	boolean	None.
Address1	string	None.
Address2	string	None.
City	string	None.
Province	string	None.
Country	string	None.
PostalCode	string	None.
PositionId	integer	None.
ZoneId	integer	None.
TerminationReasonId	integer	None.
ClinicId	integer	None.
ZoneManagerId	integer	None.
PhysicianId	integer	None.
SocialSecurityNumber	string	None.
DateOfBirth	string	None.
IdentificationCard	string	None.
ProfilePicture	string	None.
Physician	PhysicianAddVm	None.
HoursAllowedPerPayPeriod	decimal number	None.
HoursPreferred	decimal number	None.
EmployeeRank	integer	None.
WorkOvertime	boolean	None.
MoreImportant	string	None.
EmployeeRankClinics	Collection of EmployeeRankClinicsVm	None.
EmployeeWorkPreferences	Collection of EmployeeWorkPreferenceVM	None.
AzureIdentificationCard	string	None.
AzureProfilePicture	string	None.

Request Formats

application/json, text/json

Sample:

{
  "emailAddress": {
    "email": "sample string 9",
    "isValid": false
  },
  "name": {
    "firstName": "sample string 2",
    "middleName": "sample string 3",
    "lastName": "sample string 4"
  },
  "address": {
    "address1": "sample string 22",
    "address2": "sample string 23",
    "city": "sample string 24",
    "province": "sample string 25",
    "country": "sample string 26"
  },
  "title": "sample string 1",
  "firstName": "sample string 2",
  "middleName": "sample string 3",
  "lastName": "sample string 4",
  "suffix": "sample string 5",
  "phoneNumber": "sample string 6",
  "cellNumber": "sample string 7",
  "fax": "sample string 8",
  "email": "sample string 9",
  "hireDate": "2026-05-06T04:09:24.0102703+02:00",
  "termDate": "2026-05-06T04:09:24.0112717+02:00",
  "finalCheckDate": "2026-05-06T04:09:24.0112717+02:00",
  "canRehire": true,
  "hourlyRate": 1.0,
  "salary": 1.0,
  "externalId": "sample string 10",
  "fullPartTime": "sample string 11",
  "is1099": true,
  "shiftMinimum": 1,
  "extraShiftRate": 1.0,
  "isZoneManager": true,
  "issuedKeys": true,
  "issuedEmail": true,
  "issuedEmrAccess": true,
  "issuedApothecaAccess": true,
  "issuedFormSiteAccess": true,
  "isOnLeave": true,
  "isEmployed": true,
  "isNewHire": true,
  "address1": "sample string 22",
  "address2": "sample string 23",
  "city": "sample string 24",
  "province": "sample string 25",
  "country": "sample string 26",
  "postalCode": "sample string 27",
  "positionId": 1,
  "zoneId": 1,
  "terminationReasonId": 1,
  "clinicId": 1,
  "zoneManagerId": 1,
  "physicianId": 1,
  "socialSecurityNumber": "sample string 28",
  "dateOfBirth": "sample string 29",
  "identificationCard": "sample string 30",
  "profilePicture": "sample string 31",
  "physician": {
    "physicianId": 1,
    "firstName": "sample string 2",
    "middleName": "sample string 3",
    "lastName": "sample string 4",
    "suffix": "sample string 5",
    "title": "sample string 6",
    "license": "sample string 7",
    "isSupervisingPhysician": true,
    "taxonomyCode": "sample string 9",
    "npiNumber": "sample string 10",
    "deaNumber": "sample string 11",
    "taxId": "sample string 12",
    "supervisingPhysicianId": 1,
    "classification": "sample string 13",
    "country": "sample string 14",
    "primaryAddress1": "sample string 15",
    "primaryAddress2": "sample string 16",
    "primaryCity": "sample string 17",
    "primaryProvince": "sample string 18",
    "primaryPostalCode": "sample string 19",
    "billingCountry": "sample string 20",
    "billingAddress1": "sample string 21",
    "billingAddress2": "sample string 22",
    "billingCity": "sample string 23",
    "billingProvince": "sample string 24",
    "billingPostalCode": "sample string 25",
    "signOffCode": "sample string 26",
    "phoneNumber": "sample string 27",
    "emailAddress": "sample string 28",
    "createdOn": "2026-05-06T04:09:24.0122724+02:00",
    "modifiedOn": "2026-05-06T04:09:24.0122724+02:00",
    "isActive": true,
    "profileText": "sample string 30",
    "externalProviderID": "sample string 31",
    "employeeId": 32
  },
  "hoursAllowedPerPayPeriod": 32.0,
  "hoursPreferred": 33.0,
  "employeeRank": 34,
  "workOvertime": true,
  "moreImportant": "sample string 36",
  "employeeRankClinics": [
    {
      "employeeRankClinicsId": 1,
      "zoneId": 2,
      "clinicId": 3,
      "clinicName": "sample string 4",
      "employeeId": 5,
      "recOrder": 6,
      "employeeRank": 7
    },
    {
      "employeeRankClinicsId": 1,
      "zoneId": 2,
      "clinicId": 3,
      "clinicName": "sample string 4",
      "employeeId": 5,
      "recOrder": 6,
      "employeeRank": 7
    }
  ],
  "employeeWorkPreferences": [
    {
      "employeeWorkPreferenceId": 1,
      "employeeId": 2,
      "day": "sample string 3",
      "cannotWork": true,
      "anyTime": true,
      "preferred": true,
      "available": true,
      "timeFrom": "2026-05-06T04:09:24.0122724+02:00",
      "timeTo": "2026-05-06T04:09:24.0122724+02:00"
    },
    {
      "employeeWorkPreferenceId": 1,
      "employeeId": 2,
      "day": "sample string 3",
      "cannotWork": true,
      "anyTime": true,
      "preferred": true,
      "available": true,
      "timeFrom": "2026-05-06T04:09:24.0122724+02:00",
      "timeTo": "2026-05-06T04:09:24.0122724+02:00"
    }
  ],
  "azureIdentificationCard": "sample string 37",
  "azureProfilePicture": "sample string 38"
}

text/html

Sample:

{"emailAddress":{"email":"sample string 9","isValid":false},"name":{"firstName":"sample string 2","middleName":"sample string 3","lastName":"sample string 4"},"address":{"address1":"sample string 22","address2":"sample string 23","city":"sample string 24","province":"sample string 25","country":"sample string 26"},"title":"sample string 1","firstName":"sample string 2","middleName":"sample string 3","lastName":"sample string 4","suffix":"sample string 5","phoneNumber":"sample string 6","cellNumber":"sample string 7","fax":"sample string 8","email":"sample string 9","hireDate":"2026-05-06T04:09:24.0102703+02:00","termDate":"2026-05-06T04:09:24.0112717+02:00","finalCheckDate":"2026-05-06T04:09:24.0112717+02:00","canRehire":true,"hourlyRate":1.0,"salary":1.0,"externalId":"sample string 10","fullPartTime":"sample string 11","is1099":true,"shiftMinimum":1,"extraShiftRate":1.0,"isZoneManager":true,"issuedKeys":true,"issuedEmail":true,"issuedEmrAccess":true,"issuedApothecaAccess":true,"issuedFormSiteAccess":true,"isOnLeave":true,"isEmployed":true,"isNewHire":true,"address1":"sample string 22","address2":"sample string 23","city":"sample string 24","province":"sample string 25","country":"sample string 26","postalCode":"sample string 27","positionId":1,"zoneId":1,"terminationReasonId":1,"clinicId":1,"zoneManagerId":1,"physicianId":1,"socialSecurityNumber":"sample string 28","dateOfBirth":"sample string 29","identificationCard":"sample string 30","profilePicture":"sample string 31","physician":{"physicianId":1,"firstName":"sample string 2","middleName":"sample string 3","lastName":"sample string 4","suffix":"sample string 5","title":"sample string 6","license":"sample string 7","isSupervisingPhysician":true,"taxonomyCode":"sample string 9","npiNumber":"sample string 10","deaNumber":"sample string 11","taxId":"sample string 12","supervisingPhysicianId":1,"classification":"sample string 13","country":"sample string 14","primaryAddress1":"sample string 15","primaryAddress2":"sample string 16","primaryCity":"sample string 17","primaryProvince":"sample string 18","primaryPostalCode":"sample string 19","billingCountry":"sample string 20","billingAddress1":"sample string 21","billingAddress2":"sample string 22","billingCity":"sample string 23","billingProvince":"sample string 24","billingPostalCode":"sample string 25","signOffCode":"sample string 26","phoneNumber":"sample string 27","emailAddress":"sample string 28","createdOn":"2026-05-06T04:09:24.0122724+02:00","modifiedOn":"2026-05-06T04:09:24.0122724+02:00","isActive":true,"profileText":"sample string 30","externalProviderID":"sample string 31","employeeId":32},"hoursAllowedPerPayPeriod":32.0,"hoursPreferred":33.0,"employeeRank":34,"workOvertime":true,"moreImportant":"sample string 36","employeeRankClinics":[{"employeeRankClinicsId":1,"zoneId":2,"clinicId":3,"clinicName":"sample string 4","employeeId":5,"recOrder":6,"employeeRank":7},{"employeeRankClinicsId":1,"zoneId":2,"clinicId":3,"clinicName":"sample string 4","employeeId":5,"recOrder":6,"employeeRank":7}],"employeeWorkPreferences":[{"employeeWorkPreferenceId":1,"employeeId":2,"day":"sample string 3","cannotWork":true,"anyTime":true,"preferred":true,"available":true,"timeFrom":"2026-05-06T04:09:24.0122724+02:00","timeTo":"2026-05-06T04:09:24.0122724+02:00"},{"employeeWorkPreferenceId":1,"employeeId":2,"day":"sample string 3","cannotWork":true,"anyTime":true,"preferred":true,"available":true,"timeFrom":"2026-05-06T04:09:24.0122724+02:00","timeTo":"2026-05-06T04:09:24.0122724+02:00"}],"azureIdentificationCard":"sample string 37","azureProfilePicture":"sample string 38"}

application/xml, text/xml

Sample:

<EmployeeAddVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UrgentCareExtra.ViewModels.ViewModels.HR">
  <Address1>sample string 22</Address1>
  <Address2>sample string 23</Address2>
  <AzureIdentificationCard>sample string 37</AzureIdentificationCard>
  <AzureProfilePicture>sample string 38</AzureProfilePicture>
  <CanRehire>true</CanRehire>
  <CellNumber>sample string 7</CellNumber>
  <City>sample string 24</City>
  <ClinicId>1</ClinicId>
  <Country>sample string 26</Country>
  <DateOfBirth>sample string 29</DateOfBirth>
  <Email>sample string 9</Email>
  <EmployeeRank>34</EmployeeRank>
  <EmployeeRankClinics>
    <EmployeeRankClinicsVm>
      <ClinicId>3</ClinicId>
      <ClinicName>sample string 4</ClinicName>
      <EmployeeId>5</EmployeeId>
      <EmployeeRank>7</EmployeeRank>
      <EmployeeRankClinicsId>1</EmployeeRankClinicsId>
      <RecOrder>6</RecOrder>
      <ZoneId>2</ZoneId>
    </EmployeeRankClinicsVm>
    <EmployeeRankClinicsVm>
      <ClinicId>3</ClinicId>
      <ClinicName>sample string 4</ClinicName>
      <EmployeeId>5</EmployeeId>
      <EmployeeRank>7</EmployeeRank>
      <EmployeeRankClinicsId>1</EmployeeRankClinicsId>
      <RecOrder>6</RecOrder>
      <ZoneId>2</ZoneId>
    </EmployeeRankClinicsVm>
  </EmployeeRankClinics>
  <EmployeeWorkPreferences>
    <EmployeeWorkPreferenceVM>
      <AnyTime>true</AnyTime>
      <Available>true</Available>
      <CannotWork>true</CannotWork>
      <Day>sample string 3</Day>
      <EmployeeId>2</EmployeeId>
      <EmployeeWorkPreferenceId>1</EmployeeWorkPreferenceId>
      <Preferred>true</Preferred>
      <TimeFrom>2026-05-06T04:09:24.0122724+02:00</TimeFrom>
      <TimeTo>2026-05-06T04:09:24.0122724+02:00</TimeTo>
    </EmployeeWorkPreferenceVM>
    <EmployeeWorkPreferenceVM>
      <AnyTime>true</AnyTime>
      <Available>true</Available>
      <CannotWork>true</CannotWork>
      <Day>sample string 3</Day>
      <EmployeeId>2</EmployeeId>
      <EmployeeWorkPreferenceId>1</EmployeeWorkPreferenceId>
      <Preferred>true</Preferred>
      <TimeFrom>2026-05-06T04:09:24.0122724+02:00</TimeFrom>
      <TimeTo>2026-05-06T04:09:24.0122724+02:00</TimeTo>
    </EmployeeWorkPreferenceVM>
  </EmployeeWorkPreferences>
  <ExternalId>sample string 10</ExternalId>
  <ExtraShiftRate>1</ExtraShiftRate>
  <Fax>sample string 8</Fax>
  <FinalCheckDate>2026-05-06T04:09:24.0112717+02:00</FinalCheckDate>
  <FirstName>sample string 2</FirstName>
  <FullPartTime>sample string 11</FullPartTime>
  <HireDate>2026-05-06T04:09:24.0102703+02:00</HireDate>
  <HourlyRate>1</HourlyRate>
  <HoursAllowedPerPayPeriod>32</HoursAllowedPerPayPeriod>
  <HoursPreferred>33</HoursPreferred>
  <IdentificationCard>sample string 30</IdentificationCard>
  <Is1099>true</Is1099>
  <IsEmployed>true</IsEmployed>
  <IsNewHire>true</IsNewHire>
  <IsOnLeave>true</IsOnLeave>
  <IsZoneManager>true</IsZoneManager>
  <IssuedApothecaAccess>true</IssuedApothecaAccess>
  <IssuedEmail>true</IssuedEmail>
  <IssuedEmrAccess>true</IssuedEmrAccess>
  <IssuedFormSiteAccess>true</IssuedFormSiteAccess>
  <IssuedKeys>true</IssuedKeys>
  <LastName>sample string 4</LastName>
  <MiddleName>sample string 3</MiddleName>
  <MoreImportant>sample string 36</MoreImportant>
  <PhoneNumber>sample string 6</PhoneNumber>
  <Physician xmlns:d2p1="http://schemas.datacontract.org/2004/07/UrgentCareExtra.ViewModels.ViewModels.Physician">
    <d2p1:BillingAddress1>sample string 21</d2p1:BillingAddress1>
    <d2p1:BillingAddress2>sample string 22</d2p1:BillingAddress2>
    <d2p1:BillingCity>sample string 23</d2p1:BillingCity>
    <d2p1:BillingCountry>sample string 20</d2p1:BillingCountry>
    <d2p1:BillingPostalCode>sample string 25</d2p1:BillingPostalCode>
    <d2p1:BillingProvince>sample string 24</d2p1:BillingProvince>
    <d2p1:Classification>sample string 13</d2p1:Classification>
    <d2p1:Country>sample string 14</d2p1:Country>
    <d2p1:CreatedOn>2026-05-06T04:09:24.0122724+02:00</d2p1:CreatedOn>
    <d2p1:DeaNumber>sample string 11</d2p1:DeaNumber>
    <d2p1:EmailAddress>sample string 28</d2p1:EmailAddress>
    <d2p1:EmployeeId>32</d2p1:EmployeeId>
    <d2p1:ExternalProviderID>sample string 31</d2p1:ExternalProviderID>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:IsActive>true</d2p1:IsActive>
    <d2p1:IsSupervisingPhysician>true</d2p1:IsSupervisingPhysician>
    <d2p1:LastName>sample string 4</d2p1:LastName>
    <d2p1:License>sample string 7</d2p1:License>
    <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
    <d2p1:ModifiedOn>2026-05-06T04:09:24.0122724+02:00</d2p1:ModifiedOn>
    <d2p1:NpiNumber>sample string 10</d2p1:NpiNumber>
    <d2p1:PhoneNumber>sample string 27</d2p1:PhoneNumber>
    <d2p1:PhysicianId>1</d2p1:PhysicianId>
    <d2p1:PrimaryAddress1>sample string 15</d2p1:PrimaryAddress1>
    <d2p1:PrimaryAddress2>sample string 16</d2p1:PrimaryAddress2>
    <d2p1:PrimaryCity>sample string 17</d2p1:PrimaryCity>
    <d2p1:PrimaryPostalCode>sample string 19</d2p1:PrimaryPostalCode>
    <d2p1:PrimaryProvince>sample string 18</d2p1:PrimaryProvince>
    <d2p1:ProfileText>sample string 30</d2p1:ProfileText>
    <d2p1:SignOffCode>sample string 26</d2p1:SignOffCode>
    <d2p1:Suffix>sample string 5</d2p1:Suffix>
    <d2p1:SupervisingPhysicianId>1</d2p1:SupervisingPhysicianId>
    <d2p1:TaxId>sample string 12</d2p1:TaxId>
    <d2p1:TaxonomyCode>sample string 9</d2p1:TaxonomyCode>
    <d2p1:Title>sample string 6</d2p1:Title>
  </Physician>
  <PhysicianId>1</PhysicianId>
  <PositionId>1</PositionId>
  <PostalCode>sample string 27</PostalCode>
  <ProfilePicture>sample string 31</ProfilePicture>
  <Province>sample string 25</Province>
  <Salary>1</Salary>
  <ShiftMinimum>1</ShiftMinimum>
  <SocialSecurityNumber>sample string 28</SocialSecurityNumber>
  <Suffix>sample string 5</Suffix>
  <TermDate>2026-05-06T04:09:24.0112717+02:00</TermDate>
  <TerminationReasonId>1</TerminationReasonId>
  <Title>sample string 1</Title>
  <WorkOvertime>true</WorkOvertime>
  <ZoneId>1</ZoneId>
  <ZoneManagerId>1</ZoneManagerId>
</EmployeeAddVm>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.