CMS Web Services - v4.0.6550.31684 [cms-b]

<back to all web services

CmsApplicationStatusGet

Returns a list showing the status of all applications running on the specified server.

The following routes are available for this service:
POST,GET/cms/applicationStatus/get
POST,GET/cms/applicationStatus
CmsApplicationStatusGet Parameters:
NameParameterData TypeRequiredDescription
CmsNamebodystringYesThe CMS name (e.g., 'Perth')
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
CmsApplicationStatusGetResponse Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CmsNameformstringNo
OnlineformboolNo
ApplicationsformList<CmsApplication>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CmsApplication Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
NameformstringNo
RunningformboolNo
VersionformstringNo

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

HTTP + XML

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

POST /cms/applicationStatus/get HTTP/1.1 
Host: halifax.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CmsApplicationStatusGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <CmsName>String</CmsName>
</CmsApplicationStatusGet>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CmsApplicationStatusGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <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:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Applications>
    <CmsApplication>
      <Name>String</Name>
      <Running>false</Running>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <Version>String</Version>
    </CmsApplication>
  </Applications>
  <CmsName>String</CmsName>
  <Online>false</Online>
  <Timestamp>0001-01-01T00:00:00</Timestamp>
</CmsApplicationStatusGetResponse>