process-objects.json

{
  "openapi": "3.0.2",
  "info": {
    "title": "Person API",
    "version": "1.0.0",
    "contact": {
      "name": "DoIT Enterprise Integration API Team",
      "email": "api@doit.wisc.edu",
      "url": "https://go.wisc.edu/k701y6"
    },
    "description": "An API for interacting with person data at UW-Madison. Refer to the [Person API Documentation](/person-api) for more information about this API."
  },
  "servers": [
    {
      "url": "https://api.wisc.edu"
    }
  ],
  "security": [
    {
      "OAuth2ClientCredentials": []
    }
  ],
  "externalDocs": {
    "description": "Read more about JSON:API here",
    "url": "https://jsonapi.org/"
  },
  "paths": {
    "/people": {
      "get": {
        "description": "Get a collection of people.",
        "summary": "Get people.",
        "operationId": "get_people",
        "tags": [
          "people"
        ],
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "description": "Filter results of query using the [filter query parameter family](https://jsonapi.org/recommendations/#filtering). Refer to the [Person API Documentation](/person-api/filter-query-parameter) for more information about the `filter` query param.",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "attribute": {
                  "type": "string",
                  "example": "firstName"
                }
              }
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Specify the list of fields you would like to return for each resource type.  For example, `fields[people]=firstName,lastName` will just return the names for people.  If you are including related resources with 'includes' you can also specify fields on those resources as well.  For example, `includes=jobs&fields[people]=jobs&fields[jobs]=title` will just return titles for jobs.  See [Sparse Fieldsets](https://jsonapi.org/format/#fetching-sparse-fieldsets) for more details.",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "type": "string",
                  "example": "people"
                }
              }
            }
          },
          {
            "name": "include",
            "in": "query",
            "description": "[include related resources](https://jsonapi.org/format/#fetching-includes). The resources to include need to be direct relationships. Nested relationships are not supported. For example, `include=jobs,identifiers` is supported but `include=person.jobs` is not supported.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Define options for pagination of responses. For example, `page[size]=5&page[after]=400&page[before]=800` will return a response with data about 5 people whose `id` value falls after `400` but before `800`. So `page[size]` determines the number of people resources in a response, `page[after]` is the ID of the person at the end of the previous page, `page[before]` is the ID of the person at the start of the next page. Offset pagination is also supported using `page[number]` parameter (example: `page[number]=4&page[size]=10`), but it is disabled by default. The `page[number]` determines the page to display. Offset pagination has significantly worse performance than cursor pagination, so it should only be used by applications that can't support cursor pagination. Contact the developers if you would like to enable it.",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "properties": {
                "size": {
                  "type": "integer",
                  "example": 50,
                  "maximum": 1000,
                  "minimum": 1,
                  "default": 100,
                  "description": "Size of page for paginated results."
                },
                "after": {
                  "type": "string",
                  "description": "An ephemeral identifier used only in the Person API to adhere to the [JSON:API specification](https://jsonapi.org/format/#document-resource-object-identification). This ID may change if a person is split into two people or two people are merged into one person. This ID is used for paginating results or following other links returned in the API response. This ID should not be stored in a consuming system. Concatenating parts of the URL to form a link is discouraged. Instead, use the fully-formed links returned in an API response.",
                  "example": "12345"
                },
                "before": {
                  "type": "string",
                  "description": "An ephemeral identifier used only in the Person API to adhere to the [JSON:API specification](https://jsonapi.org/format/#document-resource-object-identification). This ID may change if a person is split into two people or two people are merged into one person. This ID is used for paginating results or following other links returned in the API response. This ID should not be stored in a consuming system. Concatenating parts of the URL to form a link is discouraged. Instead, use the fully-formed links returned in an API response.",
                  "example": "12345"
                },
                "number": {
                  "type": "integer",
                  "example": 1,
                  "minimum": 1,
                  "description": "Page number for paginated results. This parameter is disabled by default. Contact the developers if you would like to enable it."
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of people",
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data",
                    "links"
                  ],
                  "properties": {
                    "data": {
                      "description": "A collection of people",
                      "type": "array",
                      "items": {
                        "description": "A person",
                        "type": "object",
                        "required": [
                          "type",
                          "id",
                          "attributes",
                          "relationships",
                          "links",
                          "meta"
                        ],
                        "properties": {
                          "type": {
                            "type": "string",
                            "example": "people"
                          },
                          "id": {
                            "type": "string",
                            "description": "An ephemeral identifier used only in the Person API to adhere to the [JSON:API specification](https://jsonapi.org/format/#document-resource-object-identification). This ID may change if a person is split into two people or two people are merged into one person. This ID is used for paginating results or following other links returned in the API response. This ID should not be stored in a consuming system. Concatenating parts of the URL to form a link is discouraged. Instead, use the fully-formed links returned in an API response.",
                            "example": "12345"
                          },
                          "attributes": {
                            "type": "object",
                            "required": [
                              "firstName",
                              "lastName",
                              "emailAddress",
                              "officeAddress",
                              "officePhoneNumber"
                            ],
                            "properties": {
                              "firstName": {
                                "type": "string",
                                "example": "John",
                                "description": "First name, derived from the person's current UW affiliations."
                              },
                              "lastName": {
                                "type": "string",
                                "example": "Smith",
                                "description": "Last name, derived from the person's current UW affiliations."
                              },
                              "emailAddress": {
                                "type": "string",
                                "example": "john.smith@wisc.edu",
                                "description": "The email address this person has designated as their primary, if set.  Otherwise, their Campus Business Email, or other email derived from their current UW affiliations."
                              },
                              "officeAddress": {
                                "type": "string",
                                "description": "Primary work-related address derived from the person's current UW affiliations.  May or may not be a fully-formed street address.",
                                "example": "1210 W. Dayton Street Madison, WI 53706-1613",
                                "nullable": true
                              },
                              "officePhoneNumber": {
                                "type": "string",
                                "example": "608-262-1204",
                                "description": "Primary work-related phone number derived from the person's current UW affiliations.  May or may not be associated with the officeAddress.",
                                "nullable": true
                              }
                            }
                          },
                          "relationships": {
                            "type": "object",
                            "required": [
                              "identifiers",
                              "jobs",
                              "names",
                              "wiscard"