SegapRESTAPI1.0 specifications
Upcoming SlideShare
Loading in...5
×
 

Like this? Share it with your network

Share

SegapRESTAPI1.0 specifications

on

  • 146 views

This is the SEGAP REST API Specification document.

This is the SEGAP REST API Specification document.

Statistics

Views

Total Views
146
Views on SlideShare
146
Embed Views
0

Actions

Likes
0
Downloads
2
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

SegapRESTAPI1.0 specifications Document Transcript

  • 1. SEGAP REST API 1.0 1. Assumptions 2. Base URL {segap_host}/segap/{version} GET 3. Authorization {base}/authorization/login POST {base}/authorization/logout POST {base}/authorization/oauth2.0/authorize GET {base}/authorization/oauth2.0/token POST 4. Administration {base}/users POST {base}/users/{user_id} PUT DELETE GET {base}/games POST {base}/games/{game_id} PUT DELETE GET {base}/games/{game_id}/themes POST GET DELETE {base}/games/{game_id}/themes/{theme_id} DELETE GET {base}/games/{game_id}/themes/{theme_id}/entities POST DELETE GET 1
  • 2. {base}/games/{game_id}/themes/{theme_id}/entities/{entity_id} PUT DELETE GET {base}/games/{game_id}/themes/{theme_id}/variables POST DELETE GET {base}/games/{game_id}/themes/{theme_id}/variables/{variable_id} PUT DELETE GET {base}/games/{game_id}/themes/{theme_id}/actions POST DELETE GET {base}/games/{game_id}/themes/{theme_id}/actions/{action_id} PUT DELETE GET {base}/games/{game_id}/themes/{theme_id}/conditions POST DELETE GET {base}/games/{game_id}/themes/{theme_id}/conditions/{condition_id} PUT DELETE GET {base}/games/{game_id}/tips POST DELETE GET {base}/games/{game_id}/tips/{tip_id} PUT DELETE GET {base}/themes POST {base}/themes/{theme_id} PUT DELETE GET {base}/themes/{theme_id}/entities 2
  • 3. POST DELETE GET {base}/themes/{theme_id}/entities/{entity_id} PUT DELETE GET {base}/themes/{theme_id}/variables POST DELETE GET {base}/themes/{theme_id}/variables/{variable_id} PUT DELETE GET {base}/themes/{theme_id}/actions POST DELETE GET {base}/themes/{theme_id}/actions/{action_id} PUT DELETE GET {base}/themes/{theme_id}/conditions POST DELETE GET {base}/themes/{theme_id}/conditions/{condition_id} PUT DELETE GET 5. REST API Client data collection {base}/users/{user_id}/games POST DELETE GET {base}/users/{user_id}/games/{game_id}/themes/{theme_id}/entities GET {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/entities/{entity_id} PUT GET {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/variables GET 3
  • 4. {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/variables/{variable_id} PUT GET {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/actions GET {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/actions/{action_id} PUT GET {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/conditions GET {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/conditions/{condition_id} PUT GET {base}/users/{user_id}/games/{game_id}/history POST GET {base}/users/{user_id}/games/{game_id}/history/{date} GET 6. SPARQL dataset (rdf files, the rdf database) {base}/users GET {base}/games GET {base}/themes GET 7. SPARQL endpoint {base}/sparql POST 1. Assumptions 2. Base URL segap_host = this the location on the web where SEGAP is hosted, ex: http://www.iamahost.org version = this indicates the version of SEGAP API 4
  • 5. url {segap_host}/segap/{version} method GET parameters OAuth2.0 related stuff: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ standard response for successful HTTP requests 404 Not found ­ requested resource could not be found 405 Method not supported ­ request method not supported by that resource 500 Internal server error ­ server error message describing the error returns It returns details about the SEGAP indicated {version} in a RDF/XML format. base = {segap_host}/segap/1.0 The {base} notation will be used through the rest of the API URL specification to reduce the amount of text required for the services URL representation and make the significant part more visible. Notice the 1.0, this is the value of the {version} that we use for the current API specification, meaning SEGAP REST API Version 1.0. 3. Authorization The following services are used for basic authorization purposes regarding the user. url {base}/authorization/login method POST parameters user_id ­ (required) The unique user id user to identify the account. password ­ (required) Hashed/salted password corresponding to the account. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a session for the user and other user related task and information. 5
  • 6. url {base}/authorization/logout method POST parameters No parameters required. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It terminates the user session and user session related tasks. These next services are related only to OAuth2.0, that is used to provide game clients a way to gain access to resources without gaining access to the user password or other private secure data. url {base}/authorization/oauth2.0/authorize method GET parameters response_type ­ (required) The grant type requested, either token or code. client_id ­ (required) The client id that is making the request. redirect_uri ­ Where to redirect the user after authorization has completed. A redirect URI is required for a token flow, but optional for code. If the redirect URI is omitted, the code will be presented directly to the user and they will be invited to enter the information in the client. content Not required. http codes 200 OK ­ standard response for successful HTTP requests 404 Not found ­ requested resource could not be found 405 Method not supported ­ request method not supported by that resource 500 Internal server error ­ server error message describing the error returns There is no direct return value. However, after the user authorizes the client, they will be sent to your redirect URI. Code flow: ­ parameter passed in the query string (after the ? in the URL): 1. code ­ the authorization code, which can be used to attain a bearer token by calling {base}/authorization/oauth2.0/token. ­ example: {redirect_uri}?code=jskajsueu12bdj 6
  • 7. Token flow: ­ these parameters are passed in the URL fragment (after the # in the URL): 1. access_token ­ a token which can be used to make calls to the SEGAP REST API; 2. token_type ­ the type of the token, values: game, supplier, administrator; 3. user_id ­ the SEGAP user ID of the authorized user. ­ example: {redirect_uri}#access_token=jskajsueu12bdj&token_type=game&user_id=y2k In either flow, if an error occurs, including if the user has chosen not to authorize the app, the following parameters will be included in the redirect URI: 1. error ­ an error code per Section 4.1.2.1 of the OAuth 2.0 spec; 2. error_description ­ a user­friendly description of the error that occurred. description Provides authorize support as per RFC 6749 OAuth2.0 specifications. url {base}/authorization/oauth2.0/token method POST parameters code ­ (required) The code acquired by directing users to {base}/oauth2.0/authorize?response_type=code. grant_type ­ (required) The grant type, which must be authorization_code. client_id ­ (required) The client unique identifier. client_secret ­ (required) This is the client secret. redirect_uri ­ Only used to validate that it matches the original {base}/oauth2.0/authorize, not used to redirect again. content Not required. http codes 200 OK ­ standard response for successful HTTP requests 404 Not found ­ requested resource could not be found 405 Method not supported ­ request method not supported by that resource 500 Internal server error ­ server error message describing the error returns It returns information including an access token (access_token), token type (token_type), and SEGAPuser ID (user_id). This info is presented in RDF/XML format. description Provides token support as per RFC 6749 OAuth2.0 specifications. 4. Administration 7
  • 8. These services are not called during a game, they are present only for the resource management. The following services are used for account manipulation operations. These services are also used in order to supply various user related information that will be used for RDF SPARQL related tasks. url {base}/users method POST parameters user_id ­ (required) The unique user id user to identify the account. password ­ (required) Hashed/salted password corresponding to the account. content application/rdf+xml ­ User related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a new user in the system. There are three account types: player, supplier and administrator. The player account can be created by anyone, it is the most basic account type, the one that plays games. The supplier account type can only be create by an administrator account. This account can add games to the system. The administrator account type can be created only by other administrator accounts. He manages the themes and theme related information and it also have full right in managing other kind of accounts and tasks. url {base}/users/{user_id} method PUT parameters new_password ­ Hashed/salted new password corresponding to the account. content application/rdf+xml ­ User related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 8
  • 9. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates user information already present in the system. url {base}/users/{user_id} method DELETE parameters password ­ (required) Hashed/salted password corresponding to the account. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes user information already present in the system. url {base}/users/{user_id} method GET parameters No parameters are required. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ User related information. description It retrieves user information already present in the system. The following services are used to supply and manage game related information such as the theme of the game and game theme(template) related information. 9
  • 10. url {base}/games method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Game related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a new game and it adds it to the system. url {base}/games/{game_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Game related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a game resource already present in the system. url {base}/games/{game_id} method DELETE 10
  • 11. parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes a game resource already present in the system. url {base}/games/{game_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Game related information. description It provides information about a game resource already present in the system. The following services are related to the game specifics such as the theme and mechanics. url {base}/games/{game_id}/themes method POST 11
  • 12. parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It associates an existing theme with the current game. url {base}/games/{game_id}/themes method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Information about all the themes in regard with what is used from those themes in the current game. description It provides information about all the theme resources associated with the game. url {base}/games/{game_id}/themes method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the 12
  • 13. authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of the themes associated with the game. url {base}/games/{game_id}/themes/{theme_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes association with an existing, already associated theme with the current game. url {base}/games/{game_id}/themes/{theme_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. 13
  • 14. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme related information in regard with what is used from that theme in the current game. description It provides information about a theme resource associated with the game. url {base}/games/{game_id}/themes/{theme_id}/entities method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme entity related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates an entity from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/entities method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 14
  • 15. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of the entities created from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/entities method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme entities related information. description It returns all of the entities created from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/entities/{entity_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme entity related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. 15
  • 16. returns It does not return anything special. description It updates an entity from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/entities/{entity_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes an entity from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/entities/{entity_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme entity related information. description It returns the entity from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/variables 16
  • 17. method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme variable related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a variable from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/variables method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of the variables created from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/variables method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, 17
  • 18. values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme variables related information. description It returns all of the variables created from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/variables/{variable_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme variable related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a variable from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/variables/{variable_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. 18
  • 19. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes a variable from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/variables/{variable_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme variable related information. description It returns variable information from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/actions method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme action related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 19
  • 20. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates an action from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/actions method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of the actions created from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/actions method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme actions related information. 20
  • 21. description It returns all of the actions created from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/actions/{action_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme action related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates an action from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/actions/{action_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes an action from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/actions/{action_id} 21
  • 22. method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme action related information. description It returns action information from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/conditions method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme condition related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a condition from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/conditions method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, 22
  • 23. values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of the conditions created from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/conditions method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme conditions related information used by the game. description It returns all of the conditions created from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/conditions/{condition_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme action related information. 23
  • 24. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a condition from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/conditions/{condition_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes a condition from the associated theme for the game. url {base}/games/{game_id}/themes/{theme_id}/conditions/{condition_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 24
  • 25. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme condition related information. description It returns condition information from the associated theme for the game. url {base}/games/{game_id}/tips method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Game tip related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a tip for the game. url {base}/games/{game_id}/tips method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. 25
  • 26. description It removes all of the tips created from the game. url {base}/games/{game_id}/tips method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Game tips related information. description It returns all of the tips created for the game. url {base}/games/{game_id}/tips/{tip_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Game tip related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a tip from the game. url {base}/games/{game_id}/tips/{tip_id} 26
  • 27. method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes a tip from the game. url {base}/games/{game_id}/tips/{tip_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Game tip related information. description It returns tip information from the game. The following services are related with defining game thematics that the games will use to better describe their standing point regarding the category they are in specifics such as actions, parameters, condition and variables. 27
  • 28. url {base}/themes method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a game theme. url {base}/themes/{theme_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Game theme related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a theme with information. url {base}/themes/{theme_id} method DELETE 28
  • 29. parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes a theme from the system. url {base}/themes/{theme_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme related information. description It returns theme information from the system. url {base}/themes/{theme_id}/entities method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. 29
  • 30. content application/rdf+xml ­ Theme entity related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates an entity template for the current theme. url {base}/themes/{theme_id}/entities method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of entities created for the theme. url {base}/themes/{theme_id}/entities method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 30
  • 31. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Game tips related information. description It returns all of the entities created for the current theme. url {base}/themes/{theme_id}/entities/{entity_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme entity related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates an entity for a theme in the system. url {base}/themes/{theme_id}/entities/{entity_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. 31
  • 32. returns It does not return anything special. description It removes an entity from the current theme. url {base}/theme/{theme_id}/entities/{entity_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme entity related information. description It returns information about an entity from the current theme. url {base}/themes/{theme_id}/variables method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme entity related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a variable template information for the current theme. 32
  • 33. url {base}/themes/{theme_id}/variables method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of variables templates created for the theme. url {base}/themes/{theme_id}/variables method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Variables templates related information. description It returns all of the variable templates created for the current theme. url {base}/themes/{theme_id}/variables/{variable_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to 33
  • 34. make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme variable template related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a variable template for the current theme. url {base}/themes/{theme_id}/variables/{variable_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes a variable template from the current theme. url {base}/theme/{theme_id}/variables/{variable_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. 34
  • 35. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme variable template related information. description It returns information about a variable template from the current theme. url {base}/themes/{theme_id}/actions method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme action template related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates an action template information for the current theme. url {base}/themes/{theme_id}/actions method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 35
  • 36. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of actions templates created for the theme. url {base}/themes/{theme_id}/actions method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Action templates related information. description It returns information for all of the action templates created for the current theme. url {base}/themes/{theme_id}/actions/{action_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme action template related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 36
  • 37. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates an action template for the current theme. url {base}/themes/{theme_id}/actions/{action_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes an action template from the current theme. url {base}/theme/{theme_id}/actions/{action_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme action template related information. description It returns information about an action template from the current theme. 37
  • 38. url {base}/themes/{theme_id}/conditions method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme condition template related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates a condition template information for the current theme. url {base}/themes/{theme_id}/conditions method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of the condition templates created for the theme. url {base}/themes/{theme_id}/conditions method GET 38
  • 39. parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Condition templates related information. description It returns information for all of the condition templates created for the current theme. url {base}/themes/{theme_id}/conditions/{condition_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme condition template related information. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a condition template for the current theme. url {base}/themes/{theme_id}/conditions/{condition_id} method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the 39
  • 40. authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes a condition template from the current theme. url {base}/theme/{theme_id}/conditions/{condition_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Theme condition template related information. description It returns information about a condition template from the current theme. 5. REST API Client data collection These services are used by the client to provide information about an ongoing game to SEGAP. url {base}/users/{user_id}/games method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to 40
  • 41. make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Game related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It associates a game with the current user. url {base}/users/{user_id}/games method DELETE parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It removes all of the games associated with the user. url {base}/users/{user_id}/games method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. 41
  • 42. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Action templates related information. description It returns information for all of the games associated with the current user. url {base}/users/{user_id}/games/{game_id}/themes/{theme_id}/entities method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Entities related information. description It  return informations about all entities used in the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/entities/{entit y_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme entity information for the current game. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 42
  • 43. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates an entity for the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/entities/{entit y_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Entity related information. description It retrieves information about an entity from the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/variables method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 43
  • 44. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Variables related information. description It  returns informations about all variables used in the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/variables/{var iable_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme variable information for the current game. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a variable for the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/variables/{var iable_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. 44
  • 45. returns application/rdf+xml ­ Variable related information. description It retrieves information about a variable from the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/actions method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Actions related information. description It returns informations about all actions used in the current game for the indicated theme. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/actions/{actio n_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme action information for the current game. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. 45
  • 46. description It updates an action for the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/action/{action _id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Action related information. description It retrieves information about an action from the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/conditions method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Conditions related information. description It returns informations about all conditions used in the current game for the indicated theme. 46
  • 47. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/conditions/{c ondition_id} method PUT parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Theme condition information for the current game. http codes 200 OK ­ Standard response for successful HTTP requests. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It updates a condition for the current game. url {base}/users/{user_id}/games/{game_id}/theme/{theme_id}/conditions/{c ondition_id} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Condition related information. description It retrieves information about a condition from the current game. url {base}/users/{user_id}/games/{game_id}/history 47
  • 48. method POST parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content application/rdf+xml ­ Create game history related information. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns It does not return anything special. description It creates history information about a current game on demand from client. url {base}/users/{user_id}/games/{game_id}/history method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ History related information. description It retrieves information about the entire history from the current game. url {base}/users/{user_id}/games/{game_id}/history/{date} method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, 48
  • 49. values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ History related information at the specified date. description It retrieves information about the history from the current game at a certain date. 6. SPARQL dataset (rdf files, the rdf database) These services provide the RDF DB used by SEGAP. url {base}/users method GET parameters No parameters are required. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Information related to all of the users. description It retrieves users information already present in the system. url {base}/games method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, 49
  • 50. values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Information about all the games in the system. description It provides information about a game resources already present in the system. url {base}/themes method GET parameters OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 200 OK ­ Standard response for successful HTTP requests. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ Themes related information. description It returns information about all of the themes available. 7. SPARQL endpoint This is the place where SPARQL interrogations can be made. url {base}/sparql method POST 50
  • 51. parameters use_users ­ Values true or false, tells if the users RDF/XML should be used. use_games ­ Values true or false, tells if the games RDF/XML should be used. use_themes ­ Values true or false, tells if the themes RDF/XML should be used. sparql_query ­ the actual SPARQL query that will be executed. OAuth 2.0 related parameters: access_token ­ a token which can be used to make calls to the SEGAP REST API; token_type ­ the type of the token, values: game, supplier, administrator; user_id ­ the SEGAP user ID of the authorized user. content Not required. http codes 201 resource created ­ Request has been fulfilled; new resource created. 400 Bad request ­ The request cannot be fulfilled due to bad syntax. 401 Unauthorized ­ Authentication is possible but has failed. 403 Forbidden ­ Server refuses/not allowing to respond/fulfill a request. 404 Not found ­ Requested resource could not be found. 405 Method not supported ­ Request method not supported by that resource. 500 Internal server error ­ Server error message describing the error. returns application/rdf+xml ­ The result of the query. description Runs SPARQL queries on SEGAP resources. 51