API Documentation

Use the sidebar on the right to navigate the sections of the API documentation.

Error Messages

An error response will have a response body similar to this:

{  
	"timestamp" : 1467823619265,
	"status" : 404,
	"error" : "Not Found",
	"exception" : "com.pm.server.exceptionhttp.NotFoundException",
	"message" : "No ghost with id 12345.",
	"path" : "/ghost/12345/location"
}

Custom Footer

//$,  $,     ,
//"ss.$ss. .s'
//,     .ss$$$$$$$$$$s,
//$. s$$$$$$$$$$$$$$`$$Ss
//"$$$$$$$$$$$$$$$$$$o$$$       ,
//s$$$$$$$$$$$$$$$$$$$$$$$$s,  ,s
//s$$$$$$$$$"$$$$$$""""$$$$$$"$$$$$,
//s$$$$$$$$$$s""$$$$ssssss"$$$$$$$$"
//s$$$$$$$$$$'         `"""ss"$"$s""
//s$$$$$$$$$$,              `"""""$  .s$$s
//s$$$$$$$$$$$$s,...               `s$$'  `
//`ssss$$$$$$$$$$$$$$$$$$$$####s.     .$$"$.   , s-
//`""""$$$$$$$$$$$$$$$$$$$$#####$$$$$$"     $.$'
//"$$$$$$$$$$$$$$$$$$$$$####s""     .$$$|
//"$$$$$$$$$$$$$$$$$$$$$$$$##s    .$$" $
//$$""$$$$$$$$$$$$$$$$$$$$$$$$$$$$$"   `
//$$"  "$"$$$$$$$$$$$$$$$$$$$$S""""'
//,   ,"     '  $$$$$$$$$$$$$$$$####s
//$.          .s$$$$$$$$$$$$$$$$$####"
//,           "$s.   ..ssS$$$$$$$$$$$$$$$$$$$####"
//$           .$$$S$$$$$$$$$$$$$$$$$$$$$$$$#####"
//Ss     ..sS$$$$$$$$$$$$$$$$$$$$$$$$$$$######""
//"$$sS$$$$$$$$$$$$$$$$$$$$$$$$$$$########"
//,      s$$$$$$$$$$$$$$$$$$$$$$$$#########""'
//$    s$$$$$$$$$$$$$$$$$$$$$#######""'      s'         ,
//$$..$$$$$$$$$$$$$$$$$$######"'       ....,$$....    ,$
//"$$$$$$$$$$$$$$$######"' ,     .sS$$$$$$$$$$$$$$$$s$$
//$$$$$$$$$$$$#####"     $, .s$$$$$$$$$$$$$$$$$$$$$$$$s.
//)          $$$$$$$$$$$#####'      `$$$$$$$$$###########$$$$$$$$$$$.
//((          $$$$$$$$$$$#####       $$$$$$$$###"       "####$$$$$$$$$$
//) \         $$$$$$$$$$$$####.     $$$$$$###"             "###$$$$$$$$$   s'
//(   )        $$$$$$$$$$$$$####.   $$$$$###"                ####$$$$$$$$s$$'
//)  ( (       $$"$$$$$$$$$$$#####.$$$$$###' -Jeffrey Leung.###$$$$$$$$$$"
//(  )  )   _,$"   $$$$$$$$$$$$######.$$##'                .###$$$$$$$$$$
//) (  ( \.         "$$$$$$$$$$$$$#######,,,.          ..####$$$$$$$$$$$"
//(   )$ )  )        ,$$$$$$$$$$$$$$$$$$####################$$$$$$$$$$$"
//(   ($$  ( \     _sS"  `"$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$S$$,
//)  )$$$s ) )  .      .   `$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$"'  `$$
//(   $$$Ss/  .$,    .$,,s$$$$$$##S$$$$$$$$$$$$$$$$$$$$$$$$S""        '
//\)_$$$$$$$$$$$$$$$$$$$$$$$##"  $$        `$$.        `$$.
//`"S$$$$$$$$$$$$$$$$$#"      $          `$          `$
//`"""""""""""""'         '           '           '
//------------------------------------------------------------------------------------------------------------
//HERE BE DRAGONS