PUT api/Consumers

Update Consumer

Request Information

URI Parameters

None.

Body Parameters

The Consumer class

Consumer
NameDescriptionTypeAdditional information
Id

GUID Id for Consumer. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

Gender

Gender of Consumer [NULL]

string

None.

Address1

Address 1 for Consumer [NULL]

string

None.

Address2

Address 2 for Consumer [NULL]

string

None.

City

City of Consumer [NULL]

string

None.

State

State of Consumer [NULL]

string

None.

ZipCode

ZipCode of Consumer [NULL]

string

None.

Image

Image of Consumer [NULL]

string

None.

Deleted

Indicates whether the Consumer has been deleted or not. Set to false on Create by system. Set to true on delete by system. [REQUIRED]

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "55aeafec-de0e-49c8-a4c3-f4c7a9b82659",
  "Gender": "sample string 2",
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "City": "sample string 5",
  "State": "sample string 6",
  "ZipCode": "sample string 7",
  "Image": "sample string 8",
  "Deleted": true
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'FaceOffers.Entities.MerchantConsumer' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'FaceOffers.Entities.MerchantConsumer' contains cycles and cannot be serialized if reference tracking is disabled.

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 'Consumer'.

Response Information

Resource Description

Returns a Consumer

Consumer
NameDescriptionTypeAdditional information
Id

GUID Id for Consumer. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

Gender

Gender of Consumer [NULL]

string

None.

Address1

Address 1 for Consumer [NULL]

string

None.

Address2

Address 2 for Consumer [NULL]

string

None.

City

City of Consumer [NULL]

string

None.

State

State of Consumer [NULL]

string

None.

ZipCode

ZipCode of Consumer [NULL]

string

None.

Image

Image of Consumer [NULL]

string

None.

Deleted

Indicates whether the Consumer has been deleted or not. Set to false on Create by system. Set to true on delete by system. [REQUIRED]

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "53bce114-079f-4e1b-b674-0b89468f3de8",
  "Gender": "sample string 2",
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "City": "sample string 5",
  "State": "sample string 6",
  "ZipCode": "sample string 7",
  "Image": "sample string 8",
  "Deleted": true
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'FaceOffers.Entities.MerchantConsumer' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'FaceOffers.Entities.MerchantConsumer' contains cycles and cannot be serialized if reference tracking is disabled.