RetrieveServerStatus

 

ServerService / RetrieveServerStatus

 

Description: Retrieve server status

URL: http://{your-server-url}/api/v1/core/servers/statuses/{statusguid}

Method: GET

Token Required: True


Request Headers:
currentaccountid: {accountid - optional and default value is user's own account}
content-type: application/json or content-type: application/xml
token: {token}
Required Roles:

Portal Administrator, Account Administrator, Account Owner

Rights:

Type: Nexus.AppSpace.Service.Contract.Model.Enums.Rights.Rights

Right Require
Account_Owner Yes

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Server.ServerResponse

Parameter Type Comment
Response.Status Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Servers.ServerStatus Server Object only return server's Guid and Name

Enums:
Field Name Values
Type Nexus.AppSpace.Service.Contract.Model.Enums.Server.ServerType SmartHub = 0, Undefined = 1

The following is an example response Xml body:
<ServerResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Server" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
</ServerResponse>

The following is an example response Json body:
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1
}