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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CloseShift xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Manufacturing">
  <TerminalID>0</TerminalID>
  <UserID>0</UserID>
  <OpenNewShift>false</OpenNewShift>
  <NewShiftOpDate>0001-01-01T00:00:00</NewShiftOpDate>
  <AllowOperationTransfer>false</AllowOperationTransfer>
</CloseShift>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CloseShiftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Manufacturing">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Shift>
    <ID>0</ID>
    <TermOpenID>0</TermOpenID>
    <TermCloseID>0</TermCloseID>
    <DateOpen>0001-01-01T00:00:00</DateOpen>
    <DateClose>0001-01-01T00:00:00</DateClose>
    <UserOpenID>0</UserOpenID>
    <UserClosedID>0</UserClosedID>
    <ShiftGroupID>0</ShiftGroupID>
    <OperDate>0001-01-01T00:00:00</OperDate>
  </Shift>
</CloseShiftResponse>