GET api/v1/grainbin/{fmid_bin_id}/pos/{radius_in_miles}

Provides POS location details based on a specified radius of the bin location.

Request Information

Headers

In order to receive live data, you must provide the necessary information to authenticate. This will require an API-Key, which is to be provided within the request header for every request. If an API-Key is not provided, sandbox data will be returned.

Name Description Type Additional Information
API-Key 32 Character GUID key String Required to return live information. If not provided, sandbox data will be returned.

URI Parameters

NameDescriptionTypeAdditional information
fmid_bin_id

FMID_Bin_Id to locate

integer

Required

radius_in_miles

Radius from the bin's latitude and longitude location in miles.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Grain Bin Facility Detail

Collection of V1_Bin_POS_Detailed
NameDescriptionTypeAdditional information
Distance

The distance for the POS from the bin

integer

None.

Facility_Id

The primary identifier of the facility

integer

None.

Facility_Type

The short code facility type

string

None.

Company_Name

The name of the facility

string

None.

Address_1

The address of the facility

string

None.

City

The city of the facility

string

None.

State

The state of the facility

string

None.

Zip_Code

The zip code of the facility

string

None.

Zip_Code_4

The four digit zip code of the facility

string

None.

FIPS_Code

The FIPS Code of the facility

string

None.

Lat

The latitude of the facility

decimal number

None.

Lon

The longitude of the facility

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Distance": 1,
    "Facility_Id": 2,
    "Facility_Type": "sample string 3",
    "Company_Name": "sample string 4",
    "Address_1": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip_Code": "sample string 8",
    "Zip_Code_4": "sample string 9",
    "FIPS_Code": "sample string 10",
    "Lat": 11.1,
    "Lon": 12.1
  },
  {
    "Distance": 1,
    "Facility_Id": 2,
    "Facility_Type": "sample string 3",
    "Company_Name": "sample string 4",
    "Address_1": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip_Code": "sample string 8",
    "Zip_Code_4": "sample string 9",
    "FIPS_Code": "sample string 10",
    "Lat": 11.1,
    "Lon": 12.1
  }
]

text/html

Sample:
[{"Distance":1,"Facility_Id":2,"Facility_Type":"sample string 3","Company_Name":"sample string 4","Address_1":"sample string 5","City":"sample string 6","State":"sample string 7","Zip_Code":"sample string 8","Zip_Code_4":"sample string 9","FIPS_Code":"sample string 10","Lat":11.1,"Lon":12.1},{"Distance":1,"Facility_Id":2,"Facility_Type":"sample string 3","Company_Name":"sample string 4","Address_1":"sample string 5","City":"sample string 6","State":"sample string 7","Zip_Code":"sample string 8","Zip_Code_4":"sample string 9","FIPS_Code":"sample string 10","Lat":11.1,"Lon":12.1}]

application/xml, text/xml

Sample:
<ArrayOfV1_Bin_POS_Detailed xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FF_API.Models.Grainbin.V1">
  <V1_Bin_POS_Detailed>
    <Address_1>sample string 5</Address_1>
    <City>sample string 6</City>
    <Company_Name>sample string 4</Company_Name>
    <FIPS_Code>sample string 10</FIPS_Code>
    <Facility_Id>2</Facility_Id>
    <Facility_Type>sample string 3</Facility_Type>
    <Lat>11.1</Lat>
    <Lon>12.1</Lon>
    <State>sample string 7</State>
    <Zip_Code>sample string 8</Zip_Code>
    <Zip_Code_4>sample string 9</Zip_Code_4>
    <Distance>1</Distance>
  </V1_Bin_POS_Detailed>
  <V1_Bin_POS_Detailed>
    <Address_1>sample string 5</Address_1>
    <City>sample string 6</City>
    <Company_Name>sample string 4</Company_Name>
    <FIPS_Code>sample string 10</FIPS_Code>
    <Facility_Id>2</Facility_Id>
    <Facility_Type>sample string 3</Facility_Type>
    <Lat>11.1</Lat>
    <Lon>12.1</Lon>
    <State>sample string 7</State>
    <Zip_Code>sample string 8</Zip_Code>
    <Zip_Code_4>sample string 9</Zip_Code_4>
    <Distance>1</Distance>
  </V1_Bin_POS_Detailed>
</ArrayOfV1_Bin_POS_Detailed>