Description
<description of the API call. Up to 3 sentences describing the general use of the API call.>
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
<NameOfFirstParameter> |
<TypeOfFirstParameter> |
<IsRequired ToExecute> |
<ExampleValueOfFirstParameter> |
<DescriptionOfFirstParameter> |
2 |
<NameOfSecondParameter> |
<TypeOfsecondParameter> |
<IsRequired ToExecute> |
<ExampleValueOfSecondParameter> |
<DescriptionOfSecondParameter> |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiAPITemplate>
<dem:FirstParameter>Foo Bar</dem:FirstParameter>
<dem:SecondParameter>1234</dem:SecondParameter>
</dem:pixiAPITemplate>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: <Title of first result set>
# |
Name |
Type |
Description |
1 |
<NameOfFirstColumn> |
<TypeOfFirstColumn> |
<DescriptionOfFirstColumn> |
2 |
<NameOfSecondColumn> |
<TypeOfSecondColumn> |
<DescriptionOfSecondColumn> |
Body 2: <Title of Second result set>
# |
Name |
Type |
Description |
1 |
<NameOfFirstColumn> |
<TypeOfFirstColumn> |
<DescriptionOfFirstColumn> |
2 |
<NameOfSecondColumn> |
<TypeOfSecondColumn> |
<DescriptionOfSecondColumn> |
Additional Notes
<Business logic and settings that influence the outcome of the API call.>
<Definition of XML used in parameters>
<List of handled error responses>