Validate Draft Enrollment
post
Body
idstringOptional
auditall ofOptional
$metaall of | nullableOptional
revisioninteger · int32Optional
certificateall ofOptional
programall ofOptional
applicableToall ofOptional
string · enumOptionalPossible values:
typeall ofOptional
string · enumOptionalPossible values:
buyerall ofOptional
licenseeall ofOptional
eligibilityall ofOptional
statusall ofOptional
string · enumOptionalPossible values:
notesstring | nullableOptional
statusNotesall of | nullableOptional
assigneeall ofOptional
parametersall ofOptional
errorall of | nullableOptional
templateall ofOptional
Responses
200
OK
application/json
400
Bad Request
application/json
403
Forbidden
application/json
500
Internal Server Error
post
POST /public/v1/program/enrollments/validate HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 2620
{
"id": "text",
"audit": {
"created": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"processing": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"querying": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"completed": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"failed": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"certificate": {
"id": "text",
"revision": 1,
"name": "text"
},
"program": {
"id": "text",
"revision": 1,
"name": "text",
"status": "None",
"applicableTo": "Buyer",
"products": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"revision": 1,
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "Buyer",
"type": "Change",
"buyer": {
"id": "text",
"revision": 1,
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"revision": 1,
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "Processing",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"revision": 1,
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Order",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Order",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"revision": 1,
"name": "text",
"type": "EnrollmentProcessing"
}
}{
"id": "text",
"audit": {
"created": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"processing": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"querying": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"completed": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
},
"failed": {
"at": "2025-09-05T20:32:21.812Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"certificate": {
"id": "text",
"revision": 1,
"name": "text"
},
"program": {
"id": "text",
"revision": 1,
"name": "text",
"status": "None",
"applicableTo": "Buyer",
"products": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"revision": 1,
"name": "text",
"shortDescription": "text",
"longDescription": "text",
"externalIds": {
"operations": "text",
"defaultErpItem": "text"
},
"website": "text",
"icon": "text",
"status": "text",
"vendor": {
"id": "text",
"revision": 1,
"icon": "text",
"type": "Client",
"status": "Active",
"name": "text"
},
"settings": {
"productOrdering": true,
"productRequests": {
"enabled": true,
"name": "text",
"label": "text"
},
"itemSelection": true,
"orderQueueChanges": true,
"preValidation": {
"purchaseOrderDraft": true,
"purchaseOrderQuerying": true,
"changeOrderDraft": true,
"configurationOrderDraft": true,
"terminationOrder": true,
"productRequest": true
},
"splitBilling": {
"enabled": true,
"type": "text"
},
"subscriptionCessation": {
"enabled": true,
"mode": "Termination"
}
},
"statistics": {
"itemCount": 1,
"ordersPlacedCount": 1,
"agreementCount": 1,
"subscriptionCount": 1,
"requestCount": 1
}
}
]
},
"applicableTo": "Buyer",
"type": "Change",
"buyer": {
"id": "text",
"revision": 1,
"icon": "text",
"name": "text"
},
"licensee": {
"id": "text",
"revision": 1,
"icon": "text",
"name": "text",
"externalId": "text"
},
"eligibility": {
"client": true,
"partner": true
},
"status": "Processing",
"notes": "text",
"statusNotes": {
"id": "text",
"message": "text",
"parameters": null
},
"assignee": {
"id": "text",
"revision": 1,
"icon": "text",
"name": "text"
},
"parameters": {
"ordering": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Order",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
],
"fulfillment": [
{
"id": "text",
"externalId": "text",
"name": "text",
"type": "SingleLineText",
"phase": "Order",
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"constraints": {
"hidden": true,
"readonly": true,
"required": true
},
"displayValue": "text",
"value": null
}
]
},
"error": {
"id": "text",
"message": "text",
"parameters": null
},
"template": {
"id": "text",
"revision": 1,
"name": "text",
"type": "EnrollmentProcessing"
}
}Last updated
Was this helpful?