Sort All People

POST /People/Read/Sorted
Authorization key & Authorization date & Authorization hmac

This process returns a sorted list of all people for the customer number specified. Secret Hmac Required. Cache Time 1 Hour. Reset if person added or edited. Multiple pages possible.

Body

  • DisplayGroup number

    The display group to retrieve or 0 for all that you have access to. See /Account/Read/Group endpoint

  • SortBy string

    The field to sort by (allowed: emp_id, lastname, firstname, dispgroup, dept, title, birthday, hiredate). emp_id is the default.

  • Descending number

    If the sort should be in descending order

Responses

  • 200

    People list successfully returned

    Hide response attributes Show response attributes object
    • Total number

      The total number of people selected

    • Page string

      the current page of total pages text string

    • Sort string

      The sort fields used for these results

    • People object
      Hide People attributes Show People attributes
      • Id number

        the StrandVision record id needed for individual update or remove

      • Emp_Id string

        people / staff id

      • Created string

        date/time created

      • Deleted number

        Whether the staff member is deleted

      • Parent number

        Parent User Number

      • Custno number

        User Customer Number

      • DispGroup string

        the display group that this user is in

      • Source_Id string

        employee or other id from the source database

      • Location string

        location code specified from the source database

      • Email string

        email address

      • FirstName string

        contact first name

      • LastName string

        contact last name

      • NickName string

        name they go by

      • Phone string

        direct phone number

      • Web string

        link to their record on internal web site

      • Photo string

        location of uploaded photo

      • Gender string

        M for male, F for female, U for Unknown or Undisclosed

      • Dept string

        Department that they work in

      • Title string

        title of the employee

      • Birthday string

        Birthday with invalid year

      • HireDate string

        Hire Date

      • TermDate string

        Termination Date (if any)

      • Skip string

        Skip Display Options (Birthday, Annivarsiary, Termination)

      • DateLast string

        Last Date/Time used

      • DateEdit string

        Last Date/Time that the employee was updated
POST /People/Read/Sorted 
curl \
 -X POST https://Api.StrandVision.com/v1.0/People/Read/Sorted \
 -H "Authorization: X-apikey $ACCESS_TOKEN" \
 -H "Authorization: X-apidate $ACCESS_TOKEN" \
 -H "Authorization: X-apihmac $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"DisplayGroup":0,"SortBy":"LastName","Descending":0}'
Request example 
{
  "DisplayGroup": 0,
  "SortBy": "LastName",
  "Descending": 0
}
Request examples 
{
  "DisplayGroup": 0,
  "SortBy": "LastName",
  "Descending": 0
}
Response examples (200) 
[
  {
    "Total": 17,
    "Page": "1 of 2",
    "Sort": "lastname desc,firstname desc,emp_id desc",
    "People": [
      {
        "Id": 1234,
        "Emp_Id": 1001,
        "Created": "Thu, 21 Aug 2014 15:43:00 GMT",
        "Deleted": 0,
        "Parent": 10028,
        "Custno": 10028,
        "DispGroup": "Menomonie, WI (10)",
        "Source_Id": 1001,
        "Location": "Menomonie",
        "Email": "mjstrand@strandvision.com",
        "FirstName": "Mike",
        "LastName": "Strand",
        "NickName": "",
        "Phone": "",
        "Web": "",
        "Photo": "https://strandvision.com/.?ImageDB=PF4FX87QKHC52OFCA7RXL",
        "Gender": "Male",
        "Dept": "Administration",
        "Title": "President & CEO",
        "Birthday": "Sat, 01 Aug 2037 01:02:03 GMT",
        "HireDate": "Thu, 02 Aug 2029 01:02:03 GMT",
        "TermDate": "",
        "Skip": "Birthdays",
        "DateLast": "Fri, 04 Aug 2023 14:25:00 GMT",
        "DateEdit": "Thu, 21 Aug 2014 15:43:00 GMT"
      },
      {
        "Id": 1235,
        "Emp_Id": 1003,
        "Created": "Thu, 21 Aug 2014 15:43:00 GMT",
        "Deleted": 0,
        "Parent": 10028,
        "Custno": 10028,
        "DispGroup": "Menomonie, WI (10)",
        "Source_Id": 1003,
        "Location": "Eau Claire",
        "Email": "",
        "FirstName": "Harry",
        "LastName": "Strand",
        "NickName": "",
        "Phone": "",
        "Web": "",
        "Photo": "https://strandvision.com/.?ImageDB=LG4FX87QK1C52OFCA7RXL",
        "Gender": "Male",
        "Dept": "Development",
        "Title": "Apple Developer",
        "Birthday": "Fri, 14 Aug 2037 01:02:03 GMT",
        "HireDate": "Mon, 15 Aug 2022 01:02:03 GMT",
        "TermDate": "Thu, 17 Aug 2028 00:00:00 GMT",
        "Skip": "Anniversaries",
        "DateLast": "Fri, 04 Aug 2023 14:25:00 GMT",
        "DateEdit": "Thu, 21 Aug 2014 15:43:00 GMT"
      }
    ]
  }
]
Response examples (200) 
{
  "Total": 17,
  "Page": "1 of 2",
  "Sort": "gender,lastname,emp_id",
  "People": {
    "Id": 1016,
    "Emp_Id": 1016,
    "Created": "Thu, 21 Aug 2014 15:43:00 GMT",
    "Deleted": 0,
    "Parent": 10028,
    "Custno": 10028,
    "DispGroup": "Menomonie, WI (10)",
    "Source_Id": 1016,
    "Location": "Washington",
    "Email": "csstrand@strandvision.com",
    "FirstName": "Ingred",
    "LastName": "Bergman",
    "NickName": "string",
    "Phone": "string",
    "Web": "string",
    "Photo": "https://strandvision.com/.?ImageDB=LG4FX874KHC52OFCA7RXL",
    "Gender": "Female",
    "Dept": "Quality Assurance",
    "Title": "Quality Assurance Manager",
    "Birthday": "Sun, 09 Aug 2037 01:02:03 GMT",
    "HireDate": "Mon, 10 Aug 2015 01:02:03 GMT",
    "TermDate": 0,
    "Skip": "Birthdays",
    "DateLast": "Fri, 21 Jul 2023 22:52:00 GMT",
    "DateEdit": "Thu, 21 Aug 2014 15:43:00 GMT"
  }
}