getOrganizationAddressById

Returns an organization address by organization ID and address ID

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

Server API Syntax

https://secure2.convio.net/organization/site/SROrganizationAPI?method=getOrganizationAddressById & 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_id =value

Usage Notes

The property, address_type_id, uses 1 for a primary address, and 2 for a mailing address.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

org_id

Required. Org ID

Type xsd:int.

address_id

Required. Address ID

Type xsd:int.

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"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: