Get Genders

method: getGenders

This method returns a list of Genders and their associated GenderID. You can specify which genders to exclude.

URL / Endpoint

GET /v1/lists/getGenders

Request

PropertyTypeDescription
HideStraight boolean If set to true, the "Male and Female" couple gender will be excluded. Default is false.
HideGay boolean If set to true, the "Male and Male" and "Female and Female" couple genders will be excluded. Default is false.
HideCouples boolean If set to true, all couples genders will be excluded. Default is false.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body, or 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.

Authentication

Your API-Key is required with every request and can be passed in as a header or a query-string parameter. Don't have an API-Key? Get one now.

Samples

GET method

https://api-sandbox.adultwork.com/v1/lists/getGenders
  ?apiKey={your-api-key}
  &HideGay=true

Response

PropertyTypeDescription
Genders Array of aws:Gender List of Genders.

Response Sample

The following example returns a list of genders with HideGay criteria supplied in the request.

[
    {
        "GenderID":1,
        "GenderName":"Male"
    },
    {
        "GenderID":2,
        "GenderName":"Female"
    },
    {
        "GenderID":3,
        "GenderName":"Couple MF"
    }
]
<ArrayOfGender xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Gender>
      <GenderID>1</GenderID>
      <GenderName>Male</GenderName>
   </Gender>
   <Gender>
      <GenderID>2</GenderID>
      <GenderName>Female</GenderName>
   </Gender>
   <Gender>
      <GenderID>3</GenderID>
      <GenderName>Couple MF</GenderName>
   </Gender>
</ArrayOfGender>