API browser of generalInvoiceRequest500 COM module


/images/arrow_right.png IGeneralInvoiceRequest::AddPartner method space
Adds a partner address and ist mandatory GLN, type as well as some optional other keys like ZSR.
 
Please note that the type, cardinality and scope of the partner address is determined by the applicable law and/or the underlying tariff contract.
 
The types 'service_provider' is an exception to this rule. This type defines/subsumes the address and GLN
of all unique service provider and service responsible, that are referenced in service@provider_id, service@responsible_id,
serviceEx@provider_id and serviceEx@responsible_id, respectively. Each call of the methods AddService and AddServiceEx does automatically inject an empty address and the defined GLN into the partner list. At least for law=enVVG the corresponding address to the given GLN should be completed.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceRequest/AddPartner
[JSON input data] pIGeneralInvoiceRequest:
ePartnerType:
bstrOtherPartnerType:
bstrGLN:
bstrZSR:
pIAddress:
longValue,    //interface address
longValue,
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
longValue
[JSON result data] pbStatus: booleanValue
 
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT AddPartner( PartnerType
BSTR
BSTR
BSTR
IAddress
VARIANT_BOOL
ePartnerType,
bstrOtherPartnerType,
bstrGLN,
bstrZSR,
*pIAddress,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
E_name This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.
space
/images/arrow_right.png Calling argument description
[in] PartnerType ePartnerType ePartnerType is the type/flavor of a partner encoded by a terminal set of tokens.
 
The partner specification was primarily demanded by the "FinMa - Swiss Financial Market Supervisory Authority" to enhance the billing transparency in VVG cases.
[in] BSTR bstrOtherPartnerType The optional type description of the partner if ePartnerType=enOther is set.
[in] BSTR bstrGLN The GLN of the partner as supplied by Stiftung Refdata
[in] BSTR bstrZSR The optional ZSR number of the partner as supplied by Santesuisse
[in] IAddress *pIAddress The instance of a IAddress interface that holds the structured address parts.
A NULL pointer is supplied if no address should be set.
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
space