ApexERPHost

<back to all web services

LockObject

Requires Authentication
The following routes are available for this service:
PUT/Core/Object/Locks
LockObject Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
MetabodyDictionary<string, string>No
LockObjectResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
Resultformbool?No
ObjectLockformObjectLockNo
MetaformDictionary<string, string>No
ObjectLock Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
UsernameformstringNo
HostnameformstringNo
LockTimeformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /Core/Object/Locks HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: False,
	ObjectLock: 
	{
		Name: String,
		Username: String,
		Hostname: String,
		LockTime: 0001-01-01
	},
	Meta: 
	{
		String: String
	}
}