Skip to main content

General overview of the resource creation process

Create Resource ("Happy" Path)

  1. API user requests creation of resource
  2. System validates request
  3. System synchronously validates partner data
  4. If no exceptions, then 201 Created is returned
  5. System asynchronously validates partner data
  6. If no exceptions, then Feedback is not generated
  7. System "listens" for event indicating resource is "live"
  8. System captures Feedback and generates Notification when event message is received
  9. Periodically API user requests Notifications
  10. Notification indicates that publication of resource is successful
tip

Poll for notifications every 15 minutes

Exception Path - Warnings (Synchronous)

  1. API user requests creation of resource
  2. System validates request
  3. System synchronously validates partner data
  4. If WARNING severities only, then Feedback is generated
  5. Notification is not generated
  6. 201 Created is returned
  • Response body includes validation report
  1. System asynchronously validates partner data
  2. If no exceptions, then Feedback is not generated
  3. System "listens" for event indicating resource is "live"
  4. System captures Feedback and generates Notification when event message is received
  5. Periodically API user requests Notifications
  6. Notification indicates that publication of resource is successful
  • Notification includes feedbackUrl
  1. API user requests Feedback about the resource
  • Response body includes validation report

Exception Path - Violations (Synchronous)

  1. API user requests creation of resource
  2. System validates request
  3. System synchronously validates partner data
  4. If VIOLATION severities, then
  • No Feedback or Notification is generated
  1. 400 Bad Request is returned
  • Response body includes validation report

Exception Path - Warnings (Asynchronous)

  1. API user requests creation of resource
  2. System validates request
  3. System synchronously validates partner data
  4. If no exceptions, then 201 Created is returned
  5. System asynchronously validates partner data
  6. If WARNING severities only, then Feedback is generated
  7. Notification is not generated
  8. System "listens" for event indicating resource is "live"
  9. System captures Feedback and generates Notification when event message is received
  10. Periodically API user requests Notifications
  11. Notification indicates that publication of resource is successful
  • Notification includes feedbackUrl
  1. API user requests Feedback about the resource
  • Response body includes validation report

Exception Path - Violations (Asynchronous)

  1. API user requests creation of resource
  2. System validates request
  3. System synchronously validates partner data
  4. If no exceptions, then 201 Created is returned
  5. System asynchronously validates partner data
  6. If VIOLATION severities, then Feedback is generated
  7. Notification is generated
  8. Periodically API user requests Notifications
  9. Notification indicates that resource is REJECTED
  • Notification includes feedbackUrl
  1. API user requests Feedback about the resource
  • Response body includes validation report