POST api/ECI_GetStatus

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
jsonstring		string	None.

Request Formats

application/json, text/json

Sample:

{
  "jsonstring": "sample string 1"
}

application/xml, text/xml

Sample:

<Jsonparams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ADMSSCHOOLAPI.Models">
  <jsonstring>sample string 1</jsonstring>
</Jsonparams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ECIStatusOut

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
ServerTime	string	None.
CanCheckIn	boolean	None.
NextAction	string	None.
NextShiftId	string	None.
NextShiftName	string	None.
Shifts	Collection of ECIShiftOut	None.
FaceRegistered	boolean	None.
FaceModel	string	None.
User	ECIUserOut	None.
Location	ECILocationOut	None.
TodayCheckIn	ECIRecordOut	None.
TodayCheckOut	ECIRecordOut	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ServerTime": "sample string 3",
  "CanCheckIn": true,
  "NextAction": "sample string 5",
  "NextShiftId": "sample string 6",
  "NextShiftName": "sample string 7",
  "Shifts": [
    {
      "ShiftId": "sample string 1",
      "ShiftName": "sample string 2",
      "WorkStart": "sample string 3",
      "WorkEnd": "sample string 4",
      "CheckInOpensAt": "sample string 5",
      "CheckInClosesAt": "sample string 6",
      "CheckInAfterClose": "sample string 7",
      "CheckInClosed": true,
      "CheckOutFrom": "sample string 9",
      "CheckOutUntil": "sample string 10",
      "CheckOutMissed": true,
      "LateAfter": "sample string 12",
      "CheckIn": {
        "CheckId": 1,
        "CheckTime": "sample string 2",
        "Status": "sample string 3",
        "TimeFlag": "sample string 4",
        "DiffMinutes": 1,
        "DiffText": "sample string 5"
      },
      "CheckOut": {
        "CheckId": 1,
        "CheckTime": "sample string 2",
        "Status": "sample string 3",
        "TimeFlag": "sample string 4",
        "DiffMinutes": 1,
        "DiffText": "sample string 5"
      }
    },
    {
      "ShiftId": "sample string 1",
      "ShiftName": "sample string 2",
      "WorkStart": "sample string 3",
      "WorkEnd": "sample string 4",
      "CheckInOpensAt": "sample string 5",
      "CheckInClosesAt": "sample string 6",
      "CheckInAfterClose": "sample string 7",
      "CheckInClosed": true,
      "CheckOutFrom": "sample string 9",
      "CheckOutUntil": "sample string 10",
      "CheckOutMissed": true,
      "LateAfter": "sample string 12",
      "CheckIn": {
        "CheckId": 1,
        "CheckTime": "sample string 2",
        "Status": "sample string 3",
        "TimeFlag": "sample string 4",
        "DiffMinutes": 1,
        "DiffText": "sample string 5"
      },
      "CheckOut": {
        "CheckId": 1,
        "CheckTime": "sample string 2",
        "Status": "sample string 3",
        "TimeFlag": "sample string 4",
        "DiffMinutes": 1,
        "DiffText": "sample string 5"
      }
    }
  ],
  "FaceRegistered": true,
  "FaceModel": "sample string 9",
  "User": {
    "UserId": "sample string 1",
    "FullName": "sample string 2",
    "EmployeeId": "sample string 3",
    "JobTitle": "sample string 4",
    "UserGroup": 5,
    "SchoolId": "sample string 6",
    "SchoolName": "sample string 7",
    "BranchId": "sample string 8",
    "BranchName": "sample string 9"
  },
  "Location": {
    "Configured": true,
    "Active": true,
    "Latitude": 1.0,
    "Longitude": 1.0,
    "RadiusMeters": 3,
    "WorkStart": "sample string 4",
    "WorkEnd": "sample string 5",
    "LateGraceMinutes": 6,
    "CheckInOpensMinutes": 7,
    "CheckInOpensAt": "sample string 8",
    "CheckInClosesMinutes": 1,
    "CheckInClosesAt": "sample string 9",
    "CheckInAfterClose": "sample string 10",
    "CheckOutFrom": "sample string 11",
    "CheckOutUntil": "sample string 12",
    "LateAfter": "sample string 13",
    "BlockOutOfRange": true
  },
  "TodayCheckIn": {
    "CheckId": 1,
    "Date": "sample string 2",
    "CheckType": "sample string 3",
    "ShiftId": "sample string 4",
    "ShiftName": "sample string 5",
    "CheckTime": "sample string 6",
    "ScheduledTime": "sample string 7",
    "DiffMinutes": 1,
    "TimeFlag": "sample string 8",
    "DiffText": "sample string 9",
    "DistanceMeters": 1.0,
    "DistanceText": "sample string 10",
    "RadiusText": "sample string 11",
    "RadiusMeters": 1,
    "AccuracyMeters": 1.0,
    "WithinRange": true,
    "FaceMatched": true,
    "FaceScore": 1.0,
    "Status": "sample string 14",
    "Reason": "sample string 15",
    "AdminNote": "sample string 16",
    "Source": "sample string 17"
  },
  "TodayCheckOut": {
    "CheckId": 1,
    "Date": "sample string 2",
    "CheckType": "sample string 3",
    "ShiftId": "sample string 4",
    "ShiftName": "sample string 5",
    "CheckTime": "sample string 6",
    "ScheduledTime": "sample string 7",
    "DiffMinutes": 1,
    "TimeFlag": "sample string 8",
    "DiffText": "sample string 9",
    "DistanceMeters": 1.0,
    "DistanceText": "sample string 10",
    "RadiusText": "sample string 11",
    "RadiusMeters": 1,
    "AccuracyMeters": 1.0,
    "WithinRange": true,
    "FaceMatched": true,
    "FaceScore": 1.0,
    "Status": "sample string 14",
    "Reason": "sample string 15",
    "AdminNote": "sample string 16",
    "Source": "sample string 17"
  }
}

application/xml, text/xml

Sample:

<ECIStatusOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ADMSSCHOOLAPI.Models">
  <CanCheckIn>true</CanCheckIn>
  <FaceModel>sample string 9</FaceModel>
  <FaceRegistered>true</FaceRegistered>
  <Location>
    <Active>true</Active>
    <BlockOutOfRange>true</BlockOutOfRange>
    <CheckInAfterClose>sample string 10</CheckInAfterClose>
    <CheckInClosesAt>sample string 9</CheckInClosesAt>
    <CheckInClosesMinutes>1</CheckInClosesMinutes>
    <CheckInOpensAt>sample string 8</CheckInOpensAt>
    <CheckInOpensMinutes>7</CheckInOpensMinutes>
    <CheckOutFrom>sample string 11</CheckOutFrom>
    <CheckOutUntil>sample string 12</CheckOutUntil>
    <Configured>true</Configured>
    <LateAfter>sample string 13</LateAfter>
    <LateGraceMinutes>6</LateGraceMinutes>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <RadiusMeters>3</RadiusMeters>
    <WorkEnd>sample string 5</WorkEnd>
    <WorkStart>sample string 4</WorkStart>
  </Location>
  <Message>sample string 2</Message>
  <NextAction>sample string 5</NextAction>
  <NextShiftId>sample string 6</NextShiftId>
  <NextShiftName>sample string 7</NextShiftName>
  <ServerTime>sample string 3</ServerTime>
  <Shifts>
    <ECIShiftOut>
      <CheckIn>
        <CheckId>1</CheckId>
        <CheckTime>sample string 2</CheckTime>
        <DiffMinutes>1</DiffMinutes>
        <DiffText>sample string 5</DiffText>
        <Status>sample string 3</Status>
        <TimeFlag>sample string 4</TimeFlag>
      </CheckIn>
      <CheckInAfterClose>sample string 7</CheckInAfterClose>
      <CheckInClosed>true</CheckInClosed>
      <CheckInClosesAt>sample string 6</CheckInClosesAt>
      <CheckInOpensAt>sample string 5</CheckInOpensAt>
      <CheckOut>
        <CheckId>1</CheckId>
        <CheckTime>sample string 2</CheckTime>
        <DiffMinutes>1</DiffMinutes>
        <DiffText>sample string 5</DiffText>
        <Status>sample string 3</Status>
        <TimeFlag>sample string 4</TimeFlag>
      </CheckOut>
      <CheckOutFrom>sample string 9</CheckOutFrom>
      <CheckOutMissed>true</CheckOutMissed>
      <CheckOutUntil>sample string 10</CheckOutUntil>
      <LateAfter>sample string 12</LateAfter>
      <ShiftId>sample string 1</ShiftId>
      <ShiftName>sample string 2</ShiftName>
      <WorkEnd>sample string 4</WorkEnd>
      <WorkStart>sample string 3</WorkStart>
    </ECIShiftOut>
    <ECIShiftOut>
      <CheckIn>
        <CheckId>1</CheckId>
        <CheckTime>sample string 2</CheckTime>
        <DiffMinutes>1</DiffMinutes>
        <DiffText>sample string 5</DiffText>
        <Status>sample string 3</Status>
        <TimeFlag>sample string 4</TimeFlag>
      </CheckIn>
      <CheckInAfterClose>sample string 7</CheckInAfterClose>
      <CheckInClosed>true</CheckInClosed>
      <CheckInClosesAt>sample string 6</CheckInClosesAt>
      <CheckInOpensAt>sample string 5</CheckInOpensAt>
      <CheckOut>
        <CheckId>1</CheckId>
        <CheckTime>sample string 2</CheckTime>
        <DiffMinutes>1</DiffMinutes>
        <DiffText>sample string 5</DiffText>
        <Status>sample string 3</Status>
        <TimeFlag>sample string 4</TimeFlag>
      </CheckOut>
      <CheckOutFrom>sample string 9</CheckOutFrom>
      <CheckOutMissed>true</CheckOutMissed>
      <CheckOutUntil>sample string 10</CheckOutUntil>
      <LateAfter>sample string 12</LateAfter>
      <ShiftId>sample string 1</ShiftId>
      <ShiftName>sample string 2</ShiftName>
      <WorkEnd>sample string 4</WorkEnd>
      <WorkStart>sample string 3</WorkStart>
    </ECIShiftOut>
  </Shifts>
  <Success>true</Success>
  <TodayCheckIn>
    <AccuracyMeters>1</AccuracyMeters>
    <AdminNote>sample string 16</AdminNote>
    <CheckId>1</CheckId>
    <CheckTime>sample string 6</CheckTime>
    <CheckType>sample string 3</CheckType>
    <Date>sample string 2</Date>
    <DiffMinutes>1</DiffMinutes>
    <DiffText>sample string 9</DiffText>
    <DistanceMeters>1</DistanceMeters>
    <DistanceText>sample string 10</DistanceText>
    <FaceMatched>true</FaceMatched>
    <FaceScore>1</FaceScore>
    <RadiusMeters>1</RadiusMeters>
    <RadiusText>sample string 11</RadiusText>
    <Reason>sample string 15</Reason>
    <ScheduledTime>sample string 7</ScheduledTime>
    <ShiftId>sample string 4</ShiftId>
    <ShiftName>sample string 5</ShiftName>
    <Source>sample string 17</Source>
    <Status>sample string 14</Status>
    <TimeFlag>sample string 8</TimeFlag>
    <WithinRange>true</WithinRange>
  </TodayCheckIn>
  <TodayCheckOut>
    <AccuracyMeters>1</AccuracyMeters>
    <AdminNote>sample string 16</AdminNote>
    <CheckId>1</CheckId>
    <CheckTime>sample string 6</CheckTime>
    <CheckType>sample string 3</CheckType>
    <Date>sample string 2</Date>
    <DiffMinutes>1</DiffMinutes>
    <DiffText>sample string 9</DiffText>
    <DistanceMeters>1</DistanceMeters>
    <DistanceText>sample string 10</DistanceText>
    <FaceMatched>true</FaceMatched>
    <FaceScore>1</FaceScore>
    <RadiusMeters>1</RadiusMeters>
    <RadiusText>sample string 11</RadiusText>
    <Reason>sample string 15</Reason>
    <ScheduledTime>sample string 7</ScheduledTime>
    <ShiftId>sample string 4</ShiftId>
    <ShiftName>sample string 5</ShiftName>
    <Source>sample string 17</Source>
    <Status>sample string 14</Status>
    <TimeFlag>sample string 8</TimeFlag>
    <WithinRange>true</WithinRange>
  </TodayCheckOut>
  <User>
    <BranchId>sample string 8</BranchId>
    <BranchName>sample string 9</BranchName>
    <EmployeeId>sample string 3</EmployeeId>
    <FullName>sample string 2</FullName>
    <JobTitle>sample string 4</JobTitle>
    <SchoolId>sample string 6</SchoolId>
    <SchoolName>sample string 7</SchoolName>
    <UserGroup>5</UserGroup>
    <UserId>sample string 1</UserId>
  </User>
</ECIStatusOut>