GET Clients/Allergy

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
Match	MatchCriteriaStringType	None.
ClientAllergyIDs	Collection of integer	None.
BusinessUnits	Collection of integer	None.
ClientID	integer	None.
AllergyID	integer	None.
CustomAllergyDescription	string	None.
ReportDateUtcMin	date	None.
ReportDateUtcMax	date	None.
OnsetDateUtcMin	date	None.
OnsetDateUtcMax	date	None.
IsOnsetDateEstimated	boolean	None.
Severity	string	None.
Reaction	string	None.
InterventionAfterExposure	string	None.
Comments	string	None.
ExceptClientAllergyID	integer	None.
MaxRows	integer	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.
IncludePayload	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ClientAllergyDTO

Name	Type	Additional information
ClientAllergyID	integer	None.
ClientID	integer	None.
AllergyID	integer	None.
AllergyType	AllergyType	None.
AllergyCode	string	None.
AllergyDescription	string	None.
ReportDate	date	None.
OnsetDate	date	None.
IsOnsetDateEstimated	boolean	None.
Severity	string	None.
Reaction	string	None.
InterventionAfterExposure	string	None.
Comments	string	None.
Sources	Collection of ClientAllergySourceDTO	None.
Props	Collection of Object	None.
RecordState	ClinicalRecordState	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "clientAllergyID": 1,
    "clientID": 2,
    "allergyID": 3,
    "allergyType": 1,
    "allergyCode": "sample string 4",
    "allergyDescription": "sample string 5",
    "reportDate": "2024-12-04T08:05:58.2445134+00:00",
    "onsetDate": "2024-12-04T08:05:58.2445134+00:00",
    "isOnsetDateEstimated": true,
    "severity": "sample string 8",
    "reaction": "sample string 9",
    "interventionAfterExposure": "sample string 10",
    "comments": "sample string 11",
    "sources": [
      {
        "clientAllergyID": 1,
        "sourceEntryID": 2,
        "sourceDate": "2024-12-04T08:05:58.2445134+00:00",
        "sourceStatus": 1,
        "contactID": 1,
        "comments": "sample string 4",
        "recordState": 1,
        "createdByUserID": 5,
        "lastUpdatedByUserID": 6,
        "created": {
          "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
        },
        "sourceValue": "sample string 7",
        "summary": "sample string 7"
      },
      {
        "clientAllergyID": 1,
        "sourceEntryID": 2,
        "sourceDate": "2024-12-04T08:05:58.2445134+00:00",
        "sourceStatus": 1,
        "contactID": 1,
        "comments": "sample string 4",
        "recordState": 1,
        "createdByUserID": 5,
        "lastUpdatedByUserID": 6,
        "created": {
          "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
        },
        "sourceValue": "sample string 7",
        "summary": "sample string 7"
      }
    ],
    "recordState": 1,
    "createdByUserID": 12,
    "lastUpdatedByUserID": 13,
    "created": {
      "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
    }
  },
  {
    "clientAllergyID": 1,
    "clientID": 2,
    "allergyID": 3,
    "allergyType": 1,
    "allergyCode": "sample string 4",
    "allergyDescription": "sample string 5",
    "reportDate": "2024-12-04T08:05:58.2445134+00:00",
    "onsetDate": "2024-12-04T08:05:58.2445134+00:00",
    "isOnsetDateEstimated": true,
    "severity": "sample string 8",
    "reaction": "sample string 9",
    "interventionAfterExposure": "sample string 10",
    "comments": "sample string 11",
    "sources": [
      {
        "clientAllergyID": 1,
        "sourceEntryID": 2,
        "sourceDate": "2024-12-04T08:05:58.2445134+00:00",
        "sourceStatus": 1,
        "contactID": 1,
        "comments": "sample string 4",
        "recordState": 1,
        "createdByUserID": 5,
        "lastUpdatedByUserID": 6,
        "created": {
          "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
        },
        "sourceValue": "sample string 7",
        "summary": "sample string 7"
      },
      {
        "clientAllergyID": 1,
        "sourceEntryID": 2,
        "sourceDate": "2024-12-04T08:05:58.2445134+00:00",
        "sourceStatus": 1,
        "contactID": 1,
        "comments": "sample string 4",
        "recordState": 1,
        "createdByUserID": 5,
        "lastUpdatedByUserID": 6,
        "created": {
          "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
        },
        "sourceValue": "sample string 7",
        "summary": "sample string 7"
      }
    ],
    "recordState": 1,
    "createdByUserID": 12,
    "lastUpdatedByUserID": 13,
    "created": {
      "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:05:58.2445134+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:05:58 AM"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientAllergyDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ClientAllergyDTO>
    <AllergyCode>sample string 4</AllergyCode>
    <AllergyDescription>sample string 5</AllergyDescription>
    <AllergyID>3</AllergyID>
    <AllergyType>Food</AllergyType>
    <ClientAllergyID>1</ClientAllergyID>
    <ClientID>2</ClientID>
    <Comments>sample string 11</Comments>
    <Created>
      <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>12</CreatedByUserID>
    <InterventionAfterExposure>sample string 10</InterventionAfterExposure>
    <IsOnsetDateEstimated>true</IsOnsetDateEstimated>
    <LastUpdated>
      <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>13</LastUpdatedByUserID>
    <OnsetDate>2024-12-04T08:05:58.2445134+00:00</OnsetDate>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <Reaction>sample string 9</Reaction>
    <RecordState>Active</RecordState>
    <ReportDate>2024-12-04T08:05:58.2445134+00:00</ReportDate>
    <Severity>sample string 8</Severity>
    <Sources>
      <ClientAllergySourceDTO>
        <ClientAllergyID>1</ClientAllergyID>
        <Comments>sample string 4</Comments>
        <ContactID>1</ContactID>
        <Created>
          <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>5</CreatedByUserID>
        <LastUpdated>
          <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>6</LastUpdatedByUserID>
        <RecordState>Active</RecordState>
        <SourceDate>2024-12-04T08:05:58.2445134+00:00</SourceDate>
        <SourceEntryID>2</SourceEntryID>
        <SourceStatus>Unknown</SourceStatus>
        <SourceValue>sample string 7</SourceValue>
      </ClientAllergySourceDTO>
      <ClientAllergySourceDTO>
        <ClientAllergyID>1</ClientAllergyID>
        <Comments>sample string 4</Comments>
        <ContactID>1</ContactID>
        <Created>
          <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>5</CreatedByUserID>
        <LastUpdated>
          <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>6</LastUpdatedByUserID>
        <RecordState>Active</RecordState>
        <SourceDate>2024-12-04T08:05:58.2445134+00:00</SourceDate>
        <SourceEntryID>2</SourceEntryID>
        <SourceStatus>Unknown</SourceStatus>
        <SourceValue>sample string 7</SourceValue>
      </ClientAllergySourceDTO>
    </Sources>
  </ClientAllergyDTO>
  <ClientAllergyDTO>
    <AllergyCode>sample string 4</AllergyCode>
    <AllergyDescription>sample string 5</AllergyDescription>
    <AllergyID>3</AllergyID>
    <AllergyType>Food</AllergyType>
    <ClientAllergyID>1</ClientAllergyID>
    <ClientID>2</ClientID>
    <Comments>sample string 11</Comments>
    <Created>
      <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>12</CreatedByUserID>
    <InterventionAfterExposure>sample string 10</InterventionAfterExposure>
    <IsOnsetDateEstimated>true</IsOnsetDateEstimated>
    <LastUpdated>
      <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>13</LastUpdatedByUserID>
    <OnsetDate>2024-12-04T08:05:58.2445134+00:00</OnsetDate>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <Reaction>sample string 9</Reaction>
    <RecordState>Active</RecordState>
    <ReportDate>2024-12-04T08:05:58.2445134+00:00</ReportDate>
    <Severity>sample string 8</Severity>
    <Sources>
      <ClientAllergySourceDTO>
        <ClientAllergyID>1</ClientAllergyID>
        <Comments>sample string 4</Comments>
        <ContactID>1</ContactID>
        <Created>
          <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>5</CreatedByUserID>
        <LastUpdated>
          <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>6</LastUpdatedByUserID>
        <RecordState>Active</RecordState>
        <SourceDate>2024-12-04T08:05:58.2445134+00:00</SourceDate>
        <SourceEntryID>2</SourceEntryID>
        <SourceStatus>Unknown</SourceStatus>
        <SourceValue>sample string 7</SourceValue>
      </ClientAllergySourceDTO>
      <ClientAllergySourceDTO>
        <ClientAllergyID>1</ClientAllergyID>
        <Comments>sample string 4</Comments>
        <ContactID>1</ContactID>
        <Created>
          <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <CreatedByUserID>5</CreatedByUserID>
        <LastUpdated>
          <DateUtc>2024-12-04T08:05:58.2445134+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <LastUpdatedByUserID>6</LastUpdatedByUserID>
        <RecordState>Active</RecordState>
        <SourceDate>2024-12-04T08:05:58.2445134+00:00</SourceDate>
        <SourceEntryID>2</SourceEntryID>
        <SourceStatus>Unknown</SourceStatus>
        <SourceValue>sample string 7</SourceValue>
      </ClientAllergySourceDTO>
    </Sources>
  </ClientAllergyDTO>
</ArrayOfClientAllergyDTO>

application/x-compressed-json

Sample:

��U�N�0���+)�]��l�v`Z����*RbG�SU|��/`7iQ�DO�ݻ�<߻�>�?���3�2�V���(l|��!���`oͪ�oC�V&���E�mT*V{|�5SiaR)Za�
S���L�qU0Ĥ�p��0���%&$Bra�M�B�S�S��˘j�����ب��@�5W��Z�F[f��H��U����
����k!u�ڽ@��yn�uEղT�[�C��
��F��sB�'CM�k��0�|;ݻ��m#�T�˭�g�3��7�\s�
D!Ȩ6�"9�_�cA��v$���x�y��؝��s�ڲ�@��>�OM�`|�(��Z�g����_�m�?&���M�
�*]t�~@�=�����_�~{�1������s�le