GetMyProfileRequest

class wwt_api_client.communities.GetMyProfileRequest(communities_client)

Bases: CommunitiesAPIRequest

Get the currently logged-in user’s profile information.

The response is JSON, looking like:

{
  'ProfileId': 123456,
  'ProfileName': 'Firstname Lastname',
  'AboutProfile': '',
  'Affiliation': 'Affil Text',
  'ProfilePhotoLink': '~/Content/Images/profile.png',
  'TotalStorage': '5.00 GB',
  'UsedStorage': '0.00 B',
  'AvailableStorage': '5.00 GB',
  'PercentageUsedStorage': '0%',
  'IsCurrentUser': True,
  'IsSubscribed': False
}

Methods Summary

invalidity_reason()	Check whether the parameters of this request are valid.
make_request()	Generate a requests.Request from the current parameters.

Methods Documentation

invalidity_reason()

Check whether the parameters of this request are valid.

Returns:

reasonstring or None

If None, indicates that this request is valid. Otherwise, the returned string explains what about the request’ parameters is invalid.

Examples

You can manually check if a request is correctly set up:

>>> from wwt_api_client import Client
>>> req = Client().show_image('http://example.com/space.jpg', 'My Image')
>>> assert req.invalidity_reason() is None

make_request()

Generate a requests.Request from the current parameters.

This method returns a requests.Request object ready for sending to the API server.

Returns:

requestrequests.Request object

The HTTP request.

Examples

Get the URL that will be accessed for a request:

>>> from urllib.parse import urlparse
>>> from wwt_api_client import Client
>>> req = Client().show_image('http://example.com/space.jpg', 'My Image')
>>> parsed_url = urlparse(req.make_request().prepare().url)
>>> print(parsed_url.path)
/WWTWeb/ShowImage.aspx