Symphony API V1.0


Click here for a complete list of operations.

GetProfileList

This method can be used to get a list of profile types with their associated profile values

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/GetProfileList"

<?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:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>string</Timestamp>
      <Operation>string</Operation>
      <Signature>string</Signature>
      <APIKey>string</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetProfileList xmlns="https://developer.sym-online.com/API/1_0/SOAP/" />
  </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>
    <GetProfileListResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetProfileListResult>
        <ProfileTypes>
          <ProfileList>
            <ClientCompanyId>int</ClientCompanyId>
            <ProfileTypeId>int</ProfileTypeId>
            <ProfileType>string</ProfileType>
            <ProfileValues xsi:nil="true" />
          </ProfileList>
          <ProfileList>
            <ClientCompanyId>int</ClientCompanyId>
            <ProfileTypeId>int</ProfileTypeId>
            <ProfileType>string</ProfileType>
            <ProfileValues xsi:nil="true" />
          </ProfileList>
        </ProfileTypes>
      </GetProfileListResult>
    </GetProfileListResponse>
  </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 /API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.com
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:Header>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>string</Timestamp>
      <Operation>string</Operation>
      <Signature>string</Signature>
      <APIKey>string</APIKey>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetProfileList xmlns="https://developer.sym-online.com/API/1_0/SOAP/" />
  </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>
    <GetProfileListResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetProfileListResult>
        <ProfileTypes>
          <ProfileList>
            <ClientCompanyId>int</ClientCompanyId>
            <ProfileTypeId>int</ProfileTypeId>
            <ProfileType>string</ProfileType>
            <ProfileValues xsi:nil="true" />
          </ProfileList>
          <ProfileList>
            <ClientCompanyId>int</ClientCompanyId>
            <ProfileTypeId>int</ProfileTypeId>
            <ProfileType>string</ProfileType>
            <ProfileValues xsi:nil="true" />
          </ProfileList>
        </ProfileTypes>
      </GetProfileListResult>
    </GetProfileListResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /API/1_0/SOAP/SymphonyAPI.asmx/GetProfileList? HTTP/1.1
Host: developer.sym-online.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ProfileListResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <ProfileTypes>
    <ProfileList>
      <ClientCompanyId>int</ClientCompanyId>
      <ProfileTypeId>int</ProfileTypeId>
      <ProfileType>string</ProfileType>
      <ProfileValues>
        <ProfileValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ProfileValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProfileValues>
    </ProfileList>
    <ProfileList>
      <ClientCompanyId>int</ClientCompanyId>
      <ProfileTypeId>int</ProfileTypeId>
      <ProfileType>string</ProfileType>
      <ProfileValues>
        <ProfileValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ProfileValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProfileValues>
    </ProfileList>
  </ProfileTypes>
</ProfileListResponse>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /API/1_0/SOAP/SymphonyAPI.asmx/GetProfileList HTTP/1.1
Host: developer.sym-online.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length


HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ProfileListResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <ProfileTypes>
    <ProfileList>
      <ClientCompanyId>int</ClientCompanyId>
      <ProfileTypeId>int</ProfileTypeId>
      <ProfileType>string</ProfileType>
      <ProfileValues>
        <ProfileValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ProfileValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProfileValues>
    </ProfileList>
    <ProfileList>
      <ClientCompanyId>int</ClientCompanyId>
      <ProfileTypeId>int</ProfileTypeId>
      <ProfileType>string</ProfileType>
      <ProfileValues>
        <ProfileValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ProfileValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProfileValues>
    </ProfileList>
  </ProfileTypes>
</ProfileListResponse>