GET ExternalReportingEntities
Description
The External Reporting Entities API facilitates the retrieval of an up-to-date roster of active reporting entities linked to a designated Parent Account. Each reporting entity is uniquely identified by a distinct ID, ensuring seamless management and tracking.
Endpoint
• Endpoint: <environment base url>/v1.0/api/Forms/ExternalReportingEntities
• Method: GET
Request
• Authorization Header: Bearer token
• Type: string
Response Structure
The API response contains a list of reporting entities in the specified format. Success Response - 200 OK The API will respond with a list of active reporting entities and their information.
Sample Response:
{
"data": [
{
"id": "0000022222",
"name": [
{
"text": "ABC",
"language": "EN"
}
]
}
// Additional reporting entities may be listed here
]
}
No Content Response - 204 No Content If no reporting entities are found for the provided Parent Account, the API will respond with a "No Content" status. Error Responses
4XX response:
{
"errors": [
{
"field": "string",
"fieldValue": "string",
"message": "string"
}
]
}
5XX response:
{
"errors": [
{
"field": "string",
"fieldValue": "string",
"message": "string",
“traceId”: “String”
}
]
}
• 400 Bad Request: The request was invalid or missing required parameters.
• 401 Unauthorized: The user's authentication is not valid.
Sample Response
{
"data": [
{
"id": "EX0001",
"name": [
{
"text": "John Doe",
"language": "EN"
}
]
},
{
"id": "EX0002",
"name": [
{
"text": "Example Project 1",
"language": "EN"
}
]
},
{
"id": "EX0003",
"name": [
{
"text": "Sample Data 2",
"language": "EN"
}
]
},
{
"id": "EX0004",
"name": [
{
"text": "Acme Corporation",
"language": "EN"
}
]
},
{
"id": "EX0005",
"name": [
{
"text": "Test Case 5",
"language": "EN"
}
]
},
{
"id": "EX0006",
"name": [
{
"text": "Demo Example 6",
"language": "EN"
}
]
},
{
"id": "EX0007",
"name": [
{
"text": "Company XYZ",
"language": "EN"
}
]
}
]
}
Sample request [CURL]
curl --location 'https://exampleapi.example.net/v1.0/api/Forms/ExternalReportingEntities' \
--header 'Authorization: Bearer exampleToken1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz' \
--header 'Cookie: incap_ses_1607_1234567=exampleCookieValue1; incap_ses_76_1234567=exampleCookieValue2; incap_ses_8216_1234567=exampleCookieValue3; nlbi_1234567=exampleCookieValue4; visid_incap_1234567=exampleCookieValue5'