GET api/v1/Suppliers/Supplier?supplierid={supplierid}
Query supplier information for a specific supplier.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| supplierid |
Id of the Supplier record |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
APISupplierModel| Name | Description | Type | Additional information |
|---|---|---|---|
| supplierid | globally unique identifier |
None. |
|
| suppliernumber | string |
None. |
|
| suppliername | string |
None. |
|
| locationname | string |
None. |
|
| siteid | globally unique identifier |
None. |
|
| emailaddress | string |
None. |
|
| addressline1 | string |
None. |
|
| addressline2 | string |
None. |
|
| addressline3 | string |
None. |
|
| addressline4 | string |
None. |
|
| areacode | string |
None. |
|
| contactname | string |
None. |
|
| contacttelephone | string |
None. |
|
| contactemailaddress | string |
None. |
|
| isgroup | boolean |
None. |
|
| isingroup | boolean |
None. |
|
| parentgroup | globally unique identifier |
None. |
|
| countryid | integer |
None. |
|
| countryISO | string |
None. |
|
| latitude | decimal number |
None. |
|
| longitude | decimal number |
None. |
|
| allow_adhoctrucks | string |
None. |
|
| isrocsystemuser | boolean |
None. |
|
| iscollector | boolean |
None. |
|
| collectionlocations | Collection of api_GetSupplierCollectionLocations_Result |
None. |
Response Formats
application/json, text/json
Sample:
{
"supplierid": "2a0337db-e5b4-4a2f-b15f-ef71dca88b4e",
"suppliernumber": "sample string 1",
"suppliername": "sample string 2",
"locationname": "sample string 3",
"siteid": "76149540-9e29-4a46-b153-df006eee63a7",
"emailaddress": "sample string 4",
"addressline1": "sample string 5",
"addressline2": "sample string 6",
"addressline3": "sample string 7",
"addressline4": "sample string 8",
"areacode": "sample string 9",
"contactname": "sample string 10",
"contacttelephone": "sample string 11",
"contactemailaddress": "sample string 12",
"isgroup": true,
"isingroup": true,
"parentgroup": "568ce6b3-5a05-473a-a22b-fcc7c047fddc",
"countryid": 1,
"countryISO": "sample string 13",
"latitude": 1.0,
"longitude": 1.0,
"allow_adhoctrucks": "sample string 14",
"isrocsystemuser": true,
"iscollector": true,
"collectionlocations": []
}
application/xml, text/xml
Sample:
<APISupplierModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/nfuels_api.Models"> <addressline1>sample string 5</addressline1> <addressline2>sample string 6</addressline2> <addressline3>sample string 7</addressline3> <addressline4>sample string 8</addressline4> <allow_adhoctrucks>sample string 14</allow_adhoctrucks> <areacode>sample string 9</areacode> <collectionlocations xmlns:d2p1="http://schemas.datacontract.org/2004/07/NFuels_Database.database.portal" /> <contactemailaddress>sample string 12</contactemailaddress> <contactname>sample string 10</contactname> <contacttelephone>sample string 11</contacttelephone> <countryISO>sample string 13</countryISO> <countryid>1</countryid> <emailaddress>sample string 4</emailaddress> <iscollector>true</iscollector> <isgroup>true</isgroup> <isingroup>true</isingroup> <isrocsystemuser>true</isrocsystemuser> <latitude>1</latitude> <locationname>sample string 3</locationname> <longitude>1</longitude> <parentgroup>568ce6b3-5a05-473a-a22b-fcc7c047fddc</parentgroup> <siteid>76149540-9e29-4a46-b153-df006eee63a7</siteid> <supplierid>2a0337db-e5b4-4a2f-b15f-ef71dca88b4e</supplierid> <suppliername>sample string 2</suppliername> <suppliernumber>sample string 1</suppliernumber> </APISupplierModel>