JOC API

/daily_plan/history

POST

Gets daily plan dates history

Parameters in the POST body schema

Name	Type	Description	Example	Default
`controllerId`	optional, string	Controller ID	myController
`dateFrom`	optional, string	The value has multiple formats: an ISO 8601 date format: YYYY-MM-DD a format for a period relative to the current date, e.g. 1d, 1w that specifies the quantity followed by a qualifier: d (days) w (weeks) M (months) y (years)	1d
`dateTo`	optional, string	The value has multiple formats similiar to the `dateFrom` parameter	1d
`submitted`	optional, boolean	If false, order that could not be submitted and submissions with warnings are returned. If true, orders that could be submitted are returned. If not specified all entries are returned.	true	empty
`limit`	optional, integer	Limits the number of resulting items, -1=unlimited	5000	5000

Request

Name

Description

Example

Type

Constraints

Default

Headers

X-Access-Token*

Request requires authentication!

550e8400-e29b-11d4-a716-446655440000

string

Body

application/json

model | example

{
    "title": "daily plan history request",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "javaType": "com.sos.joc.model.dailyplan.history.MainRequest",
    "type": "object",
    "properties": {
        "controllerId": {
            "type": "string",
            "pattern": "^[^/\\<>?:\"|*]*$",
            "maxLength": 100
        },
        "dateFrom": {
            "description": "0 or [number][dwMy] (where dwMy unit for day, week, etc) or ISO date in YYYY-MM-DD format",
            "type": "string",
            "pattern": "^([+-]?0|([+-]?[0-9]+[dwMy])+|\\d{4}-\\d{2}-\\d{2})$"
        },
        "dateTo": {
            "description": "0 or [number][dwMy] (where dwMy unit for day, week, etc) or ISO date in YYYY-MM-DD format",
            "type": "string",
            "pattern": "^([+-]?0|([+-]?[0-9]+[dwMy])+|\\d{4}-\\d{2}-\\d{2})$"
        },
        "submitted": {
            "type": "boolean"
        },
        "limit": {
            "type": "integer",
            "default": 5000
        }
    }
}

Responses

Code	Description	Body
200		application/json model \| example { "title": "collection of daily plan dates", "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "javaType": "com.sos.joc.model.dailyplan.history.MainResponse", "type": "object", "required": [ "deliveryDate" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "dates": { "type": "array", "items": { "javaType": "com.sos.joc.model.dailyplan.history.items.DateItem", "type": "object", "required": [ "date", "countTotal", "countSubmitted" ], "properties": { "date": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "countTotal": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "countSubmitted": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "controllers": { "type": "array", "items": { "javaType": "com.sos.joc.model.dailyplan.history.items.ControllerItem", "type": "object", "required": [ "controllerId", "countTotal", "countSubmitted" ], "properties": { "controllerId": { "type": "string", "pattern": "^[^/\\<>?:\"\|]$", "maxLength": 100 }, "countTotal": { "type": "number", "format": "utc-millisec", "minimum": 0 }, "countSubmitted": { "type": "number", "format": "utc-millisec", "minimum": 0 } } } } } } } } }
401	Unauthorized!	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Oops!", "isAuthenticated": false, "isPermitted": false }
403	Forbidden! The user doesn't have sufficient permissions for 'history'	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false } { "user": "root", "message": "You don't have sufficient permissions for ...", "role": "all", "isAuthenticated": true, "isPermitted": false }
420	'history' failed!	application/json model \| example { "title": "error object with delivery date", "$schema": "http://json-schema.org/draft-04/schema#", "javaType": "com.sos.joc.model.common.Err420", "type": "object", "required": [ "deliveryDate", "error" ], "properties": { "deliveryDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "surveyDate": { "description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty", "type": "string", "format": "date-time" }, "error": { "javaType": "com.sos.joc.model.common.Err", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "history failed!" } } { "deliveryDate": "2016-05-05T21:13:35Z", "surveyDate": "2016-05-05T21:13:33Z", "error": { "code": "JOC-420", "message": "history failed!" } }
440	Login Timeout! The client's session has expired and must log in again.	application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "user": { "type": "string" }, "accessToken": { "type": "string" }, "message": { "type": "string" }, "role": { "type": "string" }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "sessionTimeout": { "type": "integer", "default": 1800 }, "enableTouch": { "type": "boolean", "default": true } } } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false } { "user": "root", "message": "Session has expired. Please log in again", "role": "all", "isAuthenticated": false, "isPermitted": false }