| POST | /uplift/auth |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UpliftSchedulePrincipleId | body | int | No | |
| TotalValue | body | decimal | No | |
| TotalUnits | body | double | No | |
| Region | body | string | No | |
| Channel | body | string | No | |
| Seals | body | List<UpliftSealData> | No | |
| UnbaggedItems | body | UpliftSealData | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Latitude | form | double | No | Latitude of the user making this request |
| Longitude | form | double | No | Longitude of the user making this request |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Unbagged | form | bool | No | |
| SealNumber | form | string | No | |
| AntelSealNumber | form | string | No | |
| Products | form | List<UpliftProductData> | No | |
| TotalPrice | form | double | No | |
| TotalQuantity | form | double | No | |
| NetWeight | form | double | No | |
| GrossWeight | form | double | No | |
| BillableSeal | form | bool | No | |
| InvalidAntelSealNumber | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UpliftProductId | form | int | No | |
| UpliftId | form | int | No | |
| ProductId | form | int | No | |
| UnitPrice | form | decimal | No | |
| Name | form | string | No | |
| Category | form | string | No | |
| UnitBarcode | form | string | No | |
| UnitSize | form | string | No | |
| UnitWeight | form | decimal | No | |
| Code | form | string | No | |
| UpliftImages | form | List<Object> | No | |
| Quantity | form | double | No | |
| Value | form | decimal | No | |
| PriceOverMax | form | bool | No | |
| QuantityOverMax | form | bool | No | |
| QuantityOverRequirement | form | bool | No | |
| SerialNumber | form | string | No | |
| BatchCode | form | string | No | |
| StockStatusId | form | int | No | |
| LotNumber | form | string | No | |
| ExpiryDate | form | string | No | |
| ManufactureDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UpliftAuthRequestId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | Yes | Information about the response. |
| Heading | form | string | Yes | Heading or summary of the response. |
| WasSuccessful | form | boolean | Yes | Did the intended operation for this response complete successfully? |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/auth HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"upliftSchedulePrincipleId":0,"totalValue":0,"totalUnits":0,"region":"String","channel":"String","seals":[{"unbagged":false,"sealNumber":"String","antelSealNumber":"String","products":[{"upliftProductId":0,"upliftId":0,"productId":0,"unitPrice":0,"name":"String","category":"String","unitBarcode":"String","unitSize":"String","unitWeight":0,"code":"String","upliftImages":[{}],"quantity":0,"value":0,"priceOverMax":false,"quantityOverMax":false,"quantityOverRequirement":false,"serialNumber":"String","batchCode":"String","stockStatusId":0,"lotNumber":"String","expiryDate":"String","manufactureDate":"String"}],"totalPrice":0,"totalQuantity":0,"netWeight":0,"grossWeight":0,"billableSeal":false,"invalidAntelSealNumber":false}],"unbaggedItems":{"unbagged":false,"sealNumber":"String","antelSealNumber":"String","products":[{"upliftProductId":0,"upliftId":0,"productId":0,"unitPrice":0,"name":"String","category":"String","unitBarcode":"String","unitSize":"String","unitWeight":0,"code":"String","upliftImages":[{}],"quantity":0,"value":0,"priceOverMax":false,"quantityOverMax":false,"quantityOverRequirement":false,"serialNumber":"String","batchCode":"String","stockStatusId":0,"lotNumber":"String","expiryDate":"String","manufactureDate":"String"}],"totalPrice":0,"totalQuantity":0,"netWeight":0,"grossWeight":0,"billableSeal":false,"invalidAntelSealNumber":false},"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}