Introduction

Overview

This is an OData version 4.0 standard compliant REST API that exposes entities and their relationships using well defined access, navigation and modification rules.

*Please note that XOData has generated this document by interpreting just the metadata document ( /$metadata ) provided by this API according to OData specification. API Developer should review the generated information. Further, text descriptions can be super-imposed by a technical writer to complete the API documentation. XOData API Log can be used to prepare request/response details for Methods & Examples section.

**Auto-save is provided for edits using local storage(limited memory). Please download the document after manual additions.

Version

API Name	Microsoft.OData.SampleService.Models.TripPin
API Version
OData Protocol Version	4.0

Authentication

Access

Following API endpoint and resources are exposed to be accessible with appropriate authorization.

Service Level Documents

Service Document	http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/
Metadata Document	http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/$metadata

Top Level Resources

Photo	http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/Photos
Person	http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/People
Airline	http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/Airlines
Airport	http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/Airports

Indirectly Accessible Resources

PlanItem	Accessible through parent Resource i.e. Trip
PublicTransportation	Accessible through parent of base type Resource i.e. PlanItem
Flight	Accessible through parent of base type Resource i.e. PublicTransportation
Event	Accessible through parent of base type Resource i.e. PlanItem
Trip	Accessible through parent Resource i.e. Person

Error Codes

Standard HTTP status codes are used for HTTP communication level error information. Further, OData Protocol level and application level error information is provided in the message-body. Application level error information is provided with a well defined structure. An example error response in JSON format is as below:

Sample Error Response

HTTP/1.1 404 Not Found

{
  "error": {
    "code": "NotFound",
    "message": "Resource not found for the segment 'Wrong Resource Name'.",
    "innererror": {
      "message": "Further application level details on error.",
      "type": "Type of Error Text"
    }
  }
}

About OData

OData : Open Data Protocol is a standard to enable the development and consumption of consistent and functionally effective Web APIs. Since OData is a standard, it also enables the ecosystem of compliant frameworks, generic tools and applications that help people from diverse skill-set, technical as well as business/domain background to get involved with API/Application development and consumption. For a REST API Standard, OData (V1 to V3) was well received by the enterprise business application software industry and OData V4 is now an ISO and OASIS standard as well.

For further details, please refer to:

OData.org
OASIS Open Data Protocol (OData) ( For OData V4 )

Additionally, PragmatiQa's OData Directory has a growing list of publicly accessible Reference/Demo/Sample OData Services & APIs that can be explored using integrated XOData or through other generic OData tools with support for corresponding version of OData.

Entities

Photo

Photo Properties

name	type	Description	nullable
Id 🔑	Edm.Int64		false
Name	Edm.String

Photo Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.Photo",
  "Id": "",
  "Name": ""
}

Photo Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/Photos

Request

Content-type: application/json

Response

Person

Person Properties

name	type	nullable
UserName 🔑	Edm.String	false
FirstName	Edm.String	false
LastName	Edm.String	false
Emails	Collection(Edm.String)
AddressInfo	Collection(Microsoft.OData.SampleService.Models.TripPin.Location)
Gender	Microsoft.OData.SampleService.Models.TripPin.PersonGender
Concurrency	Edm.Int64	false

Person Relations

name	Entity Type	Type	containsTarget
Friends	Person	Collection(Microsoft.OData.SampleService.Models.TripPin.Person)
Trips	Trip	Collection(Microsoft.OData.SampleService.Models.TripPin.Trip)	true
Photo	Photo	Microsoft.OData.SampleService.Models.TripPin.Photo

Person Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.Person",
  "UserName": "",
  "FirstName": "",
  "LastName": "",
  "Emails": [
    ""
  ],
  "AddressInfo": [
    {
      "Address": "",
      "City": {
        "CountryRegion": "",
        "Name": "",
        "Region": ""
      }
    }
  ],
  "Gender": "Male",
  "Concurrency": ""
}

Person Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/People

Request

Content-type: application/json

Response

Airline

Airline Properties

name	type	Description	nullable
AirlineCode 🔑	Edm.String		false
Name	Edm.String		false

Airline Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.Airline",
  "AirlineCode": "",
  "Name": ""
}

Airline Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/Airlines

Request

Content-type: application/json

Response

Airport

Airport Properties

name	type	nullable
IcaoCode 🔑	Edm.String	false
Name	Edm.String	false
IataCode	Edm.String	false
Location	Microsoft.OData.SampleService.Models.TripPin.AirportLocation	false

Airport Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.Airport",
  "IcaoCode": "",
  "Name": "",
  "IataCode": "",
  "Location": {
    "Loc": "",
    "Address": "",
    "City": {
      "CountryRegion": "",
      "Name": "",
      "Region": ""
    }
  }
}

Airport Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/Airports

Request

Content-type: application/json

Response

PlanItem

PlanItem Properties

name	type	nullable
PlanItemId 🔑	Edm.Int32	false
ConfirmationCode	Edm.String
StartsAt	Edm.DateTimeOffset
EndsAt	Edm.DateTimeOffset
Duration	Edm.Duration

PlanItem Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.PlanItem",
  "PlanItemId": 0,
  "ConfirmationCode": "",
  "StartsAt": "2016-07-25T11:45:16Z",
  "EndsAt": "2016-07-25T11:45:16Z",
  "Duration": ""
}

PlanItem Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/<SPECIFY_PARENT_RESOURCE(KEY)>/PlanItem

Request

Content-type: application/json

Response

PublicTransportation

PublicTransportation Properties

name	type	Description
SeatNumber	Edm.String

PublicTransportation Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.PublicTransportation",
  "SeatNumber": "",
  "PlanItemId": 0,
  "ConfirmationCode": "",
  "StartsAt": "2016-07-25T11:45:16Z",
  "EndsAt": "2016-07-25T11:45:16Z",
  "Duration": ""
}

