POST Requests/GetCompatibleDataMarts

Gets a list of DataMarts that are compatible with the current request's criteria, stratifiers etc.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
TermIDs	Available Terms	Collection of globally unique identifier	None.
ProjectID	Gets or sets the ID of project	globally unique identifier	None.
Request	The Request json to use when retrieving datamarts capable of responding.	string	None.
RequestID	Gets or sets the ID of the Request	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "results": [
    {
      "TermIDs": [
        "716c12d2-9fa3-4e2b-b41e-af369a638023",
        "7c8c0cdf-a489-4307-8cf0-79c42a044372"
      ],
      "ProjectID": "f23d0d58-a082-44bf-aa5b-ca264befd557",
      "Request": "sample string 1",
      "RequestID": "2b059079-3473-43c1-abed-c3bb7db642b4"
    }
  ]
}

text/javascript

Sample:

{"results":[{"TermIDs":["716c12d2-9fa3-4e2b-b41e-af369a638023","7c8c0cdf-a489-4307-8cf0-79c42a044372"],"ProjectID":"f23d0d58-a082-44bf-aa5b-ca264befd557","Request":"sample string 1","RequestID":"2b059079-3473-43c1-abed-c3bb7db642b4"}]}

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:

<MatchingCriteriaDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO.QueryComposer">
  <ProjectID>f23d0d58-a082-44bf-aa5b-ca264befd557</ProjectID>
  <Request>sample string 1</Request>
  <RequestID>2b059079-3473-43c1-abed-c3bb7db642b4</RequestID>
  <TermIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>716c12d2-9fa3-4e2b-b41e-af369a638023</d2p1:guid>
    <d2p1:guid>7c8c0cdf-a489-4307-8cf0-79c42a044372</d2p1:guid>
  </TermIDs>
</MatchingCriteriaDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DataMartListDTO

Name	Description	Type	Additional information
Name	DataMart Name	string	None.
Description	DataMart Description	string	None.
Acronym	DataMart Acronym	string	None.
StartDate	The date the DataMart was created on	date	None.
EndDate	The date the DataMart was ended on	date	None.
OrganizationID	Identifier of Organization	globally unique identifier	None.
Organization	Organization	string	None.
ParentOrganziationID	Gets or set the ID of the Organizations parent organization.	globally unique identifier	None.
ParentOrganization	Gets or sets the name of the Organizations parent organization.	string	None.
ID		globally unique identifier	None.
Timestamp		Collection of byte	None.

Response Formats

application/json, text/json

Sample:

{
  "results": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Acronym": "sample string 3",
      "StartDate": "2024-05-14T18:25:07Z",
      "EndDate": "2024-05-14T18:25:07Z",
      "OrganizationID": "796cde37-d00f-4681-a97f-f6cbbd1b8863",
      "Organization": "sample string 4",
      "ParentOrganziationID": "84973357-1307-4533-9fad-57751b996155",
      "ParentOrganization": "sample string 5",
      "ID": "2c5fe62d-3e0b-45c5-8014-972118a49e9c",
      "Timestamp": "QEA="
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Acronym": "sample string 3",
      "StartDate": "2024-05-14T18:25:07Z",
      "EndDate": "2024-05-14T18:25:07Z",
      "OrganizationID": "796cde37-d00f-4681-a97f-f6cbbd1b8863",
      "Organization": "sample string 4",
      "ParentOrganziationID": "84973357-1307-4533-9fad-57751b996155",
      "ParentOrganization": "sample string 5",
      "ID": "2c5fe62d-3e0b-45c5-8014-972118a49e9c",
      "Timestamp": "QEA="
    }
  ]
}

text/javascript

Sample:

{"results":[{"Name":"sample string 1","Description":"sample string 2","Acronym":"sample string 3","StartDate":"2024-05-14T18:25:07Z","EndDate":"2024-05-14T18:25:07Z","OrganizationID":"796cde37-d00f-4681-a97f-f6cbbd1b8863","Organization":"sample string 4","ParentOrganziationID":"84973357-1307-4533-9fad-57751b996155","ParentOrganization":"sample string 5","ID":"2c5fe62d-3e0b-45c5-8014-972118a49e9c","Timestamp":"QEA="},{"Name":"sample string 1","Description":"sample string 2","Acronym":"sample string 3","StartDate":"2024-05-14T18:25:07Z","EndDate":"2024-05-14T18:25:07Z","OrganizationID":"796cde37-d00f-4681-a97f-f6cbbd1b8863","Organization":"sample string 4","ParentOrganziationID":"84973357-1307-4533-9fad-57751b996155","ParentOrganization":"sample string 5","ID":"2c5fe62d-3e0b-45c5-8014-972118a49e9c","Timestamp":"QEA="}]}

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:

<ArrayOfDataMartListDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <DataMartListDTO>
    <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">2c5fe62d-3e0b-45c5-8014-972118a49e9c</ID>
    <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
    <Acronym>sample string 3</Acronym>
    <Description>sample string 2</Description>
    <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T22:25:07.1748459Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </EndDate>
    <Name>sample string 1</Name>
    <Organization>sample string 4</Organization>
    <OrganizationID>796cde37-d00f-4681-a97f-f6cbbd1b8863</OrganizationID>
    <ParentOrganization>sample string 5</ParentOrganization>
    <ParentOrganziationID>84973357-1307-4533-9fad-57751b996155</ParentOrganziationID>
    <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T22:25:07.1748459Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </StartDate>
  </DataMartListDTO>
  <DataMartListDTO>
    <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">2c5fe62d-3e0b-45c5-8014-972118a49e9c</ID>
    <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
    <Acronym>sample string 3</Acronym>
    <Description>sample string 2</Description>
    <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T22:25:07.1748459Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </EndDate>
    <Name>sample string 1</Name>
    <Organization>sample string 4</Organization>
    <OrganizationID>796cde37-d00f-4681-a97f-f6cbbd1b8863</OrganizationID>
    <ParentOrganization>sample string 5</ParentOrganization>
    <ParentOrganziationID>84973357-1307-4533-9fad-57751b996155</ParentOrganziationID>
    <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T22:25:07.1748459Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </StartDate>
  </DataMartListDTO>
</ArrayOfDataMartListDTO>