GET api/v0/Login/GetUserComponentPermission

Request Information

URI Parameters

None.

Body Parameters

GetUserComponentPermissionContract
NameDescriptionTypeAdditional information
Token

string

None.

solutionCode

string

None.

componentCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Token": "sample string 1",
  "solutionCode": "sample string 2",
  "componentCode": "sample string 3"
}

application/xml, text/xml

Sample:
<GetUserComponentPermissionContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.agrifoodatsolutions.com/FDService/Login/contracts/2017/01">
  <Token>sample string 1</Token>
  <componentCode>sample string 3</componentCode>
  <solutionCode>sample string 2</solutionCode>
</GetUserComponentPermissionContract>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetUserComponentPermissionData
NameDescriptionTypeAdditional information
Component

ComponentData

None.

AccessTypeAllowed

PermissionAccessTypesEnum

None.

Status

GetUserComponentPermissionStatus

None.

StatusMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Component": {
    "ID": 1,
    "SolutionID": 2,
    "Solution": {
      "ID": 1,
      "SolutionCode": "sample string 2",
      "Name": "sample string 3"
    },
    "ComponentCode": "sample string 3",
    "Name": "sample string 4"
  },
  "AccessTypeAllowed": 0,
  "Status": 0,
  "StatusMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<GetUserComponentPermissionData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.agrifoodatsolutions.com/FDService/Login/contracts/2017/01">
  <AccessTypeAllowed>NotAllowed</AccessTypeAllowed>
  <Component xmlns:d2p1="http://schemas.datacontract.org/2004/07/Agrifood.CloudFD.Service.AuthDataContracts">
    <d2p1:ComponentCode>sample string 3</d2p1:ComponentCode>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Name>sample string 4</d2p1:Name>
    <d2p1:Solution>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:SolutionCode>sample string 2</d2p1:SolutionCode>
    </d2p1:Solution>
    <d2p1:SolutionID>2</d2p1:SolutionID>
  </Component>
  <Status>Succesful</Status>
  <StatusMessage>sample string 1</StatusMessage>
</GetUserComponentPermissionData>