Lookup Genders v2.0Beta

The Lookup Genders endpoint allows a developer to retrieve valid gender values that may be used for Update Customer requests as well Add Dependent and Update Dependent requests.

GET /v2.0/lookups/customer/genders

Request

The request will get a list of genders.

Response

200

OK

Returns a Lookup resource wrapped in an ApiListResponse envelope.

Response Body

The endpoint returns our ApiListResponse envelope. The data property of the response will contain a Lookup resource.

Sample

{
    "message": "The operation succeeded!",
    "notifications": [],
    "numberOfRecords": 3,
    "data": [
        {
            "value": "Female",
            "sortOrder": 1
        },
        {
            "value": "Male",
            "sortOrder": 2
        },
        {
            "value": "Other",
            "sortOrder": 3
        }
    ]
}

Errors

The standard error responses apply.

401

Unauthorized

When authentication fails.

403

Forbidden

When authorisation fails.