VitalWare API

Dashboard

Gets Dashboard Items

To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: api.vitalware.com 
Content-Type: text/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>

<Dashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vw.Api.ServiceModel.App.Dashboard" />

    </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
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>

<DashboardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vw.Api.ServiceModel.App.Dashboard">
  <FeatureDocuments>
    <FeaturesDocument>
      <MimeType>String</MimeType>
      <ProductName>String</ProductName>
      <SourceUrl>String</SourceUrl>
    </FeaturesDocument>
  </FeatureDocuments>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <TrainingMaterials>
    <TrainingMaterial>
      <Bolded>false</Bolded>
      <HtmlDescription>String</HtmlDescription>
      <MediaType>String</MediaType>
      <PreviewImageUrl>String</PreviewImageUrl>
      <ProductName>String</ProductName>
      <Title>String</Title>
      <Tooltip>String</Tooltip>
    </TrainingMaterial>
  </TrainingMaterials>
  <Webinars>
    <Webinars>
      <Bolded>false</Bolded>
      <BoldedEntryName>String</BoldedEntryName>
      <DisplayOn>0001-01-01T00:00:00</DisplayOn>
      <DisplayOnText>String</DisplayOnText>
      <EntryId>0</EntryId>
      <EntryName>String</EntryName>
      <ScheduleOn>0001-01-01T00:00:00</ScheduleOn>
      <ScheduleOnText>String</ScheduleOnText>
      <TimeZone>String</TimeZone>
      <TrainingUrl>String</TrainingUrl>
    </Webinars>
  </Webinars>
</DashboardResponse>

    </soap12:Body>
</soap12:Envelope>