You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 5, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: source/v1/index.html.md
+16-11Lines changed: 16 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,8 +138,8 @@ To Log in and try it out hit the "Try out" button.
138
138
{
139
139
"success": false,
140
140
"error": {
141
-
"type": "HttpNotFoundException",
142
-
"message": "Page Not Found",
141
+
"type": "ValidationException",
142
+
"message": "Input data failed to pass validation",
143
143
"validation_errors": {
144
144
"attribute": "validation error for the attribute"
145
145
}
@@ -152,7 +152,7 @@ All JSON responses from the API is wrapped in a base object.
152
152
Be sure to include an `Accept: application/json` header, otherwise errors like `401`, `403` & `404` will either return HTML or redirect you to the login page.
153
153
154
154
<asideclass="warning">
155
-
The current version (1.4.2) returns `validation_errors` as an array of string, this behavior will change the one described on the right in the next version 1.4.3. (no release ETA)
155
+
The current version (1.4.2) returns `validation_errors` as an array of strings, this behavior will change the one described on the right in the next version 1.4.3. (no release ETA)
156
156
</aside>
157
157
158
158
@@ -170,7 +170,7 @@ See [pagination](#pagination)
170
170
-`X-Paginate-Pages`
171
171
-`X-Paginate-Offset`
172
172
173
-
### For HTTP Caching we Expose
173
+
### For HTTP Caching
174
174
175
175
-`Cache-Control`
176
176
-`Last-Modified`
@@ -194,7 +194,7 @@ Because the ETags are weak they can also be used on other routes.
194
194
195
195
For example, when getting a resource the API will return a `ETag` header, the value of the `ETag` header can be used on the update route prevent [the lost update problem](https://www.morpheusdata.com/blog/2015-02-21-lost-update-db).
-1. Firstly we are gonna create a [`Job`](api/index.html#JobCreateRequest) instance. A Job is a project on the Maps4News Platform.<br/>
793
+
-1. Firstly we are gonna create a `Job` instance. A Job is a project on the Maps4News platform.<br/>
794
794
We're gonna create an Annotation Map (`job_type_id`) which is a normal map with icons on it, and we're also giving out our map a title.
795
795
796
796
<br/>
797
797
798
-
-2. Second a [`Job Revision`](api/index.html#JobRevisionCreateRequest). A Revision is a point-in-time that the user decided to save his/her current progress in designing their map.<br/>
799
-
The Revision requires us to give it a `language_code`, these are 3 character string (eng, ger, ita, dut, etc.) as well a `mapstyle_set_id` and the map json as a string.<br/><br/>
800
-
A map object must be given to each revision. Revisions can not be updated, each save will result in a new revision.<br/>
801
-
Details about how to build a map object can be found on the [map object page](dispatcher.html).
798
+
-2. Second a `Job Revision`. A Revision is a point-in-time that the user decided to save his/her current progress in designing their map.
799
+
800
+
A `Revision` requires us to give it a `language_code`, these are 3 character strings, (eng, ger, ita, dut, etc.) as well a `mapstyle_set_id` and the map json as a string.
801
+
802
+
(A list of available mapstyle sets can be gotten from `/users/me/mapstyle-sets`)
803
+
804
+
A map object must be given to each revision. Revisions can not be updated, each save will result in a new revision.
805
+
806
+
Details about how to make a map object can be found on the [map object page](dispatcher.html).
802
807
803
808
<br/>
804
809
805
810
-3. If your map object was valid and the revision was created we can queue a build of your map. This will create a `JobResult` resource for that revision.
806
811
807
812
<br/>
808
813
809
-
-4. You can access your result via the `result` method on your revision.<br/>
814
+
-4. You can access your result via the `result` method on the revision.<br/>
810
815
Expect your result to be queued or processing if you get your result directly after queueing a build.<br/>
811
816
It generally takes a few seconds to a few minutes to generate a map.
0 commit comments