GET api/products/{id}
Requires authentication. Get an individual Product by GUID. If successful returns "200 OK", with the body of the response containing a representation of the Product. If not found, returns "404 Not Found" If CRM operations fail for an un-recoverable reason, the service returns "502 Bad Gateway" Any other server-side errors return "500 Internal Server Error"
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ProductRepresentation
ProductRepresentation| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Unique identifier - same as in CRM |
globally unique identifier |
None. |
| Name |
Name for product |
string |
None. |
| Sku |
Sku |
string |
None. |
| Links | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4",
"Name": "sample string 2",
"Sku": "sample string 3",
"_links": [
{
"Rel": "self",
"Href": "~/products/dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4",
"Title": null,
"IsTemplated": false
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"IsTemplated": false
},
{
"Rel": "sample string 1",
"Href": "sample string 2",
"Title": "sample string 3",
"IsTemplated": false
}
],
"_embedded": null
}
application/xml, text/xml
Sample:
<ProductRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSAT.WebServices.WebApp.Representations.Version1">
<Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/products/dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4</Href>
<LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 6</LinkName>
<Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
<Link>
<Href>~/products/dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4</Href>
<Rel>self</Rel>
<Title i:nil="true" />
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
</Link>
<Link>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
<Title>sample string 3</Title>
</Link>
</Links>
<Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 4</Rel>
<Id>dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4</Id>
<Name>sample string 2</Name>
<Sku>sample string 3</Sku>
</ProductRepresentation>
application/hal+json
Sample:
{
"Id": "dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4",
"Name": "sample string 2",
"Sku": "sample string 3",
"_links": {
"self": {
"href": "/products/dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4"
},
"sample string 1": {
"href": "sample string 2",
"title": "sample string 3"
}
}
}
application/hal+xml
Sample:
<resource rel="sample string 4" href="~/products/dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4" name="sample string 6"> <link rel="sample string 1" href="sample string 2" /> <Id>dbe60fd1-6ffd-4fbf-8fbd-f40687b10df4</Id> <Name>sample string 2</Name> <Sku>sample string 3</Sku> </resource>