API browser of generalInvoiceRequest500 COM module


/images/arrow_right.png IGeneralInvoiceResult::GetFirstPartner method space
Retrieves the first partner address from the list of partner addresses.
Please note that only partners with a defined address are returned. Notably, partners induced by the AddService/AddServiceEx mechanism existing basically only by a GLN are not returned.
 
VARIANT_FALSE is returned if the end of the case detail list is reached.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceResult/GetFirstPartner
[JSON input data] pIGeneralInvoiceResult: longValue,    //interface address
[JSON result data] pePartnerType:
pbstrOtherPartnerType:
pbstrGLN:
pbstrZSR:
ppIAddress:





















pbStatus:
longValue,
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
{
  pbIsPrivateAddress: true,
  pbstrCompanyName: "utf8StringValue",
  pbstrDepartment: "utf8StringValue",
  pbstrSalutation: "utf8StringValue",
  pbstrTitle: "utf8StringValue",
  pbstrFamilyname: "utf8StringValue",
  pbstrGivenname: "utf8StringValue",
  pbstrSubaddressing: "utf8StringValue",
  pbstrStreet: "utf8StringValue",
  pbstrPoBox: "utf8StringValue",
  pbstrZip: "utf8StringValue",
  pbstrCity: "utf8StringValue",
  pbstrStateCode: "utf8StringValue",
  pbstrCountryCode: "utf8StringValue",
  pbstrPhone1: "utf8StringValue",
  pbstrPhone2: "utf8StringValue",
  pbstrPhone3: "utf8StringValue",
  pbstrFax: "utf8StringValue",
  pbstrEMail: "utf8StringValue",
  pbstrUrl: "utf8StringValue"
}
,
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 GetFirstPartner( PartnerType
BSTR
BSTR
BSTR
IAddress
VARIANT_BOOL
*pePartnerType,
*pbstrOtherPartnerType,
*pbstrGLN,
*pbstrZSR,
**ppIAddress,
*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
[out] PartnerType *pePartnerType 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.
[out] BSTR *pbstrOtherPartnerType The optional type description of the partner if ePartnerType=enOther is set.
[out] BSTR *pbstrGLN The GLN of the partner as supplied by Stiftung Refdata
[out] BSTR *pbstrZSR The optional ZSR number of the partner as supplied by Santesuisse
[out] IAddress **ppIAddress 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