Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 1

...

Backend Response Error

Reason

HTTP Code

Message

-

Id not in URL

400

None

-

Id field in document does not match id in URL

400

{ error: { message:  'The identity of the resource does not match the identity in the updated document.' }

UPDATE_FAILURE_REFERENCE

Submitted document references one or more non-existent documents

400409

{ error: { message: 'Reference validation failed', failures: [ {resourceName: 'Student', identity: { studentId: '123' }, …] } }

UPDATE_FAILURE_IMMUTABLE_IDENTITY

Attempt to modify document identity on a resource where the identity cannot be changed

400

{ error: { message: 'The identity fields of the document cannot be modified' } }

UPDATE_FAILURE_CONFLICT

Attempt to change the identity of a document to the identity of an existing document with the same resource superclass

409

{ error: { message: 'Update failed: the identity is in use by 'School' which is also a(n) 'EducationOrganization', blockingUris:  ['/v5.0-pre.2/edfi/schools/a-school-document-with-same-identity', …] } }

UPDATE_FAILURE_WRITE_CONFLICT

Attempt to modify a document in a transaction that a concurrent transaction has modified

409

{ error: { message: 'Write conflict due to concurrent access to this or related resources' }

...

Backend Response Error

Reason

HTTP Code

Message

UPDATE_FAILURE_REFERENCE /

INSERT_FAILURE_REFERENCE

Submitted document references one or more non-existent documents

400409

{ error: { message: 'Reference validation failed', failures: [ {resourceName: 'Student', identity: { studentId: '123' }, …] } }

INSERT_FAILURE_CONFLICT

Attempt to insert a document with the identity of an existing document with the same resource superclass

409

{ error: { message: 'Insert failed: the identity is in use by 'School' which is also a(n) 'EducationOrganization', blockingUris:  ['/v5.0-pre.2/edfi/schools/a-school-document-with-same-identity', …] } }

UPSERT_FAILURE_WRITE_CONFLICT

Attempt to modify a document in a transaction that a concurrent transaction has modified

409

{ error: { message: 'Write conflict due to concurrent access to this or related resources' }

...