PerfectView Web Service

PerfectView

Click here for a complete list of operations.

RelationshipGetMarks

Get mark and relationship data

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

<?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>
    <RelationshipGetMarks 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>
      <relationshipId>guid</relationshipId>
    </RelationshipGetMarks>
  </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>
    <RelationshipGetMarksResponse xmlns="https://Api.perfectview.nl">
      <RelationshipGetMarksResult>
        <Relationship>
          <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>
            <CreatedAt>dateTime</CreatedAt>
            <CreatedByUser>guid</CreatedByUser>
            <ModifiedAt>dateTime</ModifiedAt>
            <ModifiedByUser>guid</ModifiedByUser>
          </AuditData>
          <FieldValues>
            <Items xsi:nil="true" />
          </FieldValues>
        </Relationship>
        <RelationshipMarks>
          <PvRelationshipMarkData>
            <Id>guid</Id>
            <RelationshipId>guid</RelationshipId>
            <RelationshipDescription>string</RelationshipDescription>
            <MarkId>guid</MarkId>
            <PreferredAddress>PostAddress or PrivateAddress or PrivateDifferentAddress or PostAddressOrganisation or VisitAddress or VisitAddressOrganization or BillingAddress or BillingAddressOrganization</PreferredAddress>
            <Date>dateTime</Date>
          </PvRelationshipMarkData>
          <PvRelationshipMarkData>
            <Id>guid</Id>
            <RelationshipId>guid</RelationshipId>
            <RelationshipDescription>string</RelationshipDescription>
            <MarkId>guid</MarkId>
            <PreferredAddress>PostAddress or PrivateAddress or PrivateDifferentAddress or PostAddressOrganisation or VisitAddress or VisitAddressOrganization or BillingAddress or BillingAddressOrganization</PreferredAddress>
            <Date>dateTime</Date>
          </PvRelationshipMarkData>
        </RelationshipMarks>
      </RelationshipGetMarksResult>
    </RelationshipGetMarksResponse>
  </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>
    <RelationshipGetMarks 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>
      <relationshipId>guid</relationshipId>
    </RelationshipGetMarks>
  </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>
    <RelationshipGetMarksResponse xmlns="https://Api.perfectview.nl">
      <RelationshipGetMarksResult>
        <Relationship>
          <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>
            <CreatedAt>dateTime</CreatedAt>
            <CreatedByUser>guid</CreatedByUser>
            <ModifiedAt>dateTime</ModifiedAt>
            <ModifiedByUser>guid</ModifiedByUser>
          </AuditData>
          <FieldValues>
            <Items xsi:nil="true" />
          </FieldValues>
        </Relationship>
        <RelationshipMarks>
          <PvRelationshipMarkData>
            <Id>guid</Id>
            <RelationshipId>guid</RelationshipId>
            <RelationshipDescription>string</RelationshipDescription>
            <MarkId>guid</MarkId>
            <PreferredAddress>PostAddress or PrivateAddress or PrivateDifferentAddress or PostAddressOrganisation or VisitAddress or VisitAddressOrganization or BillingAddress or BillingAddressOrganization</PreferredAddress>
            <Date>dateTime</Date>
          </PvRelationshipMarkData>
          <PvRelationshipMarkData>
            <Id>guid</Id>
            <RelationshipId>guid</RelationshipId>
            <RelationshipDescription>string</RelationshipDescription>
            <MarkId>guid</MarkId>
            <PreferredAddress>PostAddress or PrivateAddress or PrivateDifferentAddress or PostAddressOrganisation or VisitAddress or VisitAddressOrganization or BillingAddress or BillingAddressOrganization</PreferredAddress>
            <Date>dateTime</Date>
          </PvRelationshipMarkData>
        </RelationshipMarks>
      </RelationshipGetMarksResult>
    </RelationshipGetMarksResponse>
  </soap12:Body>
</soap12:Envelope>