POST Security/GetMenuStructure

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenVerifiedMenuStructureRequest
NameDescriptionTypeAdditional information
SecurityGroup

string

None.

SecurityKey

string

None.

PolicyId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SecurityGroup": "sample string 1",
  "SecurityKey": "sample string 2",
  "PolicyId": 3
}

application/xml, text/xml

Sample:
<SecurityTokenVerifiedMenuStructureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <PolicyId>3</PolicyId>
  <SecurityKey>sample string 2</SecurityKey>
  <SecurityGroup>sample string 1</SecurityGroup>
</SecurityTokenVerifiedMenuStructureRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfListOfMenuStructure
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

Collection of MenuStructure

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": [
    {
      "Id": 1,
      "Source": "sample string 2",
      "SecurityGroup": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "ComponentName": "sample string 6",
      "ParentId": 1,
      "Icon": "sample string 7",
      "Class": "sample string 8",
      "DisplayOrder": 1,
      "Visible": true,
      "StartDate": "2025-08-28T10:51:08.4733285+02:00",
      "EndDate": "2025-08-28T10:51:08.4733285+02:00"
    },
    {
      "Id": 1,
      "Source": "sample string 2",
      "SecurityGroup": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "ComponentName": "sample string 6",
      "ParentId": 1,
      "Icon": "sample string 7",
      "Class": "sample string 8",
      "DisplayOrder": 1,
      "Visible": true,
      "StartDate": "2025-08-28T10:51:08.4733285+02:00",
      "EndDate": "2025-08-28T10:51:08.4733285+02:00"
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfMenuStructurelP_S41WJs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
    <d2p1:MenuStructure>
      <d2p1:Class>sample string 8</d2p1:Class>
      <d2p1:ComponentName>sample string 6</d2p1:ComponentName>
      <d2p1:Description>sample string 5</d2p1:Description>
      <d2p1:DisplayOrder>1</d2p1:DisplayOrder>
      <d2p1:EndDate>2025-08-28T10:51:08.4733285+02:00</d2p1:EndDate>
      <d2p1:Icon>sample string 7</d2p1:Icon>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:ParentId>1</d2p1:ParentId>
      <d2p1:SecurityGroup>sample string 3</d2p1:SecurityGroup>
      <d2p1:Source>sample string 2</d2p1:Source>
      <d2p1:StartDate>2025-08-28T10:51:08.4733285+02:00</d2p1:StartDate>
      <d2p1:Visible>true</d2p1:Visible>
    </d2p1:MenuStructure>
    <d2p1:MenuStructure>
      <d2p1:Class>sample string 8</d2p1:Class>
      <d2p1:ComponentName>sample string 6</d2p1:ComponentName>
      <d2p1:Description>sample string 5</d2p1:Description>
      <d2p1:DisplayOrder>1</d2p1:DisplayOrder>
      <d2p1:EndDate>2025-08-28T10:51:08.4733285+02:00</d2p1:EndDate>
      <d2p1:Icon>sample string 7</d2p1:Icon>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:ParentId>1</d2p1:ParentId>
      <d2p1:SecurityGroup>sample string 3</d2p1:SecurityGroup>
      <d2p1:Source>sample string 2</d2p1:Source>
      <d2p1:StartDate>2025-08-28T10:51:08.4733285+02:00</d2p1:StartDate>
      <d2p1:Visible>true</d2p1:Visible>
    </d2p1:MenuStructure>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfArrayOfMenuStructurelP_S41WJs>