POST api/Policy/PolicyAgents

Policy agents list endpoint.

Request Information

URI Parameters

None.

Body Parameters

List of policies database Ids.

PolicyDataBaseIds
NameDescriptionTypeAdditional information
PolicyDataBaseId

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "policyDataBaseId": [
    "26f602a1-30c4-48a4-92c1-defdfd1e23d7",
    "3593534c-11cb-4cdd-8a64-81317e8847a4"
  ]
}

application/xml, text/xml

Sample:
<PolicyDataBaseIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData">
  <PolicyDataBaseId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>26f602a1-30c4-48a4-92c1-defdfd1e23d7</d2p1:guid>
    <d2p1:guid>3593534c-11cb-4cdd-8a64-81317e8847a4</d2p1:guid>
  </PolicyDataBaseId>
</PolicyDataBaseIds>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of PolicyAgentsCSRS against given policies database Ids.

PolicyAgentsCSRS
NameDescriptionTypeAdditional information
DatabaseId

globally unique identifier

None.

FirstName

string

None.

LastName

string

None.

Order

integer

None.

PolicyDatabaseId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "databaseId": "2b8e32bc-bd74-4730-887e-8639e97aa4a4",
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "order": 4,
  "policyDatabaseId": "2e6c67ee-dddd-4744-876d-b23267bbcb65"
}

application/xml, text/xml

Sample:
<PolicyAgentsCSRS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <DatabaseId>2b8e32bc-bd74-4730-887e-8639e97aa4a4</DatabaseId>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <Order>4</Order>
  <PolicyDatabaseId>2e6c67ee-dddd-4744-876d-b23267bbcb65</PolicyDatabaseId>
</PolicyAgentsCSRS>