GET api/Shops/SpecificID/{id}
Retrieves a singular shop class for a specific Eskimo ID/code
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | string |
Required |
Body Parameters
None.
Response Information
Resource Description
EskimoClassLibraries.clsShopName | Description | Type | Additional information |
---|---|---|---|
Name |
The friendly name of the shop |
string |
String length: inclusive between 0 and 50 |
Code |
A unique three digit string to identify the shop. |
string |
String length: inclusive between 3 and 3 |
Address1 |
The first address line |
string |
String length: inclusive between 0 and 250 |
Address2 |
The second address line |
string |
String length: inclusive between 0 and 250 |
Address3 |
The third address line |
string |
String length: inclusive between 0 and 250 |
Address4 |
The fourth address line |
string |
String length: inclusive between 0 and 250 |
PostCode |
The shop's postcode |
string |
String length: inclusive between 0 and 50 |
Telephone |
The main telephone number for the shop |
string |
String length: inclusive between 0 and 50 |
Fax |
Do people still use these? Well, if they do, this is the facsimile number for the shop. |
string |
String length: inclusive between 0 and 50 |
The email address for the shop |
string |
String length: inclusive between 0 and 50 |
|
Concession |
Determines if the unit is actually a concession - perhaps within a large department store |
boolean |
None. |
Status |
The status of the shop. |
string |
String length: inclusive between 0 and 50 |
RegionId |
The area or region that the shop is in - controlled by the retailer. |
integer |
None. |
Response Formats
application/json, text/json
{ "Name": "sample string 1", "Code": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "Address3": "sample string 5", "Address4": "sample string 6", "PostCode": "sample string 7", "Telephone": "sample string 8", "Fax": "sample string 9", "Email": "sample string 10", "Concession": true, "Status": "sample string 12", "RegionId": 13 }
application/xml, text/xml
<clsShop xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EskimoClassLibraries"> <Address1>sample string 3</Address1> <Address2>sample string 4</Address2> <Address3>sample string 5</Address3> <Address4>sample string 6</Address4> <Code>sample string 2</Code> <Concession>true</Concession> <Email>sample string 10</Email> <Fax>sample string 9</Fax> <Name>sample string 1</Name> <PostCode>sample string 7</PostCode> <RegionId>13</RegionId> <Status>sample string 12</Status> <Telephone>sample string 8</Telephone> </clsShop>