GET DeliveryTicketLock/PutDeliveryTicketLock?userId={userId}&uniqueKey={uniqueKey}&doLock={doLock}

Gets (and optionally sets) the locked status of a Delivery Ticket.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
userId

The Agvance user ID of the individual getting and/or locking the Delivery Ticket.

string

Required

uniqueKey

The Unique Key identifier that points to the Delivery Ticket record.

integer

Required

doLock

True or False condition used to lock the Delivery Ticket. (optional)

boolean

Default value is False

Body Parameters

Response Information

Resource Description

Gets (and optionally sets) the locked status of a Delivery Ticket.

AgvDeliveryTicketLock
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count indicating whether this Delivery Ticket is locked.

string
LockedByUserId

UserId of user who has this Delivery Ticket locked.

string

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "LockedByUserId": "sample string 4"
}

application/xml, text/xml

Sample:
<AgvDeliveryTicketLock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Inventory.DeliveryTicket">
  <Count>sample string 3</Count>
  <LockedByUserId>sample string 4</LockedByUserId>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvDeliveryTicketLock>