POST api/Contact/ContactInsert

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Authority	string	None.
ContactInfoXml	RichText	None.
ContactListMemberOnlyFlag	boolean	None.
ContactNum	integer	None.
ContactType	string	None.
ECVFlag	boolean	None.
EffectiveDate	date	None.
EffectiveTime	string	None.
ExpireDate	date	None.
ExpireTime	string	None.
FirstName	string	None.
KeyNum	integer	None.
KeysFlag	boolean	None.
KeyType	string	None.
LastName	string	None.
MiddleName	string	None.
NotifyCodeList	Collection of NotifyCodeListRow	None.
PIN	string	None.
Relation	string	None.
SeqNum	integer	None.
Suffix	string	None.
Title	string	None.
AlternateSitesContactFlag	boolean	None.
IgnoreSiteGroupNotifyCodesFlag	boolean	None.
SiteLanguage	string	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Authority": "sample string 1",
  "ContactInfoXml": {
    "SectionList": [
      {
        "Value": "sample string 1",
        "BrFlag": true,
        "StyleList": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          }
        ]
      },
      {
        "Value": "sample string 1",
        "BrFlag": true,
        "StyleList": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          }
        ]
      }
    ]
  },
  "ContactListMemberOnlyFlag": true,
  "ContactNum": 1,
  "ContactType": "sample string 2",
  "ECVFlag": true,
  "EffectiveDate": "2025-12-14T17:39:42.3698884-05:00",
  "EffectiveTime": "sample string 3",
  "ExpireDate": "2025-12-14T17:39:42.3698884-05:00",
  "ExpireTime": "sample string 4",
  "FirstName": "sample string 5",
  "KeyNum": 1,
  "KeysFlag": true,
  "KeyType": "sample string 6",
  "LastName": "sample string 7",
  "MiddleName": "sample string 8",
  "NotifyCodeList": [
    {
      "NotifyCode": "sample string 1",
      "SelectedFlag": true
    },
    {
      "NotifyCode": "sample string 1",
      "SelectedFlag": true
    }
  ],
  "PIN": "sample string 9",
  "Relation": "sample string 10",
  "SeqNum": 1,
  "Suffix": "sample string 11",
  "Title": "sample string 12",
  "AlternateSitesContactFlag": true,
  "IgnoreSiteGroupNotifyCodesFlag": true,
  "SiteLanguage": "sample string 13",
  "SessionNum": 14,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 15",
  "StagesURL": "sample string 16"
}

application/xml, text/xml

Sample:

<ContactDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 16</StagesURL>
  <ApplicationCode>sample string 15</ApplicationCode>
  <SessionNum>14</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <AlternateSitesContactFlag>true</AlternateSitesContactFlag>
  <Authority>sample string 1</Authority>
  <ContactInfoXml xmlns:d2p1="http://schemas.datacontract.org/2004/07/Stages">
    <d2p1:SectionList>
      <d2p1:Section>
        <d2p1:BrFlag>true</d2p1:BrFlag>
        <d2p1:StyleList>
          <d2p1:Style>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:Style>
          <d2p1:Style>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:Style>
        </d2p1:StyleList>
        <d2p1:Value>sample string 1</d2p1:Value>
      </d2p1:Section>
      <d2p1:Section>
        <d2p1:BrFlag>true</d2p1:BrFlag>
        <d2p1:StyleList>
          <d2p1:Style>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:Style>
          <d2p1:Style>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:Value>sample string 2</d2p1:Value>
          </d2p1:Style>
        </d2p1:StyleList>
        <d2p1:Value>sample string 1</d2p1:Value>
      </d2p1:Section>
    </d2p1:SectionList>
  </ContactInfoXml>
  <ContactListMemberOnlyFlag>true</ContactListMemberOnlyFlag>
  <ContactNum>1</ContactNum>
  <ContactType>sample string 2</ContactType>
  <ECVFlag>true</ECVFlag>
  <EffectiveDate>2025-12-14T17:39:42.3698884-05:00</EffectiveDate>
  <EffectiveTime>sample string 3</EffectiveTime>
  <ExpireDate>2025-12-14T17:39:42.3698884-05:00</ExpireDate>
  <ExpireTime>sample string 4</ExpireTime>
  <FirstName>sample string 5</FirstName>
  <IgnoreSiteGroupNotifyCodesFlag>true</IgnoreSiteGroupNotifyCodesFlag>
  <KeyNum>1</KeyNum>
  <KeyType>sample string 6</KeyType>
  <KeysFlag>true</KeysFlag>
  <LastName>sample string 7</LastName>
  <MiddleName>sample string 8</MiddleName>
  <NotifyCodeList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Stages">
    <d2p1:NotifyCodeListRow>
      <d2p1:NotifyCode>sample string 1</d2p1:NotifyCode>
      <d2p1:SelectedFlag>true</d2p1:SelectedFlag>
    </d2p1:NotifyCodeListRow>
    <d2p1:NotifyCodeListRow>
      <d2p1:NotifyCode>sample string 1</d2p1:NotifyCode>
      <d2p1:SelectedFlag>true</d2p1:SelectedFlag>
    </d2p1:NotifyCodeListRow>
  </NotifyCodeList>
  <PIN>sample string 9</PIN>
  <Relation>sample string 10</Relation>
  <SeqNum>1</SeqNum>
  <SiteLanguage>sample string 13</SiteLanguage>
  <Suffix>sample string 11</Suffix>
  <Title>sample string 12</Title>
</ContactDetailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ContactInsertQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of ContactInsertResult	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "AdditionalData2Flag": true,
      "AdditionalData3Flag": true,
      "AdditionalData4Flag": true,
      "AdditionalDataFlag": true,
      "AdditionalPINsFlag": true,
      "AlternateSiteFlag": true,
      "AlternateSitesContactFlag": true,
      "Authority": "sample string 1",
      "AuthorityDescription": "sample string 2",
      "ContactDeviceDisplay": "sample string 3",
      "ContactInfoXml": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "ContactListMemberOnlyFlag": true,
      "ContactNum": 1,
      "ContactType": "sample string 4",
      "ContactTypeDescription": "sample string 5",
      "CustomFlag": true,
      "CustomOption": "sample string 6",
      "DayTimeFlag": true,
      "DayTimeNum": 1,
      "DocumentFlag": true,
      "DocumentNum": 1,
      "ECVFlag": true,
      "EffectiveDate": "2025-12-14T17:39:42.3855122-05:00",
      "EffectiveTime": "sample string 7",
      "ExpireDate": "2025-12-14T17:39:42.3855122-05:00",
      "ExpiredFlag": true,
      "ExpireTime": "sample string 8",
      "FirstName": "sample string 9",
      "InactiveFlag": true,
      "KeyID": "sample string 10",
      "KeyNum": 1,
      "KeysFlag": true,
      "KeyType": "sample string 11",
      "LastName": "sample string 12",
      "MiddleName": "sample string 13",
      "MultipleDevicesFlag": true,
      "Name": "sample string 14",
      "PatientFlag": true,
      "PIN": "sample string 15",
      "PINCodeWordOK": "sample string 16",
      "Relation": "sample string 17",
      "RelationDescription": "sample string 18",
      "SeqNum": 1,
      "Suffix": "sample string 19",
      "Title": "sample string 20",
      "UserID": "sample string 21",
      "XtApplicationNum": 1,
      "HierarchyFlag": true,
      "DefaultAuthority": "sample string 22",
      "DefaultAuthorityDescription": "sample string 23",
      "IgnoreSiteGroupNotifyCodesFlag": true,
      "SiteLanguage": "sample string 24",
      "SiteLanguageDescription": "sample string 25"
    },
    {
      "AdditionalData2Flag": true,
      "AdditionalData3Flag": true,
      "AdditionalData4Flag": true,
      "AdditionalDataFlag": true,
      "AdditionalPINsFlag": true,
      "AlternateSiteFlag": true,
      "AlternateSitesContactFlag": true,
      "Authority": "sample string 1",
      "AuthorityDescription": "sample string 2",
      "ContactDeviceDisplay": "sample string 3",
      "ContactInfoXml": {
        "SectionList": [
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Value": "sample string 1",
            "BrFlag": true,
            "StyleList": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      "ContactListMemberOnlyFlag": true,
      "ContactNum": 1,
      "ContactType": "sample string 4",
      "ContactTypeDescription": "sample string 5",
      "CustomFlag": true,
      "CustomOption": "sample string 6",
      "DayTimeFlag": true,
      "DayTimeNum": 1,
      "DocumentFlag": true,
      "DocumentNum": 1,
      "ECVFlag": true,
      "EffectiveDate": "2025-12-14T17:39:42.3855122-05:00",
      "EffectiveTime": "sample string 7",
      "ExpireDate": "2025-12-14T17:39:42.3855122-05:00",
      "ExpiredFlag": true,
      "ExpireTime": "sample string 8",
      "FirstName": "sample string 9",
      "InactiveFlag": true,
      "KeyID": "sample string 10",
      "KeyNum": 1,
      "KeysFlag": true,
      "KeyType": "sample string 11",
      "LastName": "sample string 12",
      "MiddleName": "sample string 13",
      "MultipleDevicesFlag": true,
      "Name": "sample string 14",
      "PatientFlag": true,
      "PIN": "sample string 15",
      "PINCodeWordOK": "sample string 16",
      "Relation": "sample string 17",
      "RelationDescription": "sample string 18",
      "SeqNum": 1,
      "Suffix": "sample string 19",
      "Title": "sample string 20",
      "UserID": "sample string 21",
      "XtApplicationNum": 1,
      "HierarchyFlag": true,
      "DefaultAuthority": "sample string 22",
      "DefaultAuthorityDescription": "sample string 23",
      "IgnoreSiteGroupNotifyCodesFlag": true,
      "SiteLanguage": "sample string 24",
      "SiteLanguageDescription": "sample string 25"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<ContactInsertQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <ContactInsertResult>
      <AdditionalData2Flag>true</AdditionalData2Flag>
      <AdditionalData3Flag>true</AdditionalData3Flag>
      <AdditionalData4Flag>true</AdditionalData4Flag>
      <AdditionalDataFlag>true</AdditionalDataFlag>
      <AdditionalPINsFlag>true</AdditionalPINsFlag>
      <AlternateSiteFlag>true</AlternateSiteFlag>
      <AlternateSitesContactFlag>true</AlternateSitesContactFlag>
      <Authority>sample string 1</Authority>
      <AuthorityDescription>sample string 2</AuthorityDescription>
      <ContactDeviceDisplay>sample string 3</ContactDeviceDisplay>
      <ContactInfoXml>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </ContactInfoXml>
      <ContactListMemberOnlyFlag>true</ContactListMemberOnlyFlag>
      <ContactNum>1</ContactNum>
      <ContactType>sample string 4</ContactType>
      <ContactTypeDescription>sample string 5</ContactTypeDescription>
      <CustomFlag>true</CustomFlag>
      <CustomOption>sample string 6</CustomOption>
      <DayTimeFlag>true</DayTimeFlag>
      <DayTimeNum>1</DayTimeNum>
      <DefaultAuthority>sample string 22</DefaultAuthority>
      <DefaultAuthorityDescription>sample string 23</DefaultAuthorityDescription>
      <DocumentFlag>true</DocumentFlag>
      <DocumentNum>1</DocumentNum>
      <ECVFlag>true</ECVFlag>
      <EffectiveDate>2025-12-14T17:39:42.3855122-05:00</EffectiveDate>
      <EffectiveTime>sample string 7</EffectiveTime>
      <ExpireDate>2025-12-14T17:39:42.3855122-05:00</ExpireDate>
      <ExpireTime>sample string 8</ExpireTime>
      <ExpiredFlag>true</ExpiredFlag>
      <FirstName>sample string 9</FirstName>
      <HierarchyFlag>true</HierarchyFlag>
      <IgnoreSiteGroupNotifyCodesFlag>true</IgnoreSiteGroupNotifyCodesFlag>
      <InactiveFlag>true</InactiveFlag>
      <KeyID>sample string 10</KeyID>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 11</KeyType>
      <KeysFlag>true</KeysFlag>
      <LastName>sample string 12</LastName>
      <MiddleName>sample string 13</MiddleName>
      <MultipleDevicesFlag>true</MultipleDevicesFlag>
      <Name>sample string 14</Name>
      <PIN>sample string 15</PIN>
      <PINCodeWordOK>sample string 16</PINCodeWordOK>
      <PatientFlag>true</PatientFlag>
      <Relation>sample string 17</Relation>
      <RelationDescription>sample string 18</RelationDescription>
      <SeqNum>1</SeqNum>
      <SiteLanguage>sample string 24</SiteLanguage>
      <SiteLanguageDescription>sample string 25</SiteLanguageDescription>
      <Suffix>sample string 19</Suffix>
      <Title>sample string 20</Title>
      <UserID>sample string 21</UserID>
      <XtApplicationNum>1</XtApplicationNum>
    </ContactInsertResult>
    <ContactInsertResult>
      <AdditionalData2Flag>true</AdditionalData2Flag>
      <AdditionalData3Flag>true</AdditionalData3Flag>
      <AdditionalData4Flag>true</AdditionalData4Flag>
      <AdditionalDataFlag>true</AdditionalDataFlag>
      <AdditionalPINsFlag>true</AdditionalPINsFlag>
      <AlternateSiteFlag>true</AlternateSiteFlag>
      <AlternateSitesContactFlag>true</AlternateSitesContactFlag>
      <Authority>sample string 1</Authority>
      <AuthorityDescription>sample string 2</AuthorityDescription>
      <ContactDeviceDisplay>sample string 3</ContactDeviceDisplay>
      <ContactInfoXml>
        <SectionList>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
          <Section>
            <BrFlag>true</BrFlag>
            <StyleList>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
              <Style>
                <Name>sample string 1</Name>
                <Value>sample string 2</Value>
              </Style>
            </StyleList>
            <Value>sample string 1</Value>
          </Section>
        </SectionList>
      </ContactInfoXml>
      <ContactListMemberOnlyFlag>true</ContactListMemberOnlyFlag>
      <ContactNum>1</ContactNum>
      <ContactType>sample string 4</ContactType>
      <ContactTypeDescription>sample string 5</ContactTypeDescription>
      <CustomFlag>true</CustomFlag>
      <CustomOption>sample string 6</CustomOption>
      <DayTimeFlag>true</DayTimeFlag>
      <DayTimeNum>1</DayTimeNum>
      <DefaultAuthority>sample string 22</DefaultAuthority>
      <DefaultAuthorityDescription>sample string 23</DefaultAuthorityDescription>
      <DocumentFlag>true</DocumentFlag>
      <DocumentNum>1</DocumentNum>
      <ECVFlag>true</ECVFlag>
      <EffectiveDate>2025-12-14T17:39:42.3855122-05:00</EffectiveDate>
      <EffectiveTime>sample string 7</EffectiveTime>
      <ExpireDate>2025-12-14T17:39:42.3855122-05:00</ExpireDate>
      <ExpireTime>sample string 8</ExpireTime>
      <ExpiredFlag>true</ExpiredFlag>
      <FirstName>sample string 9</FirstName>
      <HierarchyFlag>true</HierarchyFlag>
      <IgnoreSiteGroupNotifyCodesFlag>true</IgnoreSiteGroupNotifyCodesFlag>
      <InactiveFlag>true</InactiveFlag>
      <KeyID>sample string 10</KeyID>
      <KeyNum>1</KeyNum>
      <KeyType>sample string 11</KeyType>
      <KeysFlag>true</KeysFlag>
      <LastName>sample string 12</LastName>
      <MiddleName>sample string 13</MiddleName>
      <MultipleDevicesFlag>true</MultipleDevicesFlag>
      <Name>sample string 14</Name>
      <PIN>sample string 15</PIN>
      <PINCodeWordOK>sample string 16</PINCodeWordOK>
      <PatientFlag>true</PatientFlag>
      <Relation>sample string 17</Relation>
      <RelationDescription>sample string 18</RelationDescription>
      <SeqNum>1</SeqNum>
      <SiteLanguage>sample string 24</SiteLanguage>
      <SiteLanguageDescription>sample string 25</SiteLanguageDescription>
      <Suffix>sample string 19</Suffix>
      <Title>sample string 20</Title>
      <UserID>sample string 21</UserID>
      <XtApplicationNum>1</XtApplicationNum>
    </ContactInsertResult>
  </ResultSet>
</ContactInsertQueryResult>