Get a specific rank - Scholarly API Documentation

Get a specific rank

curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/ranks/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "rank",
    "attributes": {
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "relationships": {}
  }
}

GET

api

ranks

{id}

Get a specific rank

curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/ranks/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "rank",
    "attributes": {
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "relationships": {}
  }
}

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

string

required

Rank UUID

Response

rank found

data

object

required

Show child attributes

data.id

string<uuid>

required

data.type

string

required

Allowed value: "rank"

Example:

"rank"

data.attributes

object

required

Show child attributes

data.attributes.name

string | null

required

data.attributes.created_at

string<datetime> | null

data.attributes.updated_at

string<datetime> | null

data.relationships

object

Create a new rank Delete a rank

⌘I

API reference

Authorizations

Headers

Path Parameters

Response