PerfectView

Click here for a complete list of operations.

RelationGetAll

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/RelationGetAll"

<?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>
    <RelationGetAll 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>
      <pageNumber>int</pageNumber>
      <pageSize>int</pageSize>
      <includeFields>boolean</includeFields>
      <includeCounters>boolean</includeCounters>
    </RelationGetAll>
  </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>
    <RelationGetAllResponse xmlns="https://Api.perfectview.nl">
      <RelationGetAllResult>
        <Relations>
          <PvRelationData>
            <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 xsi:nil="true" />
            <CounterValues xsi:nil="true" />
          </PvRelationData>
          <PvRelationData>
            <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 xsi:nil="true" />
            <CounterValues xsi:nil="true" />
          </PvRelationData>
        </Relations>
      </RelationGetAllResult>
    </RelationGetAllResponse>
  </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>
    <RelationGetAll 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>
      <pageNumber>int</pageNumber>
      <pageSize>int</pageSize>
      <includeFields>boolean</includeFields>
      <includeCounters>boolean</includeCounters>
    </RelationGetAll>
  </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>
    <RelationGetAllResponse xmlns="https://Api.perfectview.nl">
      <RelationGetAllResult>
        <Relations>
          <PvRelationData>
            <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 xsi:nil="true" />
            <CounterValues xsi:nil="true" />
          </PvRelationData>
          <PvRelationData>
            <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 xsi:nil="true" />
            <CounterValues xsi:nil="true" />
          </PvRelationData>
        </Relations>
      </RelationGetAllResult>
    </RelationGetAllResponse>
  </soap12:Body>
</soap12:Envelope>