Reference for http://dispatchweb.eureka-technology.fr/WebManager/WCFDispatchAPI.svc/REST/Json/InitOrderReportGeneration
Initie une demande de génération de report, le report sera récupérable par la méthode GetOrderReportGenerationResult
Url: http://dispatchweb.eureka-technology.fr/WebManager/WCFDispatchAPI.svc/REST/Json/InitOrderReportGeneration
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<InitOrderReportGenerationRequest xmlns="EurekaTechnology.DispatchWeb.API.Business">
<Credential>
<License>String content</License>
<Login>String content</Login>
<Password>String content</Password>
<EMail>String content</EMail>
<Language>String content</Language>
<ConnectionToken>String content</ConnectionToken>
<OrdererCode>String content</OrdererCode>
<DelegateToken>String content</DelegateToken>
<ConsumerOrdererCode>String content</ConsumerOrdererCode>
<ConsumerKey>String content</ConsumerKey>
<Sso>
<SsoConfigurationCode>String content</SsoConfigurationCode>
<SsoAuthCode>String content</SsoAuthCode>
<SsoRedirectUri>String content</SsoRedirectUri>
<SsoSamlContent>String content</SsoSamlContent>
<SsoSamlHttpMethod>String content</SsoSamlHttpMethod>
</Sso>
</Credential>
<InternalOrderId>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</InternalOrderId>
<ReportType>2147483647</ReportType>
<PaperOptions>
<SizeType>2147483647</SizeType>
<Orientation>2147483647</Orientation>
<BottomMargin>2147483647</BottomMargin>
<LeftMargin>2147483647</LeftMargin>
<TopMargin>2147483647</TopMargin>
<RightMargin>2147483647</RightMargin>
</PaperOptions>
</InitOrderReportGenerationRequest>
The following is an example request Json body:
{
"Credential":{
"License":"String content",
"Login":"String content",
"Password":"String content",
"EMail":"String content",
"Language":"String content",
"ConnectionToken":"String content",
"OrdererCode":"String content",
"DelegateToken":"String content",
"ConsumerOrdererCode":"String content",
"ConsumerKey":"String content",
"Sso":{
"SsoConfigurationCode":"String content",
"SsoAuthCode":"String content",
"SsoRedirectUri":"String content",
"SsoSamlContent":"String content",
"SsoSamlHttpMethod":"String content"
}
},
"InternalOrderId":[2147483647],
"ReportType":2147483647,
"PaperOptions":{
"SizeType":2147483647,
"Orientation":2147483647,
"BottomMargin":2147483647,
"LeftMargin":2147483647,
"TopMargin":2147483647,
"RightMargin":2147483647
}
}
The following is an example response Xml body:
<InitOrderReportGenerationResponse xmlns="EurekaTechnology.DispatchWeb.API.Business">
<Errors>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
</Errors>
<Status>OK</Status>
<DownloadGuid>String content</DownloadGuid>
<DocumentDownloadStatus>InternalError</DocumentDownloadStatus>
</InitOrderReportGenerationResponse>
The following is an example response Json body:
{
"Errors":["String content"],
"Status":0,
"DownloadGuid":"String content",
"DocumentDownloadStatus":0
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="EurekaTechnology.DispatchWeb.API.Business" elementFormDefault="qualified" targetNamespace="EurekaTechnology.DispatchWeb.API.Business" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:complexType name="InitOrderReportGenerationRequest">
<xs:complexContent mixed="false">
<xs:extension base="tns:RequestType">
<xs:sequence>
<xs:element minOccurs="0" name="InternalOrderId" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfint" />
<xs:element minOccurs="0" name="ReportType" type="xs:int" />
<xs:element minOccurs="0" name="PaperOptions" nillable="true" type="tns:ReportPaperOptions" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="InitOrderReportGenerationRequest" nillable="true" type="tns:InitOrderReportGenerationRequest" />
<xs:complexType name="RequestType">
<xs:sequence>
<xs:element name="Credential" nillable="true" type="tns:Credential" />
</xs:sequence>
</xs:complexType>
<xs:element name="RequestType" nillable="true" type="tns:RequestType" />
<xs:complexType name="Credential">
<xs:sequence>
<xs:element name="License" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Login" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Password" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EMail" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Language" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ConnectionToken" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="OrdererCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="DelegateToken" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ConsumerOrdererCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ConsumerKey" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Sso" nillable="true" type="tns:SsoAuthentication" />
</xs:sequence>
</xs:complexType>
<xs:element name="Credential" nillable="true" type="tns:Credential" />
<xs:complexType name="SsoAuthentication">
<xs:sequence>
<xs:element name="SsoConfigurationCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SsoAuthCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SsoRedirectUri" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SsoSamlContent" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SsoSamlHttpMethod" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="SsoAuthentication" nillable="true" type="tns:SsoAuthentication" />
<xs:complexType name="ReportPaperOptions">
<xs:sequence>
<xs:element minOccurs="0" name="SizeType" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Orientation" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="BottomMargin" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="LeftMargin" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="TopMargin" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="RightMargin" nillable="true" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="ReportPaperOptions" nillable="true" type="tns:ReportPaperOptions" />
</xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfint">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="int" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfint" nillable="true" type="tns:ArrayOfint" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="EurekaTechnology.DispatchWeb.API.Business" elementFormDefault="qualified" targetNamespace="EurekaTechnology.DispatchWeb.API.Business" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="InitOrderReportGenerationResponse">
<xs:complexContent mixed="false">
<xs:extension base="tns:ResponseType">
<xs:sequence>
<xs:element minOccurs="0" name="DownloadGuid" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="DocumentDownloadStatus" type="tns:EDocumentDownloadStatus" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="InitOrderReportGenerationResponse" nillable="true" type="tns:InitOrderReportGenerationResponse" />
<xs:complexType name="ResponseType">
<xs:sequence>
<xs:element minOccurs="0" name="Errors" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" />
<xs:element name="Status" type="tns:ResponseStatus" />
</xs:sequence>
</xs:complexType>
<xs:element name="ResponseType" nillable="true" type="tns:ResponseType" />
<xs:simpleType name="ResponseStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="OK">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">200</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Created">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">201</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Accepted">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">202</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="NoContent">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">204</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="NotModified">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">304</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="BadRequest">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">400</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Unauthorized">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">401</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="MethodNotAllowed">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">405</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="RequestTimeout">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">408</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="NoEquivalence">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">420</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="NOK">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">421</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="InternalServerError">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">500</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="NotImplemented">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">501</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="ServiceUnavailable">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">503</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="ResponseStatus" nillable="true" type="tns:ResponseStatus" />
<xs:simpleType name="EDocumentDownloadStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="InternalError">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">-1</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="DocumentIsDownloadingFromCarrier" />
<xs:enumeration value="PendingDocumentDownloadFromSubcontractor" />
<xs:enumeration value="PendingSubcontractorAssignment" />
</xs:restriction>
</xs:simpleType>
<xs:element name="EDocumentDownloadStatus" nillable="true" type="tns:EDocumentDownloadStatus" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfstring">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>