Case Retrieve relation data work in progress Before
Case: Retrieve relation data – work in progress Before one can retrieve relation data from Perfect. View CRM Online, one should understand the relation structure. There are two types of base relations: - Organisations - Persons
For example: - Organisation: Perfect. View - Person: Paul Verkerk
Each relation is connected to another relation. We call those connections relationships. There are different types of relationships. A relationship tells you what kind of connection a relation have with the other relation. For example: - Perfect. View (child. Relation) as supplier (Relation. Ship) of API PV CRM Inc. (parent. Relation) - Paul Verkerk (child. Relation) as contact (Relation. Ship) of Perfect. View (parent. Relation)
Which API method should I use to retrieve the relation data? There are multiple methods you could use. Each method has it’s own (dis)advantages and it’s own result of data. The most common methods to use are: A. Relation. Get. Modified - Gets all created and modified relations in a given period. e. g. If you want to sync your relations, but not all of them all the time, but just the modified ones. B. Relation. Search. By. Field - Gets the relations of which the selected fields contain specific values. e. g. If you want to get all people who are deceased C. Relation. Search. By. Name_V 2 - Gets the relations with some search characters in their name. e. g. If you want to find a relation by some characters and the result should provide you with relation data
API method Relation. Get. Modified (A 1)
API method Relation. Get. Modified (A 2) To suppress possible time-outs due to an infinite amount of data as result, you have to use pagination in this call. The maximum page. Size is 50, the minimal page. Number is 1. Between which dates should the relation for the last time be modified. All dates should be supplied in UTC-format: 2014 -07 -08 T 12: 05: 25. 8 Z Use the 1 st of January 1980 to collect all relations which are created from the starting point and are not changed (lately). These two booleans can provide you in extra data of the relation. The boolean ‘include. Fields’ determine if all fields of a relation should be in the result or just some generic ones. The boolean ‘include. Counters’ tells you the amount of activities, marks, campaign events, attachments and notes connected to the relation.
API method Relation. Get. Modified (A 3)
API method Relation. Get. Modified (A 4) <soapenv: Envelope xmlns: soapenv="http: //schemas. xmlsoap. org/soap/envelope/" xmlns: api="https: //Api. perfectview. nl"> <soapenv: Header/> <soapenv: Body> <api: Relation. Get. Modified> <!--Optional: --> ‘SECTION CREDENTIALS’ <api: page. Number>1</api: page. Number> <api: page. Size>50</api: page. Size> <api: from>2015 -01 -01 T 00: 00. 000 Z</api: from> <api: to>2015 -03 -21 T 00: 00. 000 Z</api: to> <api: include. Fields>1</api: include. Fields> <api: include. Counters>1</api: include. Counters> </api: Relation. Get. Modified> </soapenv: Body> </soapenv: Envelope>
API method Relation. Get. Modified (A 5) <soap: Envelope xmlns: soap="http: //schemas. xmlsoap. org/soap/envelope/" xmlns: xsi="http: //www. w 3. org/2001/XMLSchema-instance" xmlns: xsd="http: //www. w 3. org/2001/XMLSchema"> <soap: Body> <Relation. Get. Modified. Response xmlns="https: //Api. perfectview. nl"> <Relation. Get. Modified. Result> <Succeeded>true</Succeeded> <Number>0</Number> <Code>Ok</Code> <Description>The method is successfully executed. </Description> </Result> <Relations> <Pv. Relation. Data> <Id>10000000 -0000 -000000</Id> <Entity. Type. Id>905 edd 66 -16 b 0 -49 bc-8975 -bcc 8 e 868 b 960</Entity. Type. Id> <Info/> <Sorting. Name>API PV CRM Inc. </Sorting. Name> <Display. Name>API PV CRM Inc. </Display. Name> <Is. Root>true</Is. Root> <Is. Dummy>false</Is. Dummy> <Is. Inactive>false</Is. Inactive> ‘SECTION FIELDVALUES’ ‘SECTION COUNTERVALUES’ </Pv. Relation. Data> <Id>64 e 27 ee 8 -5654 -4 ccd-b 72 b-210 e 21281 c 9 d</Id> <Entity. Type. Id>905 edd 66 -16 b 0 -49 bc-8975 -bcc 8 e 868 b 960</Entity. Type. Id> <Info/> <Sorting. Name>PVCRM Gmb. H</Sorting. Name> <Display. Name>PVCRM Gmb. H</Display. Name> <Is. Root>false</Is. Root> <Is. Dummy>false</Is. Dummy> <Is. Inactive>false</Is. Inactive> ‘SECTION FIELDVALUES’ ‘SECTION COUNTERVALUES’ </Pv. Relation. Data> </Relations> </Relation. Get. Modified. Result> </Relation. Get. Modified. Response> </soap: Body> </soap: Envelope>
API method Relation. Get. Modified (A 6) Section Field. Values <Field. Values> <Items> <Pv. Field. Value. Data> <Id>e 836 ac 6 a-9 f 4 f-4 c 88 -91 ab-1215 cfdefa 35</Id> <Value>False</Value> </Pv. Field. Value. Data> <Id>52 f 6 cb 6 a-926 f-460 d-ab 55 -3 da 0 a 4 b 67 f 2 a</Id> <Value/> </Pv. Field. Value. Data> <Id>47 b 0 e 705 -0 cc 4 -462 d-9399 -518 db 42 dc 10 d</Id> <Value>PVCRM Gmb. H</Value> </Pv. Field. Value. Data> <Id>4427 c 201 -9484 -4 e 63 -bb 87 -598 aa 25 c 3 c 32</Id> <Value>PVCRM Gmb. H</Value> </Pv. Field. Value. Data> <Id>33 ca 722 b-5 dcd-43 af-a 457 -6 c 43 e 1015851</Id> <Value>1 bd 910 e 4 -0083 -4 c 8 c-9 a 60 -cc 8458 bc 1 ea 2</Value> </Pv. Field. Value. Data> <Id>5 cd 344 a 1 -48 a 1 -4 e 4 f-872 b-a 6 b 41549884 c</Id> <Value>2015 -03 -17 T 16: 25: 26. 633 Z</Value> </Pv. Field. Value. Data> <Id>f 11 bf 562 -f 9 a 6 -4417 -8 cd 7 -b 3 d 73 bf 829 e 5</Id> <Value>30000000 -0000 -000000</Value> </Pv. Field. Value. Data> </Items> </Field. Values>
API method Relation. Get. Modified (A 6) Section Counter. Values <Counter. Values> <Pv. Counter. Data> <Tab. Page. Type>Contacts</Tab. Page. Type> <Value>4</Value> </Pv. Counter. Data> <Tab. Page. Type>Activities</Tab. Page. Type> <Value>112</Value> </Pv. Counter. Data> <Tab. Page. Type>Marks</Tab. Page. Type> <Value>11</Value> </Pv. Counter. Data> <Tab. Page. Type>Campaign. Dashboard</Tab. Page. Type> <Value>55</Value> </Pv. Counter. Data> </Counter. Values>
API method Relation. Search. By. Field (B 1)
API method Relation. Get. Modified (A 3)
- Slides: 13