MAPI Manual

NAME

GET_ORG

FUNCTION

Get an organisation

SYNOPSIS

DESCRIPTION

This function allows admins and account managers to get the profile of an organisation.

Required Parameters

* action: GET_ORG.
* db_partition_id: partition ID of the database. It specifies in which partition of the database the organisation is stored. For more information about the list of partitions, see LIST_DBPS.
* org_id: organisation ID.

RETURN DATA

The response contains the following attributes:
* org_id: organisation ID.
* db_partition_id: partition ID of the database in which the organisation is stored.

* org_name: name of the organisation.

* org_type: organisation type.

* language_id: ID of the system language.
* org_description: description of the organisation.
* office_address_1: office address.
* office_address_2: office address.
* office_suburb: office suburb.
* office_state: office state.
* office_post_code: office postcode.
* office_phone_number: office phone number.
* office_fax_number: office fax number.
* abn_acn: ABN/ACN of the organisation.
* web_site: website of the organisation.
* account_email_address: email address of the organisation.
* postal_address_1: postal address.
* postal_address_2: postal address.
* postal_suburb: postal suburb.
* postal_state: postal state.
* postal_post_code: postal postcode.
* mcp_integration_partner_id: the partner ID of the organisation.
* creat_dt: timestamp when the organisation was created.

* status:

* creator_mcp_user_id:

* lastupdate_mcp_user_id:

* last_update_dt:

ROLE PERMITTED

Admin, Account manager

EXAMPLES

The following example shows a successful HTTP GET request and response.

Request:

http://app02.yvntech.com/MapIHttpS/MapIS?action=GET_ORG&db_partition_id=1&org_id=1000&login_name=AccountManager%40example.com&login_passwd=1111

Response:

<result tftype='1' infotype='0'>
    <resultset name="sys_org">
        <row>
            <field name="org_id">1000</field>
            <field name="db_partition_id">1</field>
            <field name="org_name">'</field>
            <field name="org_type">MCPTYPE_PERSONAL</field>
            <field name="language_id">0</field>
            <field name="org_description">MCP system enterprise level test</field>
            <field name="office_address_1" />
            <field name="office_address_2" />
            <field name="office_suburb" />
            <field name="office_state" />
            <field name="office_post_code" />
            <field name="office_phone_number" />
            <field name="office_fax_number" />
            <field name="abn_acn" />
            <field name="web_site" />
            <field name="account_email_address" />
            <field name="postal_address_1" />
            <field name="postal_address_2" />
            <field name="postal_suburb" />
            <field name="postal_state" />
            <field name="postal_post_code" />
            <field name="mcp_integration_partner_id">0</field>
            <field name="status">MCPTYPE_ACTIVE</field>
            <field name="creator_mcp_user_id">0</field>
            <field name="creat_dt">2013-11-06 11:48:22</field>
            <field name="lastupdate_mcp_user_id">0</field>
            <field name="last_update_dt">0000-00-00 00:00:00</field>
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_DBPS, LIST_ORGS

Mweb v2.0 YVNTECH 2014