StreetSmart services expose their functionality through RESTful interface. Each service implements one or more resources exposed through HTTP endpoints. A resource is an abstract thing which corresponds to some concept in a business domain (e.g., a car park). Resources are retrieved and manipulated by their representations encoded in JSON-LD format.
Important: It is important to remember that when you query the data service you receive some representation of a resource and not the resource itself (as it is an abstract concept and cannot be retrieved). |
Note: •The same resource can have an infinite number of representations. •A representation can be partial or can be enhanced with additional meta-data. |
Each resource is identified by a unique IRI (e.g. https:/{domain}/{platform}/businesscustomer/parks/V1/{ParkID}).
Very often there is a relation between two resources. Such relations are represented in resource representations by hyperlinks.
StreetSmart services support HATEOAS concept. Possible actions, which can lead to a change in the state of the resource, are exposed as hyperlinks.
