rest-spec.json

{
  "openapi" : "3.0.0",
  "info" : {
    "description" : "This is Civs' REST API documentation\n",
    "version" : "1.0.1",
    "title" : "Civis",
    "termsOfService" : "https://www.civis.vote/terms",
    "contact" : {
      "email" : "mkv@commutatus.com"
    },
    "license" : {
      "name" : "MIT",
      "url" : "https://github.com/civis-vote/civis-api/blob/develop/LICENSE"
    }
  },
  "servers" : [ {
    "description" : "SwaggerHub API Auto Mocking",
    "url" : "https://virtserver.swaggerhub.com/Civis/Civis/1.0.1"
  }, {
    "description" : "SwaggerHub API Auto Mocking",
    "url" : "https://virtserver.swaggerhub.com/mikevic/Civis/1.0.1"
  } ],
  "tags" : [ {
    "name" : "consultation",
    "description" : "A document that an organisation requires public or private feedback on"
  }, {
    "name" : "consultation_response",
    "description" : "A response is feedback to a consultation"
  }, {
    "name" : "organisation",
    "description" : "An organisation listed on Civis that can launch multiple consultations."
  }, {
    "name" : "location",
    "description" : "A service to store, list and update locations"
  }, {
    "name" : "master_reference_data",
    "description" : "All reference data is managed on these endpoint"
  } ],
  "paths" : {
    "/consultations/_search" : {
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "List consultations",
        "operationId" : "listConsultations",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationSearch"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationRead"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        },
        "description" : "Get a list of consultations"
      }
    },
    "/consultations/_create" : {
      "description" : "Create a consultation",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Create consultation",
        "operationId" : "createConsultation",
        "requestBody" : {
          "description" : "Consultation create object",
          "content" : {
            "application/json" : {
              "schema" : {
                "allOf" : [ {
                  "$ref" : "#/components/schemas/Consultation"
                }, {
                  "type" : "object",
                  "properties" : {
                    "publishing_medium_ids" : {
                      "type" : "array",
                      "items" : {
                        "type" : "integer"
                      }
                    },
                    "domain_id" : {
                      "type" : "integer"
                    },
                    "callbackUrl" : {
                      "type" : "string",
                      "format" : "uri"
                    }
                  },
                  "required" : [ "callbackUrl" ]
                } ]
              }
            }
          }
        },
        "callbacks" : {
          "sendNotification" : {
            "{$request.body#/callbackUrl}" : {
              "post" : {
                "requestBody" : {
                  "$ref" : "#/components/requestBodies/Id"
                },
                "responses" : {
                  "200" : {
                    "description" : "Sent Notification successfully"
                  }
                }
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/_update" : {
      "description" : "update details on a consultation",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Update consultation",
        "operationId" : "updateConsultation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/_delete" : {
      "description" : "Delete a consultation",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Delete consultation",
        "operationId" : "deleteConsultation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "consultation queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/_publish" : {
      "description" : "Publish a consultation for feedback on Civis",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Publish consultation",
        "operationId" : "publishConsultation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/_reject" : {
      "description" : "Reject a draft consultation",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Reject consultation",
        "operationId" : "rejectConsultation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/summaries/_search" : {
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "List consultation summary",
        "operationId" : "listConsultationsummaries",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationSummarySearch"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationSummaryRead"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        },
        "description" : "Get a list of consultation summaries"
      }
    },
    "/consultations/summaries/_create" : {
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Create consultation summary",
        "operationId" : "createConsultationsummary",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationSummary"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationSummaryWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/summaries/_update" : {
      "description" : "update details on a consultation summary",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Update consultation summary",
        "operationId" : "updateConsultationSummary",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationSummaryUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationSummaryWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/summaries/_delete" : {
      "description" : "Delete a consultation summary",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Delete consultation summary",
        "operationId" : "deleteConsultationSummary",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "consultation summary queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/summaries/_publish" : {
      "description" : "Publish a consultation summary",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "Publish consultation summary",
        "operationId" : "publishConsultationSummary",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationSummaryWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultations/summaries/_unpublish" : {
      "description" : "Unpublish a consultation summary",
      "post" : {
        "tags" : [ "consultation" ],
        "summary" : "unpublish consultation summary",
        "operationId" : "unpublishConsultationSummary",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationSummaryWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultation_responses/_search" : {
      "description" : "List consultation responses",
      "post" : {
        "tags" : [ "consultation_response" ],
        "summary" : "List consultation responses",
        "operationId" : "listConsultationResponses",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationResponseSearch"
        },
        "responses" : {
          "200" : {
            "description" : "list consultation response",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/BasePagingResponseObject"
                  }, {
                    "type" : "object",
                    "properties" : {
                      "data" : {
                        "type" : "array",
                        "items" : {
                          "allOf" : [ {
                            "$ref" : "#/components/schemas/RecordId"
                          }, {
                            "$ref" : "#/components/schemas/ConsultationResponse"
                          } ]
                        }
                      }
                    }
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultation_responses/_create" : {
      "description" : "Create a draft consultation response",
      "post" : {
        "tags" : [ "consultation_response" ],
        "summary" : "Create consultation response",
        "operationId" : "createConsultationResponse",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationResponse"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationResponseWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultation_responses/_update" : {
      "description" : "Update a response to a consultation",
      "post" : {
        "tags" : [ "consultation_response" ],
        "summary" : "Update consultation response",
        "operationId" : "updateConsultationResponse",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationResponseUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationResponseWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultation_responses/_delete" : {
      "description" : "Delete a response to a consultation",
      "post" : {
        "tags" : [ "consultation_response" ],
        "summary" : "Delete consultation response",
        "operationId" : "deleteConsultationResponse",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "consultation response queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultation_responses/_submit" : {
      "description" : "Submit a response to a consultation",
      "post" : {
        "tags" : [ "consultation_response" ],
        "summary" : "Submit consultation",
        "operationId" : "submitConsultation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationResponseWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/consultation_responses/_vote" : {
      "description" : "Vote up/down a response to a consultation",
      "post" : {
        "tags" : [ "consultation_response" ],
        "summary" : "vote consultation response",
        "operationId" : "voteConsultationResponse",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/ConsultationResponseVote"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/ConsultationResponseWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/files/_search" : {
      "description" : "List and search through files saved",
      "post" : {
        "tags" : [ "file" ],
        "summary" : "List files",
        "operationId" : "listFile",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/FileSearch"
        },
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/BasePagingResponseObject"
                  }, {
                    "type" : "object",
                    "properties" : {
                      "data" : {
                        "type" : "array",
                        "items" : {
                          "$ref" : "#/components/schemas/File"
                        }
                      }
                    }
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/files/_create" : {
      "description" : "Create a file",
      "post" : {
        "tags" : [ "file" ],
        "summary" : "Create a file",
        "operationId" : "createFile",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/File"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/FileWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/files/_update" : {
      "description" : "Update a file",
      "post" : {
        "tags" : [ "file" ],
        "summary" : "Update a file",
        "operationId" : "updateFile",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/FileUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/FileWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/files/_delete" : {
      "description" : "Delete a file",
      "post" : {
        "tags" : [ "file" ],
        "summary" : "Delete a file",
        "operationId" : "deleteFile",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/locations/_search" : {
      "description" : "List and search through locations available on Civis",
      "post" : {
        "tags" : [ "location" ],
        "summary" : "List locations",
        "operationId" : "listLocation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/LocationSearch"
        },
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/BasePagingResponseObject"
                  }, {
                    "type" : "object",
                    "properties" : {
                      "data" : {
                        "type" : "array",
                        "items" : {
                          "$ref" : "#/components/schemas/Location"
                        }
                      }
                    }
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/locations/_create" : {
      "description" : "Create a new location",
      "post" : {
        "tags" : [ "location" ],
        "summary" : "Create a location",
        "operationId" : "createLocation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Location"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/LocationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/locations/_update" : {
      "description" : "Update a location",
      "post" : {
        "tags" : [ "location" ],
        "summary" : "Update a location",
        "operationId" : "updateLocation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/LocationUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/LocationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/locations/_delete" : {
      "description" : "Delete a location",
      "post" : {
        "tags" : [ "location" ],
        "summary" : "Delete location",
        "operationId" : "deleteLocation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "location queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/_search" : {
      "description" : "List organisations and filter through them",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "List organisations",
        "operationId" : "listOrganisations",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/OrganisationSearch"
        },
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/BasePagingResponseObject"
                  }, {
                    "type" : "object",
                    "properties" : {
                      "data" : {
                        "type" : "array",
                        "items" : {
                          "allOf" : [ {
                            "$ref" : "#/components/schemas/RecordId"
                          }, {
                            "$ref" : "#/components/schemas/Organisation"
                          } ]
                        }
                      }
                    }
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/_create" : {
      "description" : "Create a organisation",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Create a organisation",
        "operationId" : "createOrganisation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Organisation"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/_update" : {
      "description" : "Update a organisation",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Update a organisation",
        "operationId" : "updateOrganisation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Organisation"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/_delete" : {
      "description" : "Delete a organisations",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Delete a organisation",
        "operationId" : "deleteOrganisation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "organisation queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/_approve" : {
      "description" : "Approve a organisation",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Approve a organisation",
        "operationId" : "publishOrganisation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/_reject" : {
      "description" : "Reject a organisation",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Reject a organisation",
        "operationId" : "rejectOrganisation",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/questionnaires/_search" : {
      "description" : "Search organisation questionnaires using a combination of parameters",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "List organisation questionnaire",
        "operationId" : "listOrganisationQuestionnaire",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/OrganisationQuestionnaireSearch"
        },
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/BasePagingResponseObject"
                  }, {
                    "type" : "object",
                    "properties" : {
                      "data" : {
                        "type" : "array",
                        "items" : {
                          "allOf" : [ {
                            "$ref" : "#/components/schemas/RecordId"
                          }, {
                            "$ref" : "#/components/schemas/OrganisationQuestionnaire"
                          } ]
                        }
                      }
                    }
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/questionnaire/_create" : {
      "description" : "Create a organisation questionnaire",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Create a organisation questionnaire",
        "operationId" : "createOrganisationQuestionnaire",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/OrganisationQuestionnaire"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationQuestionnaireWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/questionnaire/_update" : {
      "description" : "Update a organisation questionnaire",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Update a organisation questionnaire",
        "operationId" : "updateOrganisationQuestionnaire",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/OrganisationQuestionnaireUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationQuestionnaireWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/questionnaire/_delete" : {
      "description" : "Delete a organisation questionnaire",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Delete a organisation questionnaire",
        "operationId" : "deleteOrganisationQuestionnaire",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "organisation questionnaire queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/questionnaire/_approve" : {
      "description" : "Approve a organisation questionnaire",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Approve a organisation questionnaire",
        "operationId" : "approveOrganisationQuestionnaire",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationQuestionnaireWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/questionnaire/_reject" : {
      "description" : "Reject a organisation questionnaire",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Reject a organisation questionnaire",
        "operationId" : "rejectOrganisationQuestionnaire",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationQuestionnaireWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/organisations/questionnaire/_archive" : {
      "description" : "Archive a organisation questionnaire",
      "post" : {
        "tags" : [ "organisation" ],
        "summary" : "Archive a organisation questionnaire",
        "operationId" : "archiveOrganisationQuestionnaire",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/OrganisationQuestionnaireWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/master_reference_data/_search" : {
      "description" : "Search and filter through master reference data",
      "post" : {
        "tags" : [ "master_reference_data" ],
        "summary" : "List master reference data",
        "operationId" : "listMasterReferenceData",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/MasterReferenceDataSearch"
        },
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/BasePagingResponseObject"
                  }, {
                    "type" : "object",
                    "properties" : {
                      "data" : {
                        "type" : "array",
                        "items" : {
                          "allOf" : [ {
                            "$ref" : "#/components/schemas/RecordId"
                          }, {
                            "$ref" : "#/components/schemas/MasterReferenceData"
                          } ]
                        }
                      }
                    }
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/master_reference_data/_create" : {
      "description" : "Create master reference data",
      "post" : {
        "tags" : [ "master_reference_data" ],
        "summary" : "Create a master reference data",
        "operationId" : "createMasterReferenceData",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/MasterReferenceData"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/MasterReferenceDataWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/master_reference_data/_update" : {
      "description" : "Update master reference data",
      "post" : {
        "tags" : [ "master_reference_data" ],
        "summary" : "Update master_reference_data",
        "operationId" : "updateMasterReferenceData",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/MasterReferenceDataUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/MasterReferenceDataWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/_create" : {
      "description" : "Create a survey",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Create a survey",
        "operationId" : "createSurvey",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Survey"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/SurveyWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/_update" : {
      "description" : "Update a survey",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Update a survey",
        "operationId" : "updateSurvey",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/SurveyUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/SurveyWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/_delete" : {
      "description" : "Delete a survey",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Delete survey",
        "operationId" : "deleteSurvey",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "survey queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/_publish" : {
      "description" : "Publish a survey and accept responses",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Publish survey",
        "operationId" : "publishSurvey",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/SurveyWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/_unpublish" : {
      "description" : "Unpublish a survey and close it for responses",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Unpublish survey",
        "operationId" : "unpublishSurvey",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/SurveyWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/_search" : {
      "description" : "Search and filter through surveys",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "List all survey",
        "operationId" : "listSurvey",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/SurveySearch"
        },
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/BasePagingResponseObject"
                  }, {
                    "type" : "object",
                    "properties" : {
                      "data" : {
                        "type" : "array",
                        "items" : {
                          "allOf" : [ {
                            "$ref" : "#/components/schemas/RecordId"
                          }, {
                            "$ref" : "#/components/schemas/Survey"
                          } ]
                        }
                      }
                    }
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/questions/_create" : {
      "description" : "Create a survey question",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Create a survey question",
        "operationId" : "createSurveyQuestion",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/SurveyQuestion"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/SurveyQuestionWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/questions/_update" : {
      "description" : "Update a survey question",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Update a survey question",
        "operationId" : "updateSurveyQuestion",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/SurveyQuestionUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/SurveyQuestionWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/questions/_delete" : {
      "description" : "Delete a survey question",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Delete a survey question",
        "operationId" : "deleteSurveyQuestion",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "survey question queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/responses/_create" : {
      "description" : "Create a survey response",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Create a survey response",
        "operationId" : "createSurveyResponse",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/SurveyResponse"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/SurveyResponseWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/responses/_update" : {
      "description" : "Update a survey response",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Update a survey response",
        "operationId" : "updateSurveyResponse",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/SurveyResponseUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/SurveyResponseWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/surveys/responses/_delete" : {
      "description" : "Delete a survey response",
      "post" : {
        "tags" : [ "survey" ],
        "summary" : "Delete a survey response",
        "operationId" : "deleteSurveyResponse",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "survey response queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/users/_search" : {
      "description" : "Search and filter through users",
      "post" : {
        "tags" : [ "user" ],
        "summary" : "List all user detail",
        "operationId" : "listUser",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/UserSearch"
        },
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/BasePagingResponseObject"
                  }, {
                    "type" : "object",
                    "properties" : {
                      "data" : {
                        "type" : "array",
                        "items" : {
                          "allOf" : [ {
                            "$ref" : "#/components/schemas/RecordId"
                          }, {
                            "$ref" : "#/components/schemas/User"
                          } ]
                        }
                      }
                    }
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/users/_create" : {
      "description" : "Create user",
      "post" : {
        "tags" : [ "user" ],
        "summary" : "Create a user",
        "operationId" : "createUser",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/User"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/UserWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/users/_update" : {
      "description" : "Update user details",
      "post" : {
        "tags" : [ "user" ],
        "summary" : "Update user details",
        "operationId" : "updateUser",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/UserUpdate"
        },
        "responses" : {
          "200" : {
            "$ref" : "#/components/responses/UserWrite"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/users/_delete" : {
      "description" : "Delete a user",
      "post" : {
        "tags" : [ "user" ],
        "summary" : "Delete a user",
        "operationId" : "deleteUser",
        "requestBody" : {
          "$ref" : "#/components/requestBodies/Id"
        },
        "responses" : {
          "200" : {
            "description" : "user queued for deletion"
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    },
    "/users/_current" : {
      "description" : "Get current user detail",
      "post" : {
        "tags" : [ "user" ],
        "summary" : "Current user details",
        "operationId" : "currentUser",
        "responses" : {
          "200" : {
            "description" : "Request Successful",
            "content" : {
              "application/json" : {
                "schema" : {
                  "allOf" : [ {
                    "$ref" : "#/components/schemas/RecordId"
                  }, {
                    "$ref" : "#/components/schemas/User"
                  } ]
                }
              }
            }
          },
          "default" : {
            "$ref" : "#/components/responses/DefaultError"
          }
        }
      }
    }
  },
  "components" : {
    "responses" : {
      "DefaultError" : {
        "description" : "Default error response message",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/Error"
            }
          }
        }
      },
      "ConsultationWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/Consultation"
              } ]
            }
          }
        }
      },
      "ConsultationRead" : {
        "description" : "Request Successful",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BasePagingResponseObject"
              }, {
                "type" : "object",
                "properties" : {
                  "data" : {
                    "type" : "array",
                    "items" : {
                      "allOf" : [ {
                        "$ref" : "#/components/schemas/RecordId"
                      }, {
                        "$ref" : "#/components/schemas/Consultation"
                      } ]
                    }
                  }
                }
              } ]
            }
          }
        }
      },
      "ConsultationSummaryRead" : {
        "description" : "Request Successful",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BasePagingResponseObject"
              }, {
                "type" : "object",
                "properties" : {
                  "data" : {
                    "type" : "array",
                    "items" : {
                      "allOf" : [ {
                        "$ref" : "#/components/schemas/RecordId"
                      }, {
                        "$ref" : "#/components/schemas/ConsultationSummary"
                      } ]
                    }
                  }
                }
              } ]
            }
          }
        }
      },
      "ConsultationSummaryWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/ConsultationSummary"
              } ]
            }
          }
        }
      },
      "ConsultationResponseWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/ConsultationResponse"
              } ]
            }
          }
        }
      },
      "FileWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/File"
              } ]
            }
          }
        }
      },
      "LocationWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/Location"
              } ]
            }
          }
        }
      },
      "OrganisationWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/Organisation"
              } ]
            }
          }
        }
      },
      "OrganisationQuestionnaireWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/OrganisationQuestionnaire"
              } ]
            }
          }
        }
      },
      "MasterReferenceDataWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/MasterReferenceData"
              } ]
            }
          }
        }
      },
      "SurveyQuestionWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/SurveyQuestion"
              } ]
            }
          }
        }
      },
      "SurveyWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/Survey"
              } ]
            }
          }
        }
      },
      "SurveyResponseWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/SurveyResponse"
              } ]
            }
          }
        }
      },
      "UserWrite" : {
        "description" : "Accepted, operation queued for execution.",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/User"
              } ]
            }
          }
        }
      }
    },
    "schemas" : {
      "BaseObject" : {
        "type" : "object",
        "properties" : {
          "created_at" : {
            "readOnly" : true,
            "type" : "string",
            "format" : "date-time"
          },
          "updated_at" : {
            "readOnly" : true,
            "type" : "string",
            "format" : "date-time"
          }
        }
      },
      "BaseFilterObject" : {
        "type" : "object",
        "properties" : {
          "filters" : {
            "type" : "object",
            "properties" : {
              "id" : {
                "type" : "array",
                "items" : {
                  "type" : "integer"
                }
              },
              "query" : {
                "type" : "string"
              },
              "created_at" : {
                "$ref" : "#/components/schemas/DateRange"
              },
              "updated_at" : {
                "$ref" : "#/components/schemas/DateRange"
              }
            }
          }
        }
      },
      "BaseSortObject" : {
        "type" : "object",
        "properties" : {
          "sort" : {
            "type" : "object",
            "properties" : {
              "key" : {
                "type" : "string"
              },
              "direction" : {
                "$ref" : "#/components/schemas/SortDirection"
              }
            }
          }
        }
      },
      "BasePagingObject" : {
        "type" : "object",
        "properties" : {
          "paging" : {
            "type" : "object",
            "properties" : {
              "per_page" : {
                "type" : "integer"
              },
              "page" : {
                "type" : "integer"
              }
            }
          }
        }
      },
      "BasePagingResponseObject" : {
        "type" : "object",
        "properties" : {
          "paging" : {
            "type" : "object",
            "properties" : {
              "current_page" : {
                "type" : "integer"
              },
              "total_page" : {
                "type" : "integer"
              },
              "total_items" : {
                "type" : "integer"
              }
            }
          }
        }
      },
      "BaseRequestObject" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseFilterObject"
        }, {
          "$ref" : "#/components/schemas/BaseSortObject"
        }, {
          "$ref" : "#/components/schemas/BasePagingObject"
        } ]
      },
      "Consultation" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "title" : {
              "type" : "string",
              "description" : "Title of the consultation"
            },
            "status" : {
              "$ref" : "#/components/schemas/ConsultationStatus"
            },
            "summary" : {
              "type" : "string"
            },
            "visibility" : {
              "$ref" : "#/components/schemas/VisibilityLevel"
            },
            "consultation_category" : {
              "$ref" : "#/components/schemas/ConsultationCategory"
            },
            "source_published_at" : {
              "type" : "string",
              "format" : "date-time",
              "description" : "Date on which the publishing entity made the Consultation available for view to the target audience, on its own platform"
            },
            "source_reference_id" : {
              "type" : "string",
              "description" : "Unique id assigned to each Consultation, on publishing entity's platform"
            },
            "consultation_documents" : {
              "type" : "array",
              "items" : {
                "$ref" : "#/components/schemas/ConsultationDocument"
              }
            },
            "created_by" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/UserPublicProfile"
              }, {
                "readOnly" : true
              } ]
            },
            "extension_count" : {
              "readOnly" : true,
              "type" : "integer",
              "description" : "The number of times the deadline of a Consultation has been extended by the Organisation, while the Consultation is live; consequently reflected on Civis portal"
            },
            "publishing_medium" : {
              "readOnly" : true,
              "type" : "array",
              "items" : {
                "$ref" : "#/components/schemas/ReferenceDataType"
              }
            },
            "publishing_medium_ids" : {
              "writeOnly" : true,
              "type" : "array",
              "items" : {
                "type" : "integer"
              }
            },
            "domain" : {
              "$ref" : "#/components/schemas/ReferenceDataType"
            },
            "published_at" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "date-time"
            },
            "rejected_at" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "date-time"
            },
            "original_deadline" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "date-time"
            },
            "latest_deadline" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "date-time"
            },
            "organisation" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Organisation"
              }, {
                "readOnly" : true
              } ]
            },
            "is_featured" : {
              "readOnly" : true,
              "type" : "boolean"
            }
          }
        } ]
      },
      "ConsultationSummary" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "consultation_id" : {
              "type" : "integer",
              "description" : "Consultation associated with the summary"
            },
            "summary_type" : {
              "$ref" : "#/components/schemas/SummaryType"
            },
            "content" : {
              "type" : "string",
              "description" : "Text content of Consultation synopsis"
            },
            "time_taken" : {
              "type" : "integer",
              "description" : "Time taken in seconds, by human actor to prepare the Consultation summary"
            },
            "multimedia_explainer_file_id" : {
              "writeOnly" : true,
              "type" : "integer",
              "description" : "Multimedia content accompanying text synopsis of Consultation"
            },
            "language_id" : {
              "writeOnly" : true,
              "type" : "integer",
              "description" : "Language in which Consultation synopsis has been worded, on Civis' platform, must be the ID of a master reference data language"
            },
            "created_by" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/UserPublicProfile"
              }, {
                "readOnly" : true
              } ]
            },
            "multimedia_explainer_file" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/File"
              }, {
                "readOnly" : true
              } ]
            },
            "language" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ReferenceDataType"
              }, {
                "readOnly" : true
              } ]
            }
          }
        } ]
      },
      "ConsultationDocument" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "file_id" : {
              "type" : "integer",
              "description" : "file_id returned after the upload"
            },
            "original_url" : {
              "type" : "string",
              "description" : "Link to the website page on which the consultation document had been originally published by the Organisation"
            },
            "languages" : {
              "type" : "array",
              "items" : {
                "$ref" : "#/components/schemas/ReferenceDataType"
              }
            }
          }
        } ]
      },
      "ConsultationResponse" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "response_content" : {
              "writeOnly" : true,
              "type" : "string"
            },
            "visibility" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ConsultationResponseVisibility"
              }, {
                "writeOnly" : true
              } ]
            },
            "satisfaction_rating" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ConsultationResponseSatisfactionRating"
              }, {
                "writeOnly" : true
              } ]
            },
            "consultation_response_template_id" : {
              "writeOnly" : true,
              "type" : "integer"
            },
            "consultation" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Consultation"
              }, {
                "readOnly" : true
              } ]
            },
            "user" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/UserPublicProfile"
              }, {
                "readOnly" : true
              } ]
            },
            "status" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ConsultationResponseStatus"
              }, {
                "readOnly" : true
              } ]
            },
            "submitted_at" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "date-time"
            }
          }
        } ]
      },
      "DateRange" : {
        "type" : "object",
        "properties" : {
          "from" : {
            "type" : "string",
            "format" : "date-time"
          },
          "to" : {
            "type" : "string",
            "format" : "date-time"
          }
        }
      },
      "File" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "url" : {
              "readOnly" : true,
              "type" : "string"
            },
            "base" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "binary"
            },
            "file" : {
              "writeOnly" : true,
              "type" : "string",
              "format" : "binary"
            },
            "title" : {
              "type" : "string"
            },
            "desc" : {
              "type" : "string"
            },
            "created_by" : {
              "allOf" : [ {
                "readOnly" : true
              }, {
                "$ref" : "#/components/schemas/UserPublicProfile"
              } ]
            }
          }
        } ]
      },
      "Location" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "name" : {
              "type" : "string",
              "description" : "Name of the location"
            },
            "location_type" : {
              "$ref" : "#/components/schemas/LocationType"
            },
            "parent_id" : {
              "type" : "integer",
              "format" : "int64"
            }
          }
        } ]
      },
      "MasterReferenceData" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "name" : {
              "type" : "string",
              "description" : "Name of the reference data"
            },
            "reference_data_type" : {
              "$ref" : "#/components/schemas/ReferenceDataType"
            }
          }
        } ]
      },
      "Organisation" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "name" : {
              "type" : "string",
              "description" : "Text carrying the full name of the organisation, in English"
            },
            "organisation_type" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ReferenceDataType"
              }, {
                "description" : "Type of the entity, if it is an individual or an organisation and also if it is a Government affiliated one or not"
              } ]
            },
            "level" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/OrganisationLevel"
              }, {
                "description" : "The jurisdiction of Government that the Consultation has originated from. For Consultations not published by the Government, the category would be 'other'"
              } ]
            },
            "status" : {
              "$ref" : "#/components/schemas/OrganisationStatus"
            },
            "primary_email" : {
              "type" : "string",
              "description" : "Email address for correspondence"
            },
            "secondary_email" : {
              "type" : "string",
              "description" : "Additional email address for correspondence"
            },
            "created_by" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/UserPublicProfile"
              }, {
                "readOnly" : true
              } ]
            },
            "location" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Location"
              }, {
                "readOnly" : true
              } ]
            },
            "location_id" : {
              "writeOnly" : true,
              "type" : "integer",
              "description" : "Geographical location of the organisation"
            },
            "points_of_contact" : {
              "readOnly" : true,
              "type" : "array",
              "items" : {
                "$ref" : "#/components/schemas/PointOfContact"
              }
            },
            "domains" : {
              "writeOnly" : true,
              "type" : "array",
              "items" : {
                "$ref" : "#/components/schemas/ReferenceDataType"
              }
            }
          }
        } ]
      },
      "OrganisationQuestionnaire" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "name" : {
              "type" : "string"
            },
            "status" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/OrganisationQuestionnaireStatus"
              }, {
                "readOnly" : true
              } ]
            },
            "approved_at" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "date-time"
            },
            "approved_by" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/UserPublicProfile"
              }, {
                "readOnly" : true
              } ]
            },
            "rejected_at" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "date-time"
            },
            "rejected_by" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/UserPublicProfile"
              }, {
                "readOnly" : true
              } ]
            },
            "archived_at" : {
              "readOnly" : true,
              "type" : "string",
              "format" : "date-time"
            },
            "archived_by" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/UserPublicProfile"
              }, {
                "readOnly" : true
              } ]
            }
          }
        } ]
      },
      "PointOfContact" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "$ref" : "#/components/schemas/PointOfContactInput"
        } ]
      },
      "PointOfContactInput" : {
        "type" : "object",
        "properties" : {
          "full_name" : {
            "type" : "string"
          },
          "designation" : {
            "type" : "string"
          },
          "email" : {
            "type" : "string"
          }
        }
      },
      "RecordId" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "integer"
          }
        }
      },
      "Survey" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "title" : {
              "type" : "string"
            },
            "surveyable_id" : {
              "type" : "integer",
              "writeOnly" : true
            },
            "surveyable_type" : {
              "type" : "string",
              "writeOnly" : true
            },
            "surveyable" : {
              "readOnly" : true,
              "oneOf" : [ {
                "$ref" : "#/components/schemas/Consultation"
              }, {
                "$ref" : "#/components/schemas/Organisation"
              } ]
            },
            "surveyorable_id" : {
              "type" : "integer",
              "writeOnly" : true
            },
            "surveyorable_type" : {
              "type" : "string",
              "writeOnly" : true
            },
            "surveyorable" : {
              "readOnly" : true,
              "oneOf" : [ {
                "$ref" : "#/components/schemas/Organisation"
              }, {
                "$ref" : "#/components/schemas/UserPublicProfile"
              } ]
            },
            "survey_questions" : {
              "readOnly" : true,
              "type" : "array",
              "items" : {
                "$ref" : "#/components/schemas/SurveyQuestion"
              }
            }
          }
        } ]
      },
      "SurveySubQuestion" : {
        "type" : "object",
        "properties" : {
          "id" : {
            "type" : "integer"
          },
          "title" : {
            "type" : "string"
          }
        }
      },
      "SurveyQuestion" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "title" : {
              "type" : "string"
            },
            "question_type" : {
              "$ref" : "#/components/schemas/SurveyQuestionType"
            },
            "parent_id" : {
              "writeOnly" : true,
              "type" : "integer"
            },
            "survey_id" : {
              "writeOnly" : true,
              "type" : "integer"
            },
            "options" : {
              "writeOnly" : true,
              "type" : "array",
              "items" : {
                "type" : "object",
                "properties" : {
                  "id" : {
                    "type" : "integer"
                  },
                  "title" : {
                    "type" : "string"
                  }
                }
              }
            },
            "sub_options" : {
              "readOnly" : true,
              "type" : "array",
              "items" : {
                "$ref" : "#/components/schemas/SurveySubQuestion"
              }
            }
          }
        } ]
      },
      "SurveyResponse" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "survey_id" : {
              "type" : "integer"
            },
            "answers" : {
              "type" : "array",
              "items" : {
                "type" : "object",
                "properties" : {
                  "question_id" : {
                    "type" : "string"
                  },
                  "answer" : {
                    "type" : "string"
                  }
                }
              }
            }
          }
        } ]
      },
      "UserPublicProfile" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/BaseObject"
        }, {
          "type" : "object",
          "properties" : {
            "first_name" : {
              "type" : "string"
            },
            "last_name" : {
              "type" : "string"
            },
            "profile_picture" : {
              "type" : "string",
              "format" : "uri"
            }
          }
        } ]
      },
      "User" : {
        "allOf" : [ {
          "$ref" : "#/components/schemas/UserPublicProfile"
        }, {
          "type" : "object",
          "properties" : {
            "email" : {
              "type" : "string"
            },
            "email_verified_at" : {
              "type" : "string",
              "format" : "date-time"
            },
            "city_id" : {
              "writeOnly" : true,
              "type" : "integer"
            },
            "city" : {
              "allOf" : [ {
                "readOnly" : true
              }, {
                "$ref" : "#/components/schemas/Location"
              } ]
            },
            "state" : {
              "allOf" : [ {
                "readOnly" : true
              }, {
                "$ref" : "#/components/schemas/Location"
              } ]
            }
          }
        } ]
      },
      "OrganisationStatus" : {
        "type" : "string",
        "enum" : [ "approved", "rejected", "in_reivew" ]
      },
      "OrganisationQuestionnaireStatus" : {
        "type" : "string",
        "enum" : [ "draft", "approved", "rejected", "archived" ]
      },
      "OrganisationLevel" : {
        "type" : "string",
        "enum" : [ "local", "state", "national" ]
      },
      "ConsultationStatus" : {
        "type" : "string",
        "enum" : [ "draft", "active", "rejected", "closed" ]
      },
      "ConsultationCategory" : {
        "type" : "string",
        "enum" : [ "fresh", "amendment_policy", "rule" ]
      },
      "ConsultationResponseStatus" : {
        "type" : "string",
        "enum" : [ "draft", "submitted" ]
      },
      "ConsultationResponseVisibility" : {
        "type" : "string",
        "enum" : [ "shared", "anonymous" ]
      },
      "ConsultationResponseSatisfactionRating" : {
        "type" : "string",
        "enum" : [ "dissatisfied", "somewhat_dissatisfied", "somewhat_satisfied", "satisfied" ]
      },
      "ConsultationResponseVoteDirection" : {
        "type" : "string",
        "enum" : [ "up", "down" ]
      },
      "LocationType" : {
        "type" : "string",
        "enum" : [ "city", "state" ]
      },
      "SurveyQuestionType" : {
        "type" : "string",
        "enum" : [ "text", "paragraph", "dichotomous", "attachment", "checkbox", "multichoice" ]
      },
      "ReferenceDataType" : {
        "type" : "string",
        "description" : "Reference data type:\n  * `domain` - The sector to which an entity is related to E.g: Environment/Urban Settlements\n  * `organisation_type` - The constitution of the entity, as a Government affiliation or a non-government capacity\n  * `signup_mode` - Online channel preferred by Civisen for creating an account on Civis; to be chosen between 3 options - Google/Facebook/Form filling\n  * `language` - Indian regional language of summary\n  * `social_media_channel` - Social media channel on which the Consultation has been shared (Facebook/Whatsapp/Twitter/LinkedIn)\n  * `publishing_medium` - The channel(s) through which a Consultation is made available for view to the target audience and scanned by Civis for discovering Consultations. This could be a single or multiple channels.\n",
        "enum" : [ "domain", "organisation_type", "signup_mode", "language", "social_media_channel", "publishing_medium" ]
      },
      "SortDirection" : {
        "type" : "string",
        "enum" : [ "asc", "desc" ]
      },
      "SummaryType" : {
        "type" : "string",
        "description" : "Summary type:\n  * `primary` - This is the primary summary created in the primary language of English based on which other summaries are created out of.\n  * `translation` - This is a translated version of the primary summary.\n",
        "enum" : [ "primary", "translation" ]
      },
      "VisibilityLevel" : {
        "type" : "string",
        "enum" : [ "public", "private" ]
      },
      "Error" : {
        "description" : "In case of any failure during processing of the requests server is required to return the error object. It is recommended taht error codes are namespaced error codes taht can provide contexual information about the error just by examining the code, e.g. origin.badlocation.\nIn case debug is permitted for a certain role, api client has indicated the need to get the debug information during the call and server is configured to honor the debug information request - it is recommended that highly detailed ifnormation about the problem (along with complete stack trace) is provided to the api client.",
        "required" : [ "code", "message" ],
        "type" : "object",
        "readOnly" : true,
        "properties" : {
          "code" : {
            "type" : "string"
          },
          "message" : {
            "type" : "string"
          },
          "debugDetail" : {
            "type" : "string"
          }
        }
      }
    },
    "requestBodies" : {
      "Id" : {
        "description" : "Record ID for the intended operation",
        "content" : {
          "application/json" : {
            "schema" : {
              "$ref" : "#/components/schemas/RecordId"
            }
          }
        }
      },
      "Consultation" : {
        "description" : "Consultation create object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Consultation"
              } ]
            }
          }
        }
      },
      "ConsultationUpdate" : {
        "description" : "Consultation update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Consultation"
              }, {
                "$ref" : "#/components/schemas/RecordId"
              } ]
            }
          }
        }
      },
      "ConsultationSearch" : {
        "description" : "Consultation search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              }, {
                "type" : "object",
                "properties" : {
                  "filters" : {
                    "type" : "object",
                    "properties" : {
                      "status" : {
                        "type" : "array",
                        "items" : {
                          "$ref" : "#/components/schemas/ConsultationStatus"
                        }
                      },
                      "organisation_id" : {
                        "type" : "array",
                        "items" : {
                          "type" : "integer"
                        }
                      },
                      "created_by" : {
                        "type" : "array",
                        "items" : {
                          "type" : "integer"
                        }
                      },
                      "published_at" : {
                        "$ref" : "#/components/schemas/DateRange"
                      },
                      "original_deadline" : {
                        "$ref" : "#/components/schemas/DateRange"
                      },
                      "is_featured" : {
                        "type" : "boolean"
                      },
                      "visibility" : {
                        "type" : "array",
                        "items" : {
                          "$ref" : "#/components/schemas/VisibilityLevel"
                        }
                      },
                      "consultation_category" : {
                        "type" : "array",
                        "items" : {
                          "$ref" : "#/components/schemas/ConsultationCategory"
                        }
                      }
                    }
                  }
                }
              } ]
            }
          }
        }
      },
      "ConsultationSummarySearch" : {
        "description" : "Search consultation summary using combination of parameters. If multiple parameter values are provided they will be treated as an 'and' condition for the search",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              }, {
                "type" : "object",
                "properties" : {
                  "filters" : {
                    "type" : "object",
                    "properties" : {
                      "language_id" : {
                        "type" : "array",
                        "items" : {
                          "type" : "integer"
                        }
                      },
                      "consultation_id" : {
                        "type" : "array",
                        "items" : {
                          "type" : "integer"
                        }
                      },
                      "created_by" : {
                        "type" : "array",
                        "items" : {
                          "type" : "integer"
                        }
                      },
                      "summary_type" : {
                        "type" : "array",
                        "items" : {
                          "$ref" : "#/components/schemas/SummaryType"
                        }
                      }
                    }
                  }
                }
              } ]
            }
          }
        }
      },
      "ConsultationSummary" : {
        "description" : "Consultation summary create object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ConsultationSummary"
              } ]
            }
          }
        }
      },
      "ConsultationSummaryUpdate" : {
        "description" : "Consultation summary update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ConsultationSummary"
              }, {
                "$ref" : "#/components/schemas/RecordId"
              } ]
            }
          }
        }
      },
      "ConsultationResponse" : {
        "description" : "Consultation response create object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ConsultationResponse"
              }, {
                "type" : "object",
                "properties" : {
                  "consultation_id" : {
                    "type" : "integer"
                  }
                }
              } ]
            }
          }
        }
      },
      "ConsultationResponseSearch" : {
        "description" : "Consultation response search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              } ]
            }
          }
        }
      },
      "ConsultationResponseUpdate" : {
        "description" : "Consultation response update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/ConsultationResponse"
              }, {
                "$ref" : "#/components/schemas/RecordId"
              } ]
            }
          }
        }
      },
      "ConsultationResponseVote" : {
        "description" : "Consultation response update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "type" : "object",
                "properties" : {
                  "consultation_response_id" : {
                    "type" : "integer"
                  },
                  "vote_direction" : {
                    "$ref" : "#/components/schemas/ConsultationResponseVoteDirection"
                  }
                }
              } ]
            }
          }
        }
      },
      "File" : {
        "description" : "Manages the upload, storage and deletion of the files.",
        "content" : {
          "multipart/form-data" : {
            "schema" : {
              "$ref" : "#/components/schemas/File"
            }
          }
        }
      },
      "FileUpdate" : {
        "description" : "Manages the upload, storage and deletion of the files.",
        "content" : {
          "multipart/form-data" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/File"
              } ]
            }
          }
        }
      },
      "FileSearch" : {
        "description" : "File search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              } ]
            }
          }
        }
      },
      "Location" : {
        "description" : "Location create object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Location"
              } ]
            }
          }
        }
      },
      "LocationSearch" : {
        "description" : "Location search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              }, {
                "type" : "object",
                "properties" : {
                  "filters" : {
                    "type" : "object",
                    "properties" : {
                      "location_type" : {
                        "type" : "array",
                        "items" : {
                          "$ref" : "#/components/schemas/LocationType"
                        }
                      }
                    }
                  }
                }
              } ]
            }
          }
        }
      },
      "LocationUpdate" : {
        "description" : "Location update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Location"
              }, {
                "$ref" : "#/components/schemas/RecordId"
              } ]
            }
          }
        }
      },
      "MasterReferenceData" : {
        "description" : "Master reference data create object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/MasterReferenceData"
              } ]
            }
          }
        }
      },
      "MasterReferenceDataSearch" : {
        "description" : "Master reference data search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              }, {
                "type" : "object",
                "properties" : {
                  "filters" : {
                    "type" : "object",
                    "properties" : {
                      "reference_data_type" : {
                        "type" : "array",
                        "items" : {
                          "$ref" : "#/components/schemas/ReferenceDataType"
                        }
                      }
                    }
                  }
                }
              } ]
            }
          }
        }
      },
      "MasterReferenceDataUpdate" : {
        "description" : "Master reference data update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/MasterReferenceData"
              }, {
                "$ref" : "#/components/schemas/RecordId"
              } ]
            }
          }
        }
      },
      "Organisation" : {
        "description" : "Organisation input object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Organisation"
              }, {
                "type" : "object",
                "properties" : {
                  "points_of_contact_attrs" : {
                    "type" : "array",
                    "items" : {
                      "$ref" : "#/components/schemas/PointOfContactInput"
                    }
                  }
                }
              } ]
            }
          }
        }
      },
      "OrganisationSearch" : {
        "description" : "Organisation search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              } ]
            }
          }
        }
      },
      "OrganisationQuestionnaire" : {
        "description" : "Questionnaire input object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/OrganisationQuestionnaire"
              } ]
            }
          }
        }
      },
      "OrganisationQuestionnaireSearch" : {
        "description" : "Organisation questionnaire search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              } ]
            }
          }
        }
      },
      "OrganisationQuestionnaireUpdate" : {
        "description" : "Organisation questionnaire update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/OrganisationQuestionnaire"
              }, {
                "$ref" : "#/components/schemas/RecordId"
              } ]
            }
          }
        }
      },
      "Survey" : {
        "description" : "Survey input object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/Survey"
              } ]
            }
          }
        }
      },
      "SurveyUpdate" : {
        "description" : "Survey update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/Survey"
              } ]
            }
          }
        }
      },
      "SurveyQuestion" : {
        "description" : "Survey question input object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/SurveyQuestion"
              } ]
            }
          }
        }
      },
      "SurveyQuestionUpdate" : {
        "description" : "Survey question update input object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/SurveyQuestion"
              } ]
            }
          }
        }
      },
      "SurveyResponse" : {
        "description" : "Survey response input object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/SurveyResponse"
              } ]
            }
          }
        }
      },
      "SurveyResponseUpdate" : {
        "description" : "Survey response update input object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/RecordId"
              }, {
                "$ref" : "#/components/schemas/SurveyResponse"
              } ]
            }
          }
        }
      },
      "SurveySearch" : {
        "description" : "Survey search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              } ]
            }
          }
        }
      },
      "User" : {
        "description" : "User input object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/User"
              } ]
            }
          }
        }
      },
      "UserSearch" : {
        "description" : "User search object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/BaseRequestObject"
              }, {
                "type" : "object",
                "properties" : {
                  "filters" : {
                    "type" : "object",
                    "properties" : {
                      "city_id" : {
                        "type" : "array",
                        "items" : {
                          "type" : "integer"
                        }
                      },
                      "state_id" : {
                        "type" : "array",
                        "items" : {
                          "type" : "integer"
                        }
                      }
                    }
                  }
                }
              } ]
            }
          }
        }
      },
      "UserUpdate" : {
        "description" : "User update object",
        "content" : {
          "application/json" : {
            "schema" : {
              "allOf" : [ {
                "$ref" : "#/components/schemas/User"
              }, {
                "$ref" : "#/components/schemas/RecordId"
              } ]
            }
          }
        }
      }
    }
  }
}