PerfectView

Click here for a complete list of operations.

RelationGet

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 /perfectview.asmx HTTP/1.1
Host: api.perfectview.nl
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://Api.perfectview.nl/RelationGet"

<?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>
    <RelationGet 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>
      <relationId>guid</relationId>
      <includeFields>boolean</includeFields>
      <includeCounters>boolean</includeCounters>
    </RelationGet>
  </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>
    <RelationGetResponse xmlns="https://Api.perfectview.nl">
      <RelationGetResult>
        <Relation>
          <Id>guid</Id>
          <EntityTypeId>guid</EntityTypeId>
          <Info>string</Info>
          <SortingName>string</SortingName>
          <DisplayName>string</DisplayName>
          <IsRoot>boolean</IsRoot>
          <IsDummy>boolean</IsDummy>
          <ImportKey>string</ImportKey>
          <IsInactive>boolean</IsInactive>
          <FieldValues>
            <Items xsi:nil="true" />
          </FieldValues>
          <CounterValues>
            <PvCounterData xsi:nil="true" />
            <PvCounterData xsi:nil="true" />
          </CounterValues>
        </Relation>
        <Counters>
          <PvCounterData>
            <TabPageType>Dashboard or Relation or Relationship or Activity or Lines or Involveds or Marks or Attachments or InvolvedEmployees or Notes or PersonPrivate or PersonFinancial or PersonOther or OrganisationCommunication or OrganisationFinancial or OrganisationOther or Activities or Subprocesses or ConnectedActivities or Contacts or Audittrail or AudittrailLogs or AudittrailTransitions or SocialMedia or CampaignDashboard or Timeline or ReadRightUsers or None or SubAccounts or QueueMessages</TabPageType>
            <Value>int</Value>
          </PvCounterData>
          <PvCounterData>
            <TabPageType>Dashboard or Relation or Relationship or Activity or Lines or Involveds or Marks or Attachments or InvolvedEmployees or Notes or PersonPrivate or PersonFinancial or PersonOther or OrganisationCommunication or OrganisationFinancial or OrganisationOther or Activities or Subprocesses or ConnectedActivities or Contacts or Audittrail or AudittrailLogs or AudittrailTransitions or SocialMedia or CampaignDashboard or Timeline or ReadRightUsers or None or SubAccounts or QueueMessages</TabPageType>
            <Value>int</Value>
          </PvCounterData>
        </Counters>
      </RelationGetResult>
    </RelationGetResponse>
  </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 /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>
    <RelationGet 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>
      <relationId>guid</relationId>
      <includeFields>boolean</includeFields>
      <includeCounters>boolean</includeCounters>
    </RelationGet>
  </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>
    <RelationGetResponse xmlns="https://Api.perfectview.nl">
      <RelationGetResult>
        <Relation>
          <Id>guid</Id>
          <EntityTypeId>guid</EntityTypeId>
          <Info>string</Info>
          <SortingName>string</SortingName>
          <DisplayName>string</DisplayName>
          <IsRoot>boolean</IsRoot>
          <IsDummy>boolean</IsDummy>
          <ImportKey>string</ImportKey>
          <IsInactive>boolean</IsInactive>
          <FieldValues>
            <Items xsi:nil="true" />
          </FieldValues>
          <CounterValues>
            <PvCounterData xsi:nil="true" />
            <PvCounterData xsi:nil="true" />
          </CounterValues>
        </Relation>
        <Counters>
          <PvCounterData>
            <TabPageType>Dashboard or Relation or Relationship or Activity or Lines or Involveds or Marks or Attachments or InvolvedEmployees or Notes or PersonPrivate or PersonFinancial or PersonOther or OrganisationCommunication or OrganisationFinancial or OrganisationOther or Activities or Subprocesses or ConnectedActivities or Contacts or Audittrail or AudittrailLogs or AudittrailTransitions or SocialMedia or CampaignDashboard or Timeline or ReadRightUsers or None or SubAccounts or QueueMessages</TabPageType>
            <Value>int</Value>
          </PvCounterData>
          <PvCounterData>
            <TabPageType>Dashboard or Relation or Relationship or Activity or Lines or Involveds or Marks or Attachments or InvolvedEmployees or Notes or PersonPrivate or PersonFinancial or PersonOther or OrganisationCommunication or OrganisationFinancial or OrganisationOther or Activities or Subprocesses or ConnectedActivities or Contacts or Audittrail or AudittrailLogs or AudittrailTransitions or SocialMedia or CampaignDashboard or Timeline or ReadRightUsers or None or SubAccounts or QueueMessages</TabPageType>
            <Value>int</Value>
          </PvCounterData>
        </Counters>
      </RelationGetResult>
    </RelationGetResponse>
  </soap12:Body>
</soap12:Envelope>