NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve list of genders

get

/spms/v1/configurations/genders

This is to retrieve a list of all genders

Request

Supported Media Types

• application/json

Query Parameters

• limit: integer(int32)
  Paging limit
• offset: integer(int32)
  Paging offset

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieves list of Genders

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Oracle Response object
  Title: Oracle Response object

  The object returned in Oracle Standard when function is executed successfully

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/genderList"
    }
}

Nested Schema : Oracle Response object

Type: object

Title: Oracle Response object

The object returned in Oracle Standard when function is executed successfully

Show Source

• count(optional): integer
  Example: 18
• hasMore(optional): boolean
  Example: true
• items(optional): array items
• limit(optional): integer
  Example: 2
• offset(optional): integer
  Example: 0

{
    "title":"Oracle Response object",
    "description":"The object returned in Oracle Standard when function is executed successfully",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "example":18
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "limit":{
            "type":"integer",
            "example":2
        },
        "offset":{
            "type":"integer",
            "example":0
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/genders"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object genders
  Genders

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/genders"
    }
}

Nested Schema : genders

Type: object

Genders

Show Source

• code(optional): string
  Minimum Value: 1

  Maximum Value: 100

  Pattern: ^[a-zA-Z ]*$

  Example: F
• name(optional): string
  Minimum Value: 1

  Maximum Value: 200

  Pattern: ^[a-zA-Z ]*$

  Example: Female

{
    "description":"Genders",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "minimum":1,
            "maximum":100,
            "pattern":"^[a-zA-Z ]*$",
            "example":"F"
        },
        "name":{
            "type":"string",
            "minimum":1,
            "maximum":200,
            "pattern":"^[a-zA-Z ]*$",
            "example":"Female"
        }
    }
}

204 Response

No genders are available

401 Response

You are not authorized to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

The method is not available

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

The media supplied is not supported

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occurred while processing this request

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top