Share via

3.1.4.15 Properties Subrequest

  • Article

This operation is used to request information on properties.<65> Depending on the Properties attribute value, the protocol server interprets the request as one of the following types of Properties operations:

  • Property Enumerate

  • Property Get

The Properties attribute is defined in section 2.3.3.10. The SubRequestData element for a Properties subrequest is of type PropertiesSubRequestDataType and is defined in section 2.3.1.52.

The protocol client sends a Properties SubRequest message, which is of type PropertiesSubRequestType as specified in section 2.3.1.53. The protocol server responds with a Properties SubResponse message, which is of type PropertiesSubResponseType as specified in section 2.3.1.55. This is done as follows:

  • The protocol client prepares a request containing a URL for the file, a unique Request token, and one or more SubRequest elements, as defined in section 2.2.3.2 and section 2.2.3.8. The SubRequest element is of type "Properties" and the SubRequestData element contains attributes and elements that are input parameters used by the protocol server when processing the Properties subrequest. The SubRequestData element is of type PropertiesSubRequestDataType and is defined in section 2.3.1.52.

  • The protocol server receives the request, parses the logic, and depending on the type of Properties subrequest, processes the request as specified in section 3.1.4.15.1 or section 3.1.4.15.2.

  • The Response element is defined in section 2.2.3.5, and the SubResponse element is defined in section 2.2.3.10. The PropertiesSubResponseDataType defines the type of the SubResponseData element inside the Properties SubResponse element. The PropertiesSubResponseDataType is defined in section 2.3.1.54.

  • The protocol server returns results based on the following conditions:

    • Depending on the type of error, the ErrorCode is returned as an attribute of the SubResponse element. The ErrorCode attribute that is part of the SubResponse element is updated with a specific error code as specified in section 2.2.5.4.

  • An ErrorCode value of "Success" indicates success in processing the Properties request.