PublicTransportation Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/<SPECIFY_PARENT_RESOURCE(KEY)>/Microsoft.OData.SampleService.Models.TripPin.PublicTransportation

Request

Content-type: application/json

Response

Flight

Flight Properties

name	type	Description	nullable
FlightNumber	Edm.String		false

Flight Relations

name	Entity Type	Type	Nullable
From	Airport	Microsoft.OData.SampleService.Models.TripPin.Airport	false
To	Airport	Microsoft.OData.SampleService.Models.TripPin.Airport	false
Airline	Airline	Microsoft.OData.SampleService.Models.TripPin.Airline	false

Flight Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.Flight",
  "FlightNumber": "",
  "SeatNumber": "",
  "PlanItemId": 0,
  "ConfirmationCode": "",
  "StartsAt": "2016-07-25T11:45:16Z",
  "EndsAt": "2016-07-25T11:45:16Z",
  "Duration": ""
}

Flight Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/<SPECIFY_PARENT_RESOURCE(KEY)>/Microsoft.OData.SampleService.Models.TripPin.Flight

Request

Content-type: application/json

Response

Event

Event Properties

name	type	Description	nullable
Description	Edm.String
OccursAt	Microsoft.OData.SampleService.Models.TripPin.EventLocation		false

Event Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.Event",
  "Description": "",
  "OccursAt": {
    "BuildingInfo": "",
    "Address": "",
    "City": {
      "CountryRegion": "",
      "Name": "",
      "Region": ""
    }
  },
  "PlanItemId": 0,
  "ConfirmationCode": "",
  "StartsAt": "2016-07-25T11:45:16Z",
  "EndsAt": "2016-07-25T11:45:16Z",
  "Duration": ""
}

Event Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/<SPECIFY_PARENT_RESOURCE(KEY)>/Microsoft.OData.SampleService.Models.TripPin.Event

Request

Content-type: application/json

Response

Trip

Trip Properties

name	type	nullable
TripId 🔑	Edm.Int32	false
ShareId	Edm.Guid
Description	Edm.String
Name	Edm.String	false
Budget	Edm.Single	false
StartsAt	Edm.DateTimeOffset	false
EndsAt	Edm.DateTimeOffset	false
Tags	Collection(Edm.String)	false

Trip Relations

name	Entity Type	Description	extensions	Type	containsTarget
Photos	Photo			Collection(Microsoft.OData.SampleService.Models.TripPin.Photo)
PlanItems	PlanItem			Collection(Microsoft.OData.SampleService.Models.TripPin.PlanItem)	true

Trip Representation

{
  "@odata.type": "Microsoft.OData.SampleService.Models.TripPin.Trip",
  "TripId": 0,
  "ShareId": "",
  "Description": "",
  "Name": "",
  "Budget": 0,
  "StartsAt": "2016-07-25T11:45:16Z",
  "EndsAt": "2016-07-25T11:45:16Z",
  "Tags": [
    ""
  ]
}

Trip Methods & Examples

GET

http://services.odata.org/V4/(S(jndgbgy2tbu1vjtzyoei2w3e))/TripPinServiceRW/<SPECIFY_PARENT_RESOURCE(KEY)>/Trip

Request

Content-type: application/json

Response

Complex Types

City

City Properties

name	type	nullable
CountryRegion	Edm.String	false
Name	Edm.String	false
Region	Edm.String	false

Location

Location Properties

name	type	Description	nullable
Address	Edm.String		false
City	Microsoft.OData.SampleService.Models.TripPin.City		false

EventLocation

EventLocation Properties

name	type	Description
BuildingInfo	Edm.String

AirportLocation

AirportLocation Properties

name	type	Description	nullable	SRID
Loc	Edm.GeographyPoint		false	4326

Actions

ResetDataSource

ResetDataSource Properties

N/A

ResetDataSource Methods & Examples

GET

http://

Request

Content-type: application/json

Response

ShareTrip

ShareTrip Properties

name	type	nullable
person	Microsoft.OData.SampleService.Models.TripPin.Person	false
userName	Edm.String	false
tripId	Edm.Int32	false

ShareTrip Methods & Examples

GET

http://

Request

Content-type: application/json

Response

Functions

GetFavoriteAirline

GetFavoriteAirline Parameters and Return Type

name	type	Description	nullable
person	Microsoft.OData.SampleService.Models.TripPin.Person		false
ReturnType	Microsoft.OData.SampleService.Models.TripPin.Airline

GetFavoriteAirline Methods & Examples

GET

http://

Request

Content-type: application/json

Response

GetInvolvedPeople

GetInvolvedPeople Parameters and Return Type

name	type	Description	nullable
trip	Microsoft.OData.SampleService.Models.TripPin.Trip		false
ReturnType	Collection(Microsoft.OData.SampleService.Models.TripPin.Person)

GetInvolvedPeople Methods & Examples

GET

http://

Request

Content-type: application/json

Response

GetFriendsTrips

GetFriendsTrips Parameters and Return Type

name	type	nullable
person	Microsoft.OData.SampleService.Models.TripPin.Person	false
userName	Edm.String	false
ReturnType	Collection(Microsoft.OData.SampleService.Models.TripPin.Trip)

GetFriendsTrips Methods & Examples

GET

http://

Request

Content-type: application/json

Response

GetNearestAirport

GetNearestAirport Parameters and Return Type

name	type	nullable
lat	Edm.Double	false
lon	Edm.Double	false
ReturnType	Microsoft.OData.SampleService.Models.TripPin.Airport

GetNearestAirport Methods & Examples

GET

http://

Request

Content-type: application/json