v2 > Lookups > ReportingBodiesLookup

Lookup Origin supported reporting bodies.

  • URL

    /connect/v2/reporting-bodies

  • Method:

    GET

  • URL Params

Param Type Required Description Domain of value
locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
pageNumber number Yes The page number the search result will start from Positive integer greater than 0
pageSize number Yes The maximum number of result by page Integer between 1 and 100
keyword string No Return reporting bodies matching a keyword Any String (default value '*')

  • Sample URL

    /connect/v2/reporting-bodies?locale=en&pageNumber=1&pageSize=10&keyword=john%20smith

  • Request :

    The request has no body.

  • Response :
Field Type Presence Description Domain of value
status object Always The execution status A status object
status.state string Always The state of execution 'SUCCESS' or 'ERROR'
status.code string On error The general error code and message See Errors reference
status.messages[] array of string On error List of errors causes A validation message or other causes
result object On success The execution result A result object
result.entityType string On success The type of entity this result is about 'REPORTING_BODY'
result.searchInfo object On success Informations about the search result pages A searchInfo object
result.searchInfo.numberOfElements object On success The total number of elements found A positive integer
result.searchInfo.numberOfPages object On success The total number of pages NumberOfElements / pageSize
result.data[] array of object On success The actual search result: a list of standards Array of standard object
result.data[].originId string On success The reporting body unique origin ID A string
result.data[].name string On success The name of this reporting body A string
result.data[].email string On success The email of this reporting body A string
connectRequest object Always The exact request sent that produced this response A ReportinBodiesLookup request

  • Sample Response (Success):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"REPORTING_BODY",
    "searchInfo":{
      "numberOfElements":"2",
      "numberOfPages":"1"
    },
    "data":[
      {
        "originId": "801d09d3-3964-4792-82b3-65109ae1a3fd",
        "name": "Reporting Body Name 1",
        "email": "rb1@example.tld"
      },
      {
        "originId": "b5b1e2ab-9b1c-11e8-a59f-0a82ed05d48a",
        "name": "Reporting Body Name 2",
        "email": "rb2@example.tld"
      }
    ]
  },
  "connectRequest":{
    "locale":"en",
    "pageNumber":"1",
    "pageSize":"2",
    "searchCriteria": [
      {
        "name": "KEYWORD",
        "value": "*"
      }
    ]
  }
}

  • Sample Response (Error):

    HTTP Code : 400, 500

{
    "status": {
        "state": "ERROR",
        "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
        "messages": [
            "Request has invalid value '0' for field pageNumber. Allowed value(s) : [positive integer not equal zero]",
            "Request has invalid value 'es' for field locale. Allowed value(s) : [de, es_MX, en, fr, zh_CN]"
        ]
    },
    "connectRequest": {
        "locale": "es",
        "searchCriteria": [
            {
                "name": "KEYWORD",
                "value": "*"
            }
        ]
    }
}

results matching ""

    No results matching ""