Banyan Technology LIVE Connect™
  1. StaticData
Banyan Technology LIVE Connect™
  • Version 3
    • Authentication
      • Retrieve a token
    • Shipments
      • Creating
        • Create a Full Shipment
        • Create an EZ Rate Shipment
      • Updating
        • Add Document(s) to a Shipment
        • Update a Shipment
        • Adds one or more Reference Numbers to a Shipment
        • Mark as Exported
      • Retrieving
        • Get a Shipment
        • Get multiple Shipments
        • Get Quotes
        • Get Reference Numbers for a Shipment
        • Get documents for the specified shipment.
      • Booking
        • Book a Shipment
        • Unbooks the awarded quote on the specified load.
      • Canceling
        • Cancels a shipment.
    • Invoice
      • Get multiple invoices
      • Mark as Exported
    • Tracking
      • Get tracking statuses
      • Mark as exported.
    • StaticData
      • Accessorials
        GET
      • Document Types
        GET
      • Equipment Types
        GET
      • Package Types
        GET
      • Limited Access Types
        GET
      • Size UOMs
        GET
      • Weight UOMs
        GET
      • Pay Types
        GET
      • Ship Types
        GET
      • Countries
        GET
      • Statuses
        GET
      • Service Modes
        GET
  • Version 2
    • Recommended Workflow
      • Rating
        • ImportForQuote
        • ImportForQuote_Sync
        • GetQuotes
      • Booking/Dispatching
        • BookLoad
      • Tracking
        • GetTrackingStatuses
      • Documents
        • GetDocuments
      • Invoices
        • GetInvoices
        • GetInvoicesWithLoadDetails
    • Additional Offerings
      • Cancelling
        • Cancel a Load
      • Updating
        • UpdateLoad
        • UpdateLoadStatus
        • UpdateShipmentsExport
      • Importing
        • PendingImport
        • ImportForBook
      • Manual Quotes
        • AddManualQuote
      • EZ Rates
        • EzRate
        • EzRate_Sync
      • Waterfall Tendering
        • StartWaterfallTendering
        • CancelWaterfallTendering
      • Unbooking
        • UnBookLoad
      • Additional Dispatching
        • DispatchLoad
      • Load Details
        • GetLoadDetails
        • GetNotes
      • Additional Tracking
        • GetTrackingByLoad
      • Other
        • Normalized Charge Codes
      • SOAP
    • Changelog
  • Exports and Webhooks
    • Standard Load Export - v1
    • Standard Load Export - v2
    • Standard Load Export - v3
    • Push Tracking
  1. StaticData

Limited Access Types

GET
/api/StaticData/LimitedAccessTypes
StaticData
Returns a list of all available Limited Access types.
limitedAccessTypeDescription
ShipperThe limited access type will or should be included in theshipperLocation.Dock.limitedAccessType collection.
ConsigneeThe limited access type will or should be included in theconsigneeLocation.Dock.limitedAccessType object.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ws.integration.banyantechnology.com/api/StaticData/LimitedAccessTypes'

Responses

🟢200Success
application/json
Body
array of:
limitedAccessType
string 
required
description
string 
required
Example
[
  {
    "limitedAccessType": "Shipper",
    "description": "Airport"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Airport"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Cemetery"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Cemetery"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Church"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Church"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Construction Site"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Construction Site"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Container Station"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Container Station"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Convention Center"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Convention Center"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Fair/Amusement Park"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Fair/Amusement Park"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Farm Country Club Estate"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Farm Country Club Estate"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Funeral Home"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Funeral Home"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Golf Course"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Golf Course"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Grocery Warehouse"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Grocery Warehouse"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Hospital/Medical Facility"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Hospital/Medical Facility"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Hotel"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Hotel"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Inspection Site"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Inspection Site"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Marina"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Marina"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Military Base"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Military Base"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Mine Site"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Mine Site"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Mini-Storage"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Mini-Storage"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "No Dock/Dock obstruction"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "No Dock/Dock obstruction"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Nursing Home"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Nursing Home"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Park Forest/Preserve"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Park Forest/Preserve"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Piers and Wharves"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Piers and Wharves"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Prison"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Prison"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Ranch"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Ranch"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Recreational/athletic Facility"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Recreational/athletic Facility"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Remote Government"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Remote Government"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Reservation"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Reservation"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Restaurant"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Restaurant"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "School"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "School"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Service Station"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Service Station"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Shopping Center/Mall"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Shopping Center/Mall"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Social Club"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Social Club"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Steel Mill"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Steel Mill"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Unspecified"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Unspecified"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Utility Site"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Utility Site"
  },
  {
    "limitedAccessType": "Consignee",
    "description": "Winery/Brewery/Distillery"
  },
  {
    "limitedAccessType": "Shipper",
    "description": "Winery/Brewery/Distillery"
  }
]
🟠401Unauthorized
🟠403Forbidden
🟠429Too Many Requests
Modified at 2024-09-16 11:42:17
Previous
Package Types
Next
Size UOMs
Built with