Rajapinta

 

Ship API

API source

jQuery plugin

WordPress plugin

Api to search ship data and images
Version: 0.1.2
BasePath:/v1

Access

Methods

[ Jump to Models ]

Table of Contents

Attachments

Ships

Attachments

Up

get /attachments/{attachmentId}
find attachment (findAttachment)
find attachments

Path parameters

attachmentId (required)
Path Parameter — attachments id

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json;charset=utf-8

Return type

Attachment

Example data

Content-Type: application/json
{
  "buildnumber" : 123,
  "filename" : "aeiou",
  "attachmentdata" : "aeiou",
  "type" : "aeiou",
  "url" : "aeiou",
  "contenttype" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header;
the media type will be conveyed by the Content-Type response header.

  • application/json;charset=utf-8

Responses

200

Single attachment
Attachment

400

Invalid request was sent to the server
BadRequest

403

Attempted to make a call with unauthorized client
Forbidden

404

Attachment with specified ID was not found
NotFound

500

Internal server error
InternalServerError

Up

get /attachments/{attachmentId}/data
Find attachmentData (findAttachmentData)
Find attachmentData

Path parameters

attachmentId (required)
Path Parameter — attachment id

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json;charset=utf-8

Return type

byte[]

Example data

Content-Type:


Produces


This API call produces the following media types according to the Accept request header;

the media type will be conveyed by the Content-Type response header.


    

  • application/octet-stream
    • 



Responses


200


Returns an attachment data

byte[]


400


Invalid request was sent to the server

BadRequest


403


Attempted to make a call with unauthorized client

Forbidden


404


Attachment with specified ID was not found

NotFound


500


Internal server error

InternalServerError














Up


get /attachments




List attachments (listAttachments)


List attachments


Consumes


This API call consumes the following media types via the Content-Type request header:


    

  • application/json;charset=utf-8
    • 



Query parameters




buildnumber (optional)


Query Parameter — filter results by buildnumber






Return type


array[Attachment]




Example data


Content-Type: application/json


[ {
  "buildnumber" : 123,
  "filename" : "aeiou",
  "attachmentdata" : "aeiou",
  "type" : "aeiou",
  "url" : "aeiou",
  "contenttype" : "aeiou"
} ]


Produces


This API call produces the following media types according to the Accept request header;

the media type will be conveyed by the Content-Type response header.


    

  • application/json;charset=utf-8
    • 



Responses


200


An array of attachments


400


Invalid request was sent to the server

BadRequest


403


Attempted to make a call with unauthorized client

Forbidden


500


Internal server error

InternalServerError








Ships








Up


get /ships/{shipId}




Find ship (findShip)


Find ship


Path parameters




shipId (required)


Path Parameter — ship id






Consumes


This API call consumes the following media types via the Content-Type request header:


    

  • application/json;charset=utf-8
    • 



Return type


Ship




Example data


Content-Type: application/json


{
  "buildnumber" : 123,
  "type_info" : "aeiou",
  "buildyear" : "aeiou",
  "name" : "aeiou",
  "_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "aeiou",
  "type_translated" : "aeiou",
  "properties" : [ {
    "property" : "aeiou",
    "value" : "aeiou"
  } ]
}


Produces


This API call produces the following media types according to the Accept request header;

the media type will be conveyed by the Content-Type response header.


    

  • application/json;charset=utf-8
    • 



Responses


200


Returns a ship

Ship


400


Invalid request was sent to the server

BadRequest


403


Attempted to make a call with unauthorized client

Forbidden


404


Ship with specified ID was not found

NotFound


500


Internal server error

InternalServerError














Up


get /ships




List ships (listShips)


List ships


Consumes


This API call consumes the following media types via the Content-Type request header:


    

  • application/json;charset=utf-8
    • 



Query parameters




q (optional)


Query Parameter — filter results by free text search


from (optional)


Query Parameter — start from this


size (optional)


Query Parameter — number of results






Return type


array[Ship]




Example data


Content-Type: application/json


[ {
  "buildnumber" : 123,
  "type_info" : "aeiou",
  "buildyear" : "aeiou",
  "name" : "aeiou",
  "_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "aeiou",
  "type_translated" : "aeiou",
  "properties" : [ {
    "property" : "aeiou",
    "value" : "aeiou"
  } ]
} ]


Produces


This API call produces the following media types according to the Accept request header;

the media type will be conveyed by the Content-Type response header.


    

  • application/json;charset=utf-8
    • 



Responses


200


An array of ships


400


Invalid request was sent to the server

BadRequest


403


Attempted to make a call with unauthorized client

Forbidden


500


Internal server error

InternalServerError








Up


Models


[ Jump to Methods ]


Table of Contents


    

  1. Attachment
    2. 

  2. BadRequest
    3. 

  3. Forbidden
    4. 

  4. InternalServerError
    5. 

  5. NotFound
    6. 

  6. Ship
    7. 

  7. ShipProperty
    8. 





Attachment – Up






buildnumber (optional)


Integer format: int32


type (optional)


String


url (optional)


String


filename (optional)


String


contenttype (optional)


String


attachmentdata (optional)


String










BadRequest – Up






code (optional)


Integer format: int32


message (optional)


String










Forbidden – Up






code (optional)


Integer format: int32


message (optional)


String










InternalServerError – Up






code (optional)


Integer format: int32


message (optional)


String










NotFound – Up






code (optional)


Integer format: int32


message (optional)


String










Ship – Up






_id (optional)


UUID Unique identifier for a ship format: uuid


buildnumber (optional)


Integer format: int32


name (optional)


String


type_translated (optional)


String


type (optional)


String


type_info (optional)


String


buildyear (optional)


String


properties (optional)


array[ShipProperty]










ShipProperty – Up






property (optional)


String


value (optional)


String