Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • You need to figure out the URL of the particular Syndeia Cloud API endpoint, whether that endpoint is exposed over HTTP Get, Post, Put, Delete (verbs) methods, and if it accepts any parameters
  • Typically, the Post and Put methods expect some payload (data in JSON format) for the resource that has to be created / updated on the server
  • The Get methods might also need some values for parameters that are part of the URL
  • Most likely, there will be a method in the com.intercax.syndeia.services.CloudServiceUrlHelper class that will be returning a correct URL by accepting (a few) parameters - if such a method is missing, you may add one accordingly
  • Finally, you'll need to add a new method to the com.intercax.syndeia.services.CloudService class and use the URL returned by one of the methods in CloudServiceUrlHelper and then passing this URL and the type of response expected to one of the (get, getAll) methods in CoreCloudService class
  • Typically, the methods in the com.intercax.syndeia.services.CloudService class return `Either<ErrorResponseEither<ErrorResponse, *Response<T>> where -
    • *Response is one of ObjResponse(for single values), SeqResponse (for a list of values) or CreatedResponse (if something got created on the server)
    • T is one of the domain objects from the com.intercax.syndeia.domain package

...