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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetCitizenIncidentsRQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.citizen">
  <Category>String</Category>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <InitDate>0001-01-01T00:00:00</InitDate>
  <Status>String</Status>
  <WithAttachments>false</WithAttachments>
</GetCitizenIncidentsRQ>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCitizenIncidentsRS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.citizen">
  <Code xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</Code>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</ErrorMessage>
  <ErrorStackTrace xmlns="http://schemas.datacontract.org/2004/07/Nwa.Model.Tipos.nwa.core">String</ErrorStackTrace>
  <CitizenIncidents xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nwa.Model.Contexto.nwa.citizen">
    <d2p1:CitizenIncidentFull>
      <d2p1:CitizenEmail>String</d2p1:CitizenEmail>
      <d2p1:CitizenName>String</d2p1:CitizenName>
      <d2p1:CitizenPhoneNumber>String</d2p1:CitizenPhoneNumber>
      <d2p1:CitizenStatus>String</d2p1:CitizenStatus>
      <d2p1:CreatedDate>String</d2p1:CreatedDate>
      <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Fields>
      <d2p1:Files xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:ArrayOfKeyValueOfstringanyType>
          <d4p1:KeyValueOfstringanyType>
            <d4p1:Key>String</d4p1:Key>
            <d4p1:Value />
          </d4p1:KeyValueOfstringanyType>
        </d4p1:ArrayOfKeyValueOfstringanyType>
      </d2p1:Files>
      <d2p1:Follow xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:ArrayOfKeyValueOfstringanyType>
          <d4p1:KeyValueOfstringanyType>
            <d4p1:Key>String</d4p1:Key>
            <d4p1:Value />
          </d4p1:KeyValueOfstringanyType>
        </d4p1:ArrayOfKeyValueOfstringanyType>
      </d2p1:Follow>
      <d2p1:InvolvedinIndicent>0</d2p1:InvolvedinIndicent>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:Report>String</d2p1:Report>
      <d2p1:ReportId>0</d2p1:ReportId>
      <d2p1:ReportType>String</d2p1:ReportType>
      <d2p1:ReportTypeId>0</d2p1:ReportTypeId>
      <d2p1:Status>String</d2p1:Status>
    </d2p1:CitizenIncidentFull>
  </CitizenIncidents>
</GetCitizenIncidentsRS>