RetrieveServer

ServerService / RetrieveServer

Description: Retrieve server

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

Method: GET

Token Required: True

Request Headers:

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

Required Roles:

Portal Administrator, Account Administrator, Account Owner

Rights:

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

Right	Require
Account_Owner	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
includebinding	bool	True	include server bindings, default = false

Example: http://{your-server-url}/api/v1/core/servers/{serverguid}?

Response:

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

Parameter	Type
Response.Server	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Servers.Server

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>
  <Server xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Servers">
    <a:AccountId>123</a:AccountId>
    <a:CreatedDate>2014-06-17T16:58:36.8593376Z</a:CreatedDate>
    <a:Description>String</a:Description>
    <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
    <a:IP>String</a:IP>
    <a:Id>123</a:Id>
    <a:LastUpdated>2014-06-17T16:58:36.8593376Z</a:LastUpdated>
    <a:MetaData xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
      <b:KeyValuePair>
        <b:Key>String</b:Key>
        <b:Value>String</b:Value>
      </b:KeyValuePair>
    </a:MetaData>
    <a:Name>String</a:Name>
    <a:Priority>123</a:Priority>
    <a:Provider>String</a:Provider>
    <a:Type>Undefined</a:Type>
  </Server>
</ServerResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"Server":{
		"AccountId":123,
		"CreatedDate":"\/Date(1403024316859)\/",
		"Description":"String",
		"Guid":"11111111-1111-1111-1111-111111111111",
		"IP":"String",
		"Id":123,
		"LastUpdated":"\/Date(1403024316859)\/",
		"MetaData":[
			{
				"Key":"String",
				"Value":"String"
			}
		],
		"Name":"String",
		"Priority":123,
		"Provider":"String",
		"Type":1
	}
}