POST BlendTicket/PostCalculateSaltOutTemperature

Calculates the salt out temperature.

Request Information

URI Parameters

Body Parameters

Request body to calculate the salt out temperature.

ClsCalculateSaltOutTemperatureRequest
NameDescriptionTypeAdditional Information
BlendSetIdOrGuid

Identifier of the current product set

string

Required

Max length: 36

N

The Analysis N value

decimal number

Max of 2 decimal places

Must be filled out and numeric

Range: inclusive between 0 and 100

P

The Analysis P value

decimal number

Max of 2 decimal places

Must be filled out and numeric

Range: inclusive between 0 and 100

K

The Analysis K value

decimal number

Max of 2 decimal places

Must be filled out and numeric

Range: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:
{
  "BlendSetIdOrGuid": "sample string 3",
  "N": 4.1,
  "P": 5.1,
  "K": 6.1
}

application/xml, text/xml

Sample:
<ClsBlendPlanUtilities.ClsCalculateSaltOutTemperatureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.plbl">
  <BlendSetIdOrGuid>sample string 3</BlendSetIdOrGuid>
  <K>6.1</K>
  <N>4.1</N>
  <P>5.1</P>
</ClsBlendPlanUtilities.ClsCalculateSaltOutTemperatureRequest>

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

Response Information

Resource Description

Calculates the salt out temperature.

AgvBlendTicketCalculateSaltOutTemperature
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

string
ErrorList

List of error messages of the API call.

Collection of string
WarningList

List of warning messages of the API call.

Collection of string
Count

Number of results returned.

string
Data

Calculated Salt Out Temperature Response.

ClsCalculateSaltOutTemperatureResponse

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "1",
  "Data": {
    "SaltOutTemperature": "sample string 1"
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'SSI.plbl.ClsBlendPlanUtilities+ClsCalculateSaltOutTemperatureResponse' cannot inherit from a type that is not marked with DataContractAttribute or SerializableAttribute. Consider marking the base type 'SKY.Core.API.ClsApiResponse' with DataContractAttribute or SerializableAttribute, or removing them from the derived type.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'SSI.plbl.ClsBlendPlanUtilities+ClsCalculateSaltOutTemperatureResponse' cannot inherit from a type that is not marked with DataContractAttribute or SerializableAttribute. Consider marking the base type 'SKY.Core.API.ClsApiResponse' with DataContractAttribute or SerializableAttribute, or removing them from the derived type.