Add a Lock to a Party

Use the following details to add a lock to a Party using REST interface:

HTTP Method

POST

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/party/{id}/lock

Request Parameters

Provide values for the following parameters:

Parameter Name Data Type Mandatory
createdBy string optional
createdOn dateTime optional
current boolean optional
key string optional
priority optional
timeout optional

Request Model

Media Type: application/json 

{
  "createdBy": "string",
  "createdOn": "2016-07-31T05:17:58.844Z",
  "current": true,
  "key": "string",
  "priority": 0,
  "timeout": 0
}

Response Model

{
  "data": {
    "createdBy": "string",
    "createdOn": "2016-07-31T05:17:59.086Z",
    "current": true,
    "key": "string",
    "priority": 0,
    "timeout": 0
  },
  "duration": 0,
  "result": {
    "code": "string",
    "message": "string",
    "params": [
      "string"
    ]
  },
  "startTimestampMS": 0
}

Response Codes and Descriptions

Response Code Description
201 Created
401 Unauthorized
403 Forbidden
404 Not Found