GET api/delivery/suppliers?supplierId={supplierId}
Get all suppliers, or a single supplier.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| supplierId | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ResponseOfListOfSupplier| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | string |
None. |
|
| Success | boolean |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| Data | Collection of Supplier |
None. |
|
| Errors | Dictionary of string [key] and Collection of string [value] |
None. |
Response Formats
application/json, text/json
Sample:
{
"message": "sample string 1",
"success": true,
"statusCode": 100,
"data": [
{
"supplierId": 1,
"supplierName": "sample string 2",
"email": "sample string 3"
},
{
"supplierId": 1,
"supplierName": "sample string 2",
"email": "sample string 3"
}
],
"errors": {
"sample string 1": [
"sample string 1",
"sample string 2"
],
"sample string 2": [
"sample string 1",
"sample string 2"
]
}
}
application/xml, text/xml
Sample:
<ResponseOfArrayOfSuppliervhWbQmEI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response.Delivery">
<d2p1:Supplier>
<d2p1:Email>sample string 3</d2p1:Email>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Supplier_Id>1</d2p1:Supplier_Id>
</d2p1:Supplier>
<d2p1:Supplier>
<d2p1:Email>sample string 3</d2p1:Email>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:Supplier_Id>1</d2p1:Supplier_Id>
</d2p1:Supplier>
</Data>
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</d2p1:Value>
</d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
<d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value>
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</d2p1:Value>
</d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
</Errors>
<Message>sample string 1</Message>
<StatusCode>Continue</StatusCode>
<Success>true</Success>
</ResponseOfArrayOfSuppliervhWbQmEI>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Message" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Success" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="StatusCode" Continue --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data[0].Supplier_Id" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data[0].Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data[0].Email" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data[1].Supplier_Id" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data[1].Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data[1].Email" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[0].Key" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[0].Value[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[0].Value[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[1].Key" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[1].Value[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[1].Value[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e--