<back to all web services

BatchDeleteElmaCredentialsAsync

Represents a service to delete multiple ELMA credentials in an asynchronous operation.

/** @description Represents a PEM-encoded certificate. */
// @Api(Description="Represents a PEM-encoded certificate.")
export class PemCertificate
{
    /** @description The unique identifier (e.g. the file name) of the certificate. */
    // @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
    public id: string;

    /** @description The PEM-encoded content of the certificate. */
    // @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
    public content: string;

    /** @description The description of the certificate. */
    // @ApiMember(Description="The description of the certificate.", Name="Description")
    public description: string;

    /** @description Tags to label or identify the certificate. */
    // @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
    public tags: string[];

    public constructor(init?: Partial<PemCertificate>) { (Object as any).assign(this, init); }
}

/** @description Represents the credentials of a user to authenticate the access of an ELMA server. */
// @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
export class ElmaCredential implements IElmaCredential
{
    /** @description The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval. */
    // @ApiMember(Description="The unique identifier of this instance.  This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id")
    public id: string;

    /** @description The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start) */
    // @ApiMember(Description="The security certificate to authenticate the user and grant access to the ELMA server.  This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)", IsRequired=true, Name="Certificate")
    // @Required()
    // @StringLength(2147483647)
    public certificate: PemCertificate;

    /** @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
    // @ApiMember(Description="The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9).  The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start).  The number is available in the private area of the BOP user account under \"My BOP\" under the \"Registration Information\"", IsRequired=true, Name="AuthSteuernummer")
    // @Required()
    // @StringLength(11)
    public authSteuernummer: string;

    /** @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
    // @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
    // @Required()
    // @StringLength(10)
    public accountId: string;

    /** @description The password to protect the certificate from unauthorized access. */
    // @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
    public password: string;

    public constructor(init?: Partial<ElmaCredential>) { (Object as any).assign(this, init); }
}

/** @description Specfies a service to delete multiple ELMA credentials. */
// @Api(Description="Specfies a service to delete multiple ELMA credentials.")
export class BatchDeleteElmaCredentialsBase implements IPost
{
    /** @description The ELMA credentials to delete. */
    // @ApiMember(Description="The ELMA credentials to delete.", IsRequired=true, Name="Credentials")
    public credentials: ElmaCredential[];

    public constructor(init?: Partial<BatchDeleteElmaCredentialsBase>) { (Object as any).assign(this, init); }
}

/** @description Represents a service to delete multiple ELMA credentials in an asynchronous operation. */
// @Api(Description="Represents a service to delete multiple ELMA credentials in an asynchronous operation.")
export class BatchDeleteElmaCredentialsAsync extends BatchDeleteElmaCredentialsBase
{

    public constructor(init?: Partial<BatchDeleteElmaCredentialsAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript BatchDeleteElmaCredentialsAsync DTOs

POST /async/elma/credentials/batch/delete HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	credentials: 
	[
		{
			id: String_String,
			certificate: 
			{
				id: String,
				content: String,
				description: String,
				tags: 
				[
					String
				]
			},
			authSteuernummer: String,
			accountId: String,
			password: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		id: String,
		credential: 
		{
			id: String_String,
			certificate: 
			{
				id: String,
				content: String,
				description: String,
				tags: 
				[
					String
				]
			},
			authSteuernummer: String,
			accountId: String,
			password: String
		},
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	}
]