Call

This schema is an extended version of the “Return user schema” endpoint. In this case, there is an explanation of each field that will allow developers to better understand each field that can be used.

Response

This API will return a payload in JSON format, listing all the fields that are API exposed in the alumni platform. First, there is a list of all the required fields, only listing their names. Followed by a list of all the fields (required and non-required) with their properties.

Example

{
  "type": "object",
  "additionalProperties": false,
  "title": "User Json Schema",
  "description": "A user json schema with all valid fields for Integration of SignUp Manager.",
  "id": "user-schema.json",
  "required": [
    "lastCompletedAwardCountry",
    ...
    "communicationEmailAddress"
  ],
  "properties": {
    "lastName": {
      "type": "string",
      "title": "Last Name"
    },
    "emailAtCompany": {
      "type": "string",
      "format": "email",
      "title": "What is/was your JPMC email address?",
      "description": "Enter firstname.lastname||Enter mailbox domain"
    },
    "campus": {
      "type": "string",
      "title": "Campus"
    },
    ...
    "location": {
      "type": "object",
      "additionalProperties": false,
      "title": "Current Location (City)",
      "required": [
        "city",
        "country",
        "state"
      ],
      "properties": {
        "country": {
          "type": "string",
          "title": "Country"
        },
        "city": {
          "type": "string",
          "title": "City"
        },
        "state": {
          "type": "string",
          "title": "State"
        }
      }
    }
  }
}

API URL: https://gateway.enterprisealumni.com/api/v2/user/schema/json

*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.

Notes

Check https://json-schema.org/specification.html for further information.