RetrieveNetworks

NetworkService / RetrieveNetworks

Description: Retrieve networks

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

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, Network Administrator

Rights:

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

Right	Require
Network_Management	Yes

Request Query Parameters:

Parameter	Type	Nullable	Description
networkids	int[]	True	comma separated values, eg. networkids=1,2,3
networkguids	string[]	True	comma separated values, eg. networkguids=xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx,xxxx-xxxx-xxxx-xxxx
name	string	True	name
includesubnetwork	boolean	True	include sub networks
includereadonly	boolean	True	include read only resources, eg. includereadonly=true
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/networks?networkids=1,2,3&name=string&page=100

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Network.NetworkResponse

Parameter	Type
Response.Networks	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Networks.Network[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

The following is an example response Xml body:

<NetworkResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Network" 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>
  <CurrentPage>123</CurrentPage>
  <Networks xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Networks">
    <a:Network>
      <a:AccountId>123</a:AccountId>
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:Id>123</a:Id>
      <a:LastUpdate>2014-09-18T11:01:10.810818Z</a:LastUpdate>
      <a:Name>String</a:Name>
      <a:ParentId>123</a:ParentId>
    </a:Network>
  </Networks>
  <Rpp>123</Rpp>
  <TotalPages>123</TotalPages>
</NetworkResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Networks":[
		{
			"AccountId":123,
			"Guid":"11111111-1111-1111-1111-111111111111",
			"Id":123,
			"LastUpdate":"\/Date(1411038070810)\/",
			"Name":"String",
			"ParentId":123
		}
	],
	"Rpp":123,
	"TotalPages":123
}