DRF Docs

Document Web APIs made with Django REST Framework.

api/v1

No fields.

Fields:

  • id_pub: UUIDField
  • praca_manager: URLField
  • last_login: DateTimeField
  • email_verified: BooleanField
  • email: EmailField
  • family_name: CharField
  • first_name: CharField
  • full_name: CharField
  • given_name: CharField
  • name: CharField
  • picture: URLField
  • profile_picture_url: URLField
  • surname: CharField
  • sub: IntegerField
  • cpf: CharField
  • is_staff: BooleanField

None

Fields:

  • url: URLField
  • nome: CharField
  • slug: SlugField
  • id_pub: UUIDField
  • contrato: IntegerField R
  • logradouro: CharField
  • cep: IntegerField
  • bairro: CharField
  • regiao: ChoiceField R
  • uf: ChoiceField R
  • municipio: CharField R
  • modelo: ChoiceField R
  • modelo_descricao: CharField
  • situacao: ChoiceField R
  • situacao_descricao: CharField
  • repasse: DecimalField
  • bio: CharField
  • telefone1: CharField
  • telefone2: CharField
  • fax: CharField
  • email1: CharField
  • email2: EmailField
  • pagina: URLField
  • data_inauguracao: DateField
  • header_img: FileField
  • lat: DecimalField
  • long: DecimalField
  • gestor: SerializerMethodField
  • unidade_gestora: ListSerializer
  • grupo_gestor: SerializerMethodField
  • parceiros: ListSerializer
  • rh: ListSerializer
  • atores: ListSerializer
  • imagem: ListSerializer
  • funciona_dia_util: NullBooleanField
  • hora_abertura_dia_util: TimeField
  • hora_fechamento_dia_util: TimeField
  • funciona_sabado: NullBooleanField
  • hora_abertura_sabado: TimeField
  • hora_fechamento_sabado: TimeField
  • funciona_domingo: NullBooleanField
  • hora_abertura_domingo: TimeField
  • hora_fechamento_domingo: TimeField

Fields:

  • url: URLField
  • nome: CharField
  • slug: SlugField
  • id_pub: UUIDField
  • contrato: IntegerField R
  • logradouro: CharField
  • cep: IntegerField
  • bairro: CharField
  • regiao: ChoiceField R
  • uf: ChoiceField R
  • municipio: CharField R
  • modelo: ChoiceField R
  • modelo_descricao: CharField
  • situacao: ChoiceField R
  • situacao_descricao: CharField
  • repasse: DecimalField
  • bio: CharField
  • telefone1: CharField
  • telefone2: CharField
  • fax: CharField
  • email1: CharField
  • email2: EmailField
  • pagina: URLField
  • data_inauguracao: DateField
  • header_img: FileField
  • lat: DecimalField
  • long: DecimalField
  • gestor: SerializerMethodField
  • unidade_gestora: ListSerializer
  • grupo_gestor: SerializerMethodField
  • parceiros: ListSerializer
  • rh: ListSerializer
  • atores: ListSerializer
  • imagem: ListSerializer
  • funciona_dia_util: NullBooleanField
  • hora_abertura_dia_util: TimeField
  • hora_fechamento_dia_util: TimeField
  • funciona_sabado: NullBooleanField
  • hora_abertura_sabado: TimeField
  • hora_fechamento_sabado: TimeField
  • funciona_domingo: NullBooleanField
  • hora_abertura_domingo: TimeField
  • hora_fechamento_domingo: TimeField

Fields:

  • url: URLField
  • id_pub: UUIDField
  • praca: PrimaryKeyRelatedField
  • arquivo: FileField
  • header: BooleanField
  • titulo: CharField
  • descricao: CharField

Fields:

  • url: URLField
  • id_pub: UUIDField
  • praca: PrimaryKeyRelatedField
  • arquivo: FileField
  • header: BooleanField
  • titulo: CharField
  • descricao: CharField

Fields:

  • id_pub: UUIDField
  • praca: PrimaryKeyRelatedField
  • nome: CharField R
  • endereco: CharField R
  • contato: CharField
  • telefone: CharField
  • email: CharField
  • ramo_atividade: ChoiceField R
  • acoes: CharField
  • tempo_parceria: IntegerField
  • recursos_financeiros: DecimalField
  • imagem: FileField

Fields:

  • id_pub: UUIDField
  • praca: PrimaryKeyRelatedField
  • nome: CharField R
  • endereco: CharField R
  • contato: CharField
  • telefone: CharField
  • email: CharField
  • ramo_atividade: ChoiceField R
  • acoes: CharField
  • tempo_parceria: IntegerField
  • recursos_financeiros: DecimalField
  • imagem: FileField

Fields:

  • url: URLField
  • id_pub: UUIDField
  • data_instituicao: DateField
  • data_finalizacao: DateField
  • tipo_documento: ChoiceField
  • documento_constituicao: FileField
  • estatuto: FileField
  • previsao_espacos: IntegerField R
  • membros: ListSerializer

Fields:

  • url: URLField
  • id_pub: UUIDField
  • data_instituicao: DateField
  • data_finalizacao: DateField
  • tipo_documento: ChoiceField
  • documento_constituicao: FileField
  • estatuto: FileField
  • previsao_espacos: IntegerField R
  • membros: ListSerializer

Fields:

  • nome: CharField R
  • origem: ChoiceField R
  • origem_descricao: CharField

Fields:

  • nome: CharField R
  • origem: ChoiceField R
  • origem_descricao: CharField

Fields:

  • id_pub: UUIDField
  • nome: CharField R
  • tipo: ChoiceField
  • tipo_descricao: CharField
  • telefone: CharField
  • email: CharField

Fields:

  • id_pub: UUIDField
  • nome: CharField R
  • tipo: ChoiceField
  • tipo_descricao: CharField
  • telefone: CharField
  • email: CharField

Fields:

  • url: URLField
  • id_pub: UUIDField
  • nome: CharField R
  • funcao: CharField
  • local_trabalho: ListField
  • data_entrada: DateField
  • data_saida: DateField

Fields:

  • url: URLField
  • id_pub: UUIDField
  • nome: CharField R
  • funcao: CharField
  • local_trabalho: ListField
  • data_entrada: DateField
  • data_saida: DateField

Fields:

  • id_pub: UUIDField
  • nome: CharField R
  • area: ChoiceField R
  • area_descricao: CharField
  • descricao: ChoiceField R
  • descricao_descricao: CharField
  • endereco: CharField
  • cep: CharField
  • telefone1: CharField
  • telefone2: CharField
  • email: CharField
  • lat: DecimalField
  • long: DecimalField

Fields:

  • id_pub: UUIDField
  • nome: CharField R
  • area: ChoiceField R
  • area_descricao: CharField
  • descricao: ChoiceField R
  • descricao_descricao: CharField
  • endereco: CharField
  • cep: CharField
  • telefone1: CharField
  • telefone2: CharField
  • email: CharField
  • lat: DecimalField
  • long: DecimalField

No fields.

Fields:

  • url: URLField
  • id_pub: UUIDField
  • user_id_pub: CharField
  • nome: CharField
  • email: EmailField
  • praca: SerializerMethodField
  • profile_picture_url: CharField

Fields:

  • url: URLField
  • id_pub: UUIDField
  • user_id_pub: CharField
  • nome: CharField
  • email: EmailField
  • praca: SerializerMethodField
  • profile_picture_url: CharField

Fields:

  • url: URLField
  • id_pub: UUIDField
  • praca: PrimaryKeyRelatedField R
  • user: UserSerializer
  • data_abertura: DateField
  • aprovado: BooleanField
  • files: ListSerializer

Fields:

  • url: URLField
  • id_pub: UUIDField
  • praca: PrimaryKeyRelatedField R
  • user: UserSerializer
  • data_abertura: DateField
  • aprovado: BooleanField
  • files: ListSerializer

No fields.

No fields.

Fields:

  • id_pub: UUIDField
  • url: SerializerMethodField
  • ocorrencia: OcorrenciaSerializer R
  • titulo: CharField R
  • justificativa: CharField
  • faixa_etaria: ListField
  • espaco: ListField
  • tipo: ChoiceField R
  • publico: ChoiceField
  • carga_horaria: IntegerField R
  • publico_esperado: IntegerField R
  • territorio: ChoiceField
  • descricao: CharField
  • praca: PrimaryKeyRelatedField R

Fields:

  • id_pub: UUIDField
  • url: SerializerMethodField
  • ocorrencia: OcorrenciaSerializer R
  • titulo: CharField R
  • justificativa: CharField
  • faixa_etaria: ListField
  • espaco: ListField
  • tipo: ChoiceField R
  • publico: ChoiceField
  • carga_horaria: IntegerField R
  • publico_esperado: IntegerField R
  • territorio: ChoiceField
  • descricao: CharField
  • praca: PrimaryKeyRelatedField R

Fields:

  • realizado: BooleanField
  • publico_presente: IntegerField
  • pontos_positivos: CharField
  • pontos_negativos: CharField
  • data_prevista: DateTimeField
  • data_de_ocorrencia: DateField

Fields:

  • id_pub: UUIDField
  • arquivo: FileField R
  • anotacoes: CharField
  • relatorio: PrimaryKeyRelatedField
  • agenda: PrimaryKeyRelatedField