POST V2/Users/Entity?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

UserEntityDTOV2

Name	Type	Additional information
OrgID	integer	None.
Worker	WorkerDTOV2	None.
UserID	integer	None.
EntityID	integer	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Summary	string	None.

Request Formats

application/json, text/json

Sample:

{
  "orgID": 1,
  "worker": {
    "orgID": 1,
    "workerID": 2,
    "type": 1,
    "area": "sample string 3",
    "name": {
      "lastName": "sample string 1",
      "firstName": "sample string 2",
      "preferredName": "sample string 3",
      "middleName": "sample string 4",
      "prefix": "sample string 5",
      "suffix": "sample string 6",
      "summary": "sample string 1, sample string 2 (sample string 3)"
    },
    "addresses": {
      "list": [],
      "partialData": 1
    },
    "businessUnits": [
      {
        "workerID": 1,
        "buid": 2,
        "businessUnitStatusID": 3,
        "startDateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "stopDateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "statusReason": "sample string 5",
        "statusReason2": "sample string 6",
        "statusComments": "sample string 7",
        "referralSource": "sample string 8",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "businessUnitName": "sample string 9",
        "statusName": "sample string 10",
        "isSchedulable": true,
        "summary": "sample string 9"
      },
      {
        "workerID": 1,
        "buid": 2,
        "businessUnitStatusID": 3,
        "startDateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "stopDateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "statusReason": "sample string 5",
        "statusReason2": "sample string 6",
        "statusComments": "sample string 7",
        "referralSource": "sample string 8",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "businessUnitName": "sample string 9",
        "statusName": "sample string 10",
        "isSchedulable": true,
        "summary": "sample string 9"
      }
    ],
    "groups": [
      {
        "workerID": 1,
        "buid": 2,
        "groupID": 3,
        "businessUnitStatusID": 4,
        "statusReason": "sample string 5",
        "statusReason2": "sample string 6",
        "statusComments": "sample string 7",
        "startDateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "stopDateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "recordState": 1,
        "referralSource": "sample string 9",
        "created": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "statusName": "sample string 10",
        "groupName": "sample string 11",
        "businessUnitName": "sample string 12",
        "isSchedulable": true
      },
      {
        "workerID": 1,
        "buid": 2,
        "groupID": 3,
        "businessUnitStatusID": 4,
        "statusReason": "sample string 5",
        "statusReason2": "sample string 6",
        "statusComments": "sample string 7",
        "startDateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "stopDateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "recordState": 1,
        "referralSource": "sample string 9",
        "created": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "statusName": "sample string 10",
        "groupName": "sample string 11",
        "businessUnitName": "sample string 12",
        "isSchedulable": true
      }
    ],
    "notifications": [
      {
        "workerID": 1,
        "type": "sample string 2",
        "subType": "sample string 3",
        "severity": 2,
        "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "reason": "sample string 5",
        "comments": "sample string 6",
        "recordState": 1,
        "createdByUserID": 7,
        "lastUpdatedByUserID": 8,
        "created": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "summary": "WorkerNotificationDTO"
      },
      {
        "workerID": 1,
        "type": "sample string 2",
        "subType": "sample string 3",
        "severity": 2,
        "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
        "reason": "sample string 5",
        "comments": "sample string 6",
        "recordState": 1,
        "createdByUserID": 7,
        "lastUpdatedByUserID": 8,
        "created": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
        },
        "summary": "WorkerNotificationDTO"
      }
    ],
    "communicationMethods": {
      "list": [],
      "partialData": 1,
      "phoneNumbers": []
    },
    "extensions": [
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2"
        }
      },
      {
        "entityID": 1,
        "entityID2": 2,
        "formFieldLinkID": 3,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
          "userName": "sample string 2"
        }
      }
    ],
    "jobTitle": "sample string 4",
    "maritalStatus": "sample string 5",
    "gender": "sample string 6",
    "birthDate": "2024-12-04T08:13:42.0049254+00:00",
    "birthMonth": 64,
    "birthDay": 64,
    "isBirthDateEstimated": true,
    "tzidEntryID": 1,
    "windowsTZEntryID": 1,
    "props": [],
    "comments": "sample string 8",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
    },
    "summary": "sample string 1, sample string 2 (sample string 3)",
    "imageExists": true,
    "imageEntityFileID": 1,
    "imageEntityFileKey": "sample string 9",
    "imageEntityFileDateUtc": "2024-12-04T08:13:42.0049254Z",
    "imageEntityFileLastUpdatedDateUtc": "2024-12-04T08:13:42.0049254Z",
    "partialData": 1
  },
  "userID": 1,
  "entityID": 2,
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:13:42.0049254+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:13:42 AM"
  },
  "summary": "UserEntityDTO"
}

