* "computer_type" refers to the type of computer the user has ordered (basic or advanced model). THIS VALUE MUST BE PROVIDED.

Transcription

1 AKERSHUS FYLKESKOMMUNE Elev-PC godkjenningsportal v1.0.1 DEFINITIONS "Provider" in this document refers to Akershus Fylkeskommune. "Consumer" refers to the user of the the API (Leverandør). CHANGE LOG v1.0.1 *** Three new fields has been added to an order: *** * "registered" refers to the datetime (or date if datetime is not available) when the order was placed at the consumers website. THIS VALUE MUST BE PROVIDED. * "computer_type" refers to the type of computer the user has ordered (basic or advanced model). THIS VALUE MUST BE PROVIDED. * "status_comment" refers to a message from the provider regarding a waiting or rejected order. This will only be present if the order has a status of 1 (waiting) or 2 (rejected) AVAILABLE METHODS Uri Parameters /api/orders Lists all orders /api/orders/status Lists status codes for all orders /api/orders/comments Lists all comments for all orders /api/orders POST Creates a new order (token included in POST body) /api/orders/[id] Returns an order /api/orders/[id] PUT Updates an order (token included in PUT body) /api/orders/[id] DELETE Deletes an order /api/orders/[id]/status Return the status code of an order /api/orders/[id]/comments POST Creates a new

2 comment for an order (token included in POST body) /api/orders/[id]/comments Lists all comments for an order NOTIFICATIONS Optional. Two types of notifications may be received: (1) Updated order status (e.g. an order is accepted), (2) New comment ERROR CODES Code 400 Bad input parameter (error message whould indicate which one and why) 401 Unauthorized access (probably missing access token) 404 Resource not found All errors responds with a JSON formatted array (with "errors" as key). Example: INPUT "errors":["no lastname provided","no birthdate provided"]} The methods accepts input as POST/PUT data in two forms: Either as POST/PUT body content (e.g. "firstname=frida&lastname=holta& =frida@holta.no) or as JSON encoded arrays (e.g. '"firstname":"frida","lastname":"holta"," ":"frida@holta.no"}') STATUS OF ORDERS 0 = Unprocessed by RFK 1 = Marked for waiting by RFK 2 = Rejected by RFK 3 = Accepted/confirmed by RFK YEAR GROUPS 1 = Vg1 2 = Vg2 3 = Vg3 4 = Voksenrett COMPUTER TYPES 10 = Grunnmodell / Standard model 20 = Avansertmodell / Advanced model EXAMPLES

3 --- /api/orders Returns an array of all registered orders [ "id":34, "registered":" :33:01" "firstname":"frida", "lastname":"holta", "address":"kringjå 7", "postal_code":4340, "city":"bryne", "mobile": , " ":"frida@holta.no", "birthdate":" ", "parent":"helge Holta", "school":"bryne VGS", "year_group":1, "status":1... /api/orders/status Returns an array of the status of all registered orders Comment "status_comment" will only be provided if status is Waiting (status code 1) or Rejected (status code 2) [ "id":34, "status":0 "id":39, "status":1, "status_comment":"eleven står på venteliste på Vågen VGS, som har egen PC-ordning" "id":42, "status":2,

4 PC tidligere" "status_comment":"eleven har gått Vg1 og fått tilbud om "id":45, "status":3 /api/orders/comments Returns all comments for all orders [ "order_id": 4, "firstname":"heine", "lastname":"grov", " ":"heine@grov.no", "content":"denne ordren er ok. -BT"... /api/orders POST Post a new order Request "id":34,"firstname":"frida","lastname":"holta","birthdate":" ","token":"[ token]"} Response HTTP/ Created Fields id (required) registered (datetime/date, required) name (required) address (required) postal_code (required) city (required) birthdate (required) parent (optional) mobile (optional) (required) school (required) year_group (required, 1 = Vg1, 2-3 = Vg2/Vg3, 4 = Voksenrett) computer_type (required, 10 = Grunnmodell, 20 =

5 Avansertmodell) PC tidligere" /api/orders/[id] Returns an order "id":34, "updated":" :22:22", "registered":" :35:22", "firstname":"frida", "lastname":"holta", "address":"holmegata 23", "postal_code":"4340", "city":"bryne", "mobile": , "birthdate":" ", "parent":"frode Holta", "school":"bryne VGS", "year_group":1, "computer_type":10, "status":2, "status_comment":"eleven har gått Vg1 og fått tilbud om } /api/orders/[id] PUT Update an order Request "firstname":"frida","lastname":"holta","birthdate":" ","token":"[token]" } HTTP/ No content (an order existed and was updated) HTTP/ Created (an order was created) Response /api/orders/[id] DELETE Deletes an order HTTP/ No content

6 /api/orders/[id]/status Returns the status of an order 0 (possible return values: 0, 1, 2, 3) /api/orders/[id]/comments POST Post a new comment Request "firstname":"heine","lastname":"grov"," ":"heine@grov.no","content":"den ne er ok.","token":"[token]"} Response HTTP/ Created /api/orders/[id]/comments Returns all comments for an order [ "order_id":34, "firstname":"heine", "lastname":"grov", " ":"heine@grov.no", "content":"denne ordren er ok"... NOTIFICATION EXAMPLES Notifications will be posted using the HTTP POST verb. These notifications are optional (they will be posted if urls have been provided by the consumer). (Consumer may provide a token that should be sent with each POST request. Consumer should also limit connections to only allow requests from the Providers IP address.)

7 Updated status notification: (provided by consumer, e.g. " Sample data "id":34,"status":3} New comment notification: (provided by consumer, e.g. " Sample data ne er ok."}