Attributes
- Version: 1.0
- Defined types are as configured at a platform (when attached to an Org Identity) or CO (when attached to a CO Person) level. CO-specific types can be determined via the CoExtendedType API.
- See cm_addresses for definitions of other attributes and elements
JSON Request
{ "RequestType":"Addresses", "Version":"1.0", "Addresses": [ { "Version":"1.0", "Street":"<Street>", "Room":"<Room>", "Locality":"<Locality>", "State":"<State>", "PostalCode":"<PostalCode>", "Country":"<Country>", "Type":"<Type>", "Language":"<Language>", "Description":"<Description>", "Person":{"Type":("CoRole"|"Dept"|"Org"|"Organization"),"Id":"<ID>"} } ] }
XML Request
<!ELEMENT Addresses (Address)> <!ATTLIST Addresses Version CDATA #FIXED "1.0"> <!ELEMENT Address (Street,Room?,Locality?,State?,PostalCode?,Country?,Type?,Person)> <!ATTLIST Address Version CDATA #FIXED "1.0"> <!ELEMENT Street (#PCDATA)> <!ELEMENT Room (#PCDATA)> <!ELEMENT Locality (#PCDATA)> <!ELEMENT State (#PCDATA)> <!ELEMENT PostalCode (#PCDATA)> <!ELEMENT Country (#PCDATA)> <!ELEMENT Type ($PCDATA)> <!ELEMENT Description (#PCDATA)> <!ELEMENT Language (#PCDATA)> <!ELEMENT Person (Type,Id)> <!ELEMENT Person Type (CoRole|Dept|Org|Organization)> <!ELEMENT Person Id ID>
JSON Response
{ "ResponseType":"Addresses", "Version":"1.0", "Addresses": [ { "Version":"1.0", "Id":"<ID>", "Street":"<Street>", "Room":"<Room>", "Locality":"<Locality>", "State":"<State>", "PostalCode":"<PostalCode>", "Country":"<Country>", "Type":"<Type>", "Language":"<Language>", "Description":"<Description>", "Person":{"Type":("CoRole"|"Dept"|"Org"|"Organization"),"Id":"<ID>"}, "Created":"<CreateTime>", "Modified":"<ModTime>" }, {...} ] }
XML Response
<!ELEMENT Addresses (Address+)> <!ATTLIST Addresses Version CDATA #FIXED "1.0"> <!ELEMENT Address (Street,Room?,Locality?,State?,PostalCode?,Country?,Type?,Person)> <!ATTLIST Address Version CDATA #FIXED "1.0"> <!ATTLIST Address Id ID> <!ELEMENT Street (#PCDATA)> <!ELEMENT Room (#PCDATA)> <!ELEMENT Locality (#PCDATA)> <!ELEMENT State (#PCDATA)> <!ELEMENT PostalCode (#PCDATA)> <!ELEMENT Country (#PCDATA)> <!ELEMENT Type (#PCDATA)> <!ELEMENT Description (#PCDATA)> <!ELEMENT Language (#PCDATA)> <!ELEMENT Person (Type,Id)> <!ELEMENT Person Type (CoRole|Dept|Org|Organization)> <!ELEMENT Person Id ID> <!ELEMENT Created (#PCDATA)> <!ELEMENT Modified (#PCDATA)>