GET v1/SurveyResources

User roles allowed to make this request: DomainAdministrator LocalDomainManager GlobalDomainManager OperationsUser DemoUser

Permissions required to make this request: SurveyResource.Read Survey.Read

This method retrieves a list of all survey resources. This list can be filtered and sorted using standard OData syntax.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A (filtered) list of survey resources

Response Message

Collection of SurveyResourceModel

Name	Description	Type	Additional information
SurveyId	The survey id	string	None.
Name	The survey name	string	None.
Channel	The survey channel	SurveyChannel	None.
CreationDate	The time at which the survey was created	date	None.
ClientName	The client name for the survey	string	None.
State	The survey state	SurveyState	None.
Owner	Display name for the survey's owner	string	None.
LastDataDownloadDate	Last time the survey was downloaded	date	None.
LastDataCollectionDate	Last time data was collected for the survey	date	None.
WillBeStoppedOn	Date on which the survey will be automatically stopped	date	None.
WillBeDeletedOn	Date on which the survey will be automatically deleted	date	None.
Size	Size of the survey in bytes	integer	None.
IsExcludedFromAutomaticCleanup	True if the survey is excluded from automatic deletion otherwise false	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SurveyId": "sample string 1",
    "Name": "sample string 2",
    "Channel": 0,
    "CreationDate": "2024-05-18T20:40:54.8823972+00:00",
    "ClientName": "sample string 3",
    "State": 0,
    "Owner": "sample string 4",
    "LastDataDownloadDate": "2024-05-18T20:40:54.8823972+00:00",
    "LastDataCollectionDate": "2024-05-18T20:40:54.8823972+00:00",
    "WillBeStoppedOn": "2024-05-18T20:40:54.8823972+00:00",
    "WillBeDeletedOn": "2024-05-18T20:40:54.8823972+00:00",
    "Size": 1,
    "IsExcludedFromAutomaticCleanup": true
  },
  {
    "SurveyId": "sample string 1",
    "Name": "sample string 2",
    "Channel": 0,
    "CreationDate": "2024-05-18T20:40:54.8823972+00:00",
    "ClientName": "sample string 3",
    "State": 0,
    "Owner": "sample string 4",
    "LastDataDownloadDate": "2024-05-18T20:40:54.8823972+00:00",
    "LastDataCollectionDate": "2024-05-18T20:40:54.8823972+00:00",
    "WillBeStoppedOn": "2024-05-18T20:40:54.8823972+00:00",
    "WillBeDeletedOn": "2024-05-18T20:40:54.8823972+00:00",
    "Size": 1,
    "IsExcludedFromAutomaticCleanup": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfSurveyResourceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SurveyResourceModel>
    <Channel>Unknown</Channel>
    <ClientName>sample string 3</ClientName>
    <CreationDate>2024-05-18T20:40:54.8823972+00:00</CreationDate>
    <IsExcludedFromAutomaticCleanup>true</IsExcludedFromAutomaticCleanup>
    <LastDataCollectionDate>2024-05-18T20:40:54.8823972+00:00</LastDataCollectionDate>
    <LastDataDownloadDate>2024-05-18T20:40:54.8823972+00:00</LastDataDownloadDate>
    <Name>sample string 2</Name>
    <Owner>sample string 4</Owner>
    <Size>1</Size>
    <State>UnderConstruction</State>
    <SurveyId>sample string 1</SurveyId>
    <WillBeDeletedOn>2024-05-18T20:40:54.8823972+00:00</WillBeDeletedOn>
    <WillBeStoppedOn>2024-05-18T20:40:54.8823972+00:00</WillBeStoppedOn>
  </SurveyResourceModel>
  <SurveyResourceModel>
    <Channel>Unknown</Channel>
    <ClientName>sample string 3</ClientName>
    <CreationDate>2024-05-18T20:40:54.8823972+00:00</CreationDate>
    <IsExcludedFromAutomaticCleanup>true</IsExcludedFromAutomaticCleanup>
    <LastDataCollectionDate>2024-05-18T20:40:54.8823972+00:00</LastDataCollectionDate>
    <LastDataDownloadDate>2024-05-18T20:40:54.8823972+00:00</LastDataDownloadDate>
    <Name>sample string 2</Name>
    <Owner>sample string 4</Owner>
    <Size>1</Size>
    <State>UnderConstruction</State>
    <SurveyId>sample string 1</SurveyId>
    <WillBeDeletedOn>2024-05-18T20:40:54.8823972+00:00</WillBeDeletedOn>
    <WillBeStoppedOn>2024-05-18T20:40:54.8823972+00:00</WillBeStoppedOn>
  </SurveyResourceModel>
</ArrayOfSurveyResourceModel>