POST api/v1/EventLock

Lock an event in Caliq before making changes or payment.
If event is already locked will return message as 'INUSE' If event is locked ok will return 'LOCKED'

Request Information

URI Parameters

None.

Body Parameters

EventLockParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
EventID	When getting a lock the Event ID to Lock. When releasing a lock can be omitted	integer	None.
LockID	If set this lock will be released, if creating a lock then can be omitted	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "EventID": 1,
  "LockID": 1
}

application/xml, text/xml

Sample:

<EventLockParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <EventID>1</EventID>
  <LockID>1</LockID>
</EventLockParams>

Response Information

Resource Description

Returns:
200 OK Returns a lockid or clears existing lock
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

Locks

Name	Description	Type	Additional information
Lock		Lock	None.

Response Formats

application/json, text/json

Sample:

{
  "Lock": {
    "OK": true,
    "LockID": 1,
    "Message": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<Locks xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Lock>
    <OK>true</OK>
    <LockID>1</LockID>
    <Message>sample string 2</Message>
  </Lock>
</Locks>