People Import Records

POST /People/Update/ImportMass
Authorization key & Authorization date & Authorization hmac

This process imports up to 100 people records at a time. If there is an employee id, there will be an exact match to update. If not, we search based on the sound of the first and last name. If a match is not found, a new record is added. If found, the person is removed from the pending people list and if there are any changes, the record is updated. Note that photos will not be updated if they exist. To replace an existing photo, use the /People/Update/OnePhoto endpoint. *Secret Hmac Required. Do Not Cache this call.

Body

  • Custno number

    The optional customer number to retrieve

  • PhotoPath string

    The optional photo path for ALL people. Replaceable parameters are the field name surrounded by the dollar sign ($). For example to load from a web site with the employee id, you could pass https://www.website.com/photo/$emp_id$.jpg

  • People array[object]

    up to 100 people records with at least first and last name sent and preferably the employee id for an exact match of the person to update. If fields are not changed, it is recommended that you do not send them.

    Hide People attributes Show People attributes
    • FirstName string

      required contact first name

    • LastName string

      required contact last name

    • Emp_Id string

      Recommended people / staff id

    • Birthday string

      The recommended birthday preferably in the format MM-DD. If sent as YYYY-MM-DD format with a year, the year will be replaced with an invalid year.

    • HireDate string

      The recommended hire date for showing the years they have worked in YYYY-MM-DD format.

    • TermDate string

      The optional Termination Date if you want to display people who will leave soon in YYYY-MM-DD format.

    • Source_Id string

      optional employee or other id from the source database

    • Location string

      optional location code specified from the source database

    • Email string

      optional email address

    • NickName string

      optional name they go by

    • Phone string

      optional direct phone number

    • Web string

      optional link to their record on internal web site

    • Photo string

      optional location of uploaded photo

    • Gender string

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

    • Dept string

      optional Department that they work in

    • Title string

      optional title of the employee

    • Skip string

      Skip Display Options (Birthday, Annivarsiary, Termination)

Responses

  • 200

    People Import Successfully Processed

    Hide response attributes Show response attributes object
    • Count number

      The number of people processed

    • Change number

      number of records changed (not counting pending status changes)

    • Skipped number

      number of records skipped with no changes (if importing)

    • Deleted number

      number of records deleted (if terminating)

    • Pending number

      number of records still set to pending

    • Photo number

      number of photos added (if any)

    • Custno number

      the StrandVision customer number processed

    • Msg string

      The resulting message

    • Time number

      The processing time in seconds
POST /People/Update/ImportMass 
curl \
 -X POST https://Api.StrandVision.com/v1.0/People/Update/ImportMass \
 -H "Authorization: X-apikey $ACCESS_TOKEN" \
 -H "Authorization: X-apidate $ACCESS_TOKEN" \
 -H "Authorization: X-apihmac $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"Custno":10028,"PhotoPath":"string","People":[{"FirstName":"Ingred","LastName":"Bergman","Emp_Id":1016,"Birthday":"12-04","HireDate":"2010-01-15","TermDate":0,"Source_Id":1016,"Location":"Washington","Email":"csstrand@strandvision.com","NickName":"string","Phone":"string","Web":"string","Photo":"https://strandvision.com/.?ImageDB=LG4FX874KHC52OFCA7RXL","Gender":"Female","Dept":"Quality Assurance","Title":"Quality Assurance Manager","Skip":"Birthdays"}]}'
Request example 
{
  "Custno": 10028,
  "PhotoPath": "string",
  "People": [
    {
      "FirstName": "Ingred",
      "LastName": "Bergman",
      "Emp_Id": 1016,
      "Birthday": "12-04",
      "HireDate": "2010-01-15",
      "TermDate": 0,
      "Source_Id": 1016,
      "Location": "Washington",
      "Email": "csstrand@strandvision.com",
      "NickName": "string",
      "Phone": "string",
      "Web": "string",
      "Photo": "https://strandvision.com/.?ImageDB=LG4FX874KHC52OFCA7RXL",
      "Gender": "Female",
      "Dept": "Quality Assurance",
      "Title": "Quality Assurance Manager",
      "Skip": "Birthdays"
    }
  ]
}
Request examples 
{
  "Custno": 10028,
  "PhotoPath": "string",
  "People": [
    {
      "FirstName": "Ingred",
      "LastName": "Bergman",
      "Emp_Id": 1016,
      "Birthday": "12-04",
      "HireDate": "2010-01-15",
      "TermDate": 0,
      "Source_Id": 1016,
      "Location": "Washington",
      "Email": "csstrand@strandvision.com",
      "NickName": "string",
      "Phone": "string",
      "Web": "string",
      "Photo": "https://strandvision.com/.?ImageDB=LG4FX874KHC52OFCA7RXL",
      "Gender": "Female",
      "Dept": "Quality Assurance",
      "Title": "Quality Assurance Manager",
      "Skip": "Birthdays"
    }
  ]
}
Response examples (200) 
[
  {
    "Count": 17,
    "Change": 0,
    "Skipped": 17,
    "Pending": 0,
    "Photo": 0,
    "Custno": 10028,
    "Msg": "Processed 17 people of 17 with 0 changed and 17 skipped in 0.02112 Seconds",
    "Time": 0.04257
  }
]
Response examples (200) 
{
  "Count": 42.0,
  "Change": 42.0,
  "Skipped": 42.0,
  "Deleted": 42.0,
  "Pending": 42.0,
  "Photo": 42.0,
  "Custno": 42.0,
  "Msg": "string",
  "Time": 42.0
}