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.