ProcEngWebService Web Service

ProcEngWebService

Click here for a complete list of operations.

FindAppointmentsByDateRange

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /SSMWS/ProcEngWebService.asmx HTTP/1.1
Host: ta.nmwtra.org.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.tensor.com/FindAppointmentsByDateRange"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FindAppointmentsByDateRange xmlns="http://www.tensor.com/">
      <token>string</token>
      <systemID>int</systemID>
      <sysDT>dateTime</sysDT>
      <dateFrom>dateTime</dateFrom>
      <dateTo>dateTime</dateTo>
      <includeMissedAndCancelled>boolean</includeMissedAndCancelled>
      <readerID>int</readerID>
      <obeySiteNavigator>int</obeySiteNavigator>
    </FindAppointmentsByDateRange>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FindAppointmentsByDateRangeResponse xmlns="http://www.tensor.com/">
      <FindAppointmentsByDateRangeResult>
        <DiaryEntryInfo>
          <PassLastPrinted />
          <PassExpiry>dateTime</PassExpiry>
          <EmbossedNumber>string</EmbossedNumber>
          <Notes>string</Notes>
          <PurposeID>int</PurposeID>
          <Name>string</Name>
          <State>string</State>
          <Due>string</Due>
          <LastPassPrintedByUserName>string</LastPassPrintedByUserName>
          <LastPassPrintedDateTime>dateTime</LastPassPrintedDateTime>
          <Printer>string</Printer>
          <ArrivedTime>dateTime</ArrivedTime>
          <ExpDepartTime>dateTime</ExpDepartTime>
          <DepartedTime>dateTime</DepartedTime>
          <AccessGroupType>string</AccessGroupType>
          <AccessGroupID>int</AccessGroupID>
          <AccessGroupName>string</AccessGroupName>
          <AppointmentID>int</AppointmentID>
          <HighestFlag>None or Scheduled or Pending or Late or In or Overstay or Out or Missed or Cancelled or OnHold</HighestFlag>
          <FirePointID>int</FirePointID>
          <Visitortype>Unknown or Visitor or Contractor or Employee or Driver</Visitortype>
          <ParentAppointmentID>int</ParentAppointmentID>
          <AttendanceID>int</AttendanceID>
          <Start>dateTime</Start>
          <StartDateTime>dateTime</StartDateTime>
          <End>dateTime</End>
          <VisitorName>string</VisitorName>
          <VisitorCompany>string</VisitorCompany>
          <Company>string</Company>
          <Site>string</Site>
          <Location>string</Location>
          <Host>string</Host>
          <ShortHost>string</ShortHost>
          <HostID>int</HostID>
          <Privacy>Everyone or Host or Receptionist</Privacy>
          <CompanyID>int</CompanyID>
          <SiteID>int</SiteID>
          <LocationID>int</LocationID>
          <Repetition>string</Repetition>
          <RepetitionDays>Monday or Tuesday or Wednesday or Thursday or Friday or Saturday or Sunday or Public or Closed or Shutdown</RepetitionDays>
          <Cancelled>boolean</Cancelled>
          <MissedOrCancelled>boolean</MissedOrCancelled>
          <AvailableToRelatedAppointment>boolean</AvailableToRelatedAppointment>
          <AttendanceState>None or Scheduled or Pending or Late or In or Overstay or Out or Missed or Cancelled or OnHold</AttendanceState>
          <NameLookup>string</NameLookup>
          <VisitorID>int</VisitorID>
          <TemplateID>int</TemplateID>
          <IsToday>boolean</IsToday>
          <Description>string</Description>
          <VehicleID>int</VehicleID>
          <Registration>string</Registration>
          <CheckInUserID>int</CheckInUserID>
          <CheckOutUserID>int</CheckOutUserID>
          <Type>string</Type>
          <ArrivalTime>dateTime</ArrivalTime>
          <DepartureTime>dateTime</DepartureTime>
          <AutoArchive>boolean</AutoArchive>
          <Duration>int</Duration>
          <AppointmentGroup>string</AppointmentGroup>
          <NonVettingReason>string</NonVettingReason>
          <NonVettingNotes>string</NonVettingNotes>
          <VisitorLocation>int</VisitorLocation>
          <IsPrimaryContact>boolean</IsPrimaryContact>
          <TreatAsVisitor>boolean</TreatAsVisitor>
          <AppointmentDocumentFlags>
            <AppointmentDocumentTypeWithFlag xsi:nil="true" />
            <AppointmentDocumentTypeWithFlag xsi:nil="true" />
          </AppointmentDocumentFlags>
          <CanCheckIn>boolean</CanCheckIn>
          <CanCheckOut>boolean</CanCheckOut>
          <ANPRAccessGroupID>int</ANPRAccessGroupID>
          <ANPRAccessGroupType>int</ANPRAccessGroupType>
          <AppointmentTitle>string</AppointmentTitle>
        </DiaryEntryInfo>
        <DiaryEntryInfo>
          <PassLastPrinted />
          <PassExpiry>dateTime</PassExpiry>
          <EmbossedNumber>string</EmbossedNumber>
          <Notes>string</Notes>
          <PurposeID>int</PurposeID>
          <Name>string</Name>
          <State>string</State>
          <Due>string</Due>
          <LastPassPrintedByUserName>string</LastPassPrintedByUserName>
          <LastPassPrintedDateTime>dateTime</LastPassPrintedDateTime>
          <Printer>string</Printer>
          <ArrivedTime>dateTime</ArrivedTime>
          <ExpDepartTime>dateTime</ExpDepartTime>
          <DepartedTime>dateTime</DepartedTime>
          <AccessGroupType>string</AccessGroupType>
          <AccessGroupID>int</AccessGroupID>
          <AccessGroupName>string</AccessGroupName>
          <AppointmentID>int</AppointmentID>
          <HighestFlag>None or Scheduled or Pending or Late or In or Overstay or Out or Missed or Cancelled or OnHold</HighestFlag>
          <FirePointID>int</FirePointID>
          <Visitortype>Unknown or Visitor or Contractor or Employee or Driver</Visitortype>
          <ParentAppointmentID>int</ParentAppointmentID>
          <AttendanceID>int</AttendanceID>
          <Start>dateTime</Start>
          <StartDateTime>dateTime</StartDateTime>
          <End>dateTime</End>
          <VisitorName>string</VisitorName>
          <VisitorCompany>string</VisitorCompany>
          <Company>string</Company>
          <Site>string</Site>
          <Location>string</Location>
          <Host>string</Host>
          <ShortHost>string</ShortHost>
          <HostID>int</HostID>
          <Privacy>Everyone or Host or Receptionist</Privacy>
          <CompanyID>int</CompanyID>
          <SiteID>int</SiteID>
          <LocationID>int</LocationID>
          <Repetition>string</Repetition>
          <RepetitionDays>Monday or Tuesday or Wednesday or Thursday or Friday or Saturday or Sunday or Public or Closed or Shutdown</RepetitionDays>
          <Cancelled>boolean</Cancelled>
          <MissedOrCancelled>boolean</MissedOrCancelled>
          <AvailableToRelatedAppointment>boolean</AvailableToRelatedAppointment>
          <AttendanceState>None or Scheduled or Pending or Late or In or Overstay or Out or Missed or Cancelled or OnHold</AttendanceState>
          <NameLookup>string</NameLookup>
          <VisitorID>int</VisitorID>
          <TemplateID>int</TemplateID>
          <IsToday>boolean</IsToday>
          <Description>string</Description>
          <VehicleID>int</VehicleID>
          <Registration>string</Registration>
          <CheckInUserID>int</CheckInUserID>
          <CheckOutUserID>int</CheckOutUserID>
          <Type>string</Type>
          <ArrivalTime>dateTime</ArrivalTime>
          <DepartureTime>dateTime</DepartureTime>
          <AutoArchive>boolean</AutoArchive>
          <Duration>int</Duration>
          <AppointmentGroup>string</AppointmentGroup>
          <NonVettingReason>string</NonVettingReason>
          <NonVettingNotes>string</NonVettingNotes>
          <VisitorLocation>int</VisitorLocation>
          <IsPrimaryContact>boolean</IsPrimaryContact>
          <TreatAsVisitor>boolean</TreatAsVisitor>
          <AppointmentDocumentFlags>
            <AppointmentDocumentTypeWithFlag xsi:nil="true" />
            <AppointmentDocumentTypeWithFlag xsi:nil="true" />
          </AppointmentDocumentFlags>
          <CanCheckIn>boolean</CanCheckIn>
          <CanCheckOut>boolean</CanCheckOut>
          <ANPRAccessGroupID>int</ANPRAccessGroupID>
          <ANPRAccessGroupType>int</ANPRAccessGroupType>
          <AppointmentTitle>string</AppointmentTitle>
        </DiaryEntryInfo>
      </FindAppointmentsByDateRangeResult>
    </FindAppointmentsByDateRangeResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /SSMWS/ProcEngWebService.asmx HTTP/1.1
Host: ta.nmwtra.org.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FindAppointmentsByDateRange xmlns="http://www.tensor.com/">
      <token>string</token>
      <systemID>int</systemID>
      <sysDT>dateTime</sysDT>
      <dateFrom>dateTime</dateFrom>
      <dateTo>dateTime</dateTo>
      <includeMissedAndCancelled>boolean</includeMissedAndCancelled>
      <readerID>int</readerID>
      <obeySiteNavigator>int</obeySiteNavigator>
    </FindAppointmentsByDateRange>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FindAppointmentsByDateRangeResponse xmlns="http://www.tensor.com/">
      <FindAppointmentsByDateRangeResult>
        <DiaryEntryInfo>
          <PassLastPrinted />
          <PassExpiry>dateTime</PassExpiry>
          <EmbossedNumber>string</EmbossedNumber>
          <Notes>string</Notes>
          <PurposeID>int</PurposeID>
          <Name>string</Name>
          <State>string</State>
          <Due>string</Due>
          <LastPassPrintedByUserName>string</LastPassPrintedByUserName>
          <LastPassPrintedDateTime>dateTime</LastPassPrintedDateTime>
          <Printer>string</Printer>
          <ArrivedTime>dateTime</ArrivedTime>
          <ExpDepartTime>dateTime</ExpDepartTime>
          <DepartedTime>dateTime</DepartedTime>
          <AccessGroupType>string</AccessGroupType>
          <AccessGroupID>int</AccessGroupID>
          <AccessGroupName>string</AccessGroupName>
          <AppointmentID>int</AppointmentID>
          <HighestFlag>None or Scheduled or Pending or Late or In or Overstay or Out or Missed or Cancelled or OnHold</HighestFlag>
          <FirePointID>int</FirePointID>
          <Visitortype>Unknown or Visitor or Contractor or Employee or Driver</Visitortype>
          <ParentAppointmentID>int</ParentAppointmentID>
          <AttendanceID>int</AttendanceID>
          <Start>dateTime</Start>
          <StartDateTime>dateTime</StartDateTime>
          <End>dateTime</End>
          <VisitorName>string</VisitorName>
          <VisitorCompany>string</VisitorCompany>
          <Company>string</Company>
          <Site>string</Site>
          <Location>string</Location>
          <Host>string</Host>
          <ShortHost>string</ShortHost>
          <HostID>int</HostID>
          <Privacy>Everyone or Host or Receptionist</Privacy>
          <CompanyID>int</CompanyID>
          <SiteID>int</SiteID>
          <LocationID>int</LocationID>
          <Repetition>string</Repetition>
          <RepetitionDays>Monday or Tuesday or Wednesday or Thursday or Friday or Saturday or Sunday or Public or Closed or Shutdown</RepetitionDays>
          <Cancelled>boolean</Cancelled>
          <MissedOrCancelled>boolean</MissedOrCancelled>
          <AvailableToRelatedAppointment>boolean</AvailableToRelatedAppointment>
          <AttendanceState>None or Scheduled or Pending or Late or In or Overstay or Out or Missed or Cancelled or OnHold</AttendanceState>
          <NameLookup>string</NameLookup>
          <VisitorID>int</VisitorID>
          <TemplateID>int</TemplateID>
          <IsToday>boolean</IsToday>
          <Description>string</Description>
          <VehicleID>int</VehicleID>
          <Registration>string</Registration>
          <CheckInUserID>int</CheckInUserID>
          <CheckOutUserID>int</CheckOutUserID>
          <Type>string</Type>
          <ArrivalTime>dateTime</ArrivalTime>
          <DepartureTime>dateTime</DepartureTime>
          <AutoArchive>boolean</AutoArchive>
          <Duration>int</Duration>
          <AppointmentGroup>string</AppointmentGroup>
          <NonVettingReason>string</NonVettingReason>
          <NonVettingNotes>string</NonVettingNotes>
          <VisitorLocation>int</VisitorLocation>
          <IsPrimaryContact>boolean</IsPrimaryContact>
          <TreatAsVisitor>boolean</TreatAsVisitor>
          <AppointmentDocumentFlags>
            <AppointmentDocumentTypeWithFlag xsi:nil="true" />
            <AppointmentDocumentTypeWithFlag xsi:nil="true" />
          </AppointmentDocumentFlags>
          <CanCheckIn>boolean</CanCheckIn>
          <CanCheckOut>boolean</CanCheckOut>
          <ANPRAccessGroupID>int</ANPRAccessGroupID>
          <ANPRAccessGroupType>int</ANPRAccessGroupType>
          <AppointmentTitle>string</AppointmentTitle>
        </DiaryEntryInfo>
        <DiaryEntryInfo>
          <PassLastPrinted />
          <PassExpiry>dateTime</PassExpiry>
          <EmbossedNumber>string</EmbossedNumber>
          <Notes>string</Notes>
          <PurposeID>int</PurposeID>
          <Name>string</Name>
          <State>string</State>
          <Due>string</Due>
          <LastPassPrintedByUserName>string</LastPassPrintedByUserName>
          <LastPassPrintedDateTime>dateTime</LastPassPrintedDateTime>
          <Printer>string</Printer>
          <ArrivedTime>dateTime</ArrivedTime>
          <ExpDepartTime>dateTime</ExpDepartTime>
          <DepartedTime>dateTime</DepartedTime>
          <AccessGroupType>string</AccessGroupType>
          <AccessGroupID>int</AccessGroupID>
          <AccessGroupName>string</AccessGroupName>
          <AppointmentID>int</AppointmentID>
          <HighestFlag>None or Scheduled or Pending or Late or In or Overstay or Out or Missed or Cancelled or OnHold</HighestFlag>
          <FirePointID>int</FirePointID>
          <Visitortype>Unknown or Visitor or Contractor or Employee or Driver</Visitortype>
          <ParentAppointmentID>int</ParentAppointmentID>
          <AttendanceID>int</AttendanceID>
          <Start>dateTime</Start>
          <StartDateTime>dateTime</StartDateTime>
          <End>dateTime</End>
          <VisitorName>string</VisitorName>
          <VisitorCompany>string</VisitorCompany>
          <Company>string</Company>
          <Site>string</Site>
          <Location>string</Location>
          <Host>string</Host>
          <ShortHost>string</ShortHost>
          <HostID>int</HostID>
          <Privacy>Everyone or Host or Receptionist</Privacy>
          <CompanyID>int</CompanyID>
          <SiteID>int</SiteID>
          <LocationID>int</LocationID>
          <Repetition>string</Repetition>
          <RepetitionDays>Monday or Tuesday or Wednesday or Thursday or Friday or Saturday or Sunday or Public or Closed or Shutdown</RepetitionDays>
          <Cancelled>boolean</Cancelled>
          <MissedOrCancelled>boolean</MissedOrCancelled>
          <AvailableToRelatedAppointment>boolean</AvailableToRelatedAppointment>
          <AttendanceState>None or Scheduled or Pending or Late or In or Overstay or Out or Missed or Cancelled or OnHold</AttendanceState>
          <NameLookup>string</NameLookup>
          <VisitorID>int</VisitorID>
          <TemplateID>int</TemplateID>
          <IsToday>boolean</IsToday>
          <Description>string</Description>
          <VehicleID>int</VehicleID>
          <Registration>string</Registration>
          <CheckInUserID>int</CheckInUserID>
          <CheckOutUserID>int</CheckOutUserID>
          <Type>string</Type>
          <ArrivalTime>dateTime</ArrivalTime>
          <DepartureTime>dateTime</DepartureTime>
          <AutoArchive>boolean</AutoArchive>
          <Duration>int</Duration>
          <AppointmentGroup>string</AppointmentGroup>
          <NonVettingReason>string</NonVettingReason>
          <NonVettingNotes>string</NonVettingNotes>
          <VisitorLocation>int</VisitorLocation>
          <IsPrimaryContact>boolean</IsPrimaryContact>
          <TreatAsVisitor>boolean</TreatAsVisitor>
          <AppointmentDocumentFlags>
            <AppointmentDocumentTypeWithFlag xsi:nil="true" />
            <AppointmentDocumentTypeWithFlag xsi:nil="true" />
          </AppointmentDocumentFlags>
          <CanCheckIn>boolean</CanCheckIn>
          <CanCheckOut>boolean</CanCheckOut>
          <ANPRAccessGroupID>int</ANPRAccessGroupID>
          <ANPRAccessGroupType>int</ANPRAccessGroupType>
          <AppointmentTitle>string</AppointmentTitle>
        </DiaryEntryInfo>
      </FindAppointmentsByDateRangeResult>
    </FindAppointmentsByDateRangeResponse>
  </soap12:Body>
</soap12:Envelope>