ApexERPHost

<back to all web services

CloseShift

Requires Authentication
The following routes are available for this service:
POST/Shift/Close
CloseShift Parameters:
NameParameterData TypeRequiredDescription
TerminalIDbodyintNo
UserIDbodyintNo
OpenNewShiftbodyboolNo
NewShiftOpDatebodyDateTime?No
AllowOperationTransferbodyboolNo
CloseShiftResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ShiftformShiftNo
Shift Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TermOpenIDformintNo
TermCloseIDformint?No
DateOpenformDateTimeNo
DateCloseformDateTime?No
UserOpenIDformintNo
UserClosedIDformint?No
ShiftGroupIDformintNo
OperDateformDateTimeNo

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.

POST /Shift/Close HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TerminalID: 0,
	UserID: 0,
	OpenNewShift: False,
	NewShiftOpDate: 0001-01-01,
	AllowOperationTransfer: False
}
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
		}
	},
	Shift: 
	{
		ID: 0,
		TermOpenID: 0,
		TermCloseID: 0,
		DateOpen: 0001-01-01,
		DateClose: 0001-01-01,
		UserOpenID: 0,
		UserClosedID: 0,
		ShiftGroupID: 0,
		OperDate: 0001-01-01
	}
}