Table of contents

    Overview

    A Staff member is an individual that works for a Client. To call the Staff endpoint, use one of the URLs from the following table:

    URL GET PUT POST DELETE
    https://api.mypcorp.com/staff
    https://api.mypcorp.com/staff/{Guid}

    NB: Currently, the MYP API accepts GET requests. POST and PUT requests will be available in the future.

    Get

    The following table illustrates which fields can be included when receiving a GET response.

    NB: Nested properties are hidden by default. To expand all nested properties, add a query parameter $expand=* to the URL.

    Staff
    Field Name Description
    StaffGuid
    Guid (Identifier)
    The Staff Member’s id.
    FirstName
    string
    Staff Member’s first name.
    LastName
    string
    Staff Member’s last name.
    Abbreviation
    string
    Staff member’s initials. Typically, the first letter of the first and last name of the Staff member.
    SalutationChoiceOther
    string
    Staff Member’s custom salutation, if standard salutations do not suit.
    UsePrimaryEmail
    boolean
    Indicates whether the primary email should be used when communicating with the Staff Member.
    PrimaryEmail
    string
    Staff Member’s primary email, if applicable.
    UseSecondaryEmail
    boolean
    Indicates whether the secondary email should be used when communicating with the Staff Member.
    SecondaryEmail
    string
    Staff Member’s secondary email, if applicable.
    UniqueCode
    string
    Staff Member’s unique code.
    Department
    string
    Name of the Department to which this Staff Member belongs to.
    OfficialTitle
    string
    Staff Member’s official title.
    PositionOther
    string
    Staff Member’s occupation if there is no relevant Occupation object for it.
    HomePhone
    string
    Staff Member’s home phone.
    PhoneNumber
    string
    Staff Member’s phone number.
    PhoneNumber2
    string
    Staff Member’s secondary phone number, if applicable.
    PhoneExtension
    string
    Staff member’s phone extension.
    PhoneExtension
    string
    Staff member’s second phone extension.
    Fax
    string
    Staff Member’s fax number.
    FacebookUrl
    string
    URL for Staff Member’s Facebook account.
    TwitterUrl
    string
    URL for Staff Member’s Twitter account.
    YouTubeUrl
    string
    URL for Staff Member’s YouTube Channel.
    LinkedInUrl
    string
    URL for Staff Member’s LinkedIn account.
    OtherSocialMediaUrl
    string
    URL for any other social media platforms for this Staff Member.
    SpecialRequirements
    string
    Staff Member’s special requirements.
    Interests
    string
    Staff Member’s interests.
    SendBirthdayReminder
    boolean
    Indicates whether a reminder about the Staff Member’s birthday should be sent out.
    Birthday
    datetime
    Date of the Staff Member’s birthday.
    SendSpouseBirthdayReminder
    boolean
    Indicates whether a reminder about the Staff Member’s Spouses birthday should be sent.
    SpouseBirthday
    datetime
    Birth date of the Staff Member’s Spouse.
    SpouseFirstName
    string
    First name of the Staff Member’s Spouse.
    SpouseLastName
    string
    Last name of the Staff Member’s Spouse.
    NumberOfChildren
    integer
    Specifies the number of children the Staff Member has.
    AcceptsMarketingContact
    boolean
    Indicates whether the Staff Member accepts emails or not.
    CreationDate
    datetime
    The date the Staff Member’s record was created.
    ModifyDate
    datetime
    Date when the Staff Member’s record was last modified.
    ArchiveDate
    datetime
    Date when the Staff Member was archived, if they have been archived.
    AccountManagerGuid
    Guid
    Guid of the Staff Member’s Account Manager. To view the Account Manager’s details, refer to Staff endpoint.
    Address
    object
    Staff Member’s address.
    PostalAddress
    object
    Staff Member’s postal address, if it is different to their home address.
    CustomFields
    object
    Custom field(s) of a Staff Member. This field is accessible only when the endpoint is called with Staff Member’s guid.
    Salutation
    object
    Staff Member’s salutation.
    Gender
    object
    Staff Member’s gender.
    Occupation
    object
    Staff Member’s Occupation.
    Role
    object
    Staff Member’s Role.
    Client
    object
    Indicates which Client the Staff Member is associated with.
    Address
    Field Name Description
    StreetAddress
    string
    Staff Member’s home street address.
    StreetAddress2
    string
    Second field for Staff Member’s home street address.
    Suburb
    string
    Staff Member’s home suburb.
    City
    string
    Staff Member’s home Town or City.
    State
    string
    Staff Member’s home State.
    Country
    string
    Staff Member’s home Country.
    PostCode
    string
    Staff Member’s home post code.
    Postal Address
    Field Name Description
    PostalStreetAddress
    string
    Staff Member’s postal street address, if it is different to their home address.
    PostalStreetAddress2
    string
    Second field for Staff Member postal street address, if it is different to their home address.
    PostalSuburb
    string
    Staff Member’s postal suburb, if it is different to their home address.
    PostalCity
    string
    Staff Member’s postal Town or City, if it is different to their home address.
    PostalState
    string
    Staff Member’s postal State, if it is different to their home address.
    PostalPostCode
    string
    Post code for Client’s postal address, if it is different to their home address.

    Example JSON format:

    {
      "@odata.context": "https://api.mypcorp.com/$metadata#Staff(*,Salutation(),Gender(),Occupation(),Role())",
      "value": [
        {
          "StaffGuid": "03f27516-04b2-eb11-b82b-08626626e1a4",
          "FirstName": "Bruce",
          "LastName": "Wayne",
          "Abbreviation": "BW",
          "SalutationChoiceOther": "Mr",
          "UsePrimaryEmail": false,
          "PrimaryEmail": "bruce.wayne@gmail.com",
          "UseSecondaryEmail": false,
          "SecondaryEmail": "bruce.wayne@outlook.com",
          "UniqueCode": "Gotham",
          "Department": "Corporate Services Division",
          "OfficialTitle": "NDIS Participant",
          "PositionOther": "Principal",
          "HomePhone": "8877 6655",
          "PhoneNumber": "87625432109",
          "PhoneExtension": "123",
          "PhoneExtension2": "321",
          "Fax": "(03) 1234 5678",
          "FaceBookUrl": "https://www.facebook.com/brucewayne/",
          "TwitterUrl": "www.twitter.com/brucewayne",
          "YouTubeUrl": "https://www.youtube.com/channel/abcdefg",
          "LinkedInUrl": "https://www.linkedin.com/in/bruce-wayne-12345678/",
          "OtherSocialMediaUrl": "http://www.google.com",
          "SpecialRequirements": "Wants to volunteer in the community",
          "Interests": "Arts & Crafts, colouring books.",
          "SendBirthdayReminder": true,
          "Birthday": "1978-04-17T00:00:00+10:00",
          "SendSpouseBirthdayReminder": true,
          "SpouseBirthday": "1979-06-24T00:00:00+10:00",
          "SpouseFirstName": "Jane",
          "SpouseLastName": "Doe",
          "NumberOfChildren": 3,
          "AcceptsMarketingContact": true,
          "CreationDate": "2021-05-11T12:53:42.53+10:00",
          "ModifyDate": "2021-05-11T12:53:42.53+10:00",
          "ArchiveDate": null,
          "AccountManagerGuid": "af0c497c-9958-4f04-a691-e8c3623f93ee",
          "Address": {
            "StreetAddress": "Unit 1234",
            "StreetAddress2": "360 Sinclair Street",
            "Suburb": "NOBLE PARK",
            "City": "Gotham City",
            "State": "QLD",
            "Country": "Australia",
            "PostCode": "hello world"
          },
          "PostalAddress": {
            "PostalAddress": "PO Box 4321",
            "PostalAddress2": "PO Box 6543",
            "PostalSuburb": "Postal Gotham",
            "PostalCity": "Postal Gotham City",
            "PostalState": "NSW",
            "PostalPostCode": "Postal 5432"
          },
          "CustomFields": [
            {
              "CustomFieldGuid": "01faafe0-980f-40b1-a284-727677faefe5",
              "Name": "Services provided",
              "Responses": [
                {
                  "Response": "Support coordinator"
                }
              ]
            }
          ],
          "Salutation": {
            "ChoiceId": 18700,
            "Text": "Dr"
          },
          "Gender": {
            "ChoiceId": 12600,
            "Text": "Male"
          },
          "Occupation": {
            "OccupationId": 6500,
            "Role": "Commissioned Officer"
          },
          "Role": {
            "RoleGuid": "d0426984-47d5-4bd8-a5d9-bdc79f21991b",
            "Name": "CEO"
          },
          "Client": {
            "ClientGuid": "53e1e0c4-03b2-eb11-b82b-08626626e1a4",
            "BusinessName": "Wayne Enterprises Industries",
            "BusinessNumber": "5"
          }
        }
      ]
    }

    Previous article Next article