Luminate Online

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
None.	SROrganizationAPI	POST	Yes.

Server API Syntax

https://secure2.convio.net/organization/site/SROrganizationAPI?method=addOrganizationAddress & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & org_id =value & address =value

Usage Notes

This method adds an address to an organization record in the Luminate Online database.

Input data is passed url-encoded as the value of the address parameter in the following format:

      
        <organizationAddressRequest xmlns="http://convio.com/crm/v1.0">
            <address>
                <address_type_id>1</address_type_id>
                <org_id>1</org_id>
                <street1>1 Infinite Loop</street1>
                <street2>Suite 500</street2>
                <city>Cupertino</city>
                <state_province>CA</state_province>
                <postal_code>95014</postal_code>
                <country>United States</country>
            </address>
        </organizationAddressRequest>

The address_type_id property contains a '1' for the primary address or a '2' for the mailing address.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

org_id

Required. Org ID

Type xsd:int.

address

Required. The XML document containing the data for an organization address.

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<getOrganizationAddressResponse xmlns="http://convio.com/crm/v1.0">
    <address>
        <address_id>1000</address_id>
        <address_type_id>1</address_type_id>
        <org_id>150</org_id>
        <street1>100 Any Street</street1>
        <street2>Apt. 205</street2>
        <suburb>St. Matthews</suburb>
        <city>Louisville</city>
        <county>United States</county>
        <state_province>KY</state_province>
        <postal_code>40223</postal_code>
    </address>
</getOrganizationAddressResponse>

JSON response

{"getOrganizationAddressResponse":{"address":{"street2":"Apt. 205","org_id":"150","street1":"100 Any Street","state_province":"KY","county":"United States","suburb":"St. Matthews","address_id":"1000","postal_code":"40223","address_type_id":"1","city":"Louisville"}}}

addOrganizationAddress

Server API Syntax

Usage Notes

Server API Parameters

Response

Leave a Comment