Skip to content

Latest commit

 

History

History
685 lines (493 loc) · 39.3 KB

HomePageURLApi.md

File metadata and controls

685 lines (493 loc) · 39.3 KB
Raw

BeLenka\SAP\BusinessPartner\HomePageURLApi

All URIs are relative to https://:/sap/opu/odata/sap/API_BUSINESS_PARTNER, except if the operation defines another base path.

Method HTTP request Description
aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressDelete() DELETE /A_AddressHomePageURL(AddressID='{AddressID}',Person='{Person}',OrdinalNumber='{OrdinalNumber}',ValidityStartDate=datetime'{ValidityStartDate}',IsDefaultURLAddress={IsDefaultURLAddress}) Deletes home page URL address record by key fields.
aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressGet() GET /A_AddressHomePageURL(AddressID='{AddressID}',Person='{Person}',OrdinalNumber='{OrdinalNumber}',ValidityStartDate=datetime'{ValidityStartDate}',IsDefaultURLAddress={IsDefaultURLAddress}) Retrieves home page URL address records by using key fields.
aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressPatch() PATCH /A_AddressHomePageURL(AddressID='{AddressID}',Person='{Person}',OrdinalNumber='{OrdinalNumber}',ValidityStartDate=datetime'{ValidityStartDate}',IsDefaultURLAddress={IsDefaultURLAddress}) Updates home page URL address record by key fields.
aAddressHomePageURLGet() GET /A_AddressHomePageURL Retrieves home page URL address records linked to business partner address.
aAddressHomePageURLPost() POST /A_AddressHomePageURL Creates a new home page URL address record to the existing business partner address.
aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressGet() GET /A_BPContactToAddress(RelationshipNumber='{RelationshipNumber}',BusinessPartnerCompany='{BusinessPartnerCompany}',BusinessPartnerPerson='{BusinessPartnerPerson}',ValidityEndDate=datetime'{ValidityEndDate}',AddressID='{AddressID}')/to_URLAddress Retrieves home page URL address records linked to business partner address.
aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressPost() POST /A_BPContactToAddress(RelationshipNumber='{RelationshipNumber}',BusinessPartnerCompany='{BusinessPartnerCompany}',BusinessPartnerPerson='{BusinessPartnerPerson}',ValidityEndDate=datetime'{ValidityEndDate}',AddressID='{AddressID}')/to_URLAddress Creates a new home page URL address record to the existing business partner address.
aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressGet() GET /A_BusinessPartnerAddress(BusinessPartner='{BusinessPartner}',AddressID='{AddressID}')/to_URLAddress Retrieves home page URL address records linked to business partner address.
aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressPost() POST /A_BusinessPartnerAddress(BusinessPartner='{BusinessPartner}',AddressID='{AddressID}')/to_URLAddress Creates a new home page URL address record to the existing business partner address.

aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressDelete()

aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressDelete($address_id, $person, $ordinal_number, $validity_start_date, $is_default_url_address)

Deletes home page URL address record by key fields.

Deletes business Partner home page URL address data of the record identified by AddressID, Person, and OrdinalNumber

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$address_id = 'address_id_example'; // string | Address Number
$person = 'person_example'; // string | Person Number
$ordinal_number = 'ordinal_number_example'; // string | Sequence Number
$validity_start_date = 2017-04-13T00:00; // string | Valid-from date - in current Release only 00010101 possible
$is_default_url_address = True; // bool | Flag: this address is the default address

try {
    $apiInstance->aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressDelete($address_id, $person, $ordinal_number, $validity_start_date, $is_default_url_address);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
address_id string Address Number
person string Person Number
ordinal_number string Sequence Number
validity_start_date string Valid-from date - in current Release only 00010101 possible
is_default_url_address bool Flag: this address is the default address

Return type

void (empty response body)

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressGet()

aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressGet($address_id, $person, $ordinal_number, $validity_start_date, $is_default_url_address, $select): \BeLenka\SAP\BusinessPartner\Model\AAddressHomePageURLType

Retrieves home page URL address records by using key fields.

Retrieves home page URL address records by using AddressID, Person, and OrdinalNumber fields.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$address_id = 'address_id_example'; // string | Address Number
$person = 'person_example'; // string | Person Number
$ordinal_number = 'ordinal_number_example'; // string | Sequence Number
$validity_start_date = 2017-04-13T00:00; // string | Valid-from date - in current Release only 00010101 possible
$is_default_url_address = True; // bool | Flag: this address is the default address
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressGet($address_id, $person, $ordinal_number, $validity_start_date, $is_default_url_address, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
address_id string Address Number
person string Person Number
ordinal_number string Sequence Number
validity_start_date string Valid-from date - in current Release only 00010101 possible
is_default_url_address bool Flag: this address is the default address
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\AAddressHomePageURLType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressPatch()

aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressPatch($address_id, $person, $ordinal_number, $validity_start_date, $is_default_url_address, $modified_a_address_home_page_url_type)

Updates home page URL address record by key fields.

Updates business partner home page URL address data of the record identified by AddressID, Person, and OrdinalNumber.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$address_id = 'address_id_example'; // string | Address Number
$person = 'person_example'; // string | Person Number
$ordinal_number = 'ordinal_number_example'; // string | Sequence Number
$validity_start_date = 2017-04-13T00:00; // string | Valid-from date - in current Release only 00010101 possible
$is_default_url_address = True; // bool | Flag: this address is the default address
$modified_a_address_home_page_url_type = new \BeLenka\SAP\BusinessPartner\Model\ModifiedAAddressHomePageURLType(); // \BeLenka\SAP\BusinessPartner\Model\ModifiedAAddressHomePageURLType | New property values

try {
    $apiInstance->aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressPatch($address_id, $person, $ordinal_number, $validity_start_date, $is_default_url_address, $modified_a_address_home_page_url_type);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aAddressHomePageURLAddressIDAddressIDPersonPersonOrdinalNumberOrdinalNumberValidityStartDatedatetimeValidityStartDateIsDefaultURLAddressIsDefaultURLAddressPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
address_id string Address Number
person string Person Number
ordinal_number string Sequence Number
validity_start_date string Valid-from date - in current Release only 00010101 possible
is_default_url_address bool Flag: this address is the default address
modified_a_address_home_page_url_type \BeLenka\SAP\BusinessPartner\Model\ModifiedAAddressHomePageURLType New property values

Return type

void (empty response body)

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aAddressHomePageURLGet()

aAddressHomePageURLGet($top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\BusinessPartner\Model\Wrapper2

Retrieves home page URL address records linked to business partner address.

Retrieves all the home page URL address records linked to all business partner address records in the system.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$top = 50; // int | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)
$inlinecount = 'inlinecount_example'; // string | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aAddressHomePageURLGet($top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aAddressHomePageURLGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
top int Show only the first n items, see Paging - Top [optional]
skip int Skip the first n items, see Paging - Skip [optional]
filter string Filter items by property values, see Filtering [optional]
inlinecount string Include count of items, see Inlinecount [optional]
orderby string[] Order items by property values, see Sorting [optional]
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\Wrapper2

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aAddressHomePageURLPost()

aAddressHomePageURLPost($apibusinesspartnera_address_home_page_url_type_create): \BeLenka\SAP\BusinessPartner\Model\AAddressHomePageURLType

Creates a new home page URL address record to the existing business partner address.

Adds a new home page URL to the existing business partner address record. Multiple URLs can be linked to an address record.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$apibusinesspartnera_address_home_page_url_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate | New entity

try {
    $result = $apiInstance->aAddressHomePageURLPost($apibusinesspartnera_address_home_page_url_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aAddressHomePageURLPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
apibusinesspartnera_address_home_page_url_type_create \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\AAddressHomePageURLType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressGet()

aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressGet($relationship_number, $business_partner_company, $business_partner_person, $validity_end_date, $address_id, $top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\BusinessPartner\Model\Wrapper2

Retrieves home page URL address records linked to business partner address.

Retrieves all the home page URL address records linked to all business partner address records in the system.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$relationship_number = 'relationship_number_example'; // string | BP Relationship Number
$business_partner_company = 'business_partner_company_example'; // string | Business Partner Number
$business_partner_person = 'business_partner_person_example'; // string | Business Partner Number
$validity_end_date = 2017-04-13T00:00; // string | Validity Date (Valid To)
$address_id = 'address_id_example'; // string | Address Number
$top = 50; // int | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)
$inlinecount = 'inlinecount_example'; // string | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressGet($relationship_number, $business_partner_company, $business_partner_person, $validity_end_date, $address_id, $top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
relationship_number string BP Relationship Number
business_partner_company string Business Partner Number
business_partner_person string Business Partner Number
validity_end_date string Validity Date (Valid To)
address_id string Address Number
top int Show only the first n items, see Paging - Top [optional]
skip int Skip the first n items, see Paging - Skip [optional]
filter string Filter items by property values, see Filtering [optional]
inlinecount string Include count of items, see Inlinecount [optional]
orderby string[] Order items by property values, see Sorting [optional]
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\Wrapper2

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressPost()

aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressPost($relationship_number, $business_partner_company, $business_partner_person, $validity_end_date, $address_id, $apibusinesspartnera_address_home_page_url_type_create): \BeLenka\SAP\BusinessPartner\Model\AAddressHomePageURLType

Creates a new home page URL address record to the existing business partner address.

Adds a new home page URL to the existing business partner address record. Multiple URLs can be linked to an address record.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$relationship_number = 'relationship_number_example'; // string | BP Relationship Number
$business_partner_company = 'business_partner_company_example'; // string | Business Partner Number
$business_partner_person = 'business_partner_person_example'; // string | Business Partner Number
$validity_end_date = 2017-04-13T00:00; // string | Validity Date (Valid To)
$address_id = 'address_id_example'; // string | Address Number
$apibusinesspartnera_address_home_page_url_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate | New entity

try {
    $result = $apiInstance->aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressPost($relationship_number, $business_partner_company, $business_partner_person, $validity_end_date, $address_id, $apibusinesspartnera_address_home_page_url_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aBPContactToAddressRelationshipNumberRelationshipNumberBusinessPartnerCompanyBusinessPartnerCompanyBusinessPartnerPersonBusinessPartnerPersonValidityEndDatedatetimeValidityEndDateAddressIDAddressIDToURLAddressPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
relationship_number string BP Relationship Number
business_partner_company string Business Partner Number
business_partner_person string Business Partner Number
validity_end_date string Validity Date (Valid To)
address_id string Address Number
apibusinesspartnera_address_home_page_url_type_create \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\AAddressHomePageURLType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressGet()

aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressGet($business_partner, $address_id, $top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\BusinessPartner\Model\Wrapper2

Retrieves home page URL address records linked to business partner address.

Retrieves all the home page URL address records linked to all business partner address records in the system.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_partner = 'business_partner_example'; // string | Business Partner Number
$address_id = 'address_id_example'; // string | Address Number
$top = 50; // int | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)
$inlinecount = 'inlinecount_example'; // string | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressGet($business_partner, $address_id, $top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
address_id string Address Number
top int Show only the first n items, see Paging - Top [optional]
skip int Skip the first n items, see Paging - Skip [optional]
filter string Filter items by property values, see Filtering [optional]
inlinecount string Include count of items, see Inlinecount [optional]
orderby string[] Order items by property values, see Sorting [optional]
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\Wrapper2

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressPost()

aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressPost($business_partner, $address_id, $apibusinesspartnera_address_home_page_url_type_create): \BeLenka\SAP\BusinessPartner\Model\AAddressHomePageURLType

Creates a new home page URL address record to the existing business partner address.

Adds a new home page URL to the existing business partner address record. Multiple URLs can be linked to an address record.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\HomePageURLApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_partner = 'business_partner_example'; // string | Business Partner Number
$address_id = 'address_id_example'; // string | Address Number
$apibusinesspartnera_address_home_page_url_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate | New entity

try {
    $result = $apiInstance->aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressPost($business_partner, $address_id, $apibusinesspartnera_address_home_page_url_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HomePageURLApi->aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToURLAddressPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
address_id string Address Number
apibusinesspartnera_address_home_page_url_type_create \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERAAddressHomePageURLTypeCreate New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\AAddressHomePageURLType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]