GET api/ApnAdminEntity/Context?entityID={entityID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| entityID | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ApiResultOfEntityContext| Name | Description | Type | Additional information |
|---|---|---|---|
| Response | ApiResponse |
None. |
|
| Data | EntityContext |
None. |
Response Formats
application/json, text/json
Sample:
{
"Response": {
"Success": true,
"ErrorMessage": "sample string 2"
},
"Data": {
"EntityID": 1,
"Entity": "sample string 1",
"EntityStatus": "sample string 2",
"IsInactive": true,
"Nodes": [
{
"Key": "sample string 1",
"Title": "sample string 2",
"Group": "sample string 3",
"CanEdit": true
},
{
"Key": "sample string 1",
"Title": "sample string 2",
"Group": "sample string 3",
"CanEdit": true
}
],
"Flags": {
"SettingsPermissionsEnabled": true,
"ApprovalRequired": true,
"SalesPersonMandatory": true,
"SiteMandatory": true,
"CauseOfActionTypeMandatory": true,
"HideExcludeReversedPayments": true
}
}
}
application/xml, text/xml
Sample:
<ApiResultOfEntityContext289WtATZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Admin">
<d2p1:Entity>sample string 1</d2p1:Entity>
<d2p1:EntityID>1</d2p1:EntityID>
<d2p1:EntityStatus>sample string 2</d2p1:EntityStatus>
<d2p1:Flags>
<d2p1:ApprovalRequired>true</d2p1:ApprovalRequired>
<d2p1:CauseOfActionTypeMandatory>true</d2p1:CauseOfActionTypeMandatory>
<d2p1:HideExcludeReversedPayments>true</d2p1:HideExcludeReversedPayments>
<d2p1:SalesPersonMandatory>true</d2p1:SalesPersonMandatory>
<d2p1:SettingsPermissionsEnabled>true</d2p1:SettingsPermissionsEnabled>
<d2p1:SiteMandatory>true</d2p1:SiteMandatory>
</d2p1:Flags>
<d2p1:IsInactive>true</d2p1:IsInactive>
<d2p1:Nodes>
<d2p1:EntityNode>
<d2p1:CanEdit>true</d2p1:CanEdit>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Title>sample string 2</d2p1:Title>
</d2p1:EntityNode>
<d2p1:EntityNode>
<d2p1:CanEdit>true</d2p1:CanEdit>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Title>sample string 2</d2p1:Title>
</d2p1:EntityNode>
</d2p1:Nodes>
</Data>
<Response>
<ErrorMessage>sample string 2</ErrorMessage>
<Success>true</Success>
</Response>
</ApiResultOfEntityContext289WtATZ>