Hide Comments

The method element defines an operation which may be invoked on the containing resource.  The Method specifies an HTTP verb, and contains request and response message definitions.

Syntax

method <http-method> <method-name>

[<request>]

[<response>...]

Examples

method GET getTaxFilingCollection

request

response TaxFilingCollection statusCode 200

 

method POST updateTaxFilingCollection

request TaxFilingCollection

response statusCode 200

response statusCode 400

Parameters

Field Name

Type

Description

<http-method>

keyword

One of the HTTP methods as defined in section 9 of RFC 2616: CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

<method-name>

Name

Name assigned to this Method. Must be unique in the context of the containing Resource API.

Child Elements

Name

Topic

Description

<request>

Request

An optional request message specification.  If omitted, the Method is assumed to have an empty request.

<response>

Response

An optional response message specification.  If omitted, the Method is assumed to have a single response with an empty message payload and a statusCode of 200.

Parent Elements

Collection Resource
Object Resource

Created with Help & Manual 6 and styled with Premium Pack Version 2.51 © by EC Software