POST
/
api
/
v1
/
institutions
/
{institution_id}
/
ranks
Create a new rank
curl --request POST \
  --url https://api.scholarlysoftware.com/api/v1/institutions/{institution_id}/ranks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "rank",
    "attributes": {
      "name": "<string>"
    }
  }
}'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "rank",
    "attributes": {
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "relationships": {
      "institution": {
        "links": {
          "related": "/api/v1/institutions/3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    },
    "links": {
      "self": "/api/v1/ranks/7h8i9j0k-4567-8901-2345-def456789012"
    },
    "meta": {
      "deletable": true,
      "primary_appointments_count": 42
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer token

Path Parameters

institution_id
string
required

Institution UUID

Body

application/vnd.api+json

Response

201
application/vnd.api+json

rank created

The response is of type object.