Network Working Group F. Thompson Internet-Draft Afilias Canada Intended status: Informational October 17, 2007 Expires: April 19, 2008 Extensible Supply-chain Discovery Service Commands draft-thompson-esds-commands-01 Status of this Memo By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet- Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire on April 19, 2008. Copyright Notice Copyright (C) The IETF Trust (2007). Thompson Expires April 19, 2008 [Page 1] Internet-Draft ESDS Commands October 2007 Abstract The Extensible Supply-chain Discovery Service (ESDS) is an application layer protocol for the distributed sharing and discovery of notification events between associated partners within a supply chain. This document describes the details of the command interface of the ESDS. A full outline of all primary and support commands is included in this document along with examples. Comments are solicited and should be addressed to the mailing list at esds@ietf.org and/or the author(s). Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5 1.1. Conventions Used In This Document . . . . . . . . . . . . 5 2. Client Request . . . . . . . . . . . . . . . . . . . . . . . 6 3. Server Response . . . . . . . . . . . . . . . . . . . . . . . 7 3.1. Result Codes . . . . . . . . . . . . . . . . . . . . . . 7 4. Primary Object Commands . . . . . . . . . . . . . . . . . . . 13 4.1. . . . . . . . . . . . . . . . . . . . . . . . 13 4.1.1. Request . . . . . . . . . . . . . . . . . . . . . . . 13 4.1.2. Response . . . . . . . . . . . . . . . . . . . . . . 14 4.2. . . . . . . . . . . . . . . . . . . . . . . 16 4.2.1. Request . . . . . . . . . . . . . . . . . . . . . . . 16 4.2.2. Response . . . . . . . . . . . . . . . . . . . . . . 17 4.3. . . . . . . . . . . . . . . . . . . . . . . . . . 18 4.3.1. Request . . . . . . . . . . . . . . . . . . . . . . . 19 4.3.2. Response . . . . . . . . . . . . . . . . . . . . . . 20 4.4. . . . . . . . . . . . . . . . . . . . . . . 22 4.4.1. Request . . . . . . . . . . . . . . . . . . . . . . . 22 4.4.2. Response . . . . . . . . . . . . . . . . . . . . . . 24 4.5. . . . . . . . . . . . . . . . . . . . . . . . 26 4.5.1. Request . . . . . . . . . . . . . . . . . . . . . . . 26 4.5.2. Response . . . . . . . . . . . . . . . . . . . . . . 28 4.6. . . . . . . . . . . . . . . . . . . . . . . 30 4.6.1. Request . . . . . . . . . . . . . . . . . . . . . . . 30 4.6.2. Response . . . . . . . . . . . . . . . . . . . . . . 32 5. Support Object Commands . . . . . . . . . . . . . . . . . . . 35 5.1. . . . . . . . . . . . . . . . . . . . . . . . . 35 5.1.1. Request . . . . . . . . . . . . . . . . . . . . . . . 35 5.1.2. Response . . . . . . . . . . . . . . . . . . . . . . 36 5.2. . . . . . . . . . . . . . . . . . . . . . . 38 5.2.1. Request . . . . . . . . . . . . . . . . . . . . . . . 38 5.2.2. Response . . . . . . . . . . . . . . . . . . . . . . 39 5.3. . . . . . . . . . . . . . . . . . . . . . . . 41 5.3.1. Request . . . . . . . . . . . . . . . . . . . . . . . 41 Thompson Expires April 19, 2008 [Page 2] Internet-Draft ESDS Commands October 2007 5.3.2. Response . . . . . . . . . . . . . . . . . . . . . . 42 5.4. . . . . . . . . . . . . . . . . . . . . . . 44 5.4.1. Request . . . . . . . . . . . . . . . . . . . . . . . 45 5.4.2. Response . . . . . . . . . . . . . . . . . . . . . . 46 5.5. . . . . . . . . . . . . . . . . . . . . . . 48 5.5.1. Request . . . . . . . . . . . . . . . . . . . . . . . 48 5.5.2. Response . . . . . . . . . . . . . . . . . . . . . . 49 5.6. . . . . . . . . . . . . . . . . . . . . . . 50 5.6.1. Request . . . . . . . . . . . . . . . . . . . . . . . 50 5.6.2. Response . . . . . . . . . . . . . . . . . . . . . . 52 5.7. . . . . . . . . . . . . . . . . . . . . . . 53 5.7.1. Request . . . . . . . . . . . . . . . . . . . . . . . 53 5.7.2. Response . . . . . . . . . . . . . . . . . . . . . . 57 5.8. . . . . . . . . . . . . . . . . . . . . . . . 58 5.8.1. Request . . . . . . . . . . . . . . . . . . . . . . . 58 5.8.2. Response . . . . . . . . . . . . . . . . . . . . . . 61 5.9. . . . . . . . . . . . . . . . . . . . . . . 65 5.9.1. Request . . . . . . . . . . . . . . . . . . . . . . . 65 5.9.2. Response . . . . . . . . . . . . . . . . . . . . . . 68 5.10. . . . . . . . . . . . . . . . . . . . . . . 70 5.10.1. Request . . . . . . . . . . . . . . . . . . . . . . . 70 5.10.2. Response . . . . . . . . . . . . . . . . . . . . . . 71 5.11. . . . . . . . . . . . . . . . . . . . . . . 72 5.11.1. Request . . . . . . . . . . . . . . . . . . . . . . . 72 5.11.2. Response . . . . . . . . . . . . . . . . . . . . . . 74 5.12. . . . . . . . . . . . . . . . . . . . . . 75 5.12.1. Request . . . . . . . . . . . . . . . . . . . . . . . 75 5.12.2. Response . . . . . . . . . . . . . . . . . . . . . . 77 5.13. . . . . . . . . . . . . . . . . . . . . . . 79 5.13.1. Request . . . . . . . . . . . . . . . . . . . . . . . 79 5.13.2. Response . . . . . . . . . . . . . . . . . . . . . . 80 5.14. . . . . . . . . . . . . . . . . . . . . . 82 5.14.1. Request . . . . . . . . . . . . . . . . . . . . . . . 82 5.14.2. Response . . . . . . . . . . . . . . . . . . . . . . 84 5.15. . . . . . . . . . . . . . . . . . . . . . 86 5.15.1. Request . . . . . . . . . . . . . . . . . . . . . . . 86 5.15.2. Response . . . . . . . . . . . . . . . . . . . . . . 86 5.16. . . . . . . . . . . . . . . . . . . . . . 87 5.16.1. Request . . . . . . . . . . . . . . . . . . . . . . . 87 5.16.2. Response . . . . . . . . . . . . . . . . . . . . . . 88 5.17. . . . . . . . . . . . . . . . . . . . 90 5.17.1. Request . . . . . . . . . . . . . . . . . . . . . . . 90 5.17.2. Response . . . . . . . . . . . . . . . . . . . . . . 92 5.18. . . . . . . . . . . . . . . . . . . . . 94 5.18.1. Request . . . . . . . . . . . . . . . . . . . . . . . 94 5.18.2. Response . . . . . . . . . . . . . . . . . . . . . . 95 5.19. . . . . . . . . . . . . . . . . . . . 97 5.19.1. Request . . . . . . . . . . . . . . . . . . . . . . . 98 Thompson Expires April 19, 2008 [Page 3] Internet-Draft ESDS Commands October 2007 5.19.2. Response . . . . . . . . . . . . . . . . . . . . . . 99 5.20. . . . . . . . . . . . . . . . . . . . 101 5.20.1. Request . . . . . . . . . . . . . . . . . . . . . . . 101 5.20.2. Response . . . . . . . . . . . . . . . . . . . . . . 102 5.21. . . . . . . . . . . . . . . . . . . . 103 5.21.1. Request . . . . . . . . . . . . . . . . . . . . . . . 103 5.21.2. Response . . . . . . . . . . . . . . . . . . . . . . 105 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 107 7. Security Considerations . . . . . . . . . . . . . . . . . . . 108 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 109 8.1. Normative References . . . . . . . . . . . . . . . . . . 109 8.2. Informative References . . . . . . . . . . . . . . . . . 109 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 110 Intellectual Property and Copyright Statements . . . . . . . . . 111 Thompson Expires April 19, 2008 [Page 4] Internet-Draft ESDS Commands October 2007 1. Introduction This document provides a detailed outline of the command interface for the Extensible Supply-chain Discovery Service (ESDS) and includes examples. Extensible Supply-chain Discovery Service Concepts [draft-young-esds-concepts] introduces the ESDS and provides conceptual information about the protocol. Extensible Supply-chain Discovery Service Schema [draft-thompson-esds-schema] details the schema for the ESDS, which is specified in Web Service Description Language (WSDL) and XML Schema (XSD). 1.1. Conventions Used In This Document The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119]. In examples, "C:" represents lines sent by a protocol client and "S:" represents lines returned by a protocol server. Indentation and white space in examples is provided only to illustrate element relationships and is not a REQUIRED feature of this protocol. Thompson Expires April 19, 2008 [Page 5] Internet-Draft ESDS Commands October 2007 2. Client Request Commands within the ESDS are invoked as client requests, which in turn result in server responses. This client/server conversation is expressed as SOAP/XML with the following basic structure for each request. The details of the protocol syntax can be found in the ESDS Schema [draft-thompson-esds-schema].

. . .

Thompson Expires April 19, 2008 [Page 6] Internet-Draft ESDS Commands October 2007 3. Server Response Client command requests will result in a server response with the following basic structure expressed in SOAP/XML. The detailed server response syntax can be found in the ESDS Schema [draft-thompson-esds-schema].

xsi:type="esds:EventLookupOut">

3.1. Result Codes ESDS result codes are based almost verbatim on those found in [RFC4930]. Re-use of these result codes and the client-server semantics has been done in an effort to adopt existing standards. Full credit MUST be given to the author of the EPP RFC [RFC4930]. ESDS result codes are based on the theory of reply codes described in section 4.2.1 of [RFC2821]. ESDS uses four decimal digits to describe the success or failure of each ESDS command. Each of the digits of the reply have special significance. Thompson Expires April 19, 2008 [Page 7] Internet-Draft ESDS Commands October 2007 The first digit denotes command success or failure. The second digit denotes the response category, such as command syntax or security. The third and fourth digits provide explicit response detail within each response category. There are two values for the first digit of the reply code: 1yzz Positive completion reply. The command has been accepted and processed by the system without error. 2yzz Negative completion reply. The command was not accepted and the requested action did not occur. The second digit groups responses into one of six specific categories: x0zz Protocol Syntax x1zz Implementation-specific Rules x2zz Security x3zz Data Management x4zz Server System x5zz Connection Management The third and fourth digits provide response detail within the categories defined by the first and second digits. Specific result codes are listed in the table below. Every ESDS response MUST include a result code and a human-readable description of the result code. Response text in the table below is enclosed in quotes to clearly mark the beginning and ending of each response string. Quotes MUST NOT be used to delimit these strings when returning response text via the protocol. Successful command completion responses: o Code Response text in English _____________________________ o 1000 "Command completed successfully" This is the usual response code for a successfully completed command that is not addressed by any other 1xxx-series response code. o 1001 "Command completed successfully; action pending" This response code MUST be returned when responding to a command Thompson Expires April 19, 2008 [Page 8] Internet-Draft ESDS Commands October 2007 that requires offline activity before the requested action can be completed. See section 2 for a description of other processing requirements. o 1500 "Command completed successfully; ending session" This response code MUST be returned when responding to a successful command. Command error responses: o Code Response text in English _____________________________ o 2000 "Unknown command" This response code MUST be returned when a server receives a command element that is not defined by ESDS. o 2001 "Command syntax error" This response code MUST be returned when a server receives an improperly formed command element. o 2002 "Command use error" This response code MUST be returned when a server receives a properly formed command element, but the command cannot be executed due to a sequencing or context error. For example, a command cannot be executed without having first completed a command. o 2003 "Required parameter missing" This response code MUST be returned when a server receives a command for which a required parameter value has not been provided. o 2004 "Parameter value range error" This response code MUST be returned when a server receives a command parameter whose value is outside the range of values specified by the protocol. The error value SHOULD be returned via a element in the ESDS response. o 2005 "Parameter value syntax error" This response code MUST be returned when a server receives a command containing a parameter whose value is improperly formed. The error value SHOULD be returned via a element in the ESDS response. o 2100 "Unimplemented protocol version" This response code MUST be returned when a server receives a command element specifying a protocol version that is not Thompson Expires April 19, 2008 [Page 9] Internet-Draft ESDS Commands October 2007 implemented by the server. o 2101 "Unimplemented command" This response code MUST be returned when a server receives a valid ESDS command element that is not implemented by the server. o 2102 "Unimplemented option" This response code MUST be returned when a server receives a valid ESDS command element that contains a protocol option that is not implemented by the server. o 2103 "Unimplemented extension" This response code MUST be returned when a server receives a valid ESDS command element that contains a protocol command extension that is not implemented by the server. o 2104 "Billing failure" This response code MUST be returned when a server attempts to execute a billable operation and the command cannot be completed due to a client billing failure. o 2200 "Authentication error" This response code MUST be returned when a server notes an error when validating client credentials. o 2201 "Authorization error" This response code MUST be returned when a server notes a client authorization error when executing a command. This error is used to note that a client lacks privileges to execute the requested command. o 2202 "Invalid authorization information" This response code MUST be returned when a server receives invalid command authorization information required to confirm authorization to execute a command. This error is used to note that a client has the privileges required to execute the requested command, but the authorization information provided by the client does not match the authorization information archived by the server. o 2302 "Object exists" This response code MUST be returned when a server receives a command to create an object that already exists in the repository. o 2303 "Object does not exist" This response code MUST be returned when a server receives a command to query or transform an object that does not exist in the repository. Thompson Expires April 19, 2008 [Page 10] Internet-Draft ESDS Commands October 2007 o 2304 "Object status prohibits operation" This response code MUST be returned when a server receives a command to transform an object that cannot be completed due to server policy or business practices. o 2305 "Object association prohibits operation" This response code MUST be returned when a server receives a command to transform an object that cannot be completed due to dependencies on other objects that are associated with the target object. For example, a server can disallow delete commands while an object has active associations with other objects. o 2306 "Parameter value policy error" This response code MUST be returned when a server receives a command containing a parameter value that is syntactically valid, but semantically invalid due to local policy. For example, the server can support a subset of a range of valid protocol parameter values. The error value SHOULD be returned via a element in the ESDS response. o 2307 "Unimplemented object service" This response code MUST be returned when a server receives a command to operate on an object service that is not supported by the server. o 2308 "Data management policy violation" This response code MUST be returned when a server receives a command whose execution results in a violation of server data management policies. For example, removing all attribute values or object associations from an object might be a violation of a server's data management policies. o 2400 "Command failed" This response code MUST be returned when a server is unable to execute a command due to an internal server error that is not related to the protocol. The failure can be transient. The server MUST keep any ongoing session active. o 2500 "Command failed; server closing connection" This response code MUST be returned when a server receives a command that cannot be completed due to an internal server error that is not related to the protocol. The failure is not transient, and will cause other commands to fail as well. The server MUST end the active session and close the existing connection. o 2501 "Authentication error; server closing connection" This response code MUST be returned when a server notes an error Thompson Expires April 19, 2008 [Page 11] Internet-Draft ESDS Commands October 2007 when validating client credentials and a server-defined limit on the number of allowable failures has been exceeded. The server MUST close the existing connection. o 2502 "Session limit exceeded; server closing connection" This response code MUST be returned when a server receives a command, and the command cannot be completed because the client has exceeded a system-defined limit on the number of sessions that the client can establish. It might be possible to establish a session by ending existing unused sessions and closing inactive connections. Thompson Expires April 19, 2008 [Page 12] Internet-Draft ESDS Commands October 2007 4. Primary Object Commands 4.1. 4.1.1. Request o Description: The ESDS command is used to create a new session based on the credentials provided. If the transport is HTTP 1.1 [RFC2616] then a connected session will be valid for the duration of the connected client. HTTP 1.1 keep-alive, if enabled in the client and server, will allow multiple commands to execute within the connected and authenticated user session. o Elements: * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: user identifier + Type: tUserID + Use: required * + Desc: password + Type: tPassword + Use: required Thompson Expires April 19, 2008 [Page 13] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: C: C: U001 C: C: password C: C: C: 4.1.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension Thompson Expires April 19, 2008 [Page 14] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: session lease + Type: tLeaseSeconds + Use: required Thompson Expires April 19, 2008 [Page 15] Internet-Draft ESDS Commands October 2007 S: S: S: S: S: S: S: value1 S: S: S: S: S: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 S: S: 3600 S: S: S: 4.2. 4.2.1. Request o Description: The ESDS operation is used to end an existing authenticated ESDS session. o Elements: * + Desc: session identifier Thompson Expires April 19, 2008 [Page 16] Internet-Draft ESDS Commands October 2007 + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: C: 4.2.2. Response o Description: When a operation has been processed successfully, a server will respond with a . o Elements: * Thompson Expires April 19, 2008 [Page 17] Internet-Draft ESDS Commands October 2007 + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: 4.3. Thompson Expires April 19, 2008 [Page 18] Internet-Draft ESDS Commands October 2007 4.3.1. Request o Description: The ESDS operation is used primarily as a session keep- alive operation allowing the connected session identifier to maintain its lease within the ESDS. also identifies the server instance name and current server time. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: Thompson Expires April 19, 2008 [Page 19] Internet-Draft ESDS Commands October 2007 C: 4.3.2. Response o Description: When a operation has been processed successfully, a server will respond with a . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: ESDS server instance identifier + Type: xs:token + Use: required * + Desc: current server timestamp in UTC + Type: xs:dateTime + Use: required * + Desc: list of extensions Thompson Expires April 19, 2008 [Page 20] Internet-Draft ESDS Commands October 2007 + Type: tExtensionItemList + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: Acme Discovery Service S: S: 2007-01-01T00:00:01.123Z S: S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 21] Internet-Draft ESDS Commands October 2007 4.4. 4.4.1. Request o Description: The ESDS operation is used to create events in the system. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: event one of (object or void) + Type: tEventTypeChoice + Use: required * + Desc: supply chain identifier + Type: tSupplyChainID + Use: required * + Desc: proxy partner identifier Thompson Expires April 19, 2008 [Page 22] Internet-Draft ESDS Commands October 2007 + Type: tPartnerID + Use: optional, but no more than 1 occurrence(s) C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: C: C: C: C: 1 C: C: 36000 C: C: 123456 C: C: C: C: C: C: 1 Thompson Expires April 19, 2008 [Page 23] Internet-Draft ESDS Commands October 2007 C: C: 36000 C: C: urn:epc:id:sgtin:1000.2000.101 C: C: arrive C: C: C1 C: C: 2007-12-01T00:00:01.123Z C: C: C: id1 C: C: C: C: 5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8 C: C: C: C: C: SC001 C: C: P001 C: C: C: 4.4.2. Response o Description: When an operation has been processed successfully, a server will respond with an . Thompson Expires April 19, 2008 [Page 24] Internet-Draft ESDS Commands October 2007 o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: event identifier + Type: tEventID + Use: required Thompson Expires April 19, 2008 [Page 25] Internet-Draft ESDS Commands October 2007 S: S: S: S: S: S: S: value1 S: S: S: S: S: 123456 S: S: S: 4.5. 4.5.1. Request o Description: The ESDS operation is used to query the details of an individual in the ESDS. The event to be queried is located by the unique assigned to each and every event in the system. o Elements: * + Desc: session identifier Thompson Expires April 19, 2008 [Page 26] Internet-Draft ESDS Commands October 2007 + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: event identifier + Type: tEventID + Use: required C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: 123456 C: C: C: Thompson Expires April 19, 2008 [Page 27] Internet-Draft ESDS Commands October 2007 4.5.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: event one of (object or void) + Type: tInfoEvent + Use: required S: S: S: S: S: S: S: value1 S: S: S: S: S: S: 123456 S: S: urn:epc:id:sgtin:1000.2000.101 S: S: object S: S: C1 S: S: arrive S: S: 2006-12-01T12:12:12.123Z S: S: 2007-12-01T00:00:01.123Z S: S: P001 S: S: SC001 S: S: U001 S: S: S: S: S: S: S: 5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8 S: S: S: 1 S: S: 36000 S: S: S: S: 4.6. 4.6.1. Request o Description: The ESDS operation is used to query a sequence of events from the ESDS given the request parameter criteria elements below. The results returned will be the set of events posted within the search criteria, excluding the events that were marked as void with a . This operation is the primary query interface to the ESDS and can return immediate results if is set to "false" or not set at all. If is set to "true" then the request will be queued and the results will be requested asynchronously and stored in your parter result queue. The result queue will have a quota limit and results can be pulled from the result queue using the operation. o Elements: * + Desc: session identifier Thompson Expires April 19, 2008 [Page 30] Internet-Draft ESDS Commands October 2007 + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: object identifier + Type: tObjectID + Use: required * + Desc: life cycle step identifier + Type: tLifeCycleStepID + Use: optional, but no more than 1 occurrence(s) * + Desc: starting timestamp range inclusive + Type: xs:dateTime + Use: optional, but no more than 1 occurrence(s) * + Desc: ending timestamp range inclusive + Type: xs:dateTime + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 31] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: urn:epc:id:sgtin:1000.2000.101 C: C: arrive C: C: 2006-12-01T00:00:01.123Z C: C: 2007-12-01T00:00:01.123Z C: C: C: 4.6.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response Thompson Expires April 19, 2008 [Page 32] Internet-Draft ESDS Commands October 2007 + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: list of events + Type: tEventItemList + Use: required S: S: S: S: S: S: S: value1 S: S: S: S: S: S: S: S: S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 34] Internet-Draft ESDS Commands October 2007 5. Support Object Commands 5.1. 5.1.1. Request o Description: The ESDS operation is used to lookup common static table entries used by clients. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: table identifier + Type: tTableID + Use: required Thompson Expires April 19, 2008 [Page 35] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: mytable C: C: C: 5.1.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension Thompson Expires April 19, 2008 [Page 36] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) * + Desc: list of rows + Type: tTableRowItemList + Use: required S: S: S: S: S: S: S: value1 S: S: S: S: S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 37] Internet-Draft ESDS Commands October 2007 5.2. 5.2.1. Request o Description: The ESDS operation is used to create s in the ESDS system. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: role identifier + Type: tRoleID + Use: required * + Desc: list of grants (object,method,permission) + Type: tGrantItemList + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 38] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: default C: C: C: C: C: C: C: 5.2.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response Thompson Expires April 19, 2008 [Page 39] Internet-Draft ESDS Commands October 2007 + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: role unique identifier + Type: tSmallUID + Use: required S: S: S: S: S: S: S: value1 S: S: S: S: S: 101 S: Thompson Expires April 19, 2008 [Page 40] Internet-Draft ESDS Commands October 2007 S: S: 5.3. 5.3.1. Request o Description: The ESDS operation is used to query the details of an individual in the ESDS. The to be queried is located by the unique used to create the in the system. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: role identifier + Type: tRoleID + Use: required Thompson Expires April 19, 2008 [Page 41] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: default C: C: C: 5.3.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension Thompson Expires April 19, 2008 [Page 42] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) * + Desc: role unique identifier + Type: tSmallUID + Use: required * + Desc: role identifier + Type: tRoleID + Use: required * + Desc: list of grants (object,method,permission) + Type: tGrantItemList + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 43] Internet-Draft ESDS Commands October 2007 S: S: S: S: S: S: S: value1 S: S: S: S: S: 101 S: S: default S: S: S: S: S: S: S: 5.4. Thompson Expires April 19, 2008 [Page 44] Internet-Draft ESDS Commands October 2007 5.4.1. Request o Description: The ESDS operation is used to modify the contents of the specified . o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: role unique identifier + Type: tSmallUID + Use: required * + Desc: role identifier + Type: tRoleID + Use: optional, but no more than 1 occurrence(s) * + Desc: list of grants (object,method,permission) + Type: tGrantItemList Thompson Expires April 19, 2008 [Page 45] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: 101 C: C: default C: C: C: C: C: C: C: 5.4.2. Response o Description: When a operation has been processed successfully, a server will respond with an . Thompson Expires April 19, 2008 [Page 46] Internet-Draft ESDS Commands October 2007 o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 47] Internet-Draft ESDS Commands October 2007 5.5. 5.5.1. Request o Description: The ESDS operation is used to remove a from the ESDS system. If the is associated with other objects within the ESDS, then the will be marked with an "inactive" state. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: role identifier + Type: tRoleID + Use: required Thompson Expires April 19, 2008 [Page 48] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: default C: C: C: 5.5.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension Thompson Expires April 19, 2008 [Page 49] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: 5.6. 5.6.1. Request o Description: The ESDS operation is used to query a set of partners that match the search criteria specified as request parameter elements. o Elements: * + Desc: session identifier Thompson Expires April 19, 2008 [Page 50] Internet-Draft ESDS Commands October 2007 + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: role identifier + Type: tRoleID + Use: required C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: default C: C: C: Thompson Expires April 19, 2008 [Page 51] Internet-Draft ESDS Commands October 2007 5.6.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: list of roles + Type: tRoleItemList + Use: required Thompson Expires April 19, 2008 [Page 52] Internet-Draft ESDS Commands October 2007 S: S: S: S: S: S: S: value1 S: S: S: S: S: S: S: S: S: S: 5.7. 5.7.1. Request o Description: The ESDS operation is used to create s in the ESDS system. o Elements: * Thompson Expires April 19, 2008 [Page 53] Internet-Draft ESDS Commands October 2007 + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: user identifier + Type: tUserID + Use: required * + Desc: password + Type: tPassword + Use: required * + Desc: role identifier + Type: tRoleID + Use: required * + Desc: partner identifier + Type: tPartnerID + Use: required Thompson Expires April 19, 2008 [Page 54] Internet-Draft ESDS Commands October 2007 * + Desc: login mode + Type: tLoginMode + Use: required * + Desc: session lease + Type: tLeaseSeconds + Use: required * + Desc: authorized certificate list + Type: tX509CertItemList + Use: optional, but no more than 1 occurrence(s) * + Desc: event notification topic list + Type: tEventTopicItemList + Use: optional, but no more than 1 occurrence(s) C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 Thompson Expires April 19, 2008 [Page 55] Internet-Draft ESDS Commands October 2007 C: C: C: C: U001 C: C: password C: C: default C: C: P001 C: C: key-and-password C: C: 3600 C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: 5.7.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: user unique identifier + Type: tSmallUID + Use: required Thompson Expires April 19, 2008 [Page 57] Internet-Draft ESDS Commands October 2007 S: S: S: S: S: S: S: value1 S: S: S: S: S: 100 S: S: S: 5.8. 5.8.1. Request o Description: The ESDS operation is used to create s in the ESDS system. o Elements: * + Desc: session identifier + Type: tSessionID Thompson Expires April 19, 2008 [Page 58] Internet-Draft ESDS Commands October 2007 + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: user identifier + Type: tUserID + Use: required * + Desc: password + Type: tPassword + Use: required * + Desc: role identifier + Type: tRoleID + Use: required * + Desc: partner identifier + Type: tPartnerID + Use: required * + Desc: login mode + Type: tLoginMode Thompson Expires April 19, 2008 [Page 59] Internet-Draft ESDS Commands October 2007 + Use: required * + Desc: session lease + Type: tLeaseSeconds + Use: required * + Desc: authorized certificate list + Type: tX509CertItemList + Use: optional, but no more than 1 occurrence(s) * + Desc: event notification topic list + Type: tEventTopicItemList + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 60] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: U001 C: C: C: 5.8.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension Thompson Expires April 19, 2008 [Page 61] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) * + Desc: user unique identifier + Type: tSmallUID + Use: required * + Desc: user identifier + Type: tUserID + Use: required * + Desc: role identifier + Type: tRoleID + Use: required * + Desc: partner identifier + Type: tPartnerID + Use: required * + Desc: login mode + Type: tLoginMode + Use: required * + Desc: session lease + Type: tLeaseSeconds Thompson Expires April 19, 2008 [Page 62] Internet-Draft ESDS Commands October 2007 + Use: required * + Desc: authorized certificate list + Type: tX509CertItemList + Use: optional, but no more than 1 occurrence(s) * + Desc: event notification topic list + Type: tEventTopicItemList + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: 100 S: S: U001 Thompson Expires April 19, 2008 [Page 63] Internet-Draft ESDS Commands October 2007 S: S: default S: S: P001 S: S: key-and-password S: S: 3600 S: S: S: S: S: S: S: S: S: S: S: S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 64] Internet-Draft ESDS Commands October 2007 S: S: 5.9. 5.9.1. Request o Description: The ESDS operation is used to modify the contents of the specified . o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: user unique identifier + Type: tSmallUID + Use: required * + Desc: user identifier + Type: tUserID + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 65] Internet-Draft ESDS Commands October 2007 * + Desc: password + Type: tPassword + Use: optional, but no more than 1 occurrence(s) * + Desc: role identifier + Type: tRoleID + Use: optional, but no more than 1 occurrence(s) * + Desc: partner identifier + Type: tPartnerID + Use: optional, but no more than 1 occurrence(s) * + Desc: login mode + Type: tLoginMode + Use: optional, but no more than 1 occurrence(s) * + Desc: session lease + Type: tLeaseSeconds + Use: optional, but no more than 1 occurrence(s) * + Desc: authorized certificate list + Type: tX509CertItemList + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 66] Internet-Draft ESDS Commands October 2007 * + Desc: event notification topic list + Type: tEventTopicItemList + Use: optional, but no more than 1 occurrence(s) C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: 100 C: C: U001 C: C: password C: C: default C: C: P001 C: C: key-and-password C: C: 3600 Thompson Expires April 19, 2008 [Page 67] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: 5.9.2. Response o Description: When a operation has been processed successfully, a server will respond with an . Thompson Expires April 19, 2008 [Page 68] Internet-Draft ESDS Commands October 2007 o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 69] Internet-Draft ESDS Commands October 2007 5.10. 5.10.1. Request o Description: The ESDS operation is used to remove a from the ESDS system. If the is associated with other objects within the ESDS, then the will be marked with an "inactive" state. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: user identifier + Type: tUserID + Use: required Thompson Expires April 19, 2008 [Page 70] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: U001 C: C: C: 5.10.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension Thompson Expires April 19, 2008 [Page 71] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: 5.11. 5.11.1. Request o Description: The ESDS operation is used to query a set of partners that match the search criteria specified as request parameter elements. o Elements: * + Desc: session identifier Thompson Expires April 19, 2008 [Page 72] Internet-Draft ESDS Commands October 2007 + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: user identifier + Type: tUserID + Use: required C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: U001 C: C: C: Thompson Expires April 19, 2008 [Page 73] Internet-Draft ESDS Commands October 2007 5.11.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: user list + Type: tUserItemList + Use: required Thompson Expires April 19, 2008 [Page 74] Internet-Draft ESDS Commands October 2007 S: S: S: S: S: S: S: value1 S: S: S: S: S: S: S: S: S: S: 5.12. 5.12.1. Request o Description: The ESDS operation is used to create new partners within the ESDS system. s are assigned a at creation time, however this and other attributes can be changed with the operation. Thompson Expires April 19, 2008 [Page 75] Internet-Draft ESDS Commands October 2007 o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: partner identifier + Type: tPartnerID + Use: required * + Desc: list of services + Type: tServiceItemList + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 76] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: P001 C: C: C: C: C: C: C: 5.12.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response Thompson Expires April 19, 2008 [Page 77] Internet-Draft ESDS Commands October 2007 + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: partner unique identifier + Type: tSmallUID + Use: required S: S: S: S: S: S: S: value1 S: S: S: S: S: 100 S: Thompson Expires April 19, 2008 [Page 78] Internet-Draft ESDS Commands October 2007 S: S: 5.13. 5.13.1. Request o Description: The ESDS operation is used to query the details of an individual in the ESDS. The to be queried is located by the unique used to create the in the system. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: partner identifier + Type: tPartnerID + Use: required Thompson Expires April 19, 2008 [Page 79] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: P001 C: C: C: 5.13.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension Thompson Expires April 19, 2008 [Page 80] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) * + Desc: partner unique identifier + Type: tSmallUID + Use: required * + Desc: partner identifier + Type: tPartnerID + Use: required * + Desc: list of supply chains + Type: tSupplyChainItemList + Use: required * + Desc: list of services + Type: tServiceItemList + Use: required S: S: S: S: S: S: S: value1 S: S: S: S: S: 100 S: S: P001 S: S: S: S: S: S: S: S: S: S: S: 5.14. 5.14.1. Request o Description: The ESDS operation is used to modify the contents of the specified . Thompson Expires April 19, 2008 [Page 82] Internet-Draft ESDS Commands October 2007 o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: partner unique identifier + Type: tSmallUID + Use: required * + Desc: partner identifier + Type: tPartnerID + Use: optional, but no more than 1 occurrence(s) * + Desc: list of services + Type: tServiceItemList + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 83] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: 100 C: C: P001 C: C: C: C: C: C: C: 5.14.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: Thompson Expires April 19, 2008 [Page 84] Internet-Draft ESDS Commands October 2007 * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 85] Internet-Draft ESDS Commands October 2007 5.15. 5.15.1. Request C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: P001 C: C: C: 5.15.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required Thompson Expires April 19, 2008 [Page 86] Internet-Draft ESDS Commands October 2007 * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: 5.16. 5.16.1. Request Thompson Expires April 19, 2008 [Page 87] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: P001 C: C: C: 5.16.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension Thompson Expires April 19, 2008 [Page 88] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) * + Desc: list of partners + Type: tPartnerItemList + Use: required S: S: S: S: S: S: S: value1 S: S: S: S: S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 89] Internet-Draft ESDS Commands October 2007 5.17. 5.17.1. Request o Description: The ESDS operation is used to create s in the ESDS system. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: supply chain identifier + Type: tSupplyChainID + Use: required * + Desc: list of partners + Type: tPartnerItemList + Use: optional, but no more than 1 occurrence(s) * + Desc: list of event deny entries Thompson Expires April 19, 2008 [Page 90] Internet-Draft ESDS Commands October 2007 + Type: tEventDenyItemList + Use: optional, but no more than 1 occurrence(s) * + Desc: list of life cycle allow entries + Type: tEventLifeCycleStepAllowItemList + Use: optional, but no more than 1 occurrence(s) C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: SC001 C: C: C: C: C: C: C: C: C: C: C: C: C: C: C: 5.17.2. Response o Description: When a operation has been processed successfully, a server will respond with a . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml Thompson Expires April 19, 2008 [Page 92] Internet-Draft ESDS Commands October 2007 + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: supply chain unique identifier + Type: tSmallUID + Use: required S: S: S: S: S: S: S: value1 S: S: S: S: S: 100 S: S: S: Thompson Expires April 19, 2008 [Page 93] Internet-Draft ESDS Commands October 2007 5.18. 5.18.1. Request o Description: The ESDS operation is used to query the details of an individual in the ESDS. The to be queried is located by the unique used to create the in the system. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: supply chain identifier + Type: tSupplyChainID + Use: required Thompson Expires April 19, 2008 [Page 94] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: SC001 C: C: C: 5.18.2. Response o Description: When a operation has been processed successfully, a server will respond with a . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml Thompson Expires April 19, 2008 [Page 95] Internet-Draft ESDS Commands October 2007 + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: supply chain unique identifier + Type: tSmallUID + Use: required * + Desc: supply chain identifier + Type: tSupplyChainID + Use: required * + Desc: list of partners + Type: tPartnerItemList + Use: optional, but no more than 1 occurrence(s) Thompson Expires April 19, 2008 [Page 96] Internet-Draft ESDS Commands October 2007 S: S: S: S: S: S: S: value1 S: S: S: S: S: 100 S: S: SC001 S: S: S: S: S: S: S: 5.19. Thompson Expires April 19, 2008 [Page 97] Internet-Draft ESDS Commands October 2007 5.19.1. Request o Description: The ESDS operation is used to modify the contents of the specified . o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: supply chain unique identifier + Type: tSmallUID + Use: required * + Desc: supply chain identifier + Type: tSupplyChainID + Use: optional, but no more than 1 occurrence(s) * + Desc: list of partners + Type: tPartnerItemList Thompson Expires April 19, 2008 [Page 98] Internet-Draft ESDS Commands October 2007 + Use: optional, but no more than 1 occurrence(s) C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: 100 C: C: SC001 C: C: C: C: C: C: C: 5.19.2. Response o Description: When a operation has been processed successfully, a server will respond with a Thompson Expires April 19, 2008 [Page 99] Internet-Draft ESDS Commands October 2007 . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 100] Internet-Draft ESDS Commands October 2007 5.20. 5.20.1. Request o Description: The ESDS operation is used to remove a from the ESDS system. If the is associated with other objects within the ESDS, then the will be marked with an "inactive" state. o Elements: * + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: supply chain identifier + Type: tSupplyChainID + Use: required Thompson Expires April 19, 2008 [Page 101] Internet-Draft ESDS Commands October 2007 C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: SC001 C: C: C: 5.20.2. Response o Description: When a operation has been processed successfully, a server will respond with a . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml Thompson Expires April 19, 2008 [Page 102] Internet-Draft ESDS Commands October 2007 + Type: tExtension + Use: optional, but no more than 1 occurrence(s) S: S: S: S: S: S: S: value1 S: S: S: S: S: S: 5.21. 5.21.1. Request o Description: The ESDS operation is used to query a set of partners that match the search criteria specified as request parameter elements. o Elements: * Thompson Expires April 19, 2008 [Page 103] Internet-Draft ESDS Commands October 2007 + Desc: session identifier + Type: tSessionID + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: supply chain identifier + Type: tSupplyChainID + Use: required C: C: C: C: C: C: 41xM1R6VD66l5Jb1HO8462Q7hWgDtWr4 C: C: C: C: SC001 C: C: C: Thompson Expires April 19, 2008 [Page 104] Internet-Draft ESDS Commands October 2007 5.21.2. Response o Description: When a operation has been processed successfully, a server will respond with an . o Elements: * + Desc: result structure common for each response + Type: tResult + Use: required * + Desc: user defined extension xml + Type: tExtension + Use: optional, but no more than 1 occurrence(s) * + Desc: list of supply chains + Type: tSupplyChainItemList + Use: required Thompson Expires April 19, 2008 [Page 105] Internet-Draft ESDS Commands October 2007 S: S: S: S: S: S: S: value1 S: S: S: S: S: S: S: S: S: S: Thompson Expires April 19, 2008 [Page 106] Internet-Draft ESDS Commands October 2007 6. IANA Considerations This document has no actions for IANA. Thompson Expires April 19, 2008 [Page 107] Internet-Draft ESDS Commands October 2007 7. Security Considerations The ESDS service requires valid identity of all connected users via a trusted X.509 certificate signed by a trusted ESDS Certificate Authority (CA). This will be validated by the ESDS system at connection time and only clients that meet this initial connection requirement will be allowed to proceed. There will be an offline process to apply for and acquire a signed X.509 client certificiate that will be able to connect to an ESDS service. Once a partner has this client certificate, connections can be made to the ESDS web service. Security within the ESDS is layered as follows: o ESDS X.509 Certificate Authority (ESDS-CA) signs and issues client certificates. Only client certificates signed by the ESDS-CA will be accepted as trusted certificates. [RFC3280] o HTTPS transport security if HTTP is the chosen transport protocol for the ESDS protocol. [RFC2818] o PLAIN SASL (Simple Authentication and Security Layer) identifier and password as plain text for login authentication. Plain text will be encrypted inside the HTTPS connection as part of the SSL transport. o verifies X.509 client certificate CN (Common Name) and O (Organization) fields match the values associated with the partner the user belongs to as an added security measure. Thus, only certificates on record in the ESDS will be allowed to connect, even if they are signed by the ESDS-CA. o Multiple user accounts with role-based permissions will be assigned to partners, enabling them to control their user access to the ESDS. o A partner is associated with a supply chain only by partners within the supply chain that have been granted authority to add partners. o , , visibility is based on partner ownership, supply chain membership and partner ACL (Access Control List) access. o type permissible only by the partner that created the original non-void event. Thompson Expires April 19, 2008 [Page 108] Internet-Draft ESDS Commands October 2007 8. References 8.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000. [RFC2821] Klensin, J., "Simple Mail Transfer Protocol", RFC 2821, April 2001. [RFC3280] Housley, R., Polk, W., Ford, W., and D. Solo, "Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile", RFC 3280, April 2002. [RFC4930] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", RFC 4930, May 2007. 8.2. Informative References [draft-thompson-esds-schema] Thompson, F., "Extensible Supply-chain Discovery Service Schema (work in progress)", April 2007. [draft-young-esds-concepts] Young, M., "Extensible Supply-chain Discovery Service Concepts (work in progress)", April 2007. Thompson Expires April 19, 2008 [Page 109] Internet-Draft ESDS Commands October 2007 Author's Address Frank Thompson Afilias Canada 204-4141 Yonge Street Toronto, ON M2P 2A8 CA Phone: +1.416.646.3304 Email: fot@ca.afilias.info Thompson Expires April 19, 2008 [Page 110] Internet-Draft ESDS Commands October 2007 Full Copyright Statement Copyright (C) The IETF Trust (2007). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Intellectual Property The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. Acknowledgment Funding for the RFC Editor function is provided by the IETF Administrative Support Activity (IASA). Thompson Expires April 19, 2008 [Page 111]