POST Contacts/Contact?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

ContactDTO

Name	Type	Additional information
ContactID	integer	None.
ContactType	ContactType	None.
ContactTypeEntryID	integer	None.
ContactTypeEntryValue	string	None.
Area	string	None.
Name	NameDTO	None.
Addresses	AddressesDTO	None.
BusinessUnits	Collection of ContactBusinessUnitDTO	None.
CommunicationMethods	CommunicationMethodsDTO	None.
OrganizationName	string	None.
JobTitle	string	None.
MaritalStatus	string	None.
Gender	string	None.
BirthDate	date	None.
IsBirthDateEstimated	boolean	None.
BirthMonth	byte	None.
BirthDay	byte	None.
BirthCountryCode	string	None.
TZIDEntryID	integer	None.
WindowsTZEntryID	integer	None.
Props	Collection of Object	None.
Comments	string	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Notifications	Collection of ContactNotificationDTO	None.
Extensions	Collection of FormDataExtensionDto	None.
PartialData	PartialDataType	None.
Summary	string	None.
ImageExists	boolean	None.
ImageEntityFileID	integer	None.
ImageEntityFileKey	string	None.
ImageEntityFileDateUtc	date	None.
ImageEntityFileLastUpdatedDateUtc	date	None.
Global	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "contactID": 2,
  "type": 1,
  "contactType": 1,
  "contactTypeEntryID": 3,
  "contactTypeEntryValue": "sample string 4",
  "area": "sample string 5",
  "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": [
    {
      "contactID": 1,
      "buid": 2,
      "businessUnitStatusID": 3,
      "startDateUtc": "2024-12-04T08:04:44.2513343+00:00",
      "stopDateUtc": "2024-12-04T08:04:44.2513343+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:04:44.2513343+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
      },
      "businessUnitName": "sample string 9",
      "statusName": "sample string 10",
      "summary": "sample string 9"
    },
    {
      "contactID": 1,
      "buid": 2,
      "businessUnitStatusID": 3,
      "startDateUtc": "2024-12-04T08:04:44.2513343+00:00",
      "stopDateUtc": "2024-12-04T08:04:44.2513343+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:04:44.2513343+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
      },
      "businessUnitName": "sample string 9",
      "statusName": "sample string 10",
      "summary": "sample string 9"
    }
  ],
  "communicationMethods": {
    "list": [],
    "partialData": 1,
    "phoneNumbers": []
  },
  "organizationName": "sample string 6",
  "jobTitle": "sample string 7",
  "maritalStatus": "sample string 8",
  "gender": "sample string 9",
  "birthDate": "2024-12-04T08:04:44.2513343+00:00",
  "isBirthDateEstimated": true,
  "birthMonth": 64,
  "birthDay": 64,
  "birthCountryCode": "sample string 11",
  "tzidEntryID": 1,
  "windowsTZEntryID": 1,
  "props": [],
  "comments": "sample string 12",
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
  },
  "notifications": [
    {
      "contactID": 1,
      "type": "sample string 2",
      "subType": "sample string 3",
      "severity": 2,
      "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
      "reason": "sample string 5",
      "comments": "sample string 6",
      "recordState": 1,
      "createdByUserID": 7,
      "lastUpdatedByUserID": 8,
      "created": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
      },
      "summary": "ContactNotificationDTO"
    },
    {
      "contactID": 1,
      "type": "sample string 2",
      "subType": "sample string 3",
      "severity": 2,
      "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
      "reason": "sample string 5",
      "comments": "sample string 6",
      "recordState": 1,
      "createdByUserID": 7,
      "lastUpdatedByUserID": 8,
      "created": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:04:44 AM"
      },
      "summary": "ContactNotificationDTO"
    }
  ],
  "extensions": [
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2"
      }
    },
    {
      "entityID": 1,
      "entityID2": 2,
      "formFieldLinkID": 3,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:04:44.2513343+00:00",
        "userName": "sample string 2"
      }
    }
  ],
  "partialData": 1,
  "summary": "sample string 1, sample string 2 (sample string 3)",
  "imageExists": true,
  "imageEntityFileID": 1,
  "imageEntityFileKey": "sample string 13",
  "imageEntityFileDateUtc": "2024-12-04T08:04:44.2513343Z",
  "imageEntityFileLastUpdatedDateUtc": "2024-12-04T08:04:44.2513343Z",
  "global": true
}

application/xml, text/xml

Sample:

<ContactDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <Addresses>
    <List />
    <PartialData>FullData</PartialData>
  </Addresses>
  <Area>sample string 5</Area>
  <BirthCountryCode>sample string 11</BirthCountryCode>
  <BirthDate>2024-12-04T08:04:44.2513343+00:00</BirthDate>
  <BirthDay>64</BirthDay>
  <BirthMonth>64</BirthMonth>
  <BusinessUnits>
    <ContactBusinessUnitDTO>
      <BUID>2</BUID>
      <BusinessUnitName>sample string 9</BusinessUnitName>
      <BusinessUnitStatusID>3</BusinessUnitStatusID>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
      <RecordState>Active</RecordState>
      <ReferralSource>sample string 8</ReferralSource>
      <StartDateUtc>2024-12-04T08:04:44.2513343+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:04:44.2513343+00:00</StopDateUtc>
    </ContactBusinessUnitDTO>
    <ContactBusinessUnitDTO>
      <BUID>2</BUID>
      <BusinessUnitName>sample string 9</BusinessUnitName>
      <BusinessUnitStatusID>3</BusinessUnitStatusID>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
      <RecordState>Active</RecordState>
      <ReferralSource>sample string 8</ReferralSource>
      <StartDateUtc>2024-12-04T08:04:44.2513343+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:04:44.2513343+00:00</StopDateUtc>
    </ContactBusinessUnitDTO>
  </BusinessUnits>
  <Comments>sample string 12</Comments>
  <CommunicationMethods>
    <List />
    <PartialData>FullData</PartialData>
    <PhoneNumbers />
  </CommunicationMethods>
  <ContactID>2</ContactID>
  <ContactType>Global</ContactType>
  <ContactTypeEntryID>3</ContactTypeEntryID>
  <ContactTypeEntryValue>sample string 4</ContactTypeEntryValue>
  <Created>
    <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <EntityID>2</EntityID>
  <Extensions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms">
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T08:04:44.2513343+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:Created>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:EntityID2>2</d2p1:EntityID2>
      <d2p1:Field i:nil="true" />
      <d2p1:FieldValue>sample string 4</d2p1:FieldValue>
      <d2p1:FormFieldLinkID>3</d2p1:FormFieldLinkID>
      <d2p1:LastUpdated>
        <d2p1:DateUtc>2024-12-04T08:04:44.2513343+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1:FormDataExtensionDto>
    <d2p1:FormDataExtensionDto>
      <d2p1:Created>
        <d2p1:DateUtc>2024-12-04T08:04:44.2513343+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:Created>
      <d2p1:EntityID>1</d2p1:EntityID>
      <d2p1:EntityID2>2</d2p1:EntityID2>
      <d2p1:Field i:nil="true" />
      <d2p1:FieldValue>sample string 4</d2p1:FieldValue>
      <d2p1:FormFieldLinkID>3</d2p1:FormFieldLinkID>
      <d2p1:LastUpdated>
        <d2p1:DateUtc>2024-12-04T08:04:44.2513343+00:00</d2p1:DateUtc>
        <d2p1:UserName>sample string 2</d2p1:UserName>
      </d2p1:LastUpdated>
      <d2p1:RecordState>Active</d2p1:RecordState>
    </d2p1:FormDataExtensionDto>
  </Extensions>
  <Gender>sample string 9</Gender>
  <Global>true</Global>
  <ImageEntityFileDateUtc>2024-12-04T08:04:44.2513343Z</ImageEntityFileDateUtc>
  <ImageEntityFileID>1</ImageEntityFileID>
  <ImageEntityFileKey>sample string 13</ImageEntityFileKey>
  <ImageEntityFileLastUpdatedDateUtc>2024-12-04T08:04:44.2513343Z</ImageEntityFileLastUpdatedDateUtc>
  <IsBirthDateEstimated>true</IsBirthDateEstimated>
  <JobTitle>sample string 7</JobTitle>
  <LastUpdated>
    <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <MaritalStatus>sample string 8</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>
    <ContactNotificationDTO>
      <Comments>sample string 6</Comments>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>7</CreatedByUserID>
      <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
      <LastUpdated>
        <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>8</LastUpdatedByUserID>
      <Props xmlns:d4p1="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>
    </ContactNotificationDTO>
    <ContactNotificationDTO>
      <Comments>sample string 6</Comments>
      <ContactID>1</ContactID>
      <Created>
        <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>7</CreatedByUserID>
      <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
      <LastUpdated>
        <DateUtc>2024-12-04T08:04:44.2513343+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>8</LastUpdatedByUserID>
      <Props xmlns:d4p1="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>
    </ContactNotificationDTO>
  </Notifications>
  <OrganizationName>sample string 6</OrganizationName>
  <PartialData>FullData</PartialData>
  <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" />
  <RecordState>Active</RecordState>
  <TZIDEntryID>1</TZIDEntryID>
  <Type>Organization</Type>
  <WindowsTZEntryID>1</WindowsTZEntryID>
</ContactDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��WKn�0���U�:�$+?�;��4v	��ű�V$�j�9Y=R�С$;�E1�-��yμy$G?�}��S)I����D��r�3�8�G¨��w�ӟHV�_�g�i���x����0�A�+���hsV~��B��j�Fh��A)�ND�Q����ح3<]�]����9Q�f�o%F��JH����RZ�.�g����5C�a$������	3��zR���-���0��.�6��ФnD�Vm� �O�8���N����7A��M��|�vǏ@�n*����ѓ�����@�R��d�Pi���%$��Zj��P�2]+�B�j][�#O
/���m��W��ޝڒ[�s����,��EQ�G3xf��a#ՍT�
�^�ǌ�B��&�)����^�8�Jg���5�)ՄvW�pb��Y��dM��
F����ũ�	
����)3�rzQ��>��8҆��FP�:��;���x�{�4���>�=I�ۇ��1�h��&��у���\�\W�m*�6�e�p�4l\K��3T��s���e�]����ڜ�7�z�������?�
�2������7�h�qQ�R�ْ\��s�˽�F0�	�n�5 ����a�k��Q)��T��AFO��R7~�n���>�#��h�~��N&pt����!�TI�1ˠfwe�8���
܋�.��N9|��I&G$��x�	'ߑ�m

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.