Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Bearer token
Body
application/vnd.api+json
Response
primary appointment created with record extras
curl --request POST \
--url https://api.scholarlysoftware.com/api/v1/primary_appointments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "primary_appointment",
"attributes": {
"title": "Associate Professor",
"effective_from": "2025-01-01",
"appointment_type": "Tenure Track",
"track_type": "Research",
"external_id": "EMP001234",
"effective_to": "2026-01-01",
"terminated_on": "2026-12-31",
"termination_note": "Resigned to accept position elsewhere",
"percent_allocation": 100,
"full_time": true
},
"relationships": {
"profile": {
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"rank": {
"data": {
"type": "rank",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"department": {
"data": {
"type": "department",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}'
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "primary_appointment",
"attributes": {
"custom_fields": {},
"title": "Associate Professor",
"effective_from": "2025-01-01",
"appointment_type": "Tenure Track",
"track_type": "Research",
"external_id": "EMP001234",
"effective_to": "2026-01-01",
"terminated_on": "2026-12-31",
"termination_note": "Resigned to accept position elsewhere",
"percent_allocation": 100,
"full_time": true
},
"relationships": {
"profile": {
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"related": "<string>"
},
"meta": {}
},
"rank": {
"data": {
"type": "rank",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"related": "<string>"
},
"meta": {}
},
"department": {
"data": {
"type": "department",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"related": "<string>"
},
"meta": {}
}
}
}
}
Create a new primary appointment
curl --request POST \
--url https://api.scholarlysoftware.com/api/v1/primary_appointments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "primary_appointment",
"attributes": {
"title": "Associate Professor",
"effective_from": "2025-01-01",
"appointment_type": "Tenure Track",
"track_type": "Research",
"external_id": "EMP001234",
"effective_to": "2026-01-01",
"terminated_on": "2026-12-31",
"termination_note": "Resigned to accept position elsewhere",
"percent_allocation": 100,
"full_time": true
},
"relationships": {
"profile": {
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"rank": {
"data": {
"type": "rank",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"department": {
"data": {
"type": "department",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}'
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "primary_appointment",
"attributes": {
"custom_fields": {},
"title": "Associate Professor",
"effective_from": "2025-01-01",
"appointment_type": "Tenure Track",
"track_type": "Research",
"external_id": "EMP001234",
"effective_to": "2026-01-01",
"terminated_on": "2026-12-31",
"termination_note": "Resigned to accept position elsewhere",
"percent_allocation": 100,
"full_time": true
},
"relationships": {
"profile": {
"data": {
"type": "profile",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"related": "<string>"
},
"meta": {}
},
"rank": {
"data": {
"type": "rank",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"related": "<string>"
},
"meta": {}
},
"department": {
"data": {
"type": "department",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"links": {
"related": "<string>"
},
"meta": {}
}
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Bearer token
Show child attributes
primary appointment created with record extras
Show child attributes