FrameAppWS

<back to all web services

GetCitizenIncidentsRQ

The following routes are available for this service:
All Verbs/citizen/getcitizenincidents/{Category}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoreRS:
    code: Optional[str] = None
    error_message: Optional[str] = None
    error_stack_trace: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CitizenIncidentFull:
    report_id: Optional[int] = None
    citizen_email: Optional[str] = None
    citizen_name: Optional[str] = None
    citizen_phone_number: Optional[str] = None
    citizen_status: Optional[str] = None
    report_type_id: Optional[int] = None
    report_type: Optional[str] = None
    report: Optional[str] = None
    fields: Optional[Dict[str, Object]] = None
    longitude: Optional[float] = None
    latitude: Optional[float] = None
    involvedin_indicent: Optional[int] = None
    created_date: Optional[str] = None
    files: Optional[List[Dict[str, Object]]] = None
    follow: Optional[List[Dict[str, Object]]] = None
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCitizenIncidentsRS(CoreRS):
    citizen_incidents: Optional[List[CitizenIncidentFull]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCitizenIncidentsRQ:
    category: Optional[str] = None
    init_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    status: Optional[str] = None
    with_attachments: Optional[bool] = None

Python GetCitizenIncidentsRQ DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /citizen/getcitizenincidents/{Category} HTTP/1.1 
Host: ws.jimsnwa.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Category: String,
	InitDate: 0001-01-01,
	EndDate: 0001-01-01,
	Status: String,
	WithAttachments: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CitizenIncidents: 
	[
		{
			ReportId: 0,
			CitizenEmail: String,
			CitizenName: String,
			CitizenPhoneNumber: String,
			CitizenStatus: String,
			ReportTypeId: 0,
			ReportType: String,
			Report: String,
			Fields: 
			{
				String: {}
			},
			Longitude: 0,
			Latitude: 0,
			InvolvedinIndicent: 0,
			CreatedDate: String,
			Files: 
			[
				{
					String: {}
				}
			],
			Follow: 
			[
				{
					String: {}
				}
			],
			Status: String
		}
	],
	Code: String,
	ErrorMessage: String,
	ErrorStackTrace: String
}