Notes

URL:: https://<root>/<serviceName>/MapServer/exts/MaritimeChartService/MapServer/notes
Methods:: GETPOST
Required Capability:: Maritime Chart Service
Version Introduced:: 10.9

Description

The use of this resource requires an ArcGIS GIS Server Standard or Advanced license and an ArcGIS Maritime server extension license.

The notes operation is used to display the file associated with the S-57 or S-63 attributes TXTDSC, NTXTDS, and PICREP. When a user identifies a feature in the service, these attributes, if populated, will have a corresponding token associated with them.

Passing this token to the notes operation will return the associated file. For TXTDSC and NTXTDS, that file will be a text file. For PICREP, the associated file will be an image. The tokens are reset whenever the map service is restarted for security reasons. For this reason, we cannot provide a live URL example.

Request parameters

Parameter Details

Parameter	Details
`file` (Required)	The token value will be a 120-character alphanumeric value. The example does not show the full length. Syntax Use dark colors for code blocksCopy `1 File=<string>` Example Use dark colors for code blocksCopy 1 File=;pf3S5e?k<MVH=gQQ0BkAa7L:e:H4uN`Ra>PB<R2D2<RHl0?;hSMsgH@Ca3rfRL>rKpLth2mmKO@42 The value for the file is in the `token_<attribute name>`, for example, `token_picrep`. This attribute is returned by the identify operation. Once you have the token from the `identify` response, you can pass that to the `notes` operation to open the associated file.
`format (f)` (Optional)	Specifies the response format. The default response format is `html`. Values: `json`\|`html`\|`image` Syntax: Use dark colors for code blocksCopy `1 f=json` For PICREP attributes, use the image format. For TXTDSC and NTXTDS for S-57 and S-63 datasets, JSON is recommended.

file

(Required)

The token value will be a 120-character alphanumeric value. The example does not show the full length.

Syntax

Use dark colors for code blocksCopy
File=<string>

Example

Use dark colors for code blocksCopy
File=;pf3S5e?k<MVH=gQQ0BkAa7L:e:H4uN`Ra>PB<R2D2<RHl0?;hSMsgH@Ca3rfRL>rKpLth2mmKO@42

The value for the file is in the token_<attribute name>, for example, token_picrep. This attribute is returned by the identify operation. Once you have the token from the identify response, you can pass that to the notes operation to open the associated file.

format (f)

(Optional)

Specifies the response format. The default response format is html.

Values: json|html|image

Syntax:

Use dark colors for code blocksCopy
f=json

For PICREP attributes, use the image format. For TXTDSC and NTXTDS for S-57 and S-63 datasets, JSON is recommended.

Example usage

The following examples describe various ways to use the notes operation. All responses are in PJSON format.

Example 1

The following is an example of the notes operation.

Use dark colors for code blocksCopy
https://nsdemo.esri.com/arcgis/rest/services/MaritimeChartService/IENC/MapServer/exts/MaritimeChartService/MapServer/notes?f=image&file=;pf3S5e?k%3CMVH=gQQ0BkAa7L:e:H4uN`Ra%3EPB%3CfQgA3l00GJB1CTLFOj5EIsDrbrCa%3Coaphk7%3CRHl0?;hSMsgH@Ca3rfRL%3ErKpLth2mmKO@G:3EJT1=2QP00

Example 2

The following is is an example of the identify operation that will return an IENC bridge feature with PICREP populated and a token_picrep value.

Use dark colors for code blocksCopy
https://nsdemo.esri.com/arcgis/rest/services/MaritimeChartService/IENC/MapServer/exts/MaritimeChartService/MapServer/identify?f=pjson&tolerance=10&returnGeometry=false&returnFieldName=false&returnUnformattedValues=false&imageDisplay=1560%2C879%2C96&geometry=%7B%22x%22%3A-9550165.38127785%2C%22y%22%3A4618805.495114245%7D&geometryType=esriGeometryPoint&sr=102100&mapExtent=-9551338.21193063%2C4618410.1723585725%2C-9549475.059366131%2C4619459.987168955&layers=visible:1

JSON Response syntax

There is no formatted response due to the nature of the external file. The information can either be displayed as an associated JSON file or as an image.

JSON Response example 2

The following is an example of a response for example 2, where the identify operation was used to return a feature with PICREP and token_picrep populated.

Use dark colors for code blocksCopy
{
 "results": [
   {
   "layerId": 0,
   "layerName": "S57 Cells",
   "value": "1280",
   "displayFieldName": "rcid",
   "attributes": {
    "rcid": "1280",
    "objectType": "bridge",
    "objectTypeDescription": "Bridge",
    "LNAM": "U3000028771800001",
    "CATBRG": "fixed bridge",
    "HORCLR": "33.5",
    "INFORM": "North Lock Span",
    "OBJNAM": "McAlpine Locks Bridge (606.8)",
    "PICREP": "U3OH606801.JPG",
    "picrep_token": ";pf3S5e?k<MVH=gQQ0BkAa7L:e:H4uN`Ra>PB<fQgA3l00GJB1CTLFOj5EIsDrbrCa<oaphk7<RHl0?;hSMsgH@Ca3rfRL>rKpLth2mmKO@G:3EJT1=2QP00",
    "SCAMIN": "300000",
    "SORDAT": "20111218",
    "SORIND": "US,U3,light,USCG Light List No. 26793",
    "VERCLR": "22.4",
    "wtwdis": "606.8",
    "hunits": "statute miles",
    "cellName": "U37OH582.000",
    "compilationScale": "5000",
    "geometryType": "area"
    }
   }
  ]
 }

JSON error response syntax

This example shows the syntax of an error response:

Use dark colors for code blocksCopy
{
 "error": {
  "code": <value>,
  "message": "<errorMessage>",
  "details": [
   "<detailedMessage>"
  ]
 }
}

JSON error response example

This example shows error results:

Use dark colors for code blocksCopy
{
 "error": {
  "code": 400,
  "message": "Bad Request",
  "details": [
   "file must be specified"
  ]
 }
}