application/xml, text/xml

Sample:

<UserEntityDTOV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <Created>
    <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <EntityID>2</EntityID>
  <LastUpdated>
    <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <RecordState>Active</RecordState>
  <UserID>1</UserID>
  <OrgID>1</OrgID>
  <Worker>
    <Addresses>
      <List />
      <PartialData>FullData</PartialData>
    </Addresses>
    <Area>sample string 3</Area>
    <BirthDate>2024-12-04T08:13:42.0049254+00:00</BirthDate>
    <BirthDay>64</BirthDay>
    <BirthMonth>64</BirthMonth>
    <BusinessUnits>
      <WorkerBusinessUnitDTO>
        <BUID>2</BUID>
        <BusinessUnitName>sample string 9</BusinessUnitName>
        <BusinessUnitStatusID>3</BusinessUnitStatusID>
        <Created>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <IsSchedulable>true</IsSchedulable>
        <LastUpdated>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
        <RecordState>Active</RecordState>
        <ReferralSource>sample string 8</ReferralSource>
        <StartDateUtc>2024-12-04T08:13:42.0049254+00:00</StartDateUtc>
        <StatusComments>sample string 7</StatusComments>
        <StatusName>sample string 10</StatusName>
        <StatusReason>sample string 5</StatusReason>
        <StatusReason2>sample string 6</StatusReason2>
        <StopDateUtc>2024-12-04T08:13:42.0049254+00:00</StopDateUtc>
        <WorkerID>1</WorkerID>
      </WorkerBusinessUnitDTO>
      <WorkerBusinessUnitDTO>
        <BUID>2</BUID>
        <BusinessUnitName>sample string 9</BusinessUnitName>
        <BusinessUnitStatusID>3</BusinessUnitStatusID>
        <Created>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <IsSchedulable>true</IsSchedulable>
        <LastUpdated>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
        <RecordState>Active</RecordState>
        <ReferralSource>sample string 8</ReferralSource>
        <StartDateUtc>2024-12-04T08:13:42.0049254+00:00</StartDateUtc>
        <StatusComments>sample string 7</StatusComments>
        <StatusName>sample string 10</StatusName>
        <StatusReason>sample string 5</StatusReason>
        <StatusReason2>sample string 6</StatusReason2>
        <StopDateUtc>2024-12-04T08:13:42.0049254+00:00</StopDateUtc>
        <WorkerID>1</WorkerID>
      </WorkerBusinessUnitDTO>
    </BusinessUnits>
    <Comments>sample string 8</Comments>
    <CommunicationMethods>
      <List />
      <PartialData>FullData</PartialData>
      <PhoneNumbers />
    </CommunicationMethods>
    <Created>
      <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityID>2</EntityID>
    <Extensions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T08:13:42.0049254+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T08:13:42.0049254+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
      <d3p1:FormDataExtensionDto>
        <d3p1:Created>
          <d3p1:DateUtc>2024-12-04T08:13:42.0049254+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:Created>
        <d3p1:EntityID>1</d3p1:EntityID>
        <d3p1:EntityID2>2</d3p1:EntityID2>
        <d3p1:Field i:nil="true" />
        <d3p1:FieldValue>sample string 4</d3p1:FieldValue>
        <d3p1:FormFieldLinkID>3</d3p1:FormFieldLinkID>
        <d3p1:LastUpdated>
          <d3p1:DateUtc>2024-12-04T08:13:42.0049254+00:00</d3p1:DateUtc>
          <d3p1:UserName>sample string 2</d3p1:UserName>
        </d3p1:LastUpdated>
        <d3p1:RecordState>Active</d3p1:RecordState>
      </d3p1:FormDataExtensionDto>
    </Extensions>
    <Gender>sample string 6</Gender>
    <Groups>
      <WorkerGroupDTO>
        <BUID>2</BUID>
        <BusinessUnitName>sample string 12</BusinessUnitName>
        <BusinessUnitStatusID>4</BusinessUnitStatusID>
        <Created>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <GroupID>3</GroupID>
        <GroupName>sample string 11</GroupName>
        <IsSchedulable>true</IsSchedulable>
        <LastUpdated>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <RecordState>Active</RecordState>
        <ReferralSource>sample string 9</ReferralSource>
        <StartDateUtc>2024-12-04T08:13:42.0049254+00:00</StartDateUtc>
        <StatusComments>sample string 7</StatusComments>
        <StatusName>sample string 10</StatusName>
        <StatusReason>sample string 5</StatusReason>
        <StatusReason2>sample string 6</StatusReason2>
        <StopDateUtc>2024-12-04T08:13:42.0049254+00:00</StopDateUtc>
        <WorkerID>1</WorkerID>
      </WorkerGroupDTO>
      <WorkerGroupDTO>
        <BUID>2</BUID>
        <BusinessUnitName>sample string 12</BusinessUnitName>
        <BusinessUnitStatusID>4</BusinessUnitStatusID>
        <Created>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <GroupID>3</GroupID>
        <GroupName>sample string 11</GroupName>
        <IsSchedulable>true</IsSchedulable>
        <LastUpdated>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <RecordState>Active</RecordState>
        <ReferralSource>sample string 9</ReferralSource>
        <StartDateUtc>2024-12-04T08:13:42.0049254+00:00</StartDateUtc>
        <StatusComments>sample string 7</StatusComments>
        <StatusName>sample string 10</StatusName>
        <StatusReason>sample string 5</StatusReason>
        <StatusReason2>sample string 6</StatusReason2>
        <StopDateUtc>2024-12-04T08:13:42.0049254+00:00</StopDateUtc>
        <WorkerID>1</WorkerID>
      </WorkerGroupDTO>
    </Groups>
    <ImageEntityFileDateUtc>2024-12-04T08:13:42.0049254Z</ImageEntityFileDateUtc>
    <ImageEntityFileID>1</ImageEntityFileID>
    <ImageEntityFileKey>sample string 9</ImageEntityFileKey>
    <ImageEntityFileLastUpdatedDateUtc>2024-12-04T08:13:42.0049254Z</ImageEntityFileLastUpdatedDateUtc>
    <IsBirthDateEstimated>true</IsBirthDateEstimated>
    <JobTitle>sample string 4</JobTitle>
    <LastUpdated>
      <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <MaritalStatus>sample string 5</MaritalStatus>
    <Name>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 1</LastName>
      <MiddleName>sample string 4</MiddleName>
      <PreferredName>sample string 3</PreferredName>
      <Prefix>sample string 5</Prefix>
      <Suffix>sample string 6</Suffix>
    </Name>
    <Notifications>
      <WorkerNotificationDTO>
        <Comments>sample string 6</Comments>
        <Created>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>7</CreatedByUserID>
        <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
        <LastUpdated>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>8</LastUpdatedByUserID>
        <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
        <Reason>sample string 5</Reason>
        <RecordState>Active</RecordState>
        <Severity>Information</Severity>
        <SubType>sample string 3</SubType>
        <Type>sample string 2</Type>
        <WorkerID>1</WorkerID>
      </WorkerNotificationDTO>
      <WorkerNotificationDTO>
        <Comments>sample string 6</Comments>
        <Created>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>7</CreatedByUserID>
        <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
        <LastUpdated>
          <DateUtc>2024-12-04T08:13:42.0049254+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>8</LastUpdatedByUserID>
        <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
        <Reason>sample string 5</Reason>
        <RecordState>Active</RecordState>
        <Severity>Information</Severity>
        <SubType>sample string 3</SubType>
        <Type>sample string 2</Type>
        <WorkerID>1</WorkerID>
      </WorkerNotificationDTO>
    </Notifications>
    <PartialData>FullData</PartialData>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" />
    <RecordState>Active</RecordState>
    <TZIDEntryID>1</TZIDEntryID>
    <Type>Organization</Type>
    <WindowsTZEntryID>1</WindowsTZEntryID>
    <WorkerID>2</WorkerID>
    <OrgID>1</OrgID>
  </Worker>
</UserEntityDTOV2>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

���n�0�_%���%Y��;F7	�
��B��7>m�;��2�ɸ�x���+��}HLL�.���>>��c;�~�����I�񯄼�'�6�u|=-��	�O|E�"Oi�����;>'9�2��}^�(1�`��ZH��@�
3H�(��i�g��iM��L;֔�DN�w��W+.��o1$�JP
��>S�O.�����K4,DݰT���ϙF���R�Ccf��zYw��.�Ql�������S�6
�x#�6���%�VGo� ޏ��7A�����c�0#~�wGrI�j�E�73]�좤�4��D)�z2��$��T�H�j�L5�R�ld�)��'�F����;17����������ER�+Ӹ��Y:Zfd��D�����a[|[|_.�X��R�źBl3x�T��ܳ��Ud�ܤ���ɝ���p���t�#7�ͅ�Ź���ጅ��F,%�	�����9�a�e37	�@2=�+�q��͋#m�~��Dp0�j.�d��}�s
����X(N�`��>��-.-.kpTi)����Dеw{|��e>i
��k
\-*��!8�,N#!�#=f�r�??���/&�֬��m���W1�1���N!wL�����z0N�o8G52�']�yj�'�뉟�ċ��S���fy��Ҥ�3zȵ�g�q*�T�|����^�k�X{~Zaz�_H�hN�px�J�Y5�uw�2�en��#���5كN�������.j?NK�ؼ�jJ�����!�J���~q���

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.