SyFace 910 Webservice Web Service

SyFace 910 Webservice

Click here for a complete list of operations.

Heartbeat

Terminal heartbeat. Various functionality can be performed depending on response code (MsdID)

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 /Service1.asmx HTTP/1.1
Host: synergyfacefourth2.synel-saas.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Synel/Services/Heartbeat"

<?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:Header>
    <ClockCredentials xmlns="Synel/Services">
      <ClockId>string</ClockId>
      <Account>string</Account>
      <ClienteID>int</ClienteID>
      <Password>string</Password>
      <MAC>string</MAC>
    </ClockCredentials>
  </soap:Header>
  <soap:Body>
    <Heartbeat xmlns="Synel/Services">
      <message>
        <MessageId>int</MessageId>
        <Result>string</Result>
        <utcTime>dateTime</utcTime>
        <VersionTress>string</VersionTress>
        <Ip>string</Ip>
        <FPCount>string</FPCount>
      </message>
    </Heartbeat>
  </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:Header>
    <ClockCredentials xmlns="Synel/Services">
      <ClockId>string</ClockId>
      <Account>string</Account>
      <ClienteID>int</ClienteID>
      <Password>string</Password>
      <MAC>string</MAC>
    </ClockCredentials>
  </soap:Header>
  <soap:Body>
    <HeartbeatResponse xmlns="Synel/Services">
      <HeartbeatResult>
        <MsgID>int</MsgID>
        <MsgNombre>string</MsgNombre>
        <HostTime>dateTime</HostTime>
        <Message>
          <Gafete>string</Gafete>
          <HuellaID>int</HuellaID>
          <Nombre>string</Nombre>
          <Orden>int</Orden>
          <Cadena>string</Cadena>
          <ImageSize>string</ImageSize>
          <Image>string</Image>
          <Url>string</Url>
          <Propiedades>
            <ClockId>int</ClockId>
            <WebService>string</WebService>
            <UseProxy>string</UseProxy>
            <Proxy>string</Proxy>
            <ProxyPort>string</ProxyPort>
            <UseProxyAuthentication>string</UseProxyAuthentication>
            <ProxyUserName>string</ProxyUserName>
            <ProxyPassword>string</ProxyPassword>
            <Ip>string</Ip>
            <NetMask>string</NetMask>
            <DefaultGateWay>string</DefaultGateWay>
            <DNS>string</DNS>
            <TimeOut>int</TimeOut>
            <HeartBeatTimer>int</HeartBeatTimer>
            <MsgTime>int</MsgTime>
            <ErrorMsgTime>int</ErrorMsgTime>
            <RelayTime>int</RelayTime>
            <DateTimeFormat>string</DateTimeFormat>
            <Volume>int</Volume>
            <ProxReader>string</ProxReader>
            <BarCodeReader>string</BarCodeReader>
            <HID>string</HID>
            <MenuAccessCode>string</MenuAccessCode>
            <FpuNotIdetifyMessage>string</FpuNotIdetifyMessage>
            <NotValidByServerMessage>string</NotValidByServerMessage>
            <DuplicateMessage>string</DuplicateMessage>
            <AutenticateMessage>string</AutenticateMessage>
            <OfflineValidation>string</OfflineValidation>
            <OneMinuteValidate>boolean</OneMinuteValidate>
            <FingerVerify>boolean</FingerVerify>
            <EnableOfflineRelay>boolean</EnableOfflineRelay>
            <Version>string</Version>
            <Account>int</Account>
            <ClientId>int</ClientId>
            <Password>string</Password>
            <CajaId>int</CajaId>
            <Identidad>int</Identidad>
            <UseSoapActionHeader>boolean</UseSoapActionHeader>
            <SoapActionHeader>string</SoapActionHeader>
            <UpdateTimeByServer>boolean</UpdateTimeByServer>
            <ntpServer>string</ntpServer>
            <timeZone>string</timeZone>
            <MifareReader>string</MifareReader>
            <MagneticReader>string</MagneticReader>
            <ShowCameraPhoto>boolean</ShowCameraPhoto>
            <ShowPhoto>boolean</ShowPhoto>
            <FingerPrint>string</FingerPrint>
            <EnableKeyPad>boolean</EnableKeyPad>
            <Schedules xsi:nil="true" />
            <FingerScanSuccessResponse>string</FingerScanSuccessResponse>
          </Propiedades>
          <Curso>
            <Status>int</Status>
            <CurSesId>int</CurSesId>
            <CursoNombre>string</CursoNombre>
            <CursoFecha>dateTime</CursoFecha>
            <CursoMaestro>string</CursoMaestro>
            <Asistencia>int</Asistencia>
          </Curso>
        </Message>
      </HeartbeatResult>
    </HeartbeatResponse>
  </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 /Service1.asmx HTTP/1.1
Host: synergyfacefourth2.synel-saas.com
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:Header>
    <ClockCredentials xmlns="Synel/Services">
      <ClockId>string</ClockId>
      <Account>string</Account>
      <ClienteID>int</ClienteID>
      <Password>string</Password>
      <MAC>string</MAC>
    </ClockCredentials>
  </soap12:Header>
  <soap12:Body>
    <Heartbeat xmlns="Synel/Services">
      <message>
        <MessageId>int</MessageId>
        <Result>string</Result>
        <utcTime>dateTime</utcTime>
        <VersionTress>string</VersionTress>
        <Ip>string</Ip>
        <FPCount>string</FPCount>
      </message>
    </Heartbeat>
  </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:Header>
    <ClockCredentials xmlns="Synel/Services">
      <ClockId>string</ClockId>
      <Account>string</Account>
      <ClienteID>int</ClienteID>
      <Password>string</Password>
      <MAC>string</MAC>
    </ClockCredentials>
  </soap12:Header>
  <soap12:Body>
    <HeartbeatResponse xmlns="Synel/Services">
      <HeartbeatResult>
        <MsgID>int</MsgID>
        <MsgNombre>string</MsgNombre>
        <HostTime>dateTime</HostTime>
        <Message>
          <Gafete>string</Gafete>
          <HuellaID>int</HuellaID>
          <Nombre>string</Nombre>
          <Orden>int</Orden>
          <Cadena>string</Cadena>
          <ImageSize>string</ImageSize>
          <Image>string</Image>
          <Url>string</Url>
          <Propiedades>
            <ClockId>int</ClockId>
            <WebService>string</WebService>
            <UseProxy>string</UseProxy>
            <Proxy>string</Proxy>
            <ProxyPort>string</ProxyPort>
            <UseProxyAuthentication>string</UseProxyAuthentication>
            <ProxyUserName>string</ProxyUserName>
            <ProxyPassword>string</ProxyPassword>
            <Ip>string</Ip>
            <NetMask>string</NetMask>
            <DefaultGateWay>string</DefaultGateWay>
            <DNS>string</DNS>
            <TimeOut>int</TimeOut>
            <HeartBeatTimer>int</HeartBeatTimer>
            <MsgTime>int</MsgTime>
            <ErrorMsgTime>int</ErrorMsgTime>
            <RelayTime>int</RelayTime>
            <DateTimeFormat>string</DateTimeFormat>
            <Volume>int</Volume>
            <ProxReader>string</ProxReader>
            <BarCodeReader>string</BarCodeReader>
            <HID>string</HID>
            <MenuAccessCode>string</MenuAccessCode>
            <FpuNotIdetifyMessage>string</FpuNotIdetifyMessage>
            <NotValidByServerMessage>string</NotValidByServerMessage>
            <DuplicateMessage>string</DuplicateMessage>
            <AutenticateMessage>string</AutenticateMessage>
            <OfflineValidation>string</OfflineValidation>
            <OneMinuteValidate>boolean</OneMinuteValidate>
            <FingerVerify>boolean</FingerVerify>
            <EnableOfflineRelay>boolean</EnableOfflineRelay>
            <Version>string</Version>
            <Account>int</Account>
            <ClientId>int</ClientId>
            <Password>string</Password>
            <CajaId>int</CajaId>
            <Identidad>int</Identidad>
            <UseSoapActionHeader>boolean</UseSoapActionHeader>
            <SoapActionHeader>string</SoapActionHeader>
            <UpdateTimeByServer>boolean</UpdateTimeByServer>
            <ntpServer>string</ntpServer>
            <timeZone>string</timeZone>
            <MifareReader>string</MifareReader>
            <MagneticReader>string</MagneticReader>
            <ShowCameraPhoto>boolean</ShowCameraPhoto>
            <ShowPhoto>boolean</ShowPhoto>
            <FingerPrint>string</FingerPrint>
            <EnableKeyPad>boolean</EnableKeyPad>
            <Schedules xsi:nil="true" />
            <FingerScanSuccessResponse>string</FingerScanSuccessResponse>
          </Propiedades>
          <Curso>
            <Status>int</Status>
            <CurSesId>int</CurSesId>
            <CursoNombre>string</CursoNombre>
            <CursoFecha>dateTime</CursoFecha>
            <CursoMaestro>string</CursoMaestro>
            <Asistencia>int</Asistencia>
          </Curso>
        </Message>
      </HeartbeatResult>
    </HeartbeatResponse>
  </soap12:Body>
</soap12:Envelope>