RetrieveSpaces

SpaceService / RetrieveSpaces

Description: Retrieve Spaces

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

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}

Request Query Parameters:

Parameter	Type	Nullable	Description
guids	string	True	comma separated values, eg. guids=296cb9fa-0443-11e5-a9ac-247703ee6d08,2e0ff3dc-0443-11e5-a9ac-247703ee6d08
sort	string	True	sorting fields: id, CreatedDate,UpdatedDate. Comma seperated values, unary negative to imply descending sort order, e.g. sort=-id
accids	int	True	Comma seperated values, e.g. accids=AccountId1,AccountId2
names	string	True	Comma seperated values, e.g. accids=SpaceName1,SpaceName2
active	bool	True	active status, e.g. active=true
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v1/core/spaces?guids=string&sort=string&accids=100

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Spaces.SpaceResponse

Parameter	Type
Response.TotalPages	int
Response.CurrentPage	int
Response.Rpp	int
Response.TotalCount	int
Response.Spaces	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Spaces.Space[]

The following is an example response Xml body:

<SpaceResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Spaces" 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>
  <Rpp>123</Rpp>
  <Spaces xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Spaces">
    <a:Space>
      <a:AccountId>123</a:AccountId>
      <a:Active>true</a:Active>
      <a:CreatedBy>123</a:CreatedBy>
      <a:CreatedDate>2015-07-01T11:06:05.1642397Z</a:CreatedDate>
      <a:Description>String</a:Description>
      <a:Guid>11111111-1111-1111-1111-111111111111</a:Guid>
      <a:IconAltBackgroundColor>String</a:IconAltBackgroundColor>
      <a:IconAltForegroundColor>String</a:IconAltForegroundColor>
      <a:IconAltText>String</a:IconAltText>
      <a:IconUrl>String</a:IconUrl>
      <a:Id>123</a:Id>
      <a:Name>String</a:Name>
      <a:UpdatedBy>123</a:UpdatedBy>
      <a:UpdatedDate>2015-07-01T11:06:05.1642397Z</a:UpdatedDate>
    </a:Space>
  </Spaces>
  <TotalCount>123</TotalCount>
  <TotalPages>123</TotalPages>
</SpaceResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"Spaces":[
		{
			"AccountId":123,
			"Active":true,
			"CreatedBy":123,
			"CreatedDate":"\/Date(1435748765164)\/",
			"Description":"String",
			"Guid":"11111111-1111-1111-1111-111111111111",
			"IconAltBackgroundColor":"String",
			"IconAltForegroundColor":"String",
			"IconAltText":"String",
			"IconUrl":"String",
			"Id":123,
			"Name":"String",
			"UpdatedBy":123,
			"UpdatedDate":"\/Date(1435748765164)\/"
		}
	],
	"TotalCount":123,
	"TotalPages":123
}