Symphony API V1.0


Click here for a complete list of operations.

GetSubmissionDetail

This method can be used to retrieve an abstract submission given a booking reference

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
bookingId:

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

<?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>
    <GetSubmissionDetail xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <bookingId>int</bookingId>
    </GetSubmissionDetail>
  </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>
    <GetSubmissionDetailResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetSubmissionDetailResult>
        <AbstractUrl>string</AbstractUrl>
        <AbstractFileKey>string</AbstractFileKey>
        <AbstractText>string</AbstractText>
        <AbstractRtfText>string</AbstractRtfText>
        <AbstractVotes>
          <AbstractVoteResponse>
            <AbstractVoteId>int</AbstractVoteId>
            <BookingId>int</BookingId>
            <ClientUserId>int</ClientUserId>
            <ValueOne>int</ValueOne>
            <ValueTwo>int</ValueTwo>
          </AbstractVoteResponse>
          <AbstractVoteResponse>
            <AbstractVoteId>int</AbstractVoteId>
            <BookingId>int</BookingId>
            <ClientUserId>int</ClientUserId>
            <ValueOne>int</ValueOne>
            <ValueTwo>int</ValueTwo>
          </AbstractVoteResponse>
        </AbstractVotes>
        <AbstractComments>
          <AbstractCommentResponse>
            <AbstractCommentId>int</AbstractCommentId>
            <ClientUserId>int</ClientUserId>
            <BookingId>int</BookingId>
            <DateSubmitted>dateTime</DateSubmitted>
            <Comment>string</Comment>
            <ClientUserName>string</ClientUserName>
          </AbstractCommentResponse>
          <AbstractCommentResponse>
            <AbstractCommentId>int</AbstractCommentId>
            <ClientUserId>int</ClientUserId>
            <BookingId>int</BookingId>
            <DateSubmitted>dateTime</DateSubmitted>
            <Comment>string</Comment>
            <ClientUserName>string</ClientUserName>
          </AbstractCommentResponse>
        </AbstractComments>
        <PreviousSubmissionId>int</PreviousSubmissionId>
        <NextSubmissionId>int</NextSubmissionId>
        <AbstractCustomFields>
          <AbstractCustomFieldResponse>
            <FieldName>string</FieldName>
            <FieldValue>string</FieldValue>
          </AbstractCustomFieldResponse>
          <AbstractCustomFieldResponse>
            <FieldName>string</FieldName>
            <FieldValue>string</FieldValue>
          </AbstractCustomFieldResponse>
        </AbstractCustomFields>
      </GetSubmissionDetailResult>
    </GetSubmissionDetailResponse>
  </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>
    <GetSubmissionDetail xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <bookingId>int</bookingId>
    </GetSubmissionDetail>
  </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>
    <GetSubmissionDetailResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <GetSubmissionDetailResult>
        <AbstractUrl>string</AbstractUrl>
        <AbstractFileKey>string</AbstractFileKey>
        <AbstractText>string</AbstractText>
        <AbstractRtfText>string</AbstractRtfText>
        <AbstractVotes>
          <AbstractVoteResponse>
            <AbstractVoteId>int</AbstractVoteId>
            <BookingId>int</BookingId>
            <ClientUserId>int</ClientUserId>
            <ValueOne>int</ValueOne>
            <ValueTwo>int</ValueTwo>
          </AbstractVoteResponse>
          <AbstractVoteResponse>
            <AbstractVoteId>int</AbstractVoteId>
            <BookingId>int</BookingId>
            <ClientUserId>int</ClientUserId>
            <ValueOne>int</ValueOne>
            <ValueTwo>int</ValueTwo>
          </AbstractVoteResponse>
        </AbstractVotes>
        <AbstractComments>
          <AbstractCommentResponse>
            <AbstractCommentId>int</AbstractCommentId>
            <ClientUserId>int</ClientUserId>
            <BookingId>int</BookingId>
            <DateSubmitted>dateTime</DateSubmitted>
            <Comment>string</Comment>
            <ClientUserName>string</ClientUserName>
          </AbstractCommentResponse>
          <AbstractCommentResponse>
            <AbstractCommentId>int</AbstractCommentId>
            <ClientUserId>int</ClientUserId>
            <BookingId>int</BookingId>
            <DateSubmitted>dateTime</DateSubmitted>
            <Comment>string</Comment>
            <ClientUserName>string</ClientUserName>
          </AbstractCommentResponse>
        </AbstractComments>
        <PreviousSubmissionId>int</PreviousSubmissionId>
        <NextSubmissionId>int</NextSubmissionId>
        <AbstractCustomFields>
          <AbstractCustomFieldResponse>
            <FieldName>string</FieldName>
            <FieldValue>string</FieldValue>
          </AbstractCustomFieldResponse>
          <AbstractCustomFieldResponse>
            <FieldName>string</FieldName>
            <FieldValue>string</FieldValue>
          </AbstractCustomFieldResponse>
        </AbstractCustomFields>
      </GetSubmissionDetailResult>
    </GetSubmissionDetailResponse>
  </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/GetSubmissionDetail?bookingId=string 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"?>
<SubmissionDetailResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <AbstractUrl>string</AbstractUrl>
  <AbstractFileKey>string</AbstractFileKey>
  <AbstractText>string</AbstractText>
  <AbstractRtfText>string</AbstractRtfText>
  <AbstractVotes>
    <AbstractVoteResponse>
      <AbstractVoteId>int</AbstractVoteId>
      <BookingId>int</BookingId>
      <ClientUserId>int</ClientUserId>
      <ValueOne>int</ValueOne>
      <ValueTwo>int</ValueTwo>
    </AbstractVoteResponse>
    <AbstractVoteResponse>
      <AbstractVoteId>int</AbstractVoteId>
      <BookingId>int</BookingId>
      <ClientUserId>int</ClientUserId>
      <ValueOne>int</ValueOne>
      <ValueTwo>int</ValueTwo>
    </AbstractVoteResponse>
  </AbstractVotes>
  <AbstractComments>
    <AbstractCommentResponse>
      <AbstractCommentId>int</AbstractCommentId>
      <ClientUserId>int</ClientUserId>
      <BookingId>int</BookingId>
      <DateSubmitted>dateTime</DateSubmitted>
      <Comment>string</Comment>
      <ClientUserName>string</ClientUserName>
    </AbstractCommentResponse>
    <AbstractCommentResponse>
      <AbstractCommentId>int</AbstractCommentId>
      <ClientUserId>int</ClientUserId>
      <BookingId>int</BookingId>
      <DateSubmitted>dateTime</DateSubmitted>
      <Comment>string</Comment>
      <ClientUserName>string</ClientUserName>
    </AbstractCommentResponse>
  </AbstractComments>
  <PreviousSubmissionId>int</PreviousSubmissionId>
  <NextSubmissionId>int</NextSubmissionId>
  <AbstractCustomFields>
    <AbstractCustomFieldResponse>
      <FieldName>string</FieldName>
      <FieldValue>string</FieldValue>
    </AbstractCustomFieldResponse>
    <AbstractCustomFieldResponse>
      <FieldName>string</FieldName>
      <FieldValue>string</FieldValue>
    </AbstractCustomFieldResponse>
  </AbstractCustomFields>
</SubmissionDetailResponse>

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/GetSubmissionDetail HTTP/1.1
Host: developer.sym-online.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<SubmissionDetailResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <AbstractUrl>string</AbstractUrl>
  <AbstractFileKey>string</AbstractFileKey>
  <AbstractText>string</AbstractText>
  <AbstractRtfText>string</AbstractRtfText>
  <AbstractVotes>
    <AbstractVoteResponse>
      <AbstractVoteId>int</AbstractVoteId>
      <BookingId>int</BookingId>
      <ClientUserId>int</ClientUserId>
      <ValueOne>int</ValueOne>
      <ValueTwo>int</ValueTwo>
    </AbstractVoteResponse>
    <AbstractVoteResponse>
      <AbstractVoteId>int</AbstractVoteId>
      <BookingId>int</BookingId>
      <ClientUserId>int</ClientUserId>
      <ValueOne>int</ValueOne>
      <ValueTwo>int</ValueTwo>
    </AbstractVoteResponse>
  </AbstractVotes>
  <AbstractComments>
    <AbstractCommentResponse>
      <AbstractCommentId>int</AbstractCommentId>
      <ClientUserId>int</ClientUserId>
      <BookingId>int</BookingId>
      <DateSubmitted>dateTime</DateSubmitted>
      <Comment>string</Comment>
      <ClientUserName>string</ClientUserName>
    </AbstractCommentResponse>
    <AbstractCommentResponse>
      <AbstractCommentId>int</AbstractCommentId>
      <ClientUserId>int</ClientUserId>
      <BookingId>int</BookingId>
      <DateSubmitted>dateTime</DateSubmitted>
      <Comment>string</Comment>
      <ClientUserName>string</ClientUserName>
    </AbstractCommentResponse>
  </AbstractComments>
  <PreviousSubmissionId>int</PreviousSubmissionId>
  <NextSubmissionId>int</NextSubmissionId>
  <AbstractCustomFields>
    <AbstractCustomFieldResponse>
      <FieldName>string</FieldName>
      <FieldValue>string</FieldValue>
    </AbstractCustomFieldResponse>
    <AbstractCustomFieldResponse>
      <FieldName>string</FieldName>
      <FieldValue>string</FieldValue>
    </AbstractCustomFieldResponse>
  </AbstractCustomFields>
</SubmissionDetailResponse>