© 2018 Capita Business Services Ltd. All rights reserved.

Capita Education Software Solutions is a trading name of Capita Business Services Ltd. Our Registered office is 30 Berners Street, London, W1T 3LR and our registered number is 02299747. Further information about Capita plc can be found in our legal statement.

SIMS 8 - V3 - Staff Personal Basics - GET

Staff Personal Basics

This information domain is intended to provide basic staff data. Please note there is no filter availability on current staff.

Example Call

<Stem>/Staff/V3/StaffPersonalBasics

Definition

 "StaffService2.Models.OData.StaffPersonalBasic.StaffPersonalBasic": {
      "type": "object",
      "properties": {
        "PreferredForename": { "type": "string" },
        "PreferredSurname": { "type": "string" },
        "Gender": { "$ref": "#/definitions/StaffService2.Models.OData.StaffPersonalBasic.GenderRef" },
        "IsDeceased": { "type": "boolean" },
        "StaffCode": { "type": "string" },
        "Title": { "$ref": "#/definitions/StaffService2.Models.OData.StaffPersonalBasic.TitleRef" },
        "ExternalID": {
          "format": "uuid",
          "type": "string",
          "example": "00000000-0000-0000-0000-000000000000"
        }
      }
    },

Example return

        {
      "ExternalID": "11fb0b84-16fc-4168-86eb-a53bce3fa50c",
      "PreferredForename": "Alex",
      "PreferredSurname": "Lifeson",
      "IsDeceased": false,
      "StaffCode": "AL",
      "Gender": {
        "ExternalID": "6b535f9b-6841-4402-9409-5beafacba485",
        "Type": "Staff.Lookup.Gender"
      },
      "Title": {
        "ExternalID": "ee728a21-58df-4596-9fb7-b7820eb200f5",
        "Type": "Staff.Lookup.Title"
      }
    },