Record Context

Aaron Rendell
Aaron Rendell
  • Updated

GetPrimaryIdentifierByConfigId

Each configuration demographic’s have a primary Identifier assigned, this api call simple will return that information which can then be used in conjunction with GetDemographicInfomation


GET /api/external/configuration/GetPrimaryIdentifierByConfigId/{ConfigurationId}

200 Success

{

  "httpStatusCode": 0,

  "errors": [

    "string"

  ],

  "demographicPrimaryIdentifier": "string"

}

 


400 Bad Request A 400 error will be presented in the status code and errors will be returned

500 Server Error A 500 error will be presented in the status code and errors will be returned

 

GetDemographicInformation

Provides demographic information about a Filer entity in multiple formats, enabling its use for routing operations or for retrieving a comprehensive list of details about the entity.

POST: /api/external/demographic/getdemographicinformation

Example Request Body:

 

{

  "organisationId": 0,

  "user": "string",

  "configurationId": 0,

  "searchBy": "string",

  "searchValue": "string"

}

 

 

200 Success

 

{

  "httpStatusCode": 0,

  "errors": [

    "string"

  ],

  "demographicItems": [

    {

      "key": "string",

      "value": "string"

    }

  ],

  "demographicMetadata": [

    {

      "key": "string",

      "value": "string",

      "dataType": "string"

    }

  ]

}

 


400 Bad Request A 400 error will be presented in the status code and errors will be returned

500 Server Error A 500 error will be presented in the status code and errors will be returned