Loading Points API Guide
Read LoadingPoint by number - Successfully
GET /v1/loading-points/5819768/4201
Path Variables
Path Variable | Type | Optional | Description |
---|---|---|---|
servicePointNumber |
Integer |
false |
|
loadingPointNumber |
Integer |
false |
Example request
$ curl 'http://localhost:8080/v1/loading-points/5819768/4201' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 539
[ {
"creationDate" : "2025-05-26T10:57:37.765646",
"creator" : "e123456",
"editionDate" : "2025-05-26T10:57:37.76568",
"editor" : "e123456",
"status" : null,
"id" : 1017,
"number" : 4201,
"designation" : "Piazzale",
"designationLong" : "Piazzaleee",
"connectionPoint" : false,
"validFrom" : "2018-06-28",
"validTo" : "2099-12-31",
"etagVersion" : 0,
"servicePointNumber" : {
"number" : 5819768,
"numberShort" : 19768,
"checkDigit" : 1,
"uicCountryCode" : 58
},
"servicePointSloid" : null
} ]
Read LoadingPoint by ID - Successfully
GET /v1/loading-points/versions/1013
Path Variables
Path Variable | Type | Optional | Description |
---|---|---|---|
id |
Integer |
false |
Example request
$ curl 'http://localhost:8080/v1/loading-points/versions/1013' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 536
{
"creationDate" : "2025-05-26T10:57:36.573158",
"creator" : "e123456",
"editionDate" : "2025-05-26T10:57:36.573191",
"editor" : "e123456",
"status" : null,
"id" : 1013,
"number" : 4201,
"designation" : "Piazzale",
"designationLong" : "Piazzaleee",
"connectionPoint" : false,
"validFrom" : "2018-06-28",
"validTo" : "2099-12-31",
"etagVersion" : 0,
"servicePointNumber" : {
"number" : 5819768,
"numberShort" : 19768,
"checkDigit" : 1,
"uicCountryCode" : 58
},
"servicePointSloid" : null
}
Read LoadingPoint by number - NotFound
GET /v1/loading-points/versions/9123
Path Variables
Path Variable | Type | Optional | Description |
---|---|---|---|
id |
Integer |
false |
Example request
$ curl 'http://localhost:8080/v1/loading-points/versions/9123' -i -X GET
Example response
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 386
{
"status" : 404,
"message" : "Entity not found",
"error" : "Not found",
"details" : [ {
"message" : "Object with id 9123 not found",
"field" : "id",
"displayInfo" : {
"code" : "ERROR.ENTITY_NOT_FOUND",
"parameters" : [ {
"key" : "field",
"value" : "id"
}, {
"key" : "value",
"value" : "9123"
} ]
}
} ]
}
Read LoadingPoint by number - Unsuccessfully
GET /v1/loading-points/versions/9123
Path Variables
Path Variable | Type | Optional | Description |
---|---|---|---|
id |
Integer |
false |
Example request
$ curl 'http://localhost:8080/v1/loading-points/versions/9123' -i -X GET
Example response
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 386
{
"status" : 404,
"message" : "Entity not found",
"error" : "Not found",
"details" : [ {
"message" : "Object with id 9123 not found",
"field" : "id",
"displayInfo" : {
"code" : "ERROR.ENTITY_NOT_FOUND",
"parameters" : [ {
"key" : "field",
"value" : "id"
}, {
"key" : "value",
"value" : "9123"
} ]
}
} ]
}
Read LoadingPoint by servicePointNumber - Unsuccessfully
GET /v1/loading-points
Query Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
numbers |
Array[Integer] |
true |
|
servicePointSloids |
Array[String] |
true |
|
servicePointUicCountryCodes |
Array[Integer] |
true |
|
servicePointNumbersShorts |
Array[Integer] |
true |
|
servicePointNumbers |
Array[Integer] |
true |
|
sboids |
Array[String] |
true |
|
validOn |
String |
true |
|
fromDate |
String |
true |
|
toDate |
String |
true |
|
validToFromDate |
String |
true |
|
createdAfter |
String |
true |
|
modifiedAfter |
String |
true |
|
page |
Integer |
true |
|
size |
Integer |
true |
|
sort |
Array[String] |
true |
Example request
$ curl 'http://localhost:8080/v1/loading-points?servicePointNumbers=12345678' -i -X GET
Example response
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 531
{
"status" : 400,
"message" : "Constraint for requestbody was violated",
"error" : "Method argument not valid error",
"details" : [ {
"message" : "Value 12345678 rejected due to must be less than or equal to 9999999",
"field" : "servicePointNumbers[0]",
"displayInfo" : {
"code" : "ERROR.CONSTRAINT",
"parameters" : [ {
"key" : "rejectedValue",
"value" : "12345678"
}, {
"key" : "cause",
"value" : "must be less than or equal to 9999999"
} ]
}
} ]
}
Read LoadingPoints without filter - Successfully
GET /v1/loading-points
Query Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
numbers |
Array[Integer] |
true |
|
servicePointSloids |
Array[String] |
true |
|
servicePointUicCountryCodes |
Array[Integer] |
true |
|
servicePointNumbersShorts |
Array[Integer] |
true |
|
servicePointNumbers |
Array[Integer] |
true |
|
sboids |
Array[String] |
true |
|
validOn |
String |
true |
|
fromDate |
String |
true |
|
toDate |
String |
true |
|
validToFromDate |
String |
true |
|
createdAfter |
String |
true |
|
modifiedAfter |
String |
true |
|
page |
Integer |
true |
|
size |
Integer |
true |
|
sort |
Array[String] |
true |
Example request
$ curl 'http://localhost:8080/v1/loading-points' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 620
{
"objects" : [ {
"creationDate" : "2025-05-26T10:57:36.095386",
"creator" : "e123456",
"editionDate" : "2025-05-26T10:57:36.095418",
"editor" : "e123456",
"status" : null,
"id" : 1012,
"number" : 4201,
"designation" : "Piazzale",
"designationLong" : "Piazzaleee",
"connectionPoint" : false,
"validFrom" : "2018-06-28",
"validTo" : "2099-12-31",
"etagVersion" : 0,
"servicePointNumber" : {
"number" : 5819768,
"numberShort" : 19768,
"checkDigit" : 1,
"uicCountryCode" : 58
},
"servicePointSloid" : null
} ],
"totalCount" : 1
}
Read LoadingPoints with search filter - Successfully
GET /v1/loading-points
Query Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
numbers |
Array[Integer] |
true |
|
servicePointSloids |
Array[String] |
true |
|
servicePointUicCountryCodes |
Array[Integer] |
true |
|
servicePointNumbersShorts |
Array[Integer] |
true |
|
servicePointNumbers |
Array[Integer] |
true |
|
sboids |
Array[String] |
true |
|
validOn |
String |
true |
|
fromDate |
String |
true |
|
toDate |
String |
true |
|
validToFromDate |
String |
true |
|
createdAfter |
String |
true |
|
modifiedAfter |
String |
true |
|
page |
Integer |
true |
|
size |
Integer |
true |
|
sort |
Array[String] |
true |
Example request
$ curl 'http://localhost:8080/v1/loading-points?numbers=4201&servicePointSloids=ch:1:sloid:19768&servicePointUicCountryCodes=58&servicePointNumbersShorts=19768&servicePointNumbers=5819768&sboid=ch:1:sboid:100626&fromDate=2018-06-28&toDate=2099-12-31&validOn=2020-06-28&createdAfter=2025-05-26%2010:57:31&modifiedAfter=2025-05-26%2010:57:32' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 619
{
"objects" : [ {
"creationDate" : "2025-05-26T10:57:32.086608",
"creator" : "e123456",
"editionDate" : "2025-05-26T10:57:32.08667",
"editor" : "e123456",
"status" : null,
"id" : 1003,
"number" : 4201,
"designation" : "Piazzale",
"designationLong" : "Piazzaleee",
"connectionPoint" : false,
"validFrom" : "2018-06-28",
"validTo" : "2099-12-31",
"etagVersion" : 0,
"servicePointNumber" : {
"number" : 5819768,
"numberShort" : 19768,
"checkDigit" : 1,
"uicCountryCode" : 58
},
"servicePointSloid" : null
} ],
"totalCount" : 1
}
Read LoadingPoints with search array in filter - Successfully
GET /v1/loading-points
Query Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
numbers |
Array[Integer] |
true |
|
servicePointSloids |
Array[String] |
true |
|
servicePointUicCountryCodes |
Array[Integer] |
true |
|
servicePointNumbersShorts |
Array[Integer] |
true |
|
servicePointNumbers |
Array[Integer] |
true |
|
sboids |
Array[String] |
true |
|
validOn |
String |
true |
|
fromDate |
String |
true |
|
toDate |
String |
true |
|
validToFromDate |
String |
true |
|
createdAfter |
String |
true |
|
modifiedAfter |
String |
true |
|
page |
Integer |
true |
|
size |
Integer |
true |
|
sort |
Array[String] |
true |
Example request
$ curl 'http://localhost:8080/v1/loading-points?numbers=4201&numbers=1000&servicePointSloids=ch:1:sloid:19768&servicePointSloids=ch:1:sloid:19769&servicePointUicCountryCodes=58&servicePointUicCountryCodes=85&servicePointNumbersShorts=19768&servicePointNumbersShorts=12768&servicePointNumbers=5819768&servicePointNumbers=5819768&sboid=ch:1:sboid:100626&sboid=ch:1:sboid:100628&fromDate=2018-06-28&toDate=2099-12-31&validOn=2020-06-28&createdAfter=2025-05-26%2010:57:32&modifiedAfter=2025-05-26%2010:57:33' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 620
{
"objects" : [ {
"creationDate" : "2025-05-26T10:57:33.988508",
"creator" : "e123456",
"editionDate" : "2025-05-26T10:57:33.988539",
"editor" : "e123456",
"status" : null,
"id" : 1007,
"number" : 4201,
"designation" : "Piazzale",
"designationLong" : "Piazzaleee",
"connectionPoint" : false,
"validFrom" : "2018-06-28",
"validTo" : "2099-12-31",
"etagVersion" : 0,
"servicePointNumber" : {
"number" : 5819768,
"numberShort" : 19768,
"checkDigit" : 1,
"uicCountryCode" : 58
},
"servicePointSloid" : null
} ],
"totalCount" : 1
}
Read LoadingPoints with search filter - Unsuccessfully
GET /v1/loading-points
Query Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
numbers |
Array[Integer] |
true |
|
servicePointSloids |
Array[String] |
true |
|
servicePointUicCountryCodes |
Array[Integer] |
true |
|
servicePointNumbersShorts |
Array[Integer] |
true |
|
servicePointNumbers |
Array[Integer] |
true |
|
sboids |
Array[String] |
true |
|
validOn |
String |
true |
|
fromDate |
String |
true |
|
toDate |
String |
true |
|
validToFromDate |
String |
true |
|
createdAfter |
String |
true |
|
modifiedAfter |
String |
true |
|
page |
Integer |
true |
|
size |
Integer |
true |
|
sort |
Array[String] |
true |
Example request
$ curl 'http://localhost:8080/v1/loading-points?numbers=1000' -i -X GET
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 41
{
"objects" : [ ],
"totalCount" : 0
}