API Result Documentation

API Result is a data model that holds information about the results from the request made.

This data is only sent when a request can be processed.

What is a Query Param?

Api Result Model

Result model for successful API request

• Links ( Array[Link] ) Links related to the current API request
• LastUpdated ( DateTime ) Date the data was last retrieved
• AccecptedFilters ( Array[QueryParam] , optional ) Filters that were validated and applied
• RejectedFilters ( Array[QueryParam] , optional ) Filters that failed validation and were not applied
• TotalPageCount ( Int32 ) Total number of pages of data available. (Based on current page size)
• TotalResultCount ( Int32 ) Total result count of the API request
• CurrentResultCount ( Int32 ) Number of results returned from the API (May vary from total results if pagination occurred)
• Results ( Array[Result] ) List of the requested API data (cameras, construction, etc)

Link Model

Links capture data related to the current model they live on. The type of link is dependent on the rel property.

• Href ( String ) Url to a page or endpoint
• Rel ( String ) Identifier for the href url. [self] = link to the current item, [documentation] = link to related documentation, [redirect] = link to redirect page
• Method ( String , optional ) Method type of the link. If not displayed then GET is assumed.