Skip to content

Commit 3c3d108

Browse files
committed
CMR-10583: adding error examples in documentation
1 parent cc188ce commit 3c3d108

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

  • schemas/resources/schemas/citation/v1.0.0

schemas/resources/schemas/citation/v1.0.0/ingest.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,21 @@ get a JSON response:
3737
{"concept-id":"CIT1200000000-PROV1","revision-id":1,"warnings":null,"existing-errors":null}
3838
```
3939

40+
#### Unsuccessful Response in XML
41+
42+
```
43+
<?xml version="1.0" encoding="UTF-8"?>
44+
<errors>
45+
<error>While validating the record against the [citation] schema with version [1.1.0] the following error occurred: [#: #: only 1 subschema matches out of 2]. The record cannot be ingested.</error>
46+
</errors>
47+
```
48+
49+
#### Unsuccessful Response in JSON
50+
51+
```
52+
{"errors":["While validating the record against the [citation] schema with version [1.1.0] the following error occurred: [#: #: only 1 subschema matches out of 2]. The record cannot be ingested."]}
53+
```
54+
4055
### <a name="delete-citation"></a> Delete a Citation
4156

4257
Citation metadata can be deleted by sending an HTTP DELETE to the URL `%CMR-ENDPOINT%/providers/<provider-id>/citations/<native-id>`. The response will include the [concept id](#concept-id) and the [revision id](#revision-id) of the tombstone.

0 commit comments

Comments
 (0)