...
3.1 Parameters in the Generic Document Request
| Parameter Name | Element Description | Required |
|---|---|---|
| DocumentType | Element should contain the value of the root tag/document being requested. | Yes |
| DateRange – StartDate, EndDate | DateRange – StartDate, EndDate | No |
| MaximumDocuments | Maximum number of documents the consumer wants to receive back. | Yes |
| DocumentReference | Specific document ID on transaction being requested. If sent, then takes |
...
| precedence over StartDate and EndDate. | No |
3.2 Sample web service Response XML
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" |
...
xmlns:xsd="http://www.w3.org/2001/XMLSchema" |
...
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
...
xmlns:ns0="urn:aggateway:names:ws:docexchange"> |
...
<env:Body> |
...
<ns0:outboundData> <processStep>ShipNoticeList</processStep> <messageId>456</messageId> <xmlPayload> <ns1:ShipNoticeList xmlns="urn:ecms:schema:shipnotice:response:1:0" |
...
xmlns:cidx="urn:cidx:names:specification:ces:schema:all:4:0" |
...
xmlns:ns1="urn:ecms:schema:shipnotice:response:1:0" |
...
xmlns:ecms="urn:ecms:schema:shipnotice:response:1:0" Version="1.0"> |
...
<cidx:Header xmlns:cidx="urn:cidx:names:specification:ces:schema:all:4:0"> |
...
<cidx:ThisDocumentIdentifier> |
...
<cidx:DocumentIdentifier>489</cidx:DocumentIdentifier> |
...
</cidx:ThisDocumentIdentifier> |
...
<cidx:ThisDocumentDateTime> |
...
<cidx:DateTime DateTimeQualifier="On" |
...
>2008-05-19T17:17:56Z</cidx:DateTime> |
...
</cidx:ThisDocumentDateTime> |
...
<cidx:From> |
...
<cidx:PartnerInformation> |
...
<cidx:PartnerName>GROWMARK INC</cidx:PartnerName> |
...
<cidx:PartnerIdentifier Agency="AGIIS-EBID" |
...
>0576403930000</cidx:PartnerIdentifier> |
...
</cidx:PartnerInformation> |
...
</cidx:From> |
...
<cidx:To> |
...
<cidx:PartnerInformation> <cidx:PartnerName>LINCOLN LAND FS INC</cidx:PartnerName> |
...
<cidx:PartnerIdentifier Agency="AGIIS-EBID" |
...
>1563760970000</cidx:PartnerIdentifier> |
...
</cidx:PartnerInformation> |
...
</cidx:To> </cidx:Header> |
...
<ns1:ShipNoticeListBody> |
...
<ns1:ShipNoticeListProperties/> |
...
<ns1:ShipNoticeListDetails> |
...
<ns2:ShipNoticeBody |
...
xmlns:ns2="urn:cidx:names:specification:ces:schema:all:4:0"> |
...
<ns2:ShipNoticeProperties> <ns2:ShipmentIdentification> <ns2:DocumentReference> <ns2:DocumentIdentifier>8731832</ns2:DocumentIdentifier> </ns2:DocumentReference> </ns2:ShipmentIdentification> <ns2:ShipDate> <ns2:DateTime DateTimeQualifier="On" >2008-05-16T05:00:00Z</ns2:DateTime> |
...
</ns2:ShipDate> |
...
<ns2:PurchaseOrderInformation> <ns2:DocumentReference> <ns2:DocumentIdentifier>8731832</ns2:DocumentIdentifier> |
...
</ns2:DocumentReference> </ns2:PurchaseOrderInformation> <ns2:TransportMethodCode Domain="UN-Rec-19" |
...
>6</ns2:TransportMethodCode> |
...
<ns2:ReferenceInformation ReferenceType="DeliveryNoteNumber"> |
...
<ns2:DocumentReference> <ns2:DocumentIdentifier>8731832</ns2:DocumentIdentifier> |
...
</ns2:DocumentReference> </ns2:ReferenceInformation> <ns2:ShipNoticeDate> <ns2:DateTime DateTimeQualifier="On" >2008-05-19T17:17:56Z</ns2:DateTime> |
...
</ns2:ShipNoticeDate> |
...
</ns2:ShipNoticeProperties> |
...
<ns2:ShipNoticePartners> <ns2:Buyer> <ns2:PartnerInformation> <ns2:PartnerName>LINCOLN LAND FS INC</ns2:PartnerName> <ns2:PartnerIdentifier Agency="AGIIS-EBID" >1563760970000</ns2:PartnerIdentifier> </ns2:PartnerInformation> </ns2:Buyer> <ns2:Seller> <ns2:PartnerInformation> <ns2:PartnerName>GROWMARK INC</ns2:PartnerName> <ns2:PartnerIdentifier Agency="AGIIS-EBID" >0576403930000</ns2:PartnerIdentifier> </ns2:PartnerInformation> </ns2:Seller> </ns2:ShipNoticePartners> <ns2:ShipNoticeDetails> <ns2:ShipNoticeProductLineItem> <ns2:LineNumber>1</ns2:LineNumber> <ns2:ProductIdentification> <ns2:ProductIdentifier Agency="AGIIS-ProductID" >629245288686</ns2:ProductIdentifier> <ns2:ProductName>OPTIMIZE SOYBEAN GROWTH PROMOTER 200 UNIT/10,000#</ns2:ProductName> </ns2:ProductIdentification> <ns2:ShippedQuantity> <ns2:Measurement> <ns2:MeasurementValue>2</ns2:MeasurementValue> <ns2:UnitOfMeasureCode Domain="UN-Rec-20" >EA</ns2:UnitOfMeasureCode> </ns2:Measurement> </ns2:ShippedQuantity> </ns2:ShipNoticeProductLineItem> </ns2:ShipNoticeDetails> </ns2:ShipNoticeBody> </ns1:ShipNoticeListDetails> </ns1:ShipNoticeListBody> </ns1:ShipNoticeList> </xmlPayload> </ns0:outboundData> </env:Body> </env:Envelope> |