GET api/v1/reports/iv-commpatibility/report?aliasIds={aliasIds}
Returns an IVCompatibility report based on the product aliases passed in
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| aliasIds |
A list of Alias IDs |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
IVCompatibilityDetailsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| count | integer |
None. |
|
| aliases | Collection of IVCompatibilityAlias |
None. |
|
| sections | Collection of IVCompatibilitySection |
None. |
|
| _links | Collection of Link |
None. |
|
| _languages | Collection of LanguagesLink |
None. |
Response Codes
| Code | Description | Additional information |
|---|---|---|
| 200 | OK | The request returned without error |
| 204 | No Content | The request was successful but no results were returned |
| 400 | Bad Request | A parameter was missing or invalid |
| 404 | Not Found | The requested resource was not found |
Response Formats
application/json, text/json
Sample:
{
"count": 1,
"aliases": [
{
"id": 1,
"alias": "sample string 2",
"ivProductId": 3,
"productName": "sample string 4"
},
{
"id": 1,
"alias": "sample string 2",
"ivProductId": 3,
"productName": "sample string 4"
}
],
"sections": [
{
"type": "sample string 1",
"rows": [
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilities": [
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilityCode": "sample string 4",
"resultIds": [
1,
2
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
},
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilityCode": "sample string 4",
"resultIds": [
1,
2
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
}
]
},
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilities": [
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilityCode": "sample string 4",
"resultIds": [
1,
2
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
},
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilityCode": "sample string 4",
"resultIds": [
1,
2
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
}
]
}
]
},
{
"type": "sample string 1",
"rows": [
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilities": [
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilityCode": "sample string 4",
"resultIds": [
1,
2
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
},
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilityCode": "sample string 4",
"resultIds": [
1,
2
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
}
]
},
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilities": [
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilityCode": "sample string 4",
"resultIds": [
1,
2
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
},
{
"productName": "sample string 1",
"productId": 2,
"aliasId": 3,
"compatibilityCode": "sample string 4",
"resultIds": [
1,
2
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
}
]
}
]
}
],
"_links": [
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
},
{
"rel": "sample string 1",
"locale": "sample string 4",
"href": "sample string 2",
"templated": true
}
],
"_languages": [
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
},
{
"rel": "sample string 1",
"locale": "sample string 3",
"name": "sample string 4",
"href": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<ivCompatibilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<aliases>
<alias>
<alias>sample string 2</alias>
<id>1</id>
<ivProductId>3</ivProductId>
<productName>sample string 4</productName>
</alias>
<alias>
<alias>sample string 2</alias>
<id>1</id>
<ivProductId>3</ivProductId>
<productName>sample string 4</productName>
</alias>
</aliases>
<count>1</count>
<sections>
<section>
<rows xmlns:d4p1="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Reports.IVCompatibility">
<d4p1:row>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilities>
<d4p1:compatibility>
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilityCode>sample string 4</d4p1:compatibilityCode>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
<d4p1:resultIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>1</d8p1:int>
<d8p1:int>2</d8p1:int>
</d4p1:resultIds>
</d4p1:compatibility>
<d4p1:compatibility>
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilityCode>sample string 4</d4p1:compatibilityCode>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
<d4p1:resultIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>1</d8p1:int>
<d8p1:int>2</d8p1:int>
</d4p1:resultIds>
</d4p1:compatibility>
</d4p1:compatibilities>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
</d4p1:row>
<d4p1:row>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilities>
<d4p1:compatibility>
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilityCode>sample string 4</d4p1:compatibilityCode>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
<d4p1:resultIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>1</d8p1:int>
<d8p1:int>2</d8p1:int>
</d4p1:resultIds>
</d4p1:compatibility>
<d4p1:compatibility>
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilityCode>sample string 4</d4p1:compatibilityCode>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
<d4p1:resultIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>1</d8p1:int>
<d8p1:int>2</d8p1:int>
</d4p1:resultIds>
</d4p1:compatibility>
</d4p1:compatibilities>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
</d4p1:row>
</rows>
<type>sample string 1</type>
</section>
<section>
<rows xmlns:d4p1="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Reports.IVCompatibility">
<d4p1:row>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilities>
<d4p1:compatibility>
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilityCode>sample string 4</d4p1:compatibilityCode>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
<d4p1:resultIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>1</d8p1:int>
<d8p1:int>2</d8p1:int>
</d4p1:resultIds>
</d4p1:compatibility>
<d4p1:compatibility>
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilityCode>sample string 4</d4p1:compatibilityCode>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
<d4p1:resultIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>1</d8p1:int>
<d8p1:int>2</d8p1:int>
</d4p1:resultIds>
</d4p1:compatibility>
</d4p1:compatibilities>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
</d4p1:row>
<d4p1:row>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilities>
<d4p1:compatibility>
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilityCode>sample string 4</d4p1:compatibilityCode>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
<d4p1:resultIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>1</d8p1:int>
<d8p1:int>2</d8p1:int>
</d4p1:resultIds>
</d4p1:compatibility>
<d4p1:compatibility>
<_languages>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
<languageslink>
<rel>sample string 1</rel>
<locale>sample string 3</locale>
<name>sample string 4</name>
<href>sample string 2</href>
</languageslink>
</_languages>
<_links>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
<link>
<rel>sample string 1</rel>
<locale>sample string 4</locale>
<href>sample string 2</href>
<templated>true</templated>
</link>
</_links>
<d4p1:aliasId>3</d4p1:aliasId>
<d4p1:compatibilityCode>sample string 4</d4p1:compatibilityCode>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
<d4p1:resultIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>1</d8p1:int>
<d8p1:int>2</d8p1:int>
</d4p1:resultIds>
</d4p1:compatibility>
</d4p1:compatibilities>
<d4p1:productId>2</d4p1:productId>
<d4p1:productName>sample string 1</d4p1:productName>
</d4p1:row>
</rows>
<type>sample string 1</type>
</section>
</sections>
</ivCompatibilityResponse>