Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart Community APIsSmart Community Data Integration ServiceOrganization ManagementQuery Organization Details

Query Organization Details

Last Updated on : 2023-06-21 07:13:10download

Query the details of a specified organization.Returns information such as organization name, contact person, etc.

API address

GET: /v1.0/iot-02/community/structure

Request parameter

Parameter name	Type	IN	Required	Description
structure_id	String	query	true	The ID of a specified organization.

Return parameter

Parameter name	Type	Description
result	HighwayStructureDetailResponse

Description of result

Parameter name	Type	Description
structure_id	String	The ID of a specified organization.
parent_structure_id	String	The parent organization. An empty value indicates the root organization.
structure_name	String	The name of a specified organization.
address_code	String	Address (the code of the province, city, district, and street). For more information, visit http://www.stats.gov.cn/english/.
address_detail	String	The detailed address.
contact	String	The contact name.
contact_mobile	String	The contact person's phone number.
contact_email	String	The contact person's email address.

Request example

GET: /v1.0/iot-02/community/structure?structure_id=137209008422933xxxx

Return example

{
    "businessLicense": "",
    "contactMobile": "1345555xxxx",
    "addressCode": "230000,230200,230205,230205006,230205006003",
    "contactEmail": "",
    "level": 2,
    "structureName": "Test Organization",
    "structureId": "138445394780829xxxx",
    "aliasCode": "vQ2cd",
    "parentStructureId": "138278031145626xxxx",
    "aliasCodePath": "pSNwE44boovQ2cd",
    "addressDetail": "111",
    "children": [
        {
            "structureName": "9789",
            "structureId": "138448681041504xxxx"
        },
        {
            "structureName": "test",
            "structureId": "138526787284608xxxx"
        }
    ],
    "contact": "Test Personnel",
    "addressName": "Ang'angxi District, Qiqihar City, Heilongjiang Province"
}

Error code

For more information, see error code.

Prev DocAdd Organization

Next DocQuery Sub-Organization