PUT BlendTicket/PutAgSyncBlendStatus

Updates the AgSync Status on BlendField record(s).

Request Information

URI Parameters

Body Parameters

Information about what to update.

ClsAgSyncUpdateStatusRequest
NameDescriptionTypeAdditional Information
TicketNumber

The Blend ticket number to update

 integer

Required

Cannot be negative
AgSyncStatus

The Status of the Order in AgSync

 AgSyncOrderStatus

Required
SubFieldId

IF provided - the field of the ticket to set the status for. If omitted - will set the status on all fields for this ticket.

 string

Max length: 8

Request Formats

application/json, text/json

Sample: 
{
  "TicketNumber": 3,
  "AgSyncStatus": 1,
  "SubFieldId": "sample string 4"
}

application/xml, text/xml

Sample: 
<clsAPIBlendFields.ClsAgSyncUpdateStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <AgSyncStatus>Plan</AgSyncStatus>
  <SubFieldId>sample string 4</SubFieldId>
  <TicketNumber>3</TicketNumber>
</clsAPIBlendFields.ClsAgSyncUpdateStatusRequest>

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

Response Information

Resource Description

Updates the AgSync Status on BlendField record(s).

AgvBlendFieldAgSyncStatus
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

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"
  ]
}

application/xml, text/xml

Sample: 
<AgvBlendFieldAgSyncStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Blend">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvBlendFieldAgSyncStatus>