API Documentation

wwt_api_client Package

Classes

APIRequest(client)

A base class represent various WWT API requests.

APIResponseError(value)

Raised when the API returns an HTTP error.

Client([api_base])

The main object for accessing the WWT web services.

InvalidRequestError(value)

Raised when an API request is not in a valid state

ShowImageRequest(client)

Request a WTML XML document suitable for showing an image in a client.

TileImageRequest(client)

Tile a large image on the server and obtain a WTML XML document suitable for displaying it in a client.

wwt_api_client.communities Module

Interacting with the WWT Communities APIs.

Classes

CommunitiesAPIRequest(communities_client)

A base class for WWT Communities API requests.

CommunitiesClient(parent_client[, …])

A client for WWT Communities API requests.

CreateCommunityRequest(communities_client)

Create a new community.

DeleteCommunityRequest(communities_client)

Delete a community.

GetCommunityInfoRequest(communities_client)

Get information about the specified community.

GetLatestCommunityRequest(communities_client)

Get information about the most recently created WWT Communities.

GetMyProfileRequest(communities_client)

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

GetProfileEntitiesRequest(communities_client)

Get “entities” associated with the logged-in user.

IsUserRegisteredRequest(communities_client)

Asks whether the logged-in Microsoft Live user is registered with the WWT Communities system.

wwt_api_client.enums Module

Various enumerations.

From wwt-website/WWTMVC5/Models/Enum.cs

Classes

CategoryType

An enumeration.

CommunityType

An enumeration.

ContentType

An enumeration.

EntityType

An enumeration.

HighlightType

An enumeration.

PermissionsTab

Weird name inherited from wwt-website.

UserRole

An enumeration.