Jump to

• Request
• Response

Find Demographics details

get

/ohfapi/cg/v3.3/demographics/{demographicstype}

This end point finds the matching values for the corresponsding Demophics Type provided.If the operator is null, then it defaults to equals. If limit is null then defaults to 100.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• demographicstype: string
  Demographics Type

  Allowed Values: [ "Ethnicity", "Race", "Gender", "MaritalStatus", "City", "State", "ZipCode", "County", "Country", "Datasource", "DatasourceNameCode" ]

Query Parameters

• code(optional): array
  Collection Format: multi

  Demographics Type Search Parameter

  • [0]: string

  {
      "name":"code",
      "in":"query",
      "description":"Demographics Type Search Parameter",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• codeOperator(optional): string
  Demographics Type Search Operator

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]
• limit(optional): integer(int32)
  Limit
• name(optional): array
  Collection Format: multi

  Demographics Type Search Parameter

  • [0]: string

  {
      "name":"name",
      "in":"query",
      "description":"Demographics Type Search Parameter",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• nameOperator(optional): string
  Demographics Type Search Operator

  Allowed Values: [ "Equals", "StartsWith", "Contains", "NotEquals" ]

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Demographics
  Model for a Demographics Query Builder

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

Nested Schema : Demographics

Type: object

Model for a Demographics Query Builder

Show Source

• code(optional): string
  Code of the search result
• id(optional): string
  Unique Identifier
• name(optional): string
  Name of the search result

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Code of the search result"
        },
        "name":{
            "type":"string",
            "description":"Name of the search result"
        },
        "id":{
            "type":"string",
            "description":"Unique Identifier"
        }
    },
    "description":"Model for a Demographics Query Builder"
}

400 Response

Invalid parameters supplied

404 Response

No data found

Back to Top