Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define URL scheme that allows updating #147

Closed
cookeac opened this issue Aug 28, 2020 · 3 comments
Closed

Define URL scheme that allows updating #147

cookeac opened this issue Aug 28, 2020 · 3 comments

Comments

@cookeac
Copy link
Collaborator

cookeac commented Aug 28, 2020

Build on the example URL scheme in issue #18 and address the question about use of PATCH/PUT for fields in issue #140 .
Create a URL scheme that includes POST (new resources), PUT and PATCH (update resources)

@ahokkonen
Copy link
Contributor

Within that task I think we also should define standardized response messages for POST/PUT requests - event id (for mapping between request items and response statuses), processions status, possible errors, etc...

@ahokkonen
Copy link
Contributor

As discussed during our previous technical meeting here is a response model used for event POST requests in Nordic Data Exchange:

[
  {
    "EventID": "string",
    "AdditionalObjectIDs": [
      {
        "ObjectID": "string",
        "ObjectIDType": 0,
        "ObjectHierarchyLevel": 0
      }
    ],
    "Status": 0,
    "Errors": [
      {
        "ErrorID": 0,
        "ErrorText": "string",
        "ErrorFieldName": "string",
        "ErrorSource": 0
      }
    ]
  }
]

As you can this response is an array of object with specific status fields for each posted event.

  • EventID - tracking identifier used to map response object to original event by its ID
  • Status - procession status (separate code set used)
  • Errors - detailed information about errors if procession failed
  • AdditionalObjectIDs - additional definition for sub resources (for example progenies inside parent birth event etc.)

@cookeac cookeac added this-release Scheduled to be implemented for this release in development and removed enhancement New feature or request labels Sep 28, 2020
@cookeac cookeac removed the this-release Scheduled to be implemented for this release in development label Mar 25, 2021
@cookeac
Copy link
Collaborator Author

cookeac commented Jul 15, 2021

Will be addressed for POST when #154 is resolved.

@cookeac cookeac closed this as completed Jul 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants