MAPI Manual

NAME

UPDATE_ORG

FUNCTION

Update an organisation

SYNOPSIS

action: UPDATE_ORG
db_partition_id
org_id
org_name
language_id
org_description
office_address_1
office_address_2
office_suburb
office_state
office_post_code
office_phone_number
office_fax_number
abn_acn
wet_site
account_email_address
postal_address_1
postal_address_2
postal_suburb
postal_state
postal_post_code
mcp_integration_partner_id

login_name 
login_passwd 
or 
login_name 
session_id 
or 
device_id 

DESCRIPTION

This function allows admins and account managers to update an existing organisation. Both GET and POST methods can be used to perform the request.

Required Parameters
* action: specifies the requested function. Sets to UPDATE_ORG.
* db_partition_id: specifies the partition ID of the database in which the organisation is stored. For more information about the list of partition IDs, see LIST_DBPS.
  Note: The database partition ID of an organisation cannot be updated. This value cannot be changed once the organisation is created.
* org_id: specifies the organisation ID.
* org_name: name of the organisation.
* language_id: ID of the system language. For more information about the list of languages, see LIST_LANGUAGES.
* 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.

* login_name: the login name for authenticating the user.
* login_passwd: the login password for authenticating the user.
or
* login_name: the login name for authenticating the user.
* session_id: the session ID for authenticating the user.
or
* device_id: a unique ID of the device. The system can use it as a key to identify users.

RETURN DATA

For each valid request, the server provides a response in XML format.
The response contains the following attribute:
* msg: a string indicating the organisation has been updated successfully.

For an invalid request, the response XML contains the following attribute:
* msg: a string containing the error message.

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=UPDATE_ORG&db_partition_id=1&org_id=30&org_name=TechBeach&org_description=Tech%20Company%20in%20Manly&device_id=mydemoid

Response:
<result tftype='1' infotype='0'>
    <field name='msg'>SUCCESS</field>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

ADD_ORG, LIST_DBPS, LIST_LANGUAGES

Mweb v2.0 YVNTECH 2014