# Account

## Retrieves the collection of Account resources.

> Retrieves the collection of Account resources.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Account.AccountDTO.jsonld-account.read_translation":{"type":"object","description":"LanceCoreAccount","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"description":"The unique identifier for the account entity","type":"integer"},"providerId":{"description":"The provider ID","type":"integer"},"identifier":{"description":"The account identifier","type":"string"},"externalUsername":{"description":"The account external username","type":"string"},"person":{"description":"The Person","type":"string","format":"iri-reference"}}},"Account.AccountDTO-account.read_translation":{"type":"object","description":"LanceCoreAccount","properties":{"id":{"description":"The unique identifier for the account entity","type":"integer"},"providerId":{"description":"The provider ID","type":"integer"},"identifier":{"description":"The account identifier","type":"string"},"externalUsername":{"description":"The account external username","type":"string"},"person":{"description":"The Person","type":"string","format":"iri-reference"}}}}},"paths":{"/api/accounts":{"get":{"operationId":"getAccountCollection","tags":["Account"],"responses":{"200":{"description":"Account collection","content":{"application/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#/components/schemas/Account.AccountDTO.jsonld-account.read_translation"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text/html":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Account.AccountDTO-account.read_translation"}}}}}},"summary":"Retrieves the collection of Account resources.","description":"Retrieves the collection of Account resources.","parameters":[{"name":"id[between]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false}],"deprecated":false}}}}
```

## Creates a Account resource.

> Creates a Account resource.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Account.jsonld-account.read_translation":{"type":"object","description":"LanceCoreAccount","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"}}},"Account-account.read_translation":{"type":"object","description":"LanceCoreAccount"},"Account.AccountInputDTO.jsonld-account.write_translation":{"type":"object","description":"LanceCoreAccount","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"providerId":{"description":"The provider id","type":"integer"},"identifier":{"description":"The account identifier","type":"string"},"externalUsername":{"description":"The account external username","type":"string"},"person":{"description":"The Person","type":"string","format":"iri-reference"},"password":{"description":"The account external username","type":"string"}}},"Account.AccountInputDTO-account.write_translation":{"type":"object","description":"LanceCoreAccount","properties":{"providerId":{"description":"The provider id","type":"integer"},"identifier":{"description":"The account identifier","type":"string"},"externalUsername":{"description":"The account external username","type":"string"},"person":{"description":"The Person","type":"string","format":"iri-reference"},"password":{"description":"The account external username","type":"string"}}}}},"paths":{"/api/accounts":{"post":{"operationId":"postAccountCollection","tags":["Account"],"responses":{"201":{"description":"Account resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Account.jsonld-account.read_translation"}},"text/html":{"schema":{"$ref":"#/components/schemas/Account-account.read_translation"}}},"links":{"GetAccountItem":{"operationId":"getAccountItem","parameters":{"id":"$response.body#/id"},"description":"The `id` value returned in the response can be used as the `id` parameter in `GET /api/accounts/{id}`."}}},"400":{"description":"Invalid input"},"422":{"description":"Unprocessable entity"}},"summary":"Creates a Account resource.","description":"Creates a Account resource.","parameters":[],"requestBody":{"description":"The new Account resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Account.AccountInputDTO.jsonld-account.write_translation"}},"text/html":{"schema":{"$ref":"#/components/schemas/Account.AccountInputDTO-account.write_translation"}}},"required":true},"deprecated":false}}}}
```

## Retrieves a Account resource.

> Retrieves a Account resource.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Account.AccountDTO.jsonld-account.read_translation":{"type":"object","description":"LanceCoreAccount","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"description":"The unique identifier for the account entity","type":"integer"},"providerId":{"description":"The provider ID","type":"integer"},"identifier":{"description":"The account identifier","type":"string"},"externalUsername":{"description":"The account external username","type":"string"},"person":{"description":"The Person","type":"string","format":"iri-reference"}}},"Account.AccountDTO-account.read_translation":{"type":"object","description":"LanceCoreAccount","properties":{"id":{"description":"The unique identifier for the account entity","type":"integer"},"providerId":{"description":"The provider ID","type":"integer"},"identifier":{"description":"The account identifier","type":"string"},"externalUsername":{"description":"The account external username","type":"string"},"person":{"description":"The Person","type":"string","format":"iri-reference"}}}}},"paths":{"/api/accounts/{id}":{"get":{"operationId":"getAccountItem","tags":["Account"],"responses":{"200":{"description":"Account resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Account.AccountDTO.jsonld-account.read_translation"}},"text/html":{"schema":{"$ref":"#/components/schemas/Account.AccountDTO-account.read_translation"}}}},"404":{"description":"Resource not found"}},"summary":"Retrieves a Account resource.","description":"Retrieves a Account resource.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}}}}
```

## Removes the Account resource.

> Removes the Account resource.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/accounts/{id}":{"delete":{"operationId":"deleteAccountItem","tags":["Account"],"responses":{"204":{"description":"Account resource deleted"},"404":{"description":"Resource not found"}},"summary":"Removes the Account resource.","description":"Removes the Account resource.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}}}}
```