GET Tk-Ws/Export/GetAtsNotificationsByQueryAndTemplate?queryId={queryId}&transferFileId={transferFileId}

Get the list of ATS Notifications returned by running the Query with the specified id. The returned ATS Notifications only contain results for the Terms included in the specified Transfer File (if any)

Request Information

URI Parameters

Name	Description	Type	Additional information
queryId	The id of the desired Query	globally unique identifier	Required
transferFileId	the id of the Transfer File to be used for exporting (if any)	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of AtsNotification

Name	Description	Type	Additional information
ReportStatus	The Report Status of the Occurrence The value should be one of the following: Unsubmitted, Submitted, Dismissed, UnderInvestigation, Closed, InvestigationCompleted	string	None.
DateSubmitted		date	None.
Name	The Name of the Occurrence	string	None.
ReferenceNumber	The Reference Number of the Occurrence Only for displaying purposes when exporting occurrences When importing, the Reference Number will be automatically computed based on the current configuration	string	None.
ReferenceNumberPattern	The Reference Number Pattern configuration at the time when this entity was created. If later on, the Organization changes the Reference Number Configuration, this ReferenceNumberPattern shall be used to preserve the original reference number.	string	None.
Description	The description of the Occurrence	string	None.
DateOfOccurrence	Date of occurrence Only for displaying purposes. There should be a Term Result containing the value for Date of Occurrence	date	None.
TimeOfOccurrence	Time of occurrence Only for displaying purposes. There should be a Term Result containing the value for Time of Occurrence	time interval	None.
InputResults	Collection of Input Results (results obtained from Heidi Terms)	Collection of InputResult	None.
TreeControlResults	Collection of Tree Control Results (results obtained from Tree Controls)	Collection of TreeControlResult	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "ReportStatus": "sample string 1",
    "DateSubmitted": "2025-05-17T18:27:42.6747364+02:00",
    "Name": "sample string 2",
    "ReferenceNumber": "sample string 3",
    "ReferenceNumberPattern": "sample string 4",
    "Description": "sample string 5",
    "DateOfOccurrence": "2025-05-17T18:27:42.6747364+02:00",
    "TimeOfOccurrence": "00:00:00.1234567",
    "InputResults": [
      {
        "TermId": "81ce0e11-18f7-4ef2-9049-50d9ec0713db",
        "AutomaticResult": true,
        "InputId": "34a57e9a-7c70-42f3-88f5-8b4f879959b7",
        "Name": "sample string 4",
        "Index": 5,
        "Value": "sample string 6"
      },
      {
        "TermId": "81ce0e11-18f7-4ef2-9049-50d9ec0713db",
        "AutomaticResult": true,
        "InputId": "34a57e9a-7c70-42f3-88f5-8b4f879959b7",
        "Name": "sample string 4",
        "Index": 5,
        "Value": "sample string 6"
      }
    ],
    "TreeControlResults": [
      {
        "TreeControlId": "59062e6c-83eb-4c2e-a048-2d99c8b05de9",
        "Name": "sample string 2",
        "TranslatedName": "sample string 3",
        "DisplayName": "sample string 4",
        "OtherText": "sample string 5",
        "Index": 6
      },
      {
        "TreeControlId": "59062e6c-83eb-4c2e-a048-2d99c8b05de9",
        "Name": "sample string 2",
        "TranslatedName": "sample string 3",
        "DisplayName": "sample string 4",
        "OtherText": "sample string 5",
        "Index": 6
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAtsNotificationWsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Core.WebService.Dto.Ws.TaxonomyRecords.Entities">
  <AtsNotificationWsDto z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
    <DateOfOccurrence>2025-05-17T18:27:42.6747364+02:00</DateOfOccurrence>
    <Description>sample string 5</Description>
    <InputResults xmlns:d3p1="http://schemas.datacontract.org/2004/07/Core.WebService.Dto.Ws.TaxonomyRecords.Results">
      <d3p1:InputResultWsDto>
        <d3p1:AutomaticResult>true</d3p1:AutomaticResult>
        <d3p1:Index>5</d3p1:Index>
        <d3p1:InputId>34a57e9a-7c70-42f3-88f5-8b4f879959b7</d3p1:InputId>
        <d3p1:Name>sample string 4</d3p1:Name>
        <d3p1:TermId>81ce0e11-18f7-4ef2-9049-50d9ec0713db</d3p1:TermId>
        <d3p1:Value>sample string 6</d3p1:Value>
      </d3p1:InputResultWsDto>
      <d3p1:InputResultWsDto>
        <d3p1:AutomaticResult>true</d3p1:AutomaticResult>
        <d3p1:Index>5</d3p1:Index>
        <d3p1:InputId>34a57e9a-7c70-42f3-88f5-8b4f879959b7</d3p1:InputId>
        <d3p1:Name>sample string 4</d3p1:Name>
        <d3p1:TermId>81ce0e11-18f7-4ef2-9049-50d9ec0713db</d3p1:TermId>
        <d3p1:Value>sample string 6</d3p1:Value>
      </d3p1:InputResultWsDto>
    </InputResults>
    <Name>sample string 2</Name>
    <ReferenceNumber>sample string 3</ReferenceNumber>
    <ReferenceNumberPattern>sample string 4</ReferenceNumberPattern>
    <TimeOfOccurrence>PT0.1234567S</TimeOfOccurrence>
    <TreeControlResults xmlns:d3p1="http://schemas.datacontract.org/2004/07/Core.WebService.Dto.Ws.TaxonomyRecords.Results">
      <d3p1:TreeControlResultWsDto>
        <d3p1:DisplayName>sample string 4</d3p1:DisplayName>
        <d3p1:Index>6</d3p1:Index>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:OtherText>sample string 5</d3p1:OtherText>
        <d3p1:TranslatedName>sample string 3</d3p1:TranslatedName>
        <d3p1:TreeControlId>59062e6c-83eb-4c2e-a048-2d99c8b05de9</d3p1:TreeControlId>
      </d3p1:TreeControlResultWsDto>
      <d3p1:TreeControlResultWsDto>
        <d3p1:DisplayName>sample string 4</d3p1:DisplayName>
        <d3p1:Index>6</d3p1:Index>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:OtherText>sample string 5</d3p1:OtherText>
        <d3p1:TranslatedName>sample string 3</d3p1:TranslatedName>
        <d3p1:TreeControlId>59062e6c-83eb-4c2e-a048-2d99c8b05de9</d3p1:TreeControlId>
      </d3p1:TreeControlResultWsDto>
    </TreeControlResults>
    <DateSubmitted>2025-05-17T18:27:42.6747364+02:00</DateSubmitted>
    <ReportStatus>sample string 1</ReportStatus>
  </AtsNotificationWsDto>
  <AtsNotificationWsDto z:Ref="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />
</ArrayOfAtsNotificationWsDto>