PerfectView Web Service

PerfectView

Click here for a complete list of operations.

RelationGetFields

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

<?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>
    <RelationGetFields 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>
      <baseRelationType>NotApplicable or Person or Organisation</baseRelationType>
    </RelationGetFields>
  </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>
    <RelationGetFieldsResponse xmlns="https://Api.perfectview.nl">
      <RelationGetFieldsResult>
        <Fields>
          <PvFieldData>
            <Id>guid</Id>
            <Label>string</Label>
            <Name>string</Name>
            <SortIndex>short</SortIndex>
            <CategoryName>string</CategoryName>
            <CategorySortIndex>short</CategorySortIndex>
            <HideAtEntryForm>boolean</HideAtEntryForm>
            <UserFriendlyName>string</UserFriendlyName>
            <IsReadOnly>boolean</IsReadOnly>
            <Description>string</Description>
            <Control>TextBox or CheckBox or PvComboBox or PvDateTimePicker or PvMailTextBox or PvUrlTextBox or PvIntegerTextBox or PvCurrencyTextBox or PvLabelControl</Control>
            <Type>UniqueIdentifier or NVarChar or Datetime or Datetime2 or Bit or Float or Int or Decimal or VarBinary or SmallInt or Currency or BigInt or VarChar or Label</Type>
            <Length>int</Length>
            <ComboboxValues>Datastore or Enumeration or Countries or Employees or Users or SbiCodes or SystemDatastore or Vat or Unit</ComboboxValues>
            <ExtraInfo>string</ExtraInfo>
            <IsRequired>boolean</IsRequired>
          </PvFieldData>
          <PvFieldData>
            <Id>guid</Id>
            <Label>string</Label>
            <Name>string</Name>
            <SortIndex>short</SortIndex>
            <CategoryName>string</CategoryName>
            <CategorySortIndex>short</CategorySortIndex>
            <HideAtEntryForm>boolean</HideAtEntryForm>
            <UserFriendlyName>string</UserFriendlyName>
            <IsReadOnly>boolean</IsReadOnly>
            <Description>string</Description>
            <Control>TextBox or CheckBox or PvComboBox or PvDateTimePicker or PvMailTextBox or PvUrlTextBox or PvIntegerTextBox or PvCurrencyTextBox or PvLabelControl</Control>
            <Type>UniqueIdentifier or NVarChar or Datetime or Datetime2 or Bit or Float or Int or Decimal or VarBinary or SmallInt or Currency or BigInt or VarChar or Label</Type>
            <Length>int</Length>
            <ComboboxValues>Datastore or Enumeration or Countries or Employees or Users or SbiCodes or SystemDatastore or Vat or Unit</ComboboxValues>
            <ExtraInfo>string</ExtraInfo>
            <IsRequired>boolean</IsRequired>
          </PvFieldData>
        </Fields>
      </RelationGetFieldsResult>
    </RelationGetFieldsResponse>
  </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>
    <RelationGetFields 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>
      <baseRelationType>NotApplicable or Person or Organisation</baseRelationType>
    </RelationGetFields>
  </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>
    <RelationGetFieldsResponse xmlns="https://Api.perfectview.nl">
      <RelationGetFieldsResult>
        <Fields>
          <PvFieldData>
            <Id>guid</Id>
            <Label>string</Label>
            <Name>string</Name>
            <SortIndex>short</SortIndex>
            <CategoryName>string</CategoryName>
            <CategorySortIndex>short</CategorySortIndex>
            <HideAtEntryForm>boolean</HideAtEntryForm>
            <UserFriendlyName>string</UserFriendlyName>
            <IsReadOnly>boolean</IsReadOnly>
            <Description>string</Description>
            <Control>TextBox or CheckBox or PvComboBox or PvDateTimePicker or PvMailTextBox or PvUrlTextBox or PvIntegerTextBox or PvCurrencyTextBox or PvLabelControl</Control>
            <Type>UniqueIdentifier or NVarChar or Datetime or Datetime2 or Bit or Float or Int or Decimal or VarBinary or SmallInt or Currency or BigInt or VarChar or Label</Type>
            <Length>int</Length>
            <ComboboxValues>Datastore or Enumeration or Countries or Employees or Users or SbiCodes or SystemDatastore or Vat or Unit</ComboboxValues>
            <ExtraInfo>string</ExtraInfo>
            <IsRequired>boolean</IsRequired>
          </PvFieldData>
          <PvFieldData>
            <Id>guid</Id>
            <Label>string</Label>
            <Name>string</Name>
            <SortIndex>short</SortIndex>
            <CategoryName>string</CategoryName>
            <CategorySortIndex>short</CategorySortIndex>
            <HideAtEntryForm>boolean</HideAtEntryForm>
            <UserFriendlyName>string</UserFriendlyName>
            <IsReadOnly>boolean</IsReadOnly>
            <Description>string</Description>
            <Control>TextBox or CheckBox or PvComboBox or PvDateTimePicker or PvMailTextBox or PvUrlTextBox or PvIntegerTextBox or PvCurrencyTextBox or PvLabelControl</Control>
            <Type>UniqueIdentifier or NVarChar or Datetime or Datetime2 or Bit or Float or Int or Decimal or VarBinary or SmallInt or Currency or BigInt or VarChar or Label</Type>
            <Length>int</Length>
            <ComboboxValues>Datastore or Enumeration or Countries or Employees or Users or SbiCodes or SystemDatastore or Vat or Unit</ComboboxValues>
            <ExtraInfo>string</ExtraInfo>
            <IsRequired>boolean</IsRequired>
          </PvFieldData>
        </Fields>
      </RelationGetFieldsResult>
    </RelationGetFieldsResponse>
  </soap12:Body>
</soap12:Envelope>