Archive 1.x:Auth Registrar: WS/1.1

From OSF Wiki
Jump to: navigation, search
Auth Registrar: WS endpoint version:
1.1
2
3


The Auth Registrar: WS Web service is used to register a Web service endpoint to the WSF (Web Services Framework). Once a Web service is registered to a WSF, it can then be used by other Web services, become accessible to users, etc.

Developers communicate with the Auth Registrar: WS Web service using the HTTP GET method. You may request any content type (*/*).

No content is returned by the Web service endpoint if the endpoint successfully executed the query. Only a "200 OK" message will be returned in the header.

Version

This documentation page is used for the version 1.1 of this endpoint. Check at the top of this page to see the documentation pages for the other versions of this endpoint.

Usage

This Web service is intended to be used by content management systems, developers or administrators to manage access to WSF (Web Service Framework) resources (users, datasets, Web services endpoints).

Web Service Endpoint Information

This section describes all you permissions you need in the WSF (Web Service Framework) to send a query to this Web service endpoint, and it describes how to access it.

To access this Web service endpoint you need the proper CRUD (Create, Read, Update and Delete) permissions on a specific graph (dataset) of the WSF. Without the proper permissions on this graph you won't be able to send any queries to the endpoint.

Needed registered CRUD permission:
  • Create: True
  • Read: True
  • Update: False
  • Delete: False

As shown on the graph URI:

  • http://[...]/wsf/

Here is the information needed to communicate with this Web service's endpoint. Descriptions of the parameters are included below.

Note: if a parameter has a default value, the requester can omit it and the default value will be used. Also, some baseline Web services may not offer other values than the default.

HTTP method:
  • GET

Possible "Accept:" HTTP header field value:

  • */*

URI:

  • http://[...]/ws/auth/registrar/ws/ ?title=param1&endpoint=param2&crud_usage=param3&ws_uri=param4

URI dynamic parameters description:

Note: All parameters have to be URL-encoded

  • param1.Title of the web service to register
  • param2.URL of the endpoint where to send the HTTP queries
  • param3.A quadruple with a value "True" or "False" defined as <Create;Read;Update;Delete>. Each value is separated by the ";" character. an example of such a quadruple is: "crud_usage=True;True;False;False", meaning: Create = True, Read = True, Update = False and Delete = False
  • param4.URI of the resource describing the Web service

Query Answer from the Endpoint

If the query is successfully performed by the endpoint (i.e., the Web service resource has been properly created, updated or deleted), the endpoint will return the HTTP status message "200 OK" with an empty body. If an error occured, one of the HTTP status messages with the description of the error message in the body of the HTTP query will be returned.

HTTP Status Codes

Here are the possible HTTP status (error) codes returned by this Web service endpoint.

On error code and the specific error, a different message description can be issued (meaning a different error has been returned).

  • Code: 200
    • Message: OK
  • Code: 400
    • Message: Bad Request
    • Message description: No endpoint URL
    • Message description: No CRUD usage defined
    • Message description: No web service URI defined
    • Message description: Web service already registered
    • Message description: No target dataset
    • Message description: No Web service URI available
    • Message description: Target Web service XYZ not registered to this Web Services Framework
    • Message description: No access defined for this requester IP XYZ, dataset (XYZ) and Web service (XYZ)
    • Message description: The target Web service (XYZ) needs create access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
    • Message description: The target Web service (XYZ) needs read access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
    • Message description: The target Web service (XYZ) needs update access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
    • Message description: The target Web service (XYZ) needs delete access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
  • Code: 406
    • Message: Not Acceptable
    • Message description: Unacceptable mime type requested
  • Code: 500
    • Message: Internal Error