POST public-api/transactions/public/asset/check-out
This method checks out the assets that are passed in, both Fixed and Inventory assets. For checking out Fixed Assets, you don’t need to provide the from location or quantity fields. Requires the Allow Check Out permission, enforces Role Site and Asset Type security Accepts a maximum of 500 records at a time
Request Information
URI Parameters
None.
Body Parameters
Collection of AssetCheckOutModelName | Description | Type | Additional information |
---|---|---|---|
AssetTag |
Required, the asset tag of the asset being checked in |
string |
None. |
FromSiteName |
The current site of the asset being checked in, required for multi-quantity assets |
string |
None. |
FromLocationCode |
The current location of the asset being checked in, required for multi-quantity assets |
string |
None. |
FromGroupTag |
The current asset tag of the group the checked in asset belongs to, required for multi-quantity assets |
string |
None. |
ToSiteName |
The new site of the checked in asset, optional |
string |
None. |
ToLocationCode |
The new location of the checked in asset, optional |
string |
None. |
ToGroupTag |
The new asset tag of the group the checked in asset belongs to, optional |
string |
None. |
DueDate |
Optional, the date the asset is due back |
date |
None. |
CheckOutDate |
Optional, the date the asset was checked out, will default to Now |
date |
None. |
VendorNumber |
The vendor number of the assignee that is checking in the asset, required for multi-quantity assets |
string |
None. |
CustomerNumber |
The customer number of the assignee that is checking in the asset, required for multi-quantity assets |
string |
None. |
EmployeeNumber |
The employee number of the assignee that is checking in the asset, required for multi-quantity assets |
string |
None. |
Quantity |
Required for multi-quantity assets, the amount of the asset being checked out |
decimal number |
None. |
RecordSource |
Optional, identifier for device checking out the asset (i.e. a PC Name, Kiosk name, mobile device) |
string |
None. |
Note |
Optional, note associated with the check out transaction |
string |
None. |
Condition |
during check out, the asset condition could be set. if a valid value is specified, then the new asset condition value will be used to update the asset record as well as stored into the check out transaction history. |
string |
None. |
Request Formats
application/json
[ { "AssetTag": "sample string 1", "FromSiteName": "sample string 2", "FromLocationCode": "sample string 3", "FromGroupTag": "sample string 4", "ToSiteName": "sample string 5", "ToLocationCode": "sample string 6", "ToGroupTag": "sample string 7", "DueDate": "2025-04-02T04:33:34.7495136+00:00", "CheckOutDate": "2025-04-02T04:33:34.7495136+00:00", "VendorNumber": "sample string 8", "CustomerNumber": "sample string 9", "EmployeeNumber": "sample string 10", "Quantity": 1.0, "RecordSource": "sample string 11", "Note": "sample string 12", "Condition": "sample string 13" }, { "AssetTag": "sample string 1", "FromSiteName": "sample string 2", "FromLocationCode": "sample string 3", "FromGroupTag": "sample string 4", "ToSiteName": "sample string 5", "ToLocationCode": "sample string 6", "ToGroupTag": "sample string 7", "DueDate": "2025-04-02T04:33:34.7495136+00:00", "CheckOutDate": "2025-04-02T04:33:34.7495136+00:00", "VendorNumber": "sample string 8", "CustomerNumber": "sample string 9", "EmployeeNumber": "sample string 10", "Quantity": 1.0, "RecordSource": "sample string 11", "Note": "sample string 12", "Condition": "sample string 13" } ]
Response Information
Resource Description
WaspResultOfListOfInt32Name | Description | Type | Additional information |
---|---|---|---|
Data |
Type specific result that always depends on the function called. |
Collection of integer |
None. |
Messages |
List of Messages. All APIs should return messages. If an API function returns an error you can find more information about the error or errors in this collection of messages. |
Collection of WtResult |
None. |
BatchNumber |
This is a global batch number generated by a mass group of transaction records to be returned to the consumer on each call to rolling transaction rules. This requests that each group of Move/Add/Remove transaction batches is tied together. In prior products (such as Mobile Asset Cloud), all are set to null and the only time when the batch number is generated is for multiple check-out transactions but the old is to generate for each responsible party. |
integer |
None. |
HasError |
True if an API function result has an error message in the results. If this is false, the function succeeded but other informative messages may be available. |
boolean |
None. |
HasHttpError |
True if an API function call could not be fully posted to the server or the results could not be fully returned. |
boolean |
None. |
HasMessage |
True if any message is available. |
boolean |
None. |
HasSuccessWithMoreDataRemaining |
True if the server sent part of the data and there is more data available. Use with paging APIs to fetch data one page at a time. |
boolean |
None. |
TotalRecordsLongCount |
This is the total number of records available in the database based on the query and filer conditions provided. It is possible that the value can change from call to call as users add and delete records so this should not be used to page through multiple recordsets of data. This is used, for example, to set relative scroll bar sizes. When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is an time-consuming operation. To avoid that extra calculation, and help prevent throttling, assign TotalRecordsLongCount to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page thru the records faster. |
integer |
None. |
Response Formats
application/json
{ "Data": [ 1, 2 ], "Messages": [ { "ResultCode": 0, "Message": "sample string 1", "HttpStatusCode": 200, "FieldName": "sample string 2" }, { "ResultCode": 0, "Message": "sample string 1", "HttpStatusCode": 200, "FieldName": "sample string 2" } ], "BatchNumber": 1, "HasError": false, "HasHttpError": false, "HasMessage": true, "HasSuccessWithMoreDataRemaining": false, "TotalRecordsLongCount": 1 }