Table of contents

    Overview

    An Occupation object identifies a Contact‘s Occupation. To call the Occupation endpoint, use one of the URLs from the following table:

    URL GET PUT POST DELETE
    https://api.mypcorp.com/occupation
    https://api.mypcorp.com/occupation/{Id}

    NB: Currently, the MYP API accepts only GET requests for Occupation endpoint. 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.

    Claim
    Field Name Description
    OccupationId
    integer (Identifier)
    The Occupation id.
    Role
    string
    The Occupation role. E.g. ‘Bookkeeper’, ‘Accountant’, ‘Finance Manager’, etc.

    Example JSON response:

    {
      "@odata.context": "https://api.mypcorp.com/$metadata#Occupation",
      "value": [
        {
          "OccupationId": 100,
          "Role": "Commissioned Officer"
        }
      ]
    }

    Previous article Next article