RetrieveSlugs

 

TagService / RetrieveSlugs

 

Description: Retrieve slugs

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

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}
currentuserid: {switch to user id}
Rights:

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

Right Require Comment
Portal_Adminstrator Optional Required either one for switch user
Account_Adminstrator Optional

Request Query Parameters:
Parameter Type Nullable Description
slugids int[] True comma separated values, eg. slugids=1,2,3
resourcescope Contract.Model.Enums.Resource.Scope True
resourceids int[] True comma separated values, eg. resourceids=1,2,3
includereadonly boolean True include read only resources, eg. includereadonly=true
page int True page number
rpp int True records per page, will retrieve all by default

Example: http://{your-server-url}/api/v1/core/tags/slugs?slugids=1,2,3&resourceids=1,2,3&page=100


Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Tag.TagResponse

Parameter Type
Response.Slugs string[]
Response.CurrentPage int
Response.TotalPages int
Response.TotalCount int
Response.Rpp int

The following is an example response Xml body:
<TagResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Tag" 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>
  <Slugs xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:string>String</a:string>
  </Slugs>
  <TotalCount>123</TotalCount>
  <TotalPages>123</TotalPages>
</TagResponse>

The following is an example response Json body:
{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"Slugs":[
		"String"
	],
	"TotalCount":123,
	"TotalPages":123
}