POST api/Entities/Edit/Customer

Request Information

URI Parameters

None.

Body Parameters

Customer
NameDescriptionTypeAdditional information
CustomerID

string

Required

BSB

string

Required

AccountNumber

string

Required

CustomerName

string

Required

EntityCode

string

Required

Suffix

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerID": "sample string 1",
  "BSB": "sample string 2",
  "AccountNumber": "sample string 3",
  "CustomerName": "sample string 4",
  "EntityCode": "sample string 5",
  "Suffix": "sample string 6"
}

application/xml, text/xml

Sample:
<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Entities">
  <AccountNumber>sample string 3</AccountNumber>
  <BSB>sample string 2</BSB>
  <CustomerID>sample string 1</CustomerID>
  <CustomerName>sample string 4</CustomerName>
  <EntityCode>sample string 5</EntityCode>
  <Suffix>sample string 6</Suffix>
</Customer>

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

Response Information

Resource Description

EntityValidationResult
NameDescriptionTypeAdditional information
Success

boolean

None.

ChangesFound

boolean

None.

Pending

boolean

None.

Errors

Collection of ItemValidation

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ChangesFound": true,
  "Pending": true,
  "Errors": [
    {
      "FieldName": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "FieldName": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<EntityValidationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Entities">
  <ChangesFound>true</ChangesFound>
  <Errors>
    <ItemValidation>
      <FieldName>sample string 1</FieldName>
      <Message>sample string 2</Message>
    </ItemValidation>
    <ItemValidation>
      <FieldName>sample string 1</FieldName>
      <Message>sample string 2</Message>
    </ItemValidation>
  </Errors>
  <Pending>true</Pending>
  <Success>true</Success>
</EntityValidationResult>