This API operation creates a scheduled DirectCam show for the user.
POST
/v1/DirectCam/ScheduleShow
POST
/v1/Groups/DirectCam/ScheduleShow
(See Group manager)
Property | Type | Description |
---|---|---|
ScheduledDate |
datetime | Required. The date of when the show is taking place. Note: Must be in the future. The minutes can only be one of the following: 00 , 15 , 30 , 45 . Format: YYYY-MM-dd HH:mm . |
EstimatedLengthInMinutes |
integer | Required. The estimated amount of minutes the show will take. Possible values are: 5 , 10 , 15 , 30 , 45 , 60 , 90 , 120 . Make sure it does not conflict with existing scheduled shows. See the getScheduledShowsForUser endpoint. |
Title |
string | Required. The maximum length is 50 characters. |
WebcamCategoryID |
integer | Required. The DirectCam category ID. See the getDirectcamCategories method. |
Summary |
string | Required. This should state the theme of your show, e.g. "Sindy does food sex" or "Jenny's first day in the office". The maximum length is 50 characters. |
Image |
string | Required. A picture that relates to the show you are scheduling. This has to be a valid 64 base encoded string of an image. |
Details |
string | Describe in full what will be on offer in the show and what you have planned to take place. e.g. "Jenny plans to seduce her boss on her first day in the office. Starting off with some fully clothed fun, a slow and sensual strip tease, ending with two extremely sexy people satisfying each other.". It supports BBCode. |
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. |
Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body.
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.
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.
This endpoint requires the following scope:
Scope |
---|
account_webcam_bookings |
Property | Type | Description |
---|---|---|
ScheduleID |
integer | ID of the direct cam scheduled show. |
Title |
string | The title of the DirectCam Scheduled Show. |
Summary |
string | The summary of the DirectCam Scheduled Show. |
Details |
string | The details of the DirectCam Scheduled Show. |
EstimatedLengthInMinutes |
integer | The estimated duration of the DirectCam Scheduled Show. |
CategoryID |
integer | The ID of the Child category. See the getDirectCamCategories method. |
ScheduledDate |
datetime | The scheduled date of when the show will take place. |
Interests |
integer | The amount of users who have set the option to receive an email or sms a period of time before the show starts. |
DateBlocked |
boolean | Indicates if this show rescheduled. If this value is true it cannot be rescheduled. |
Credits |
decimal | The price per minute (in Credits) of the show. |
UserID |
integer | The ID of the AdultWork.com user profile. This is the primary means of identifying a profile. |
Nickname |
string | The nickname of the user. |
ProfileRatings |
aws:ProfileRatings | The member's AdultWork.com Ratings score in detail. |
Note: Performers will never be in any of the four main parent categories alone and will always be part of one of their respective child categories.
The following example returns a successful scheduled show.