households-api.json

{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://bravo-ch4mp:4201","description":"Generated server url"}],"paths":{"/households":{"get":{"tags":["households-controller"],"operationId":"getPage","parameters":[{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}},{"name":"householdLabel","in":"query","required":false,"schema":{"type":"string","default":""}},{"name":"taxpayerNameOrId","in":"query","required":false,"schema":{"type":"string","default":""}},{"name":"householdTypeLabel","in":"query","required":false,"schema":{"type":"string","default":""}}],"responses":{"404":{"description":"Not Found"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"200":{"description":"OK","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelHouseholdDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelHouseholdDto"}}}}}}},"/households/{id}":{"get":{"tags":["households-controller"],"operationId":"getById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"404":{"description":"Not Found"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"200":{"description":"OK","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/EntityModelHouseholdDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/EntityModelHouseholdDto"}}}}}}},"/households/types":{"get":{"tags":["households-controller"],"operationId":"getAllTypes","responses":{"404":{"description":"Not Found"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"string"}}}},"200":{"description":"OK","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/CollectionModelHouseholdTypeDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CollectionModelHouseholdTypeDto"}}}}}}}},"components":{"schemas":{"Pageable":{"type":"object","properties":{"page":{"minimum":0,"type":"integer","format":"int32"},"size":{"minimum":1,"type":"integer","format":"int32"},"sort":{"type":"array","items":{"type":"string"}}}},"EntityModelHouseholdDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"type":{"type":"string"},"taxpayer":{"$ref":"#/components/schemas/TaxpayerDto"},"_links":{"$ref":"#/components/schemas/Links"}}},"Links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Link"}},"PageMetadata":{"type":"object","properties":{"size":{"type":"integer","format":"int64"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"},"number":{"type":"integer","format":"int64"}}},"PagedModelEntityModelHouseholdDto":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"households":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelHouseholdDto"}}}},"_links":{"$ref":"#/components/schemas/Links"},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"TaxpayerDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"CollectionModelHouseholdTypeDto":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"householdTypes":{"type":"array","items":{"$ref":"#/components/schemas/HouseholdTypeDto"}}}},"_links":{"$ref":"#/components/schemas/Links"}}},"HouseholdTypeDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"}}},"Link":{"type":"object","properties":{"href":{"type":"string"},"hreflang":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"deprecation":{"type":"string"},"profile":{"type":"string"},"name":{"type":"string"},"templated":{"type":"boolean"}}}}}}