GET | /CreateUuidAsync | An asynchronous service to generate a Universal Unique Identifier. |
---|
/** @description Specifies a base service to generate a Universal Unique Identifier. */
// @Api(Description="Specifies a base service to generate a Universal Unique Identifier.")
export class CreateUuidBase implements IGet
{
public constructor(init?: Partial<CreateUuidBase>) { (Object as any).assign(this, init); }
}
/** @description Specifies a service response from an ERiC service operation. */
// @Api(Description="Specifies a service response from an ERiC service operation.")
export class ServiceReponseBase implements IHasIndex
{
/** @description The unique identifier of the response. */
// @ApiMember(Description="The unique identifier of the response.", Name="Id")
public id: string;
/** @description The position of the response element in an indexed collection. */
// @ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
public index: number;
/** @description Metadata that contains structured error information on the service response. */
// @ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
public responseStatus?: ResponseStatus;
public constructor(init?: Partial<ServiceReponseBase>) { (Object as any).assign(this, init); }
}
/** @description Enumeration of ERiC API error codes. */
export enum EricFehlerCode
{
ERIC_OK = 0,
ERIC_GLOBAL_UNKNOWN = 610001001,
ERIC_GLOBAL_PRUEF_FEHLER = 610001002,
ERIC_GLOBAL_HINWEISE = 610001003,
ERIC_GLOBAL_FEHLERMELDUNG_NICHT_VORHANDEN = 610001007,
ERIC_GLOBAL_KEINE_DATEN_VORHANDEN = 610001008,
ERIC_GLOBAL_NICHT_GENUEGEND_ARBEITSSPEICHER = 610001013,
ERIC_GLOBAL_DATEI_NICHT_GEFUNDEN = 610001014,
ERIC_GLOBAL_HERSTELLER_ID_NICHT_ERLAUBT = 610001016,
ERIC_GLOBAL_ILLEGAL_STATE = 610001017,
ERIC_GLOBAL_FUNKTION_NICHT_ERLAUBT = 610001018,
ERIC_GLOBAL_ECHTFALL_NICHT_ERLAUBT = 610001019,
ERIC_GLOBAL_NO_VERSAND_IN_BETA_VERSION = 610001020,
ERIC_GLOBAL_TESTMERKER_UNGUELTIG = 610001025,
ERIC_GLOBAL_DATENSATZ_ZU_GROSS = 610001026,
ERIC_GLOBAL_VERSCHLUESSELUNGS_PARAMETER_NICHT_ERLAUBT = 610001027,
ERIC_GLOBAL_NUR_PORTALZERTIFIKAT_ERLAUBT = 610001028,
ERIC_GLOBAL_ABRUFCODE_NICHT_ERLAUBT = 610001029,
ERIC_GLOBAL_ERROR_XML_CREATE = 610001030,
ERIC_GLOBAL_TEXTPUFFERGROESSE_FIX = 610001031,
ERIC_GLOBAL_INTERNER_FEHLER = 610001032,
ERIC_GLOBAL_ARITHMETIKFEHLER = 610001033,
ERIC_GLOBAL_STEUERNUMMER_UNGUELTIG = 610001034,
ERIC_GLOBAL_STEUERNUMMER_FALSCHE_LAENGE = 610001035,
ERIC_GLOBAL_STEUERNUMMER_NICHT_NUMERISCH = 610001036,
ERIC_GLOBAL_LANDESNUMMER_UNBEKANNT = 610001037,
ERIC_GLOBAL_BUFANR_UNBEKANNT = 610001038,
ERIC_GLOBAL_LANDESNUMMER_BUFANR = 610001039,
ERIC_GLOBAL_PUFFER_ZUGRIFFSKONFLIKT = 610001040,
ERIC_GLOBAL_PUFFER_UEBERLAUF = 610001041,
ERIC_GLOBAL_DATENARTVERSION_UNBEKANNT = 610001042,
ERIC_GLOBAL_DATENARTVERSION_XML_INKONSISTENT = 610001044,
ERIC_GLOBAL_COMMONDATA_NICHT_VERFUEGBAR = 610001045,
ERIC_GLOBAL_LOG_EXCEPTION = 610001046,
ERIC_GLOBAL_TRANSPORTSCHLUESSEL_NICHT_ERLAUBT = 610001047,
ERIC_GLOBAL_OEFFENTLICHER_SCHLUESSEL_UNGUELTIG = 610001048,
ERIC_GLOBAL_TRANSPORTSCHLUESSEL_TYP_FALSCH = 610001049,
ERIC_GLOBAL_PUFFER_UNGLEICHER_INSTANZ = 610001050,
ERIC_GLOBAL_VORSATZ_UNGUELTIG = 610001051,
ERIC_GLOBAL_DATEIZUGRIFF_VERWEIGERT = 610001053,
ERIC_GLOBAL_UNGUELTIGE_INSTANZ = 610001080,
ERIC_GLOBAL_NICHT_INITIALISIERT = 610001081,
ERIC_GLOBAL_MEHRFACHE_INITIALISIERUNG = 610001082,
ERIC_GLOBAL_FEHLER_INITIALISIERUNG = 610001083,
ERIC_GLOBAL_UNKNOWN_PARAMETER_ERROR = 610001102,
ERIC_GLOBAL_CHECK_CORRUPTED_NDS = 610001108,
ERIC_GLOBAL_VERSCHLUESSELUNGS_PARAMETER_NICHT_ANGEGEBEN = 610001206,
ERIC_GLOBAL_SEND_FLAG_MEHR_ALS_EINES = 610001209,
ERIC_GLOBAL_UNGUELTIGE_FLAG_KOMBINATION = 610001218,
ERIC_GLOBAL_ERSTE_SEITE_DRUCK_NICHT_UNTERSTUETZT = 610001220,
ERIC_GLOBAL_UNGUELTIGER_PARAMETER = 610001222,
ERIC_GLOBAL_DRUCK_FUER_VERFAHREN_NICHT_ERLAUBT = 610001224,
ERIC_GLOBAL_VERSAND_ART_NICHT_UNTERSTUETZT = 610001225,
ERIC_GLOBAL_UNGUELTIGE_PARAMETER_VERSION = 610001226,
ERIC_GLOBAL_TRANSFERHANDLE = 610001227,
ERIC_GLOBAL_PLUGININITIALISIERUNG = 610001228,
ERIC_GLOBAL_INKOMPATIBLE_VERSIONEN = 610001229,
ERIC_GLOBAL_VERSCHLUESSELUNGSVERFAHREN_NICHT_UNTERSTUETZT = 610001230,
ERIC_GLOBAL_MEHRFACHAUFRUFE_NICHT_UNTERSTUETZT = 610001231,
ERIC_GLOBAL_UTI_COUNTRY_NOT_SUPPORTED = 610001404,
ERIC_GLOBAL_IBAN_FORMALER_FEHLER = 610001501,
ERIC_GLOBAL_IBAN_LAENDERCODE_FEHLER = 610001502,
ERIC_GLOBAL_IBAN_LANDESFORMAT_FEHLER = 610001503,
ERIC_GLOBAL_IBAN_PRUEFZIFFER_FEHLER = 610001504,
ERIC_GLOBAL_BIC_FORMALER_FEHLER = 610001510,
ERIC_GLOBAL_BIC_LAENDERCODE_FEHLER = 610001511,
ERIC_GLOBAL_ZULASSUNGSNUMMER_ZU_LANG = 610001519,
ERIC_GLOBAL_IDNUMMER_UNGUELTIG = 610001525,
ERIC_GLOBAL_NULL_PARAMETER = 610001526,
ERIC_GLOBAL_EWAZ_UNGUELTIG = 610001527,
ERIC_GLOBAL_EWAZ_LANDESKUERZEL_UNBEKANNT = 610001528,
ERIC_GLOBAL_UPDATE_NECESSARY = 610001851,
ERIC_GLOBAL_EINSTELLUNG_NAME_UNGUELTIG = 610001860,
ERIC_GLOBAL_EINSTELLUNG_WERT_UNGUELTIG = 610001861,
ERIC_GLOBAL_ERR_DEKODIEREN = 610001862,
ERIC_GLOBAL_FUNKTION_NICHT_UNTERSTUETZT = 610001863,
ERIC_GLOBAL_NUTZDATENTICKETS_NICHT_EINDEUTIG = 610001865,
ERIC_GLOBAL_NUTZDATENHEADERVERSIONEN_UNEINHEITLICH = 610001866,
ERIC_GLOBAL_BUNDESLAENDER_UNEINHEITLICH = 610001867,
ERIC_GLOBAL_ZEITRAEUME_UNEINHEITLICH = 610001868,
ERIC_GLOBAL_NUTZDATENHEADER_EMPFAENGER_NICHT_KORREKT = 610001869,
ERIC_TRANSFER_COM_ERROR = 610101200,
ERIC_TRANSFER_VORGANG_NICHT_UNTERSTUETZT = 610101201,
ERIC_TRANSFER_ERR_XML_THEADER = 610101210,
ERIC_TRANSFER_ERR_PARAM = 610101251,
ERIC_TRANSFER_ERR_DATENTEILENDNOTFOUND = 610101253,
ERIC_TRANSFER_ERR_BEGINDATENLIEFERANT = 610101255,
ERIC_TRANSFER_ERR_ENDDATENLIEFERANT = 610101256,
ERIC_TRANSFER_ERR_BEGINTRANSPORTSCHLUESSEL = 610101257,
ERIC_TRANSFER_ERR_ENDTRANSPORTSCHLUESSEL = 610101258,
ERIC_TRANSFER_ERR_BEGINDATENGROESSE = 610101259,
ERIC_TRANSFER_ERR_ENDDATENGROESSE = 610101260,
ERIC_TRANSFER_ERR_SEND = 610101271,
ERIC_TRANSFER_ERR_NOTENCRYPTED = 610101274,
ERIC_TRANSFER_ERR_PROXYCONNECT = 610101276,
ERIC_TRANSFER_ERR_CONNECTSERVER = 610101278,
ERIC_TRANSFER_ERR_NORESPONSE = 610101279,
ERIC_TRANSFER_ERR_PROXYAUTH = 610101280,
ERIC_TRANSFER_ERR_SEND_INIT = 610101282,
ERIC_TRANSFER_ERR_TIMEOUT = 610101283,
ERIC_TRANSFER_ERR_PROXYPORT_INVALID = 610101284,
ERIC_TRANSFER_ERR_OTHER = 610101291,
ERIC_TRANSFER_ERR_XML_NHEADER = 610101292,
ERIC_TRANSFER_ERR_XML_ENCODING = 610101293,
ERIC_TRANSFER_ERR_ENDSIGUSER = 610101294,
ERIC_TRANSFER_ERR_XMLTAG_NICHT_GEFUNDEN = 610101295,
ERIC_TRANSFER_ERR_DATENTEILFEHLER = 610101297,
ERIC_TRANSFER_EID_ZERTIFIKATFEHLER = 610101500,
ERIC_TRANSFER_EID_KEINKONTO = 610101510,
ERIC_TRANSFER_EID_IDNRNICHTEINDEUTIG = 610101511,
ERIC_TRANSFER_EID_SERVERFEHLER = 610101512,
ERIC_TRANSFER_EID_KEINCLIENT = 610101520,
ERIC_TRANSFER_EID_CLIENTFEHLER = 610101521,
ERIC_TRANSFER_EID_FEHLENDEFELDER = 610101522,
ERIC_TRANSFER_EID_IDENTIFIKATIONABGEBROCHEN = 610101523,
ERIC_TRANSFER_EID_NPABLOCKIERT = 610101524,
ERIC_CRYPT_ERROR_CREATE_KEY = 610201016,
ERIC_CRYPT_E_INVALID_HANDLE = 610201101,
ERIC_CRYPT_E_MAX_SESSION = 610201102,
ERIC_CRYPT_E_BUSY = 610201103,
ERIC_CRYPT_E_OUT_OF_MEM = 610201104,
ERIC_CRYPT_E_PSE_PATH = 610201105,
ERIC_CRYPT_E_PIN_WRONG = 610201106,
ERIC_CRYPT_E_PIN_LOCKED = 610201107,
ERIC_CRYPT_E_P7_READ = 610201108,
ERIC_CRYPT_E_P7_DECODE = 610201109,
ERIC_CRYPT_E_P7_RECIPIENT = 610201110,
ERIC_CRYPT_E_P12_READ = 610201111,
ERIC_CRYPT_E_P12_DECODE = 610201112,
ERIC_CRYPT_E_P12_SIG_KEY = 610201113,
ERIC_CRYPT_E_P12_ENC_KEY = 610201114,
ERIC_CRYPT_E_P11_SIG_KEY = 610201115,
ERIC_CRYPT_E_P11_ENC_KEY = 610201116,
ERIC_CRYPT_E_XML_PARSE = 610201117,
ERIC_CRYPT_E_XML_SIG_ADD = 610201118,
ERIC_CRYPT_E_XML_SIG_TAG = 610201119,
ERIC_CRYPT_E_XML_SIG_SIGN = 610201120,
ERIC_CRYPT_E_ENCODE_UNKNOWN = 610201121,
ERIC_CRYPT_E_ENCODE_ERROR = 610201122,
ERIC_CRYPT_E_XML_INIT = 610201123,
ERIC_CRYPT_E_ENCRYPT = 610201124,
ERIC_CRYPT_E_DECRYPT = 610201125,
ERIC_CRYPT_E_P11_SLOT_EMPTY = 610201126,
ERIC_CRYPT_E_NO_SIG_ENC_KEY = 610201127,
ERIC_CRYPT_E_LOAD_DLL = 610201128,
ERIC_CRYPT_E_NO_SERVICE = 610201129,
ERIC_CRYPT_E_ESICL_EXCEPTION = 610201130,
ERIC_CRYPT_E_TOKEN_TYPE_MISMATCH = 610201144,
ERIC_CRYPT_E_P12_CREATE = 610201146,
ERIC_CRYPT_E_VERIFY_CERT_CHAIN = 610201147,
ERIC_CRYPT_E_P11_ENGINE_LOADED = 610201148,
ERIC_CRYPT_E_USER_CANCEL = 610201149,
ERIC_CRYPT_ZERTIFIKAT = 610201200,
ERIC_CRYPT_SIGNATUR = 610201201,
ERIC_CRYPT_NICHT_UNTERSTUETZTES_PSE_FORMAT = 610201203,
ERIC_CRYPT_PIN_BENOETIGT = 610201205,
ERIC_CRYPT_PIN_STAERKE_NICHT_AUSREICHEND = 610201206,
ERIC_CRYPT_E_INTERN = 610201208,
ERIC_CRYPT_ZERTIFIKATSPFAD_KEIN_VERZEICHNIS = 610201209,
ERIC_CRYPT_ZERTIFIKATSDATEI_EXISTIERT_BEREITS = 610201210,
ERIC_CRYPT_PIN_ENTHAELT_UNGUELTIGE_ZEICHEN = 610201211,
ERIC_CRYPT_E_INVALID_PARAM_ABC = 610201212,
ERIC_CRYPT_CORRUPTED = 610201213,
ERIC_CRYPT_EIDKARTE_NICHT_UNTERSTUETZT = 610201214,
ERIC_CRYPT_E_SC_SLOT_EMPTY = 610201215,
ERIC_CRYPT_E_SC_NO_APPLET = 610201216,
ERIC_CRYPT_E_SC_SESSION = 610201217,
ERIC_CRYPT_E_P11_NO_SIG_CERT = 610201218,
ERIC_CRYPT_E_P11_INIT_FAILED = 610201219,
ERIC_CRYPT_E_P11_NO_ENC_CERT = 610201220,
ERIC_CRYPT_E_P12_NO_SIG_CERT = 610201221,
ERIC_CRYPT_E_P12_NO_ENC_CERT = 610201222,
ERIC_CRYPT_E_SC_ENC_KEY = 610201223,
ERIC_CRYPT_E_SC_NO_SIG_CERT = 610201224,
ERIC_CRYPT_E_SC_NO_ENC_CERT = 610201225,
ERIC_CRYPT_E_SC_INIT_FAILED = 610201226,
ERIC_CRYPT_E_SC_SIG_KEY = 610201227,
ERIC_IO_FEHLER = 610301001,
ERIC_IO_DATEI_INKORREKT = 610301005,
ERIC_IO_PARSE_FEHLER = 610301006,
ERIC_IO_NDS_GENERIERUNG_FEHLGESCHLAGEN = 610301007,
ERIC_IO_MASTERDATENSERVICE_NICHT_VERFUEGBAR = 610301010,
ERIC_IO_STEUERZEICHEN_IM_NDS = 610301014,
ERIC_IO_VERSIONSINFORMATIONEN_NICHT_GEFUNDEN = 610301031,
ERIC_IO_FALSCHES_VERFAHREN = 610301104,
ERIC_IO_READER_MEHRFACHE_STEUERFAELLE = 610301105,
ERIC_IO_READER_UNERWARTETE_ELEMENTE = 610301106,
ERIC_IO_READER_FORMALE_FEHLER = 610301107,
ERIC_IO_READER_FALSCHES_ENCODING = 610301108,
ERIC_IO_READER_MEHRFACHE_NUTZDATEN_ELEMENTE = 610301109,
ERIC_IO_READER_MEHRFACHE_NUTZDATENBLOCK_ELEMENTE = 610301110,
ERIC_IO_UNBEKANNTE_DATENART = 610301111,
ERIC_IO_READER_UNTERSACHBEREICH_UNGUELTIG = 610301114,
ERIC_IO_READER_ZU_VIELE_NUTZDATENBLOCK_ELEMENTE = 610301115,
ERIC_IO_READER_STEUERZEICHEN_IM_TRANSFERHEADER = 610301150,
ERIC_IO_READER_STEUERZEICHEN_IM_NUTZDATENHEADER = 610301151,
ERIC_IO_READER_STEUERZEICHEN_IN_DEN_NUTZDATEN = 610301152,
ERIC_IO_READER_ZU_VIELE_ANHAENGE = 610301190,
ERIC_IO_READER_ANHANG_ZU_GROSS = 610301191,
ERIC_IO_READER_ANHAENGE_ZU_GROSS = 610301192,
ERIC_IO_READER_SCHEMA_VALIDIERUNGSFEHLER = 610301200,
ERIC_IO_READER_UNBEKANNTE_XML_ENTITY = 610301201,
ERIC_IO_DATENTEILNOTFOUND = 610301252,
ERIC_IO_DATENTEILENDNOTFOUND = 610301253,
ERIC_IO_UEBERGABEPARAMETER_FEHLERHAFT = 610301300,
ERIC_IO_UNGUELTIGE_UTF8_SEQUENZ = 610301400,
ERIC_IO_UNGUELTIGE_ZEICHEN_IN_PARAMETER = 610301401,
ERIC_PRINT_INTERNER_FEHLER = 610501001,
ERIC_PRINT_DRUCKVORLAGE_NICHT_GEFUNDEN = 610501002,
ERIC_PRINT_UNGUELTIGER_DATEI_PFAD = 610501004,
ERIC_PRINT_INITIALISIERUNG_FEHLERHAFT = 610501007,
ERIC_PRINT_AUSGABEZIEL_UNBEKANNT = 610501008,
ERIC_PRINT_ABBRUCH_DRUCKVORBEREITUNG = 610501009,
ERIC_PRINT_ABBRUCH_GENERIERUNG = 610501010,
ERIC_PRINT_STEUERFALL_NICHT_UNTERSTUETZT = 610501011,
ERIC_PRINT_FUSSTEXT_ZU_LANG = 610501012,
}
/** @description Represent a base response that encapsulate any ERiC API function return value. */
// @Api(Description="Represent a base response that encapsulate any ERiC API function return value.")
export class EricFehlerCodeResponse extends ServiceReponseBase
{
/** @description The status code that the ERiC API function returns. */
// @ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public statusCode: EricFehlerCode;
/** @description The status message that the ERiC API function returns. */
// @ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public statusText?: string;
/** @description The unique identifier of the response. */
// @ApiMember(Description="The unique identifier of the response.", Name="Id")
public id: string;
/** @description The position of the response element in an indexed collection. */
// @ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
public index: number;
/** @description Metadata that contains structured error information on the service response. */
// @ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
public responseStatus?: ResponseStatus;
public constructor(init?: Partial<EricFehlerCodeResponse>) { super(init); (Object as any).assign(this, init); }
}
/** @description Represents a type that encaspulates a Universal Unique Identifier (UUID). */
// @Api(Description="Represents a type that encaspulates a Universal Unique Identifier (UUID).")
export class UuidResponse extends EricFehlerCodeResponse
{
/** @description The generated Universal Unique Identifier. */
// @ApiMember(Description="The generated Universal Unique Identifier.")
public uuid?: string;
/** @description The status code that the ERiC API function returns. */
// @ApiMember(Description="The status code that the ERiC API function returns.", Name="StatusCode")
public statusCode: EricFehlerCode;
/** @description The status message that the ERiC API function returns. */
// @ApiMember(Description="The status message that the ERiC API function returns.", Name="StatusText")
public statusText?: string;
/** @description The unique identifier of the response. */
// @ApiMember(Description="The unique identifier of the response.", Name="Id")
public id: string;
/** @description The position of the response element in an indexed collection. */
// @ApiMember(Description="The position of the response element in an indexed collection.", Name="Index")
public index: number;
/** @description Metadata that contains structured error information on the service response. */
// @ApiMember(Description="Metadata that contains structured error information on the service response.", Name="ResponseStatus")
public responseStatus?: ResponseStatus;
public constructor(init?: Partial<UuidResponse>) { super(init); (Object as any).assign(this, init); }
}
/** @description An asynchronous service to generate a Universal Unique Identifier. */
// @Api(Description="An asynchronous service to generate a Universal Unique Identifier.")
export class CreateUuidAsync extends CreateUuidBase
{
public constructor(init?: Partial<CreateUuidAsync>) { super(init); (Object as any).assign(this, init); }
}
TypeScript CreateUuidAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /CreateUuidAsync HTTP/1.1 Host: taxfiling.staging.pwc.de Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UuidResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses"> <Id>String</Id> <Index>0</Index> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <StatusCode>ERIC_OK</StatusCode> <StatusText>String</StatusText> <UUID>String</UUID> </UuidResponse>