API browser of generalInvoiceRequest500 COM module


/images/arrow_right.png IGeneralInvoiceResult::GetPartners method space
This method has a Restful Webservice representation only!
Method for collecting all partner addresses covered by the IGeneralInvoiceResult interface and returned as JSON array.
 
Please note that IGeneralInvoiceResult::GetPartners takes over the functionality of the iterator pair IGeneralInvoiceResult::GetFirstPartner / IGeneralInvoiceResult::GetNextPartner with a single call, making the latter superfluous.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceResult/GetPartners
[JSON input data] pIGeneralInvoiceResult: longValue,    //interface address
[JSON result array] { 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 Calling argument description
[out] PartnerType *pePartnerType The type of BfS record for which the number=name pair is supplied.
[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 the end of data is reached
space