Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 1.19 KB

File metadata and controls

68 lines (42 loc) · 1.19 KB

Profile

Allowed HTTP methods

Method Description
GET get the profile object
PUT update the profile object

Note

See RFC 2616 for more details on HTTP methods semantics

Listing

.. http:get:: /profile/

Gets the user profile. Note that profile is a single object so the API does not return a list.

statuscode 200:no error

Example request:

.. literalinclude:: dumps/request_profile
    :language: http


Example response:

.. literalinclude:: dumps/response_profile
    :language: javascript

Editing

.. http:put:: /profile/

statuscode 200:no error

Edits a user profile. (We want to change the company name for example)

Example request:

.. literalinclude:: dumps/request_profile_update
    :language: http


Example response:

.. literalinclude:: dumps/response_profile_update
    :language: javascript

Schema

.. literalinclude:: dumps/response_profile_schema
    :language: javascript