Get Dashboard

This API operation returns a user's dashboard.

URL / Endpoint

GET /v1/Dashboard/GetDashboard

Request

Property Type Description

Property	Type	Description
`Options`	integer	Required The bitmask representing the dashboard options you want to retrieve: UnreadEmails = 1, UnreadEscortBookingCount = 2, CurrentCreditsBalance = 4, BlacklistedUserIds = 8, Hotlists = 16 Eg pass '?options=14' to retrieve UnreadEscortBookingCount, CurrentCreditsBalance and BlacklistedUserIds ( = 8+4+2)

Options

integer

Required The bitmask representing the dashboard
options you want to retrieve:

UnreadEmails = 1,
UnreadEscortBookingCount = 2,
CurrentCreditsBalance = 4,
BlacklistedUserIds = 8,
Hotlists = 16

Eg pass '?options=14' to retrieve
UnreadEscortBookingCount,
CurrentCreditsBalance and
BlacklistedUserIds
( = 8+4+2)

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

This endpoint has the following optional headers:

Headers	Value
`X-MaskImages`	`1`	What's this?

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Scopes

This endpoint requires different scopes depending on the input parameter Options.

Option	Scope
UnreadEmails	`account_communications`
UnreadEscortBookingCount	`account_escort_bookings`
CurrentCreditsBalance	`account_credits_history`
Hotlists	`profile_hotlist`
BlacklistedUserIds	`profile_blacklist`

Samples

GET method

https://api-sandbox.adultwork.com/v1/Dashboard/GetDashboard?options=31

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`Dashboard`	aws:Dashboard	The dashboard data.

Response Sample

The following example shows a sample dashboard returned by the API.

JSON
XML

{
  "Profile": {
    "UserID": 123456,
    "Nickname": "JosepheneBlogs",
    "ImageSafe": true,
    "ImageThumbnailURL": "//cdn.adultwork.com/images/t/123456_1.jpg",
    "ImageMediumURL": "//cdn.adultwork.com/images/i/123456_1.jpg",
    "ImageLargeURL": "//cdn.adultwork.com/images/f/123456_1.jpg",
    "ImageSquareURL": "//cdn.adultwork.com/images2/sq/40/123456_1.jpg",
    "UserTypeID": 1,
    "UserType": "Offering Services"
  },
  "UnreadEmails": 1,
  "UnreadEscortBookingCount": 0,
  "CurrentCreditsBalance": 366,
  "BlacklistedUserIds": [],
  "Hotlists": [
    {
      "ListName": "My first hotlist",
      "MemberCount": 2
    },
    {
      "ListName": "My second hotlist",
      "MemberCount": 3
    }
  ]
}

<Dashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
    <BlacklistedUserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <CurrentCreditsBalance>366</CurrentCreditsBalance>
    <Hotlists xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.Models.HotLists">
        <d2p1:HotListDetailsForDashboard>
            <d2p1:ListName>My first hotlist</d2p1:ListName>
            <d2p1:MemberCount>2</d2p1:MemberCount>
        </d2p1:HotListDetailsForDashboard>
        <d2p1:HotListDetailsForDashboard>
            <d2p1:ListName>My second hotlist</d2p1:ListName>
            <d2p1:MemberCount>3</d2p1:MemberCount>
        </d2p1:HotListDetailsForDashboard>
    </Hotlists>
	<Profile>
	<ImageDescription>Look at me :-)</ImageDescription>
<ImageLargeURL>//cdn.adultwork.com/images/f/123456_1.jpg</ImageLargeURL>
<ImageMediumURL>//cdn.adultwork.com/images/i/123456_1.jpg</ImageMediumURL>
<ImageSquareURL>//cdn.adultwork.com/images2/sq/40/123456_1.jpg</ImageSquareURL>
<ImageSafe>true</ImageSafe>
<ImageThumbnailURL>//cdn.adultwork.com/images/t/123456_1.jpg</ImageThumbnailURL>
	<Nickname>JosepheneBlogs</Nickname>
	<UserID>123456</UserID>
	<UserType>Offering Services</UserType>
        <UserTypeID>1</UserTypeID>
   	</Profile>
    <UnreadEmails>1</UnreadEmails>
    <UnreadEscortBookingCount>0</UnreadEscortBookingCount>
</Dashboard>