SOAP API Request Format
Learn more about how to format a request and information about which fields are required.
Format a request
Option 1: SOAP without attachments
This option allows you to send a request inside the body with the code inline (for the payload).
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:eb="http://www.ebxml.org/namespaces/messageHeader" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsd="http://www.w3.org/1999/XMLSchema"> <SOAP-ENV:Header> <eb:MessageHeader SOAP-ENV:mustUnderstand="1" eb:version="1.0"> <eb:From> <eb:PartyId /> </eb:From> <eb:To> <eb:PartyId /> </eb:To> <eb:CPAId>YourIPCC</eb:CPAId> <eb:ConversationId>YourConversationID</eb:ConversationId> <eb:Service>TheServiceActionCodeRQ</eb:Service> <eb:Action>TheServiceActionCodeRQ</eb:Action> <eb:MessageData> <eb:MessageId>mid:20001209-133003-2333@clientofsabre.com</eb:MessageId> <eb:Timestamp>2001-02-15T11:15:12Z</eb:Timestamp> <eb:TimeToLive>2001-02-15T11:15:12Z</eb:TimeToLive> </eb:MessageData> </eb:MessageHeader> <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/12/secext"> <wsse:BinarySecurityToken valueType="String" EncodingType="wsse:Base64Binary">TheBinarySecurityTokenFromTokenCreateRQorSessionCreateRQ</wsse:BinarySecurityToken> </wsse:Security> </SOAP-ENV:Header> <SOAP-ENV:Body> <eb:SoapAPIServiceActionCode> <!-- NOTE: see documentation for the given API's request payload. --> </eb:SoapAPIServiceActionCode> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Option 2: SOAP with attachments
This option allows you to send the envelope with the header (separate from the payload).
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:eb="http://www.ebxml.org/namespaces/messageHeader" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsd="http://www.w3.org/1999/XMLSchema"> <SOAP-ENV:Header> <eb:MessageHeader SOAP-ENV:mustUnderstand="1" eb:version="1.0"> <eb:From> <eb:PartyId /> </eb:From> <eb:To> <eb:PartyId /> </eb:To> <eb:CPAId>YourIPCC</eb:CPAId> <eb:ConversationId>YourConversationID</eb:ConversationId> <eb:Service>TheServiceActionCodeRQ</eb:Service> <eb:Action>TheServiceActionCodeRQ</eb:Action> <eb:MessageData> <eb:MessageId>mid:20001209-133003-2333@clientofsabre.com</eb:MessageId> <eb:Timestamp>2001-02-15T11:15:12Z</eb:Timestamp> <eb:TimeToLive>2001-02-15T11:15:12Z</eb:TimeToLive> </eb:MessageData> </eb:MessageHeader> <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/12/secext"> <wsse:BinarySecurityToken valueType="String" EncodingType="wsse:Base64Binary">TheBinarySecurityTokenFromTokenCreateRQorSessionCreateRQ</wsse:BinarySecurityToken> </wsse:Security> </SOAP-ENV:Header> <SOAP-ENV:Body> <eb:Manifest SOAP-ENV:mustUnderstand="1" eb:version="1.0"> <eb:Reference xlink:href="cid:rootelement" xlink:type="simple" /> </eb:Manifest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Required request fields
Required
The following fields are required in all SOAP API requests.
Field Name | Description | Sample Format | Maximum Field Size |
---|---|---|---|
eb:CPAId |
|
- | 20 |
eb:Action |
|
BargainFinderMaxRQ | 48 |
eb:Service |
|
BargainFinderMaxRQ | 128 |
eb:ConversationId |
|
See below: #related links | 255 |
wsse:BinarySecurityToken |
|
200 |
Optional
The following fields must be in the request, but which a value is optional.
Field Name | Description | Sample Format | Maximum Field Size |
---|---|---|---|
eb:MessageId |
|
mid:20001209-133003-2333@texasfares.com | 255 |
eb:From/eb:PartyId |
|
matt@texasfares.com | 255 |
eb:To/eb:PartyId |
|
http://{domain}.com | 255 |
eb:RefToMessageId |
|
255 | |
eb:Timestamp |
|
YYYY-MM-DDT11:59:00Z | 30 |
eb:Timeout |
|
- | 6 |