Update.WarningLetter

This will update an array of warning letter statuses.

Status flow

Input

Name	Description	Type	M/O
Id	The unique identifier of the warning letter	Integer	M
Status	The new status for the given warning letter	LetterStatus Enum {"Created", "Archived"}	M
SiteId	Site where action will be executed	Int	O
VendorId	VendorId which will be associated with created content	Text	O

Output

Finished Status:

If the warning letters was successfully updated. Returns the warning letter ID's and confirmation message

Warning Status:

If the warning letter ID is invalid or doesn't exist
Status for given warning letter is invalid (See status flow chart)

Errors Status

Invalid format / parameters (different to specified schema).
Message contains duplicates for warning letter ID per request.

Schema

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns="urn:message-schema"
           elementFormDefault="qualified"
           targetNamespace="urn:message-schema">
  <xs:element name="Message" type="MessageType" />
  <xs:complexType name="MessageType">
    <xs:sequence>
      <xs:element name="UpdateWarningLetter" type="UpdateWarningLetterType" />
    </xs:sequence>
  </xs:complexType>
 
  <xs:complexType name="UpdateWarningLetterType">
    <xs:sequence>
      <xs:element name="WarningLetterStatusPair" minOccurs="1" maxOccurs="unbounded" >
        <xs:complexType>
          <xs:sequence>
            <xs:element name="Id" type="xs:integer" minOccurs="1" maxOccurs="1" />
            <xs:element name="Status" type="LetterStatus" minOccurs="1" maxOccurs="1"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
 
  <xs:simpleType name="LetterStatus">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Created" />
      <xs:enumeration value="Archived" />
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Message content example

<Message xmlns="urn:message-schema">
  <UpdateWarningLetter>
      <WarningLetterStatusPair>
         <Id>1</Id>
         <Status>Archived</Status>
      </WarningLetterStatusPair>
      <WarningLetterStatusPair>
         <Id>2</Id>
         <Status>Archived</Status>
      </WarningLetterStatusPair>
      <WarningLetterStatusPair>
         <Id>3</Id>
         <Status>Created</Status>
      </WarningLetterStatusPair>
  </UpdateWarningLetter>
</Message>