Taffy Dashboard

Resources:

Assigns weight for tag id DELETE PATCH PUT POST GET `/weight`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Sets weight for a load/tag id. Either gross or tare is required

Inputs

required string tagId

optional numeric gross (default: -1)

optional numeric tare (default: -1)

optional string grossWeighedOn (default: "")

optional string tareWeighedOn (default: "")

optional string photo

base64 photo image

Tag validation DELETE PATCH PUT POST GET `/tags/{id}`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

get

Validates a tag - requires auth

Inputs

Tag creation DELETE PATCH PUT POST GET `/tags`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Adds a tag - requires auth

Inputs

optional any id

Photo for outbound load DELETE PATCH PUT POST GET `/outbound-photos`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Inputs

optional any photo

Retrieve loads pending assignment or weight DELETE PATCH PUT POST GET `/loads/pending`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

get

Gets pending loads

Inputs

Load Photo DELETE PATCH PUT POST GET `/loads/{id}/photos/{photoId}`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

get

Inputs

required string id

required string path

optional string storedIn (default: db)

Photos for a load DELETE PATCH PUT POST GET `/loads/{id}/photos`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

get

Inputs

post

Inputs

optional any photo

LoadMember DELETE PATCH PUT POST GET `/loads/{id}`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

delete

Inputs

get

Get load

Inputs

put

Inputs

optional any tare

optional any gross

optional any commodityPriceId

All loads DELETE PATCH PUT POST GET `/loads`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

get

Gets matching loads

Inputs

optional any commodityPriceId (default: "")

optional any loadedOnFrom (default: "")

optional any loadedOnTo (default: "")

optional any status (default: "")

optional any tagId (default: "")

post

Inputs

required string tagId

optional any gross

optional any tare

optional any loadedOn

optional any commodityPriceId

optional array photos (default: [runtime expression])

Retrieve container pending assignment DELETE PATCH PUT POST GET `/load-assignment/{tagId}`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

get

Gets last load for this tag id - requires auth

Inputs

required string tagId

Commodity assignment DELETE PATCH PUT POST GET `/load-assignment`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Assigns a commodity to a load - requires auth

Inputs

required string tagId

optional any commodityId

optional array photos (default: [runtime expression])

All commodities DELETE PATCH PUT POST GET `/commodities`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

get

Retrieves commodities - requires auth

Inputs

AuthenticationVerifyToken DELETE PATCH PUT POST GET `/auth/verify-token`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Inputs

required string token

Set password DELETE PATCH PUT POST GET `/auth/set-password`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Inputs

required string code

required any password

Password code validation DELETE PATCH PUT POST GET `/auth/reset-password-validation`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Inputs

required string code

Reset password request DELETE PATCH PUT POST GET `/auth/reset-password`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Inputs

required string email

AuthenticationLogin DELETE PATCH PUT POST GET `/auth/login`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Inputs

required string username

required string password

Token invalidation DELETE PATCH PUT POST GET `/auth/invalidate-token`

Run it
Documentation

+Query Params +Accept +Headers +Basic Auth

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Inputs

required string token

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.

Reload on every request:	? No
Return Exceptions as JSON:	? Yes
CORS:	? Yes
E-Tags:	? No
JSONP:	? No
Endpoint URL Param:	? endpoint
Serializer:	? taffy.core.nativeJsonSerializer
Return Formats:	text/json application/json
Global Headers:	? None
Exception Log Adapter:	? taffy.bonus.LogToEmail
Exception Log Adapter Config:	? emailSubj Exception Trapped in CSI emailType html emailTo laura@asfusion.com emailFrom bugs@asfusion.com
Unhandled Paths:	/flex2gateway

API Dashboard

Resources:

Assigns weight for tag id DELETE PATCH PUT POST GET /weight

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Tag validation DELETE PATCH PUT POST GET /tags/{id}

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

get

Tag creation DELETE PATCH PUT POST GET /tags

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Photo for outbound load DELETE PATCH PUT POST GET /outbound-photos

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

post

Retrieve loads pending assignment or weight DELETE PATCH PUT POST GET /loads/pending

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

get

Load Photo DELETE PATCH PUT POST GET /loads/{id}/photos/{photoId}

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

get

Photos for a load DELETE PATCH PUT POST GET /loads/{id}/photos

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

get

post

LoadMember DELETE PATCH PUT POST GET /loads/{id}

Query String Parameters: (optional)

Accept:

URI Tokens: (required)

Request Headers:

Basic Auth:

Request Body:

Response:

delete

get

put

All loads DELETE PATCH PUT POST GET /loads

Query String Parameters: (optional)

Accept:

Request Headers:

Basic Auth:

Request Body:

Response:

Assigns weight for tag id DELETE PATCH PUT POST GET `/weight`

Tag validation DELETE PATCH PUT POST GET `/tags/{id}`

Tag creation DELETE PATCH PUT POST GET `/tags`

Photo for outbound load DELETE PATCH PUT POST GET `/outbound-photos`

Retrieve loads pending assignment or weight DELETE PATCH PUT POST GET `/loads/pending`

Load Photo DELETE PATCH PUT POST GET `/loads/{id}/photos/{photoId}`

Photos for a load DELETE PATCH PUT POST GET `/loads/{id}/photos`

LoadMember DELETE PATCH PUT POST GET `/loads/{id}`

All loads DELETE PATCH PUT POST GET `/loads`

Retrieve container pending assignment DELETE PATCH PUT POST GET `/load-assignment/{tagId}`

Commodity assignment DELETE PATCH PUT POST GET `/load-assignment`

All commodities DELETE PATCH PUT POST GET `/commodities`

AuthenticationVerifyToken DELETE PATCH PUT POST GET `/auth/verify-token`

Set password DELETE PATCH PUT POST GET `/auth/set-password`

Password code validation DELETE PATCH PUT POST GET `/auth/reset-password-validation`