GET api/Files/GetOpportunityLevelFolders/{opportunityDatabaseId}

Returns opportunity files folder details.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
opportunityDatabaseId

Opportunity database Id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Opportunity level folder details.

NowCertsApiResultOfFolderDetails
NameDescriptionTypeAdditional information
Status

ApiStatus

None.

Data

FolderDetails

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": 0,
  "data": {
    "id": "a34a4faa-eb2b-428f-a745-a6ce8b352636",
    "parentId": "b2b9416a-f96c-4ed6-b44e-b93349dd4a01",
    "name": "sample string 2",
    "isSystemFolder": true,
    "systemFolderType": 0,
    "type": 4,
    "insuredDatabaseId": "93bcb96b-e903-4782-a252-38cceee391df",
    "opportunityIdDatabaseId": "86d33afe-bc76-4a0c-9207-721ba12c34ba",
    "policyDatabaseId": "b6a069de-b121-41c7-81c0-775e8cec84f3",
    "createDate": "2024-12-10T09:24:07.1661161-06:00",
    "changeDate": "2024-12-10T09:24:07.1661161-06:00"
  },
  "message": "sample string 1"
}

application/xml, text/xml

Sample:
<NowCertsApiResultOfFolderDetailsmXcRfcts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum.File">
    <d2p1:ChangeDate>2024-12-10T09:24:07.1661161-06:00</d2p1:ChangeDate>
    <d2p1:CreateDate>2024-12-10T09:24:07.1661161-06:00</d2p1:CreateDate>
    <d2p1:Id>a34a4faa-eb2b-428f-a745-a6ce8b352636</d2p1:Id>
    <d2p1:InsuredDatabaseId>93bcb96b-e903-4782-a252-38cceee391df</d2p1:InsuredDatabaseId>
    <d2p1:IsSystemFolder>true</d2p1:IsSystemFolder>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:OpportunityIdDatabaseId>86d33afe-bc76-4a0c-9207-721ba12c34ba</d2p1:OpportunityIdDatabaseId>
    <d2p1:ParentId>b2b9416a-f96c-4ed6-b44e-b93349dd4a01</d2p1:ParentId>
    <d2p1:PolicyDatabaseId>b6a069de-b121-41c7-81c0-775e8cec84f3</d2p1:PolicyDatabaseId>
    <d2p1:SystemFolderType>InsuredsRoot</d2p1:SystemFolderType>
    <d2p1:Type>4</d2p1:Type>
  </Data>
  <Message>sample string 1</Message>
  <Status>Error</Status>
</NowCertsApiResultOfFolderDetailsmXcRfcts>