A. Example of Swagger API call return

 

 

Previous Table of Content Next

 

 

A. Example of Swagger API call return

The below example shows the Swagger API call return of a model definition for the Change endpoint. Appendix B shows the same returned as JSON.

 

GeoRepository.WebAPI.Models.SearchResults[GeoRepository.WebAPI.Models.Change.ChangeSearchResult] {

Results (Array[GeoRepository.WebAPI.Models.Change.ChangeSearchResult], optional, read only),

Count (integer, optional, read only),

Page (integer, optional),

PageSize (integer, optional),

TotalResults (integer, optional),

Links (Array[GeoRepository.WebAPI.Models.Link], optional)

}
GeoRepository.WebAPI.Models.Change.ChangeSearchResult {

Code (number, optional),

Links (Array[GeoRepository.WebAPI.Models.Link], optional),

Name (string, optional),

Remark (string, optional),

DataSource (string, optional),

InformationSource (string, optional),

RevisionDate (string, optional),

Deprecations (Array[GeoRepository.WebAPI.Models.Entity.Deprecation], optional),

Supersessions (Array[GeoRepository.WebAPI.Models.Entity.Supersession], optional)

}
GeoRepository.WebAPI.Models.Link {

rel (string, optional),

href (string, optional)

}
GeoRepository.WebAPI.Models.Entity.Deprecation {

Id (integer, optional),

Date (string, optional),

ChangeId (number, optional),

ReplacedBy (GeoRepository.WebAPI.Models.ChildLink, optional),

Reason (string, optional)

}
GeoRepository.WebAPI.Models.Entity.Supersession {

Id (integer, optional),

SupersededBy (GeoRepository.WebAPI.Models.ChildLink, optional),

Year (integer, optional),

Remarks (string, optional)

}
GeoRepository.WebAPI.Models.ChildLink {

Code (integer, optional),

Name (string, optional),

href (string, optional)

}