Create Album

This API operation creates a user's private gallery album.

URL / Endpoint

POST /v1/Pictures/CreateAlbum

POST /v1/Groups/Pictures/CreateAlbum (See Group manager)

Request

Property	Type	Description
`Name`	string	Required. The name of the album. The maximum length is `20`.
`Description`	string	The description you want to give to the album.
`PinNumber`	string	The PinNumber of the album. It must be `4` characters in length and can be any combination of letters and numbers and should be impossible to guess. The PINPrice is required when setting this.
`PINPrice`	decimal	The price (in credits) of the album when using the PinNumber. When setting the PINPrice the PinNumber is required.

Group manager

If the authenticated user is the manager of a group, the user can impersonate another member of the group. This allows the manager to perform tasks of other group members without having to authenticate as them.

The request can be build in the same way as the regular request, but targeted towards the Group manager endpoint. Additionally, it has the following extra parameters:

Property	Type	Description
`UserID`	integer	Required. The ID of a member in the group that will be impersonated for this request.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body.

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.

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 the following scope:

Scope
`profile_gallery`

Samples

POST method

https://api-sandbox.adultwork.com/v1/Pictures/CreateAlbum

Authorization: bearer {your-access-token}
{
    "Name" : "Look at my pictures",
    "Description" : "My new album!"
}

POST as Group manager

https://api-sandbox.adultwork.com/v1/Groups/Pictures/CreateAlbum

Authorization: bearer {your-access-token}
{
    "UserID": 123456,
    "Name" : "Look at my pictures",
    "Description" : "My new album!"
}

Response

Property	Type	Description
`UserID`	integer	The ID of the AdultWork.com user profile. This is the primary means of identifying a profile.
`AlbumID`	integer	The ID of the album.
`AlbumName`	string	The name of the album.
`AlbumDescription`	string	The description of the album.
`AlbumSize`	integer	The amount of pictures in the album.
`Sequence`	integer	The sequence to display the album.
`ThumbUrl`	string	The ThumbURL of the album.
`PictureIDs`	string	A comma delimited string of IDs of the pictures in the album.

Response Sample

The following example shows a sample returned by the API.

JSON
XML

{
    "UserID": 123456,
    "AlbumID": 1,
    "AlbumName": "Look at my pictures",
    "AlbumDescription": "My new album!",
    "AlbumSize": 0,
    "Sequence": 0,
    "ThumbUrl": null,
    "PictureIDs": null
}

<PictureAlbum xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Pictures">
    <AlbumDescription>My new album!</AlbumDescription>
    <AlbumID>1</AlbumID>
    <AlbumName>Look at my pictures</AlbumName>
    <AlbumSize>0</AlbumSize>
    <PictureIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <Sequence>0</Sequence>
    <ThumbUrl i:nil="true" />
    <UserID>123456</UserID>
</PictureAlbum>