REL documentation
inventory auditbatchlist (http://api.3plcentral.com/rels/inventory/auditbatchlist)
Resource:
Collection: of auditbatch
C# Rel Const:
Rels.InventorySvc.AuditBatchList
URI template:
auditbatchs
Obtain URI from:
Billboard
Create a new audit batch from specified payhload
Success status: 200
none
Payload indicating batch parameters and content
Type Description
Name string
AssignedUser Generic.Models.UserIdentifier
Name string
Id int
Priority int
Status int
InventoryAuditIds IList<int>
Sample content-type: application/hal+json
 
{
  "name": "str",
  "assignedUser": {
    "name": "str",
    "id": 2
  },
  "priority": 2,
  "status": 3,
  "inventoryAuditIds": [
    1
  ]
}
New AuditBatch record
Type Description
Name string
AssignedUser Generic.Models.UserIdentifier
Name string
Id int
Priority int
Status int
InventoryAuditIds IList<int>
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "name": "str",
  "assignedUser": {
    "name": "str",
    "id": 2
  },
  "priority": 2,
  "status": 3,
  "inventoryAuditIds": [
    1
  ]
}
Success status: 200
none
Type Description
NameOperation Common.Enum.FilterOperator? ...
- 0: Less
- 1: LessOrEqual
- 2: Equals
- 3: NotEquals
- 4: GreaterOrEqual
- 5: Greater
- 6: StartsWith
- 7: EndsWith
- 8: Contains
- 9: ContainedIn
- 10: NotContains
NameValue string
PriorityOperation Common.Enum.FilterOperator? ...
- 0: Less
- 1: LessOrEqual
- 2: Equals
- 3: NotEquals
- 4: GreaterOrEqual
- 5: Greater
- 6: StartsWith
- 7: EndsWith
- 8: Contains
- 9: ContainedIn
- 10: NotContains
PriorityValue int? ...
StatusValue Common.Enum.AuditBatchStatus? ...
- 0: Open
- 1: InProgress
- 2: Closed
UserIdValue int? ...
FacilityIdValue int? ...
Sample content-type: application/hal+json
 
{
  "nameOperation": 0,
  "nameValue": "str",
  "priorityOperation": 0,
  "priorityValue": 1,
  "statusValue": 0,
  "userIdValue": 1,
  "facilityIdValue": 1
}
Type Description
ResourceList IList<Inventory.Models.AuditBatch>
Name string
AssignedUser Generic.Models.UserIdentifier
Name string
Id int
Priority int
Status int
InventoryAuditIds IList<int>
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "_embedded": {
    "http://api.3plCentral.com/rels/inventory/auditbatch": [
      {
        "name": "str",
        "assignedUser": {
          "name": "str",
          "id": 2
        },
        "priority": 2,
        "status": 3,
        "inventoryAuditIds": [
          1
        ]
      }
    ]
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.