Reference for http://api.gdata.pl/IspRestApi/login
Url: http://api.gdata.pl/IspRestApi/login
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:
<Credentials xmlns="http://schemas.datacontract.org/2004/07/GData.Authentication"> <ApiKey>String content</ApiKey> <ApiName>String content</ApiName> <Password>String content</Password> <SigType>HMACSHA1</SigType> <Signature>String content</Signature> <TimeStamp>String content</TimeStamp> <Uri>String content</Uri> <UserName>String content</UserName> </Credentials>
The following is an example request Json body:
{
"ApiKey":"String content",
"ApiName":"String content",
"Password":"String content",
"SigType":0,
"Signature":"String content",
"TimeStamp":"String content",
"Uri":"String content",
"UserName":"String content"
}
The following is an example response Xml body:
<Response xmlns="http://schemas.datacontract.org/2004/07/Gdta.API.Common"> <AccessToken>String content</AccessToken> <ErrorCode>OK</ErrorCode> <ErrorMessage>String content</ErrorMessage> </Response>
The following is an example response Json body:
{
"AccessToken":"String content",
"ErrorCode":0,
"ErrorMessage":"String content"
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/GData.Authentication" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/GData.Authentication" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="Credentials">
<xs:sequence>
<xs:element minOccurs="0" name="ApiKey" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ApiName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Password" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SigType" type="tns:SignatureType" />
<xs:element minOccurs="0" name="Signature" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TimeStamp" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Uri" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="UserName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Credentials" nillable="true" type="tns:Credentials" />
<xs:simpleType name="SignatureType">
<xs:restriction base="xs:string">
<xs:enumeration value="HMACSHA1" />
<xs:enumeration value="HMACMD5" />
<xs:enumeration value="HMACSHA256" />
</xs:restriction>
</xs:simpleType>
<xs:element name="SignatureType" nillable="true" type="tns:SignatureType" />
</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>
<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="http://schemas.datacontract.org/2004/07/Gdta.API.Common" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Gdta.API.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
<xs:complexType name="Response">
<xs:sequence>
<xs:element minOccurs="0" name="AccessToken" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ErrorCode" type="tns:ErrorCodes" />
<xs:element minOccurs="0" name="ErrorMessage" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Response" nillable="true" type="tns:Response" />
<xs:simpleType name="ErrorCodes">
<xs:restriction base="xs:string">
<xs:enumeration value="OK" />
<xs:enumeration value="SESSION_EXPIRED" />
<xs:enumeration value="INVALID_TOKEN" />
<xs:enumeration value="INVALID_PARAMETER" />
<xs:enumeration value="INVALID_CREDENTIALS" />
<xs:enumeration value="INVALID_API_CREDENTIALS" />
<xs:enumeration value="LOGIN_EXISTS" />
<xs:enumeration value="LOGIN_DOESNT_EXIST" />
<xs:enumeration value="USER_DOESNT_EXIST" />
<xs:enumeration value="WRONG_REG_NUMBER" />
<xs:enumeration value="WRONG_SERIAL" />
<xs:enumeration value="ALREADY_REGISTERED" />
<xs:enumeration value="PARTNER_DOESNT_EXIST" />
<xs:enumeration value="INVALID_DOCUMENT" />
<xs:enumeration value="USER_DISABLED" />
<xs:enumeration value="USER_BLOCKED" />
<xs:enumeration value="KEY_DOESNT_EXIST" />
<xs:enumeration value="ORDER_EXIST" />
<xs:enumeration value="ORDER_CANCELLATION_NOT_ALLOWED" />
<xs:enumeration value="NOT_REGISTERED" />
<xs:enumeration value="MAC_KEY" />
<xs:enumeration value="NETWORK_ERROR" />
<xs:enumeration value="UANUTHORIZED" />
<xs:enumeration value="UNKNOWN_REG_NUMBER" />
<xs:enumeration value="OTHER">
<xs:annotation>
<xs:appinfo>
<EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">999</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="ErrorCodes" nillable="true" type="tns:ErrorCodes" />
</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>
<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>