POST api/clients/{clientId}/allergy/add

Adds an allergy to a client

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

the Id of the client the new allergy is to be added to.

integer

Required

Body Parameters

the input data needed to process the AddClientAllergy operation.

AddClientAllergyInput
NameDescriptionTypeAdditional information
AllergyName

string

Required

String length: inclusive between 0 and 150

AdditionalText

string

String length: inclusive between 0 and 150

ReactionId

integer

None.

ReactionNotes

string

None.

Severity

string

String length: inclusive between 0 and 50

FdbConceptId

decimal number

None.

FdbConceptTypeId

decimal number

None.

IsMedAllergy

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "AllergyName": "sample string 2",
  "AdditionalText": "sample string 3",
  "ReactionId": 1,
  "ReactionNotes": "sample string 4",
  "Severity": "sample string 5",
  "FdbConceptId": 1.0,
  "FdbConceptTypeId": 1.0,
  "IsMedAllergy": true
}

application/xml, text/xml

Sample:
<AddClientAllergyInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO.ActionInputs">
  <AdditionalText>sample string 3</AdditionalText>
  <AllergyName>sample string 2</AllergyName>
  <FdbConceptId>1</FdbConceptId>
  <FdbConceptTypeId>1</FdbConceptTypeId>
  <IsMedAllergy>true</IsMedAllergy>
  <ReactionId>1</ReactionId>
  <ReactionNotes>sample string 4</ReactionNotes>
  <Severity>sample string 5</Severity>
</AddClientAllergyInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AddClientAllergyInput'.

Response Information

Resource Description

An Http response message with the following status codes: 200 = success (includes the Id of the recently client allergy), 400 = bad request (the request is malformed or with invalid data), 404 = not found (this is returned when the supplied client Id can't be found.) 500 = something went wrong (the request was not processed).

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.