PerfectView
Click here for a complete list of operations.
RelationshipViewGetData
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /V1/perfectview.asmx HTTP/1.1 Host: api.perfectview.nl Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://Api.perfectview.nl/RelationshipViewGetData" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RelationshipViewGetData xmlns="https://Api.perfectview.nl"> <credentials> <ApiKey>guid</ApiKey> <DatabaseId>guid</DatabaseId> <UserId>guid</UserId> <UserName>string</UserName> <Password>string</Password> <SourceApplication> <Name>string</Name> <Category>string</Category> <Subcategory>string</Subcategory> <Version>string</Version> </SourceApplication> </credentials> <viewSql>string</viewSql> <pageNumber>int</pageNumber> <pageSize>int</pageSize> <searchText>string</searchText> <fieldIds> <guid>guid</guid> <guid>guid</guid> </fieldIds> </RelationshipViewGetData> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RelationshipViewGetDataResponse xmlns="https://Api.perfectview.nl"> <RelationshipViewGetDataResult> <Relationships> <PvRelationshipData> <Id>guid</Id> <EntityTypeId>guid</EntityTypeId> <ParentRelationId>guid</ParentRelationId> <ChildRelationId>guid</ChildRelationId> <Description>string</Description> <DisplayCity>string</DisplayCity> <DisplayName>string</DisplayName> <SortingName>string</SortingName> <IsContact>boolean</IsContact> <IsEmployee>boolean</IsEmployee> <IsOrganisation>boolean</IsOrganisation> <PreferredAddress>PostAddress or PrivateAddress or PrivateDifferentAddress or PostAddressOrganisation or VisitAddress or VisitAddressOrganization or BillingAddress or BillingAddressOrganization</PreferredAddress> <AddresStyle>Formal or Informal or ExecutiveBoard or Family or Board or Partner or Residents or Owners or FormalWithFirstnames or FormalWithFunction or None or FormalWithInformal</AddresStyle> <Addressing>string</Addressing> <Openening>string</Openening> <AddressingVariant>string</AddressingVariant> <OpeneningVariant>string</OpeneningVariant> <TittleId>guid</TittleId> <AccountManagerId>guid</AccountManagerId> <IsInactive>boolean</IsInactive> <OptOut>boolean</OptOut> <AuditData xsi:nil="true" /> <FieldValues xsi:nil="true" /> </PvRelationshipData> <PvRelationshipData> <Id>guid</Id> <EntityTypeId>guid</EntityTypeId> <ParentRelationId>guid</ParentRelationId> <ChildRelationId>guid</ChildRelationId> <Description>string</Description> <DisplayCity>string</DisplayCity> <DisplayName>string</DisplayName> <SortingName>string</SortingName> <IsContact>boolean</IsContact> <IsEmployee>boolean</IsEmployee> <IsOrganisation>boolean</IsOrganisation> <PreferredAddress>PostAddress or PrivateAddress or PrivateDifferentAddress or PostAddressOrganisation or VisitAddress or VisitAddressOrganization or BillingAddress or BillingAddressOrganization</PreferredAddress> <AddresStyle>Formal or Informal or ExecutiveBoard or Family or Board or Partner or Residents or Owners or FormalWithFirstnames or FormalWithFunction or None or FormalWithInformal</AddresStyle> <Addressing>string</Addressing> <Openening>string</Openening> <AddressingVariant>string</AddressingVariant> <OpeneningVariant>string</OpeneningVariant> <TittleId>guid</TittleId> <AccountManagerId>guid</AccountManagerId> <IsInactive>boolean</IsInactive> <OptOut>boolean</OptOut> <AuditData xsi:nil="true" /> <FieldValues xsi:nil="true" /> </PvRelationshipData> </Relationships> </RelationshipViewGetDataResult> </RelationshipViewGetDataResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /V1/perfectview.asmx HTTP/1.1 Host: api.perfectview.nl Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <RelationshipViewGetData xmlns="https://Api.perfectview.nl"> <credentials> <ApiKey>guid</ApiKey> <DatabaseId>guid</DatabaseId> <UserId>guid</UserId> <UserName>string</UserName> <Password>string</Password> <SourceApplication> <Name>string</Name> <Category>string</Category> <Subcategory>string</Subcategory> <Version>string</Version> </SourceApplication> </credentials> <viewSql>string</viewSql> <pageNumber>int</pageNumber> <pageSize>int</pageSize> <searchText>string</searchText> <fieldIds> <guid>guid</guid> <guid>guid</guid> </fieldIds> </RelationshipViewGetData> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <RelationshipViewGetDataResponse xmlns="https://Api.perfectview.nl"> <RelationshipViewGetDataResult> <Relationships> <PvRelationshipData> <Id>guid</Id> <EntityTypeId>guid</EntityTypeId> <ParentRelationId>guid</ParentRelationId> <ChildRelationId>guid</ChildRelationId> <Description>string</Description> <DisplayCity>string</DisplayCity> <DisplayName>string</DisplayName> <SortingName>string</SortingName> <IsContact>boolean</IsContact> <IsEmployee>boolean</IsEmployee> <IsOrganisation>boolean</IsOrganisation> <PreferredAddress>PostAddress or PrivateAddress or PrivateDifferentAddress or PostAddressOrganisation or VisitAddress or VisitAddressOrganization or BillingAddress or BillingAddressOrganization</PreferredAddress> <AddresStyle>Formal or Informal or ExecutiveBoard or Family or Board or Partner or Residents or Owners or FormalWithFirstnames or FormalWithFunction or None or FormalWithInformal</AddresStyle> <Addressing>string</Addressing> <Openening>string</Openening> <AddressingVariant>string</AddressingVariant> <OpeneningVariant>string</OpeneningVariant> <TittleId>guid</TittleId> <AccountManagerId>guid</AccountManagerId> <IsInactive>boolean</IsInactive> <OptOut>boolean</OptOut> <AuditData xsi:nil="true" /> <FieldValues xsi:nil="true" /> </PvRelationshipData> <PvRelationshipData> <Id>guid</Id> <EntityTypeId>guid</EntityTypeId> <ParentRelationId>guid</ParentRelationId> <ChildRelationId>guid</ChildRelationId> <Description>string</Description> <DisplayCity>string</DisplayCity> <DisplayName>string</DisplayName> <SortingName>string</SortingName> <IsContact>boolean</IsContact> <IsEmployee>boolean</IsEmployee> <IsOrganisation>boolean</IsOrganisation> <PreferredAddress>PostAddress or PrivateAddress or PrivateDifferentAddress or PostAddressOrganisation or VisitAddress or VisitAddressOrganization or BillingAddress or BillingAddressOrganization</PreferredAddress> <AddresStyle>Formal or Informal or ExecutiveBoard or Family or Board or Partner or Residents or Owners or FormalWithFirstnames or FormalWithFunction or None or FormalWithInformal</AddresStyle> <Addressing>string</Addressing> <Openening>string</Openening> <AddressingVariant>string</AddressingVariant> <OpeneningVariant>string</OpeneningVariant> <TittleId>guid</TittleId> <AccountManagerId>guid</AccountManagerId> <IsInactive>boolean</IsInactive> <OptOut>boolean</OptOut> <AuditData xsi:nil="true" /> <FieldValues xsi:nil="true" /> </PvRelationshipData> </Relationships> </RelationshipViewGetDataResult> </RelationshipViewGetDataResponse> </soap12:Body> </soap12:Envelope>