Cora Record API Documentation

This document describes the REST API endpoints exposed by the RecordEndpoint class. The API supports operations for creating, reading, updating, deleting, validating, indexing records, and uploading/downloading resources. Although the API supports both XML and JSON, XML examples are used throughout this documentation.

Base URL

The base URL is derived from the incoming HTTP request and internal settings. For example, if your server is hosted at:

http://<host>:<port>/<context>/

then the effective base URL for record endpoints becomes:

{baseUrl}/record/

Similarly, the IIIF URL is built using a setting (e.g., iiifPublicPathToSystem ). If the request includes an X-Forwarded-Proto header, the protocol is adjusted (e.g., from HTTP to HTTPS).

Authentication

All endpoints require an authentication token provided either as a header or query parameter:

Header: authToken
Query: authToken

If both are provided, the header token is used. (If you run without an authToken, you will be treated as GUEST.)

Supported Media Types (General)

Records: XML: application/vnd.uub.record+xml; JSON: application/vnd.uub.record+json
Record Lists: XML: application/vnd.uub.recordList+xml; JSON: application/vnd.uub.recordList+json; Browser-friendly: application/xml; qs=0.1
Work Orders (for Validation): XML: application/vnd.uub.workorder+xml; JSON: application/vnd.uub.workorder+json
File Uploads: multipart/form-data
Error Responses: text/plain; charset=utf-8

1. Create Record

Description

Creates a new record of a given type. The record is sent as a top-level XML data group.

Endpoint

POST {baseUrl}/record/{type}

Parameters

Path Parameter: type (string) – The type of record to create.
Authentication: authToken (Header or Query Parameter)
Request Body: An XML document representing the record.

Supported Media Types

Consumes: application/vnd.uub.record+xml, application/vnd.uub.record+json
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Request Example (XML)

<record>
  <recordinfo>
    <id>123</id>
    <type>{type}</type>
  </recordinfo>
  <title>Example Record</title>
  <variable1>Value1</variable1>
  <variable2>Value2</variable2>
  <variable3>Value3</variable3>
</record>

Response

Status: 201 Created
Headers:
- Location: URI of the newly created record (e.g. {baseUrl}/record/{type}/{id})
- Content-Type: application/vnd.uub.record+xml
Body: The created record in XML format.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages returned in plain text.

2. Read Record List

Description

Retrieves a list of complete records for a given type. If no filter is provided, a default empty filter is used.

Endpoint

GET {baseUrl}/record/{type}/

Parameters

Path Parameter: type (string) – The record type.
Query Parameter: filter (string, optional) – An XML string representing filter criteria.
If omitted, a default filter is used:
```
<filter></filter>
```
Authentication: authToken (Header or Query Parameter)

Supported Media Types

Produces: application/vnd.uub.recordList+xml, application/vnd.uub.recordList+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: A list of complete records in XML format.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

3. Read Single Record

Description

Retrieves a specific record by its type and identifier.

Endpoint

GET {baseUrl}/record/{type}/{id}

Parameters

Path Parameters:
- type (string) – The record type.
- id (string) – The record identifier.
Authentication: authToken (Header or Query Parameter)

Supported Media Types

Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: The requested record in XML format.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

4. Read Incoming Record Links

Description

Fetches a list of incoming record links for the specified record. Each link shows a record that references the target record.

Endpoint

GET {baseUrl}/record/{type}/{id}/incomingLinks

Parameters

Path Parameters:
- type (string) – The record type.
- id (string) – The record identifier.
Authentication: authToken (Header or Query Parameter)

Supported Media Types

Produces: application/vnd.uub.recordList+xml, application/vnd.uub.recordList+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: A list of incoming record links in XML format.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

5. Delete Record

Description

Deletes a specific record.

Endpoint

DELETE {baseUrl}/record/{type}/{id}

Parameters

Path Parameters:
- type (string) – The record type.
- id (string) – The record identifier.
Authentication: authToken (Header or Query Parameter)

Supported Media Types

Produces: text/plain; charset=utf-8

Response

Status: 200 OK
Body: No response body.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

6. Update Record

Description

Updates an existing record.

Endpoint

POST {baseUrl}/record/{type}/{id}

Parameters

Path Parameters:
- type (string) – The record type.
- id (string) – The record identifier.
Authentication: authToken (Header or Query Parameter)
Request Body: An XML document representing the updated record.

Supported Media Types

Consumes: application/vnd.uub.record+xml, application/vnd.uub.record+json
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Example Request (XML)

<record>
  <recordinfo>
    <id>123</id>
    <type>{type}</type>
  </recordinfo>
  <title>Updated Record</title>
  <variable1>NewValue1</variable1>
  <variable2>NewValue2</variable2>
  <variable3>NewValue3</variable3>
</record>

Response

Status: 200 OK
Body: The updated record in XML format.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

7. Download Resource

Description

Downloads a resource file that is attached to a record.

Endpoint

GET {baseUrl}/record/{type}/{id}/{resourceType}

Parameters

Path Parameters:
- type (string) – The record type.
- id (string) – The record identifier.
- resourceType (string) – The type of resource to download.
Authentication: authToken (Header or Query Parameter)

Supported Media Types

Produces: Binary stream (MIME type depends on the resource, e.g. application/octet-stream)

Response

Status: 200 OK
Headers:
- Content-Disposition: Attachment with filename
- Content-Length: File size
- Content-Type: MIME type (e.g. application/octet-stream)
Body: The binary file stream.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

8. Upload Resource

Description

Uploads a resource (file) and associates it with a record.

Endpoint

POST {baseUrl}/record/{type}/{id}/{resourceType}

Parameters

Path Parameters:
- type (string) – The record type.
- id (string) – The record identifier.
- resourceType (string) – The type of resource to upload.
Authentication: authToken (Header or Query Parameter)
Request Body: multipart/form-data with a file field named file

Supported Media Types

Consumes: multipart/form-data
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: The updated record (including the new resource) in XML format.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

9. Search Record

Description

Searches for records based on criteria passed in the request.

Endpoint

GET {baseUrl}/searchResult/{searchId}

Parameters

Path Parameter: searchId (string) – An identifier for the search.
Query Parameter: searchData (string) – An XML string containing search criteria.
Authentication: authToken (Header or Query Parameter)

Supported Media Types

Produces: application/vnd.uub.recordList+xml, application/vnd.uub.recordList+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: A list of records matching the search criteria in XML format.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

10. Validate Record

Description

Validates a record using a work order format. The work order includes two parts:

order – The validation parameters.
record – The record data to be validated.

Endpoint

POST {baseUrl}/record/{type}

Parameters

Path Parameter: type (string) – The record type to validate (internally mapped to a validation order type).
Authentication: authToken (Header or Query Parameter)
Request Body: An XML document containing the work order.

Supported Media Types

Consumes: application/vnd.uub.workorder+xml, application/vnd.uub.workorder+json
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Example Request (XML)

<workOrder>
  <order>
    <parameter name="validate">true</parameter>
  </order>
  <record>
    <recordinfo>
      <id>123</id>
      <type>{type}</type>
    </recordinfo>
    <title>Record to Validate</title>
    <variable1>Value1</variable1>
    <variable2>Value2</variable2>
    <variable3>Value3</variable3>
  </record>
</workOrder>

Response

Status: 200 OK
Body: The result of the validation as an XML record.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

11. Batch Index Records

Description

Starts a batch indexing job for all records of a given type. Optional index settings can be provided; if none are supplied, a default empty settings object is used.

Endpoint

POST {baseUrl}/record/index/{type}

Parameters

Path Parameter: type (string) – The type of records to index.
Authentication: authToken (Header or Query Parameter)
Request Body: An XML document containing index settings. If omitted, a default is used:
```
<indexSettings></indexSettings>
```

Supported Media Types

Consumes: application/vnd.uub.record+xml, application/vnd.uub.record+json
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Response

Status: 201 Created
Headers:
- Location: URI for the created batch job (e.g. {baseUrl}/record/indexBatchJob/{id})
Body: The batch job record in XML format.

Error Handling

Possible errors include 400, 401, 403, 404, 409, or 500, with error messages in plain text.

Getting Started

This section provides a step-by-step workflow to help you quickly start using the API.

Using Guest Mode

If you do not provide an authToken , the API runs in GUEST mode. For example:

GET {baseUrl}/record/person/

This returns data accessible to a guest user.

List All Record Types

To see which record types are available, call the Record Type Listing endpoint:

GET {baseUrl}/recordType

The response might include types such as "person", "publication", "resource", etc.

Search for a Record Type

Use the Search Record endpoint with appropriate search criteria. For example, to search for records of type "person":

GET {baseUrl}/searchResult/search

With the following search data:

<search>
  <criteria>person</criteria>
</search>

This returns records matching the criteria.

Read a Record

After identifying a record from the search results, retrieve its complete details using the Read Single Record endpoint. For example:

GET {baseUrl}/record/person/123

This returns the complete data for the record with id 123 of type "person".

Common Error Responses

400 Bad Request: Input is malformed or conversion errors occurred.
401 Unauthorized: Authentication token is missing or invalid.
403 Forbidden: The authenticated user does not have the necessary permissions.
404 Not Found: The requested record or resource does not exist.
409 Conflict: Conflicts due to record state or duplicate entries.
500 Internal Server Error: An unexpected error occurred.

Notes

Content Negotiation: The API uses the Content-Type header to determine the request format and the Accept header for the response format. Although both XML and JSON are supported, XML examples are provided here.
Error Handling: Errors are mapped to appropriate HTTP status codes with plain text error messages.
File Uploads/Downloads: The API streams binary data for file operations and includes headers for file metadata.
Returned Data Variability: The returned data may vary depending on the active user. In many cases, endpoints for fetching data (such as reading records) can be accessed without an authentication token, though authentication may change the data returned.

Cora Record API Dokumentation

Detta dokument beskriver REST API-endpoints som exponeras av klassen RecordEndpoint . API:et stöder operationer för att skapa, läsa, uppdatera, radera, validera, indexera poster samt ladda upp/ned filer. Även om API:et stöder både XML och JSON används XML-exempel genomgående i denna dokumentation.

Bas-URL

Bas-URL:en härleds från den inkommande HTTP-begäran och interna inställningar. Till exempel, om din server är värd på:

http://<host>:<port>/<context>/

blir den effektiva bas-URL:en för postendpunkter:

{baseUrl}/record/

På samma sätt byggs IIIF-URL:en med en inställning (t.ex. iiifPublicPathToSystem ). Om begäran innehåller en X-Forwarded-Proto -header justeras protokollet (t.ex. från HTTP till HTTPS).

Autentisering

Alla endpoints kräver ett autentiseringstoken som skickas antingen som header eller query-parameter:

Header: authToken
Query: authToken

Om båda anges används header-token. (Om du inte skickar med ett token behandlas du som GÄST.)

Stödda Mediatyper (Generellt)

Poster: XML: application/vnd.uub.record+xml; JSON: application/vnd.uub.record+json
Postlistor: XML: application/vnd.uub.recordList+xml; JSON: application/vnd.uub.recordList+json; Webbläsarvänligt: application/xml; qs=0.1
Arbetsordrar (för validering): XML: application/vnd.uub.workorder+xml; JSON: application/vnd.uub.workorder+json
Filuppladdning: multipart/form-data
Felmeddelanden: text/plain; charset=utf-8

1. Skapa Post

Beskrivning

Skapar en ny post av en given typ. Posten skickas som en XML-datagruppering.

Endpoint

POST {baseUrl}/record/{type}

Parametrar

Path-parameter: type (sträng) – Den posttyp som ska skapas.
Autentisering: authToken (Header eller Query)
Request Body: Ett XML-dokument som representerar posten.

Stödda Mediatyper

Consumes: application/vnd.uub.record+xml, application/vnd.uub.record+json
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Exempel på Request (XML)

<record>
  <recordinfo>
    <id>123</id>
    <type>{type}</type>
  </recordinfo>
  <title>Exempelpost</title>
  <variable1>Värde1</variable1>
  <variable2>Värde2</variable2>
  <variable3>Värde3</variable3>
</record>

Response

Status: 201 Created
Headers:
- Location: URI till den nyskapade posten (t.ex. {baseUrl}/record/{type}/{id})
- Content-Type: application/vnd.uub.record+xml
Body: Den skapade posten i XML-format.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

2. Läs Postlista

Beskrivning

Hämtar en lista med kompletta poster för en given typ. Om inget filter anges används ett standardtomt filter.

Endpoint

GET {baseUrl}/record/{type}/

Parametrar

Path-parameter: type (sträng) – Den posttyp som ska hämtas.
Query-parameter: filter (sträng, valfritt) – En XML-sträng som representerar filterkriterier.
Om inget anges används:
```
<filter></filter>
```
Autentisering: authToken (Header eller Query)

Stödda Mediatyper

Produces: application/vnd.uub.recordList+xml, application/vnd.uub.recordList+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: En lista med kompletta poster i XML-format.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

3. Läs Enstaka Post

Beskrivning

Hämtar en specifik post baserat på posttyp och id.

Endpoint

GET {baseUrl}/record/{type}/{id}

Parametrar

Path-parametrar:
- type (sträng) – Den posttyp som ska hämtas.
- id (sträng) – Postens id.
Autentisering: authToken (Header eller Query)

Stödda Mediatyper

Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: Den efterfrågade posten i XML-format.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

4. Läs Inkommande Postlänkar

Beskrivning

Hämtar en lista med inkommande postlänkar för den angivna posten. Varje länk visar en post som refererar till den aktuella.

Endpoint

GET {baseUrl}/record/{type}/{id}/incomingLinks

Parametrar

Path-parametrar:
- type (sträng) – Den posttyp som ska hämtas.
- id (sträng) – Postens id.
Autentisering: authToken (Header eller Query)

Stödda Mediatyper

Produces: application/vnd.uub.recordList+xml, application/vnd.uub.recordList+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: En lista med inkommande postlänkar i XML-format.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

5. Ta Bort Post

Beskrivning

Tar bort en specifik post.

Endpoint

DELETE {baseUrl}/record/{type}/{id}

Parametrar

Path-parametrar:
- type (sträng) – Den posttyp som ska tas bort.
- id (sträng) – Postens id.
Autentisering: authToken (Header eller Query)

Stödda Mediatyper

Produces: text/plain; charset=utf-8

Response

Status: 200 OK
Body: Inget svarsinnehåll.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

6. Uppdatera Post

Beskrivning

Uppdaterar en befintlig post.

Endpoint

POST {baseUrl}/record/{type}/{id}

Parametrar

Path-parametrar:
- type (sträng) – Den posttyp som ska uppdateras.
- id (sträng) – Postens id.
Autentisering: authToken (Header eller Query)
Request Body: Ett XML-dokument som representerar den uppdaterade posten.

Stödda Mediatyper

Consumes: application/vnd.uub.record+xml, application/vnd.uub.record+json
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Exempel på Request (XML)

<record>
  <recordinfo>
    <id>123</id>
    <type>{type}</type>
  </recordinfo>
  <title>Uppdaterad Post</title>
  <variable1>NyttVärde1</variable1>
  <variable2>NyttVärde2</variable2>
  <variable3>NyttVärde3</variable3>
</record>

Response

Status: 200 OK
Body: Den uppdaterade posten i XML-format.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

7. Ladda Ned Resurs

Beskrivning

Laddar ner en resursfil som är kopplad till en post.

Endpoint

GET {baseUrl}/record/{type}/{id}/{resourceType}

Parametrar

Path-parametrar:
- type (sträng) – Den posttyp som ska hämtas.
- id (sträng) – Postens id.
- resourceType (sträng) – Typ av resurs att ladda ner.
Autentisering: authToken (Header eller Query)

Stödda Mediatyper

Produces: Binär ström (MIME-typ beror på resursen, t.ex. application/octet-stream)

Response

Status: 200 OK
Headers:
- Content-Disposition: Filen skickas som bilaga med filnamn
- Content-Length: Filens storlek
- Content-Type: MIME-typ (t.ex. application/octet-stream)
Body: Den binära filströmmen.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

8. Ladda Upp Resurs

Beskrivning

Laddar upp en resurs (fil) och kopplar den till en post.

Endpoint

POST {baseUrl}/record/{type}/{id}/{resourceType}

Parametrar

Path-parametrar:
- type (sträng) – Den posttyp som ska användas.
- id (sträng) – Postens id.
- resourceType (sträng) – Typ av resurs att ladda upp.
Autentisering: authToken (Header eller Query)
Request Body: multipart/form-data med ett fält med namnet file

Stödda Mediatyper

Consumes: multipart/form-data
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: Den uppdaterade posten (inklusive den nya resursen) i XML-format.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

9. Sök Post

Beskrivning

Söker efter poster baserat på kriterier som skickas med i begäran.

Endpoint

GET {baseUrl}/searchResult/{searchId}

Parametrar

Path-parameter: searchId (sträng) – Ett id för sökningen.
Query-parameter: searchData (sträng) – En XML-sträng med sökkriterier.
Autentisering: authToken (Header eller Query)

Stödda Mediatyper

Produces: application/vnd.uub.recordList+xml, application/vnd.uub.recordList+json; qs=0.9, application/xml; qs=0.1

Response

Status: 200 OK
Body: En lista med poster som matchar sökkriterierna i XML-format.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

10. Validera Post

Beskrivning

Validerar en post med hjälp av ett arbetsordningsformat. Arbetsordern innehåller två delar:

order – Valideringsparametrar.
record – De data för posten som ska valideras.

Endpoint

POST {baseUrl}/record/{type}

Parametrar

Path-parameter: type (sträng) – Den posttyp som ska valideras (internt mappad till en valideringsordning).
Autentisering: authToken (Header eller Query)
Request Body: Ett XML-dokument med arbetsordern.

Stödda Mediatyper

Consumes: application/vnd.uub.workorder+xml, application/vnd.uub.workorder+json
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Exempel på Request (XML)

<workOrder>
  <order>
    <parameter name="validate">true</parameter>
  </order>
  <record>
    <recordinfo>
      <id>123</id>
      <type>{type}</type>
    </recordinfo>
    <title>Post att Validera</title>
    <variable1>Value1</variable1>
    <variable2>Value2</variable2>
    <variable3>Value3</variable3>
  </record>
</workOrder>

Response

Status: 200 OK
Body: Resultatet av valideringen som en XML-post.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

11. Batchindexera Poster

Beskrivning

Startar ett batchindexeringsjobb för alla poster av en given typ. Valfria indexinställningar kan anges; om inga tillhandahålls används ett standardtomt inställningsobjekt.

Slutpunkt

POST {baseUrl}/record/index/{type}

Parametrar

Vägparameter: type (sträng) – Typen av poster som ska indexeras.
Autentisering: authToken (Header eller Query Parameter)
Begäranskropp: Ett XML-dokument som innehåller indexinställningar. Om den utelämnas används standardinställningen:
```
<indexSettings></indexSettings>
```

Stödda medietyper

Consumes: application/vnd.uub.record+xml, application/vnd.uub.record+json
Produces: application/vnd.uub.record+xml, application/vnd.uub.record+json; qs=0.9, application/xml; qs=0.1

Svar

Status: 201 Skapad
Headers:
- Location: URI för det skapade batchjobbet (t.ex. {baseUrl}/record/indexBatchJob/{id})
Kropp: Batchjobbsposten i XML-format.

Felhantering

Möjliga fel inkluderar 400, 401, 403, 404, 409 eller 500 med felmeddelanden i ren text.

Kom igång

Detta avsnitt ger en steg-för-steg arbetsgång för att snabbt komma igång med API:et.

Använd Gästläge

Om du inte anger en authToken kör API:et i GÄST-läge. Till exempel:

GET {baseUrl}/record/person/

Detta returnerar data som är tillgänglig för en gäst.

Lista Alla Posttyper

För att se vilka posttyper som finns tillgängliga, anropa slutpunkten för posttypslistning:

GET {baseUrl}/recordType

Svaret kan inkludera typer som "person", "publication", "resource", etc.

Sök efter en Posttyp

Använd sökpostslutpunkten med lämpliga sökkriterier. Till exempel, för att söka efter poster av typen "person":

GET {baseUrl}/searchResult/search

Med följande sökdata:

<search>
  <criteria>person</criteria>
</search>

Detta returnerar poster som matchar kriterierna.

Läs en Post

Efter att ha identifierat en post från sökresultaten, hämta dess kompletta detaljer med slutpunkten för att läsa en enskild post. Till exempel:

GET {baseUrl}/record/person/123

Detta returnerar komplett data för posten med id 123 av typen "person".

Vanliga Felresponser

400 Felaktig begäran: Indata är felaktigt formaterad eller omvandlingsfel har inträffat.
401 Obehörig: Autentiseringstoken saknas eller är ogiltigt.
403 Förbjudet: Den autentiserade användaren har inte nödvändiga behörigheter.
404 Hittades inte: Den begärda posten eller resursen existerar inte.
409 Konflikt: Konflikter på grund av postens tillstånd eller dubblettposter.
500 Internt serverfel: Ett oväntat fel har inträffat.

Anteckningar

Content Negotiation: API:et använder Content-Type-headern för att bestämma begärans format och Accept-headern för svarformatet. Även om både XML och JSON stöds, ges XML-exempel här.
Felhantering: Fel mappas till lämpliga HTTP-statuskoder med felmeddelanden i ren text.
Filuppladdningar/Nedladdningar: API:et strömmar binärdata för filoperationer och inkluderar headers för filmetadata.
Variabilitet i returnerad data: Den returnerade datan kan variera beroende på vilken användare som är aktiv. I många fall kan slutpunkter för att hämta data (såsom att läsa poster) nås utan autentisering, även om autentisering kan förändra den data som returneras.