Using the API

Enumerated types

Oovvuu utilises enumerated types for status codes, menu options and several other areas of the API. As GraphQL is a defined schema we can search and list the enumerations. For example to receive the list of Genres we can do

query {
  __type(name: "Genre") {
    name 
    enumValues {
      name
    }
  }
}

Error handling

When errors occur within the request to the Oovvuu Platform or unexpected errors occur there will be two main types of responses sent.

HTTP Response

The HTTP response is the first type of error code that should be checked as this is still the basis of the communication protocol. The Oovvuu Public API respects and sends the Standard HTTP error codes, the full comprehensive list of codes and their meanings can be found her   https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

However the primary ones that an external application should be concerned with when dealing with the Oovvuu Pubilc API are:

GraphQL Error

In the event of an HTTP 500 error oovvuu will also provide an Errors object within the response. Apollo have a robust error handling mechanism that the Oovvuu Pubilc API also follows, and it has been very documented here:

https://www.apollographql.com/docs/apollo-server/data/errors/

For example a typical response might be

{
  data: {
    userInputError: null
  },
  errors: {
    message: "User Input Error, validation failed for field 'preferredName'",
    path: [""],
    extensions: {
      code: ""
    }
}