Skip to main content
POST
/
api
/
v1
/
resignation_requests
Error
A valid request URL is required to generate request examples
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "user": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "localCenter": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "fullName": "<string>"
  },
  "requestedBy": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "localCenter": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "fullName": "<string>"
  },
  "reason": "<string>",
  "conclusion": "<string>",
  "promptToReinroll": "<string>",
  "stayActive": true,
  "resignationDate": "2023-11-07T05:31:56Z",
  "dateCreated": "2023-11-07T05:31:56Z",
  "tenant": "https://example.com/",
  "status": "pending",
  "approvedBy": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "localCenter": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>"
    },
    "fullName": "<string>"
  }
}

Body

The new ResignationRequest resource

​
user
string<iri-reference>
Example:

"https://example.com/"

​
reason
string | null
​
conclusion
string | null
​
promptToReinroll
string | null
​
stayActive
boolean
​
resignationDate
string<date-time> | null

Response

ResignationRequest resource created

​
@context
​
@id
string
​
@type
string
​
id
integer
​
user
object
​
requestedBy
object
​
reason
string | null
​
conclusion
string | null
​
promptToReinroll
string | null
​
stayActive
boolean
​
resignationDate
string<date-time> | null
​
dateCreated
string<date-time>
​
tenant
string<iri-reference>
Example:

"https://example.com/"

​
status
string
default:pending
Example:

"pending"

​
approvedBy
object