Skip to main content
Eptura Knowledge Center

Endpoint - people

  1. Last updated
  2. Save as PDF

The API has the following endpoints:
worddava8dd1977acc7dedf41662a900a2fe3fd.png

Returns all the people in the system

Request URL

https://[client_instance].serraview.com/api/v2/people

worddav63d5464a9dcbcb4de563b0894791bb61.png

Model Schema

{
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7eaf5f63-2040-4db1-b3dc-864c9e902781"><ac:plain-text-body><![CDATA[  "data": [
]]></ac:plain-text-body></ac:structured-macro>
    {
      "businessKey": "",
      "division": {
        "id": 0,
        "name": ""
      },
      "email": "",
      "employeeNumber": "",
      "firstName": "",
      "id": 0,
      "jobTitle": "",
      "lastName": "",
      "logonName": "",
      "mobileNumber": "",
      "phoneExt": "",
      "phoneNumber": "",
      "team": {
        "id": 0,
        "name": ""
      }
    }
  ],
  "paging": {
    "next": "",
    "previous": "",
    "totalItemCount": 0
  }
}

Create a person in the system

Request URL

https://[client_instance].serraview.com/api/v2/people

worddavf06cc2610f39918e5e6949556f60e97c.png

Model Schema

{
  "businessKey": "",
  "division": {
    "id": 0,
    "name": ""
  },
  "email": "",
  "employeeNumber": "",
  "firstName": "",
  "id": 0,
  "jobTitle": "",
  "lastName": "",
  "logonName": "",
  "mobileNumber": "",
  "phoneExt": "",
  "phoneNumber": "",
  "team": {
    "id": 0,
    "name": ""
  }
}
 

Returns a person's details

Request URL

https://[client_instance].serraview.com/api/v2/people/{id}

worddav60aaf0afeeccb7cb61a460e92d018a1f.png

Model Schema

{
  "businessKey": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="296e4cda-d5b4-4f62-ab90-6fc2f368bfd8"><ac:plain-text-body><![CDATA[  "customFields": [
]]></ac:plain-text-body></ac:structured-macro>
    ""
  ],
  "division": {
    "id": 0,
    "name": ""
  },
  "email": "",
  "employeeNumber": "",
  "firstName": "",
  "id": 0,
  "jobTitle": "",
  "lastName": "",
  "logonName": "",
  "mobileNumber": "",
  "phoneExt": "",
  "phoneNumber": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b77efd4d-4adb-4610-8514-3732e9fe4236"><ac:plain-text-body><![CDATA[  "tags": [
]]></ac:plain-text-body></ac:structured-macro>
    ""
  ],
  "team": {
    "id": 0,
    "name": ""

  }

}

Returns the location for a person

Request URL

https://[client_instance].serraview.com/api/v2/people/{id}/location

worddavb3f82479ce6b7c44a23264e698a96889.png

Model Schema

{
  "building": {
    "buildingNumber": "",
    "buildingType": {
      "id": 0,
      "name": ""
    },
    "city": "",
    "country": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="37fa463d-cbda-46fc-827b-16a7cf8abb6a"><ac:plain-text-body><![CDATA[    "customFields": [
]]></ac:plain-text-body></ac:structured-macro>
      ""
    ],
    "id": 0,
    "latitude": "Decimal",
    "longitude": "Decimal",
    "name": "",
    "postcode": "",
    "region": {
      "id": 0,
      "name": ""
    },
    "shortName": "",
    "showInMapping": false,
    "showInVBS": false,
    "showInWayfinding": false,
    "state": "",
    "street": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ef67e1ff-dfaa-4e15-8064-17e6e71ed5a3"><ac:plain-text-body><![CDATA[    "tags": [
]]></ac:plain-text-body></ac:structured-macro>
      ""
    ]
  },
  "businessKey": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2938f8d6-0bd2-4872-9761-c9cd3f43b944"><ac:plain-text-body><![CDATA[  "customFields": [
]]></ac:plain-text-body></ac:structured-macro>
    ""
  ],
  "division": {
    "id": 0,
    "name": ""
  },
  "email": "",
  "employeeNumber": "",
  "firstName": "",
  "floor": {
    "buildingId": 0,
    "buildingNumberOverride": "",
    "businessKey": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9874d164-0171-4d33-beff-9c61f7605150"><ac:plain-text-body><![CDATA[    "customFields": [
]]></ac:plain-text-body></ac:structured-macro>
      ""
    ],
    "gla": 0,
    "id": 0,
    "name": "",
    "nla": 0,
    "sequence": 0,
    "showInMapping": false,
    "showInVBS": false,
    "showInWayfinding": false,
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b3360ed8-9738-47d5-8667-c29324ecbb0e"><ac:plain-text-body><![CDATA[    "tags": [
]]></ac:plain-text-body></ac:structured-macro>
      ""
    ],
    "workpoints": 0
  },
  "id": 0,
  "jobTitle": "",
  "lastName": "",
  "logonName": "",
  "mobileNumber": "",
  "phoneExt": "",
  "phoneNumber": "",
  "space": {
    "assignedOrgUnit": {
      "id": 0,
      "name": ""
    },
    "buildingId": 0,
    "capacity": 0,
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="04cca9e3-7541-498b-9945-149da4dbcca3"><ac:plain-text-body><![CDATA[    "customFields": [
]]></ac:plain-text-body></ac:structured-macro>
      ""
    ],
    "floorId": 0,
    "id": 0,
    "isFlexible": false,
    "isReserveDisabled": false,
    "manualOccupancyTypeId": 0,
    "name": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2a305c8b-9eb2-4e99-a429-ecd365a3084b"><ac:plain-text-body><![CDATA[    "occupants": [
]]></ac:plain-text-body></ac:structured-macro>
      0
    ],
    "retentionStatusId": 0,
    "spaceType": "SpaceTypeDto",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5ac061c0-653e-494d-bd76-ffe0e7490877"><ac:plain-text-body><![CDATA[    "tags": [
]]></ac:plain-text-body></ac:structured-macro>
      ""
    ],
    "zone": {
      "id": 0,
      "name": ""
    }
  },
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c156c6dd-e5dd-452d-a443-7ae5cc4023f8"><ac:plain-text-body><![CDATA[  "tags": [
]]></ac:plain-text-body></ac:structured-macro>
    ""
  ],
  "team": {
    "id": 0,
    "name": ""
  }
}

Returns a floorplan where a person is located

Request URL

https://[client_instance].serraview.com/api/v2/people/{id}/location/image

worddav233533cd267a882beda4f83dc1f0437d.png

Result

worddavb51d172812d5c87286ac519089ab1c4c.png

Returns a person's details (from employeeNo)

Request URL

https://[client_instance].serraview.com/api/v2/people/employeeNo?

worddavc0722cfe18d5cfe4177b89f19b94c433.png

Model Schema

{
  "businessKey": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="71242c31-61ca-41a2-a55b-1987ccfd57a3"><ac:plain-text-body><![CDATA[  "customFields": [
]]></ac:plain-text-body></ac:structured-macro>
    ""
  ],
  "division": {
    "id": 0,
    "name": ""
  },
  "email": "",
  "employeeNumber": "",
  "firstName": "",
  "id": 0,
  "jobTitle": "",
  "lastName": "",
  "logonName": "",
  "mobileNumber": "",
  "phoneExt": "",
  "phoneNumber": "",
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d23e9a3d-4930-4ae1-a701-d22c3f1f7b72"><ac:plain-text-body><![CDATA[  "tags": [
]]></ac:plain-text-body></ac:structured-macro>
    ""
  ],
  "team": {
    "id": 0,
    "name": ""
  }
}

Find people using a fuzzy search across multiple columns

Request URL

https://[client_instance].serraview.com/api/v2/people/search

worddavdd1663d7cda4cd66f4fd37db1e40045f.png

Model Schema

{
  "businessKey": "",
  "division": {
    "id": 0,
    "name": ""
  },
  "email": "",
  "employeeNumber": "",
  "firstName": "",
  "id": 0,
  "jobTitle": "",
  "lastName": "",
  "logonName": "",
  "mobileNumber": "",
  "phoneExt": "",
  "phoneNumber": "",
  "team": {
    "id": 0,
    "name": ""
  }
}