POST web/admin/workforce/employees/create

No documentation available.

Request Information

Parameters

Name	Description	Additional information
inVO	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "entityType": "sample string 1",
  "entityId": "sample string 2",
  "forEmbed": true,
  "pageSuffix": "sample string 4",
  "curUserId": "sample string 5",
  "isSSO": true,
  "requestHost": "sample string 7",
  "applicationPath": "sample string 8",
  "secureApplicationPath": "sample string 9",
  "absoluteApplicationPath": "sample string 10",
  "isHttps": true,
  "isMobileDevice": true,
  "isElectron": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 15",
  "clientOS": "sample string 16",
  "clientBuild": "sample string 17",
  "premiumAppId": "sample string 18",
  "clientWidth": 19,
  "clientHeight": 20,
  "timezone": 21,
  "payload": {
    "id": "sample string 1",
    "userId": "sample string 2",
    "displayName": "sample string 3",
    "email": "sample string 4",
    "phone": "sample string 5",
    "employeeNumber": "sample string 6",
    "employmentType": "sample string 7",
    "isStudent": true,
    "maxHoursPerWeek": 1,
    "hireDate": "sample string 8",
    "terminationDate": "sample string 9",
    "supervisorId": "sample string 10",
    "photoUrl": "sample string 11",
    "positions": [
      {
        "positionId": "sample string 1",
        "wageCents": 1,
        "isPrimary": true
      },
      {
        "positionId": "sample string 1",
        "wageCents": 1,
        "isPrimary": true
      },
      {
        "positionId": "sample string 1",
        "wageCents": 1,
        "isPrimary": true
      }
    ],
    "certifications": [
      {
        "certId": "sample string 1",
        "issuedDate": "sample string 2",
        "expirationDate": "sample string 3"
      },
      {
        "certId": "sample string 1",
        "issuedDate": "sample string 2",
        "expirationDate": "sample string 3"
      },
      {
        "certId": "sample string 1",
        "issuedDate": "sample string 2",
        "expirationDate": "sample string 3"
      }
    ]
  },
  "pageType": 0
}

application/xml, text/xml

Sample:

<WorkforceEmployeeSaveInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Web.API.VO.Input.Workforce">
  <ClientHeight xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">20</ClientHeight>
  <ClientType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">Site</ClientType>
  <ClientWidth xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">19</ClientWidth>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 10</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 8</applicationPath>
  <cachedKey xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</cachedKey>
  <clientBuild xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 17</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 16</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 15</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 5</curUserId>
  <isElectron xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isElectron>
  <isFullEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isFullEmbed>
  <isHttps xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isHttps>
  <isMobileDevice xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isMobileDevice>
  <isSSO xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isSSO>
  <premiumAppId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 18</premiumAppId>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 7</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 9</secureApplicationPath>
  <timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">21</timezone>
  <entityId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 2</entityId>
  <entityType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</entityType>
  <forEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</forEmbed>
  <pageSuffix xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 4</pageSuffix>
  <pageType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">FrontPage</pageType>
  <payload xmlns:d2p1="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input.Workforce">
    <d2p1:certifications>
      <d2p1:WorkforceEmployeeCertPayload>
        <d2p1:certId>sample string 1</d2p1:certId>
        <d2p1:expirationDate>sample string 3</d2p1:expirationDate>
        <d2p1:issuedDate>sample string 2</d2p1:issuedDate>
      </d2p1:WorkforceEmployeeCertPayload>
      <d2p1:WorkforceEmployeeCertPayload>
        <d2p1:certId>sample string 1</d2p1:certId>
        <d2p1:expirationDate>sample string 3</d2p1:expirationDate>
        <d2p1:issuedDate>sample string 2</d2p1:issuedDate>
      </d2p1:WorkforceEmployeeCertPayload>
      <d2p1:WorkforceEmployeeCertPayload>
        <d2p1:certId>sample string 1</d2p1:certId>
        <d2p1:expirationDate>sample string 3</d2p1:expirationDate>
        <d2p1:issuedDate>sample string 2</d2p1:issuedDate>
      </d2p1:WorkforceEmployeeCertPayload>
    </d2p1:certifications>
    <d2p1:displayName>sample string 3</d2p1:displayName>
    <d2p1:email>sample string 4</d2p1:email>
    <d2p1:employeeNumber>sample string 6</d2p1:employeeNumber>
    <d2p1:employmentType>sample string 7</d2p1:employmentType>
    <d2p1:hireDate>sample string 8</d2p1:hireDate>
    <d2p1:id>sample string 1</d2p1:id>
    <d2p1:isStudent>true</d2p1:isStudent>
    <d2p1:maxHoursPerWeek>1</d2p1:maxHoursPerWeek>
    <d2p1:phone>sample string 5</d2p1:phone>
    <d2p1:photoUrl>sample string 11</d2p1:photoUrl>
    <d2p1:positions>
      <d2p1:WorkforceEmployeePositionPayload>
        <d2p1:isPrimary>true</d2p1:isPrimary>
        <d2p1:positionId>sample string 1</d2p1:positionId>
        <d2p1:wageCents>1</d2p1:wageCents>
      </d2p1:WorkforceEmployeePositionPayload>
      <d2p1:WorkforceEmployeePositionPayload>
        <d2p1:isPrimary>true</d2p1:isPrimary>
        <d2p1:positionId>sample string 1</d2p1:positionId>
        <d2p1:wageCents>1</d2p1:wageCents>
      </d2p1:WorkforceEmployeePositionPayload>
      <d2p1:WorkforceEmployeePositionPayload>
        <d2p1:isPrimary>true</d2p1:isPrimary>
        <d2p1:positionId>sample string 1</d2p1:positionId>
        <d2p1:wageCents>1</d2p1:wageCents>
      </d2p1:WorkforceEmployeePositionPayload>
    </d2p1:positions>
    <d2p1:supervisorId>sample string 10</d2p1:supervisorId>
    <d2p1:terminationDate>sample string 9</d2p1:terminationDate>
    <d2p1:userId>sample string 2</d2p1:userId>
  </payload>
</WorkforceEmployeeSaveInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.id"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.userId"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.displayName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.email"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.phone"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.employeeNumber"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.employmentType"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.isStudent"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.maxHoursPerWeek"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.hireDate"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.terminationDate"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.supervisorId"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.photoUrl"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[0].positionId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[0].wageCents"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[0].isPrimary"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[1].positionId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[1].wageCents"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[1].isPrimary"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[2].positionId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[2].wageCents"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.positions[2].isPrimary"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[0].certId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[0].issuedDate"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[0].expirationDate"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[1].certId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[1].issuedDate"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[1].expirationDate"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[2].certId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[2].issuedDate"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="payload.certifications[2].expirationDate"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="pageType"

FrontPage
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="cachedKey"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "isDone": true,
  "code": 0,
  "message": "sample string 2",
  "data": {},
  "cachedKey": "sample string 4",
  "correlationId": "a5e026d7-a594-4aa9-9a27-0b202601e7eb",
  "jwtTokenForSPA": "sample string 6",
  "jwtTokenIndexForSPA": 1
}

application/xml, text/xml

Sample:

<ResultOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Common">
  <CachedKey>sample string 4</CachedKey>
  <Code>None</Code>
  <CorrelationId>a5e026d7-a594-4aa9-9a27-0b202601e7eb</CorrelationId>
  <Data />
  <IsDone>true</IsDone>
  <JwtTokenForSPA>sample string 6</JwtTokenForSPA>
  <JwtTokenIndexForSPA>1</JwtTokenIndexForSPA>
  <Message>sample string 2</Message>
</ResultOutVO>

multipart/form-data

Sample:

Sample not available.