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]optionalread only),

Count (integeroptionalread only),

Page (integeroptional),

PageSize (integeroptional),

TotalResults (integeroptional),

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

}
GeoRepository.WebAPI.Models.Change.ChangeSearchResult {

Code (numberoptional),

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

Name (stringoptional),

Remark (stringoptional),

DataSource (stringoptional),

InformationSource (stringoptional),

RevisionDate (stringoptional),

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

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

}
GeoRepository.WebAPI.Models.Link {

rel (stringoptional),

href (stringoptional)

}
GeoRepository.WebAPI.Models.Entity.Deprecation {

Id (integeroptional),

Date (stringoptional),

ChangeId (numberoptional),

ReplacedBy (GeoRepository.WebAPI.Models.ChildLinkoptional),

Reason (stringoptional)

}
GeoRepository.WebAPI.Models.Entity.Supersession {

Id (integeroptional),

SupersededBy (GeoRepository.WebAPI.Models.ChildLinkoptional),

Year (integeroptional),

Remarks (stringoptional)

}
GeoRepository.WebAPI.Models.ChildLink {

Code (integeroptional),

Name (stringoptional),

href (stringoptional)

}