Company profile API documentation version v1
https://
About Company Profile
Company Profile is where we can view the information about the company,its locations and its associated organisations.
Purpose
This API allows you to get information about the company and its associated organisations.
/company/profile(orgName)
get
This endpoint allows you get information about the Company Profile.
get /company/profile(orgName)
This endpoint allows you get information about the Company Profile.
Secured by basic
REST API supports Basic Authentication
HTTP status code 200
Gets the Information about the company profile.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema",
"title": "Business Partner JSON Schema",
"type": "object",
"additionalProperties": false,
"properties": {
"orgInfo": {
"description": "Business Partner type Organization",
"businessPartnerID": {
"type": "string",
"maxLength": 32
},
"accountType": {
"type": "string",
"maxLength": 1
},
"accountTypeDescription": {
"type": "string"
},
"isAcquisition": {
"type": "boolean"
},
"acquisitionDate": {
"type": "string"
},
"parentOrgInfo": {
"businessPartnerID": {
"type": "string",
"maxLength": 32
},
"organizationName1": {
"type": "string",
"maxLength": 255
},
"organizationName2": {
"type": "string",
"maxLength": 255
}
},
"addressRepresentationISOCode": {
"type": "string",
"maxLength": 4
},
"logoDocumentID": {
"type": "string",
"maxLength": 100
},
"profileDocumentID": {
"type": "string",
"maxLength": 100
},
"mnemonics": {
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tagName": {
"type": "string"
}
}
}
}
},
"addressInfo": {
"type": "array",
"items": {
"communicationDataID": {
"type": "string",
"maxLength": 32
},
"addressRepresentationISOCode": {
"type": "string",
"maxLength": 4
},
"country": {
"type": "string",
"maxLength": 2
},
"countryDescription": {
"type": "string"
},
"region": {
"type": "string",
"maxLength": 3
},
"regionDescription": {
"type": "string"
},
"cityName": {
"type": "string",
"maxLength": 255
},
"postalCode": {
"type": "string",
"maxLength": 128
},
"streetName": {
"type": "string",
"maxLength": 255
},
"poBoxIsWithoutNumber": {
"type": "boolean"
}
}
},
"phoneInfo": {
"type": "array",
"items": {
"communicationDataID": {
"type": "string",
"maxLength": 32
},
"phoneNumber": {
"type": "string",
"maxLength": 255
},
"phoneNumberType": {
"type": "string",
"enum": [
"Mobile",
"Landline"
]
},
"isDefault": {
"type": "boolean"
}
}
},
"webInfo": {
"type": "array",
"items": {
"communicationDataID": {
"type": "string",
"maxLength": 32
},
"webUrl": {
"type": "string",
"maxLength": 255
},
"isDefault": {
"type": "boolean"
}
}
}
},
"personInfo": {
"description": "Business Partner type Person",
"type": "array",
"items": {
"type": "object",
"organizationID": {
"type": "string",
"maxLength": 32
},
"businessPartnerID": {
"description": "Business Partner ID",
"type": "string",
"maxLength": 32
},
"addressRepresentationISOCode": {
"description": "Address Representation ISO Code",
"type": "string",
"maxLength": 4
},
"familyName": {
"type": "string",
"maxLength": 255
},
"givenName": {
"type": "string",
"maxLength": 255
},
"initials": {
"type": "string",
"maxLength": 128
},
"initialsDescription": {
"type": "string"
},
"isMarkedForDeletion": {
"type": "integer"
},
"addressInfo": {
"type": "array",
"items": {
"type": "object",
"communicationDataID": {
"type": "string",
"maxLength": 32
},
"country": {
"type": "string",
"maxLength": 2
},
"countryDescription": {
"type": "string"
},
"region": {
"type": "string",
"maxLength": 3
},
"regionDescription": {
"type": "string"
},
"cityName": {
"type": "string",
"maxLength": 255
},
"postalCode": {
"type": "string",
"maxLength": 128
},
"streetName": {
"type": "string",
"maxLength": 255
},
"poBoxIsWithoutNumber": {
"type": "boolean"
}
}
},
"emailInfo": {
"type": "array",
"items": {
"type": "object",
"communicationDataID": {
"type": "string",
"maxLength": 32
},
"emailAddress": {
"type": "string",
"maxLength": 255
},
"isDefault": {
"type": "boolean"
}
}
},
"phoneInfo": {
"type": "array",
"items": {
"type": "object",
"communicationDataID": {
"type": "string",
"maxLength": 32
},
"phoneNumber": {
"type": "string",
"maxLength": 255
},
"phoneNumberType": {
"type": "string",
"enum": [
"Mobile",
"Landline"
]
},
"isDefault": {
"type": "boolean"
}
}
},
"additionalDetails": {
"businessPartnerID": {
"type": "string",
"maxLength": 32
},
"isMainContact": {
"type": "boolean"
}
}
}
}
}
}Example:
{
"orgInfo": {
"businessPartnerID": "098ddfd9bffe4de983949c798b4ce666",
"accountType": "1",
"accountTypeDescription": "Premium",
"addressRepresentationISOCode": " ",
"organizationName1": "Ubuntu",
"organizationName2": "ubuntu",
"logoDocumentID": "6DF077141BDD45FCBB0C857B70F3A0D2",
"profileDocumentID": "BB8648B18165442791E221AF9BD5A713",
"mnemonics": {
"tags": [{
"tagName": "ubu"
}, {
"tagName": "ub"
}, {
"tagName": "ubt"
}, {
"tagName": "ubuntu"
}],
"isChanged": false
},
"addressInfo": [{
"communicationDataID": "83ECB881252242E0B9412B1423F54338",
"country": "AS",
"countryDescription": "American Samoa",
"region": "",
"cityName": "New York City",
"postalCode": "43051",
"streetName": "Downtown Street",
"streetPrefixName": "12",
"poBox": "110059",
"poBoxIsWithoutNumber": false
}],
"phoneInfo": [{
"communicationDataID": "83ECB881252242E0B9412B1423F54338",
"phoneNumber": "988035476",
"phoneNumberType": "Landline",
"isDefault": false
}, {
"communicationDataID": "83ECB881252242E0B9412B1423F54338",
"phoneNumber": "98803513",
"phoneNumberType": "Landline",
"isDefault": true
}],
"webInfo": [{
"communicationDataID": "83ECB881252242E0B9412B1423F54338",
"webUrl": "www.ubuntu.com",
"isDefault": true
}]
},
"personInfo": [{
"organizationID": "098ddfd9bffe4de983949c798b4ce666",
"businessPartnerID": "C865796DE3EE4E5F9A20AA49FC0E6755",
"familyName": "Shuttleburg",
"givenName": "Mark",
"initials": "0001",
"initialsDescription": "Mr.",
"isMarkedForDeletion": 0,
"addressInfo": [{
"communicationDataID": "C879C5322533430287DCEE18F2CFE5D9",
"country": "IN",
"countryDescription": "India",
"region": "01",
"regionDescription": "Andra Pradesh",
"cityName": "New Zealand",
"postalCode": "204312",
"streetName": "",
"poBoxIsWithoutNumber": false
}],
"emailInfo": [{
"communicationDataID": "C879C5322533430287DCEE18F2CFE5D9",
"emailAddress": "enquiries@markshuttleworth.com",
"isDefault": true
}],
"phoneInfo": [{
"communicationDataID": "C879C5322533430287DCEE18F2CFE5D9",
"phoneNumber": "+91-987654321",
"phoneNumberType": "Landline",
"isDefault": true
}],
"additionalDetails": {
"businessPartnerID": "C865796DE3EE4E5F9A20AA49FC0E6755",
"isMainContact": true,
"reuseMainContact": false,
"locationName": ""
}
}]
}HTTP status code 400
Bad request, when trying to search using invalid organization name
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessages": {
"type": "array",
"items": {
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"EntitiesNotFound": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The system could not find a business partner for the specified organization name.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
/company/profile(orgName)/locations
get
This endpoint allows you get information about the Company Profile locations.
get /company/profile(orgName)/locations
This endpoint allows you get information about the Company Profile locations.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves the information about the locations based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('Germany', locationName) eq true)
HTTP status code 200
Gets Locations based on query parameters
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"type": "array",
"items": {
"businessPartnerID": {
"type": "string"
},
"organizationID": {
"type": "string"
},
"communicationDataID": {
"type": "string"
},
"locationName": {
"type": "integer"
},
"givenName": {
"type": "string"
},
"familyName": {
"type": "string"
},
"initialsCode": {
"type": "string"
},
"initials": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"defaultPhoneNumber": {
"type": "string"
},
"otherPhoneNumber": {
"type": "string"
},
"cityName": {
"type": "string"
},
"streetName": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"country": {
"type": "string"
},
"regionCode": {
"type": "string"
},
"region": {
"type": "string"
},
"reuseMainContact": {
"type": "string"
}
}
}
}Example:
[{
"businessPartnerID": "03A06BEEFC334E18809CEB0032F77FF1",
"organizationID": "098ddfd9bffe4de983949c798b4ce666",
"communicationDataID": "871487AF2EEE4221A5A80C59D8DC28D8",
"locationName": "SAP Labs India Ltd",
"givenName": "Mark",
"familyName": "Shuttleworth",
"initialsCode": "",
"initials": null,
"emailAddress": "enquiries@markshuttleworth.com",
"defaultPhoneNumber": "",
"otherPhoneNumber": "",
"cityName": "Bangalore1",
"streetName": "Street1",
"postalCode": "6781",
"countryCode": "IN",
"country": "India",
"regionCode": "01",
"region": "Andra Pradesh"
}, {
"businessPartnerID": "1DD4AA8AC26746FD8B02FB6D045B758F",
"organizationID": "098ddfd9bffe4de983949c798b4ce666",
"communicationDataID": "6EBEB64F1454488AB37009D44F164AA0",
"locationName": "SAP APJ",
"givenName": "Ranjith Kumar",
"familyName": "Nookala",
"initialsCode": "0002",
"initials": "Ms.",
"emailAddress": "enquiries@markshuttleworth.com",
"defaultPhoneNumber": "1234577",
"otherPhoneNumber": "1234577",
"cityName": "",
"streetName": "",
"postalCode": "",
"countryCode": "AF",
"country": "Afghanistan",
"regionCode": "",
"region": null
}, {
"businessPartnerID": "3F194AF0CEBE4F239680C7BB55C18E2A",
"organizationID": "098ddfd9bffe4de983949c798b4ce666",
"communicationDataID": "82DEA93E985045FE8AD6EE4F4167860D",
"locationName": "SAP Australia",
"givenName": "SSS",
"familyName": "VVV",
"initialsCode": "0001",
"initials": "Mr.",
"emailAddress": "ssdas@fadasd.com",
"defaultPhoneNumber": "432423423",
"otherPhoneNumber": "4324324",
"cityName": "dsdsa",
"streetName": "44",
"postalCode": "123",
"countryCode": "AG",
"country": "Antigua and Barbuda",
"regionCode": "",
"region": null
}, {
"businessPartnerID": "61A0B0F5E0CE47209E622B3BDA64C5ED",
"organizationID": "098ddfd9bffe4de983949c798b4ce666",
"communicationDataID": "A7C52DC4934D4CDDAF9E56F7D2DAA1C3",
"locationName": "BLR Whitefield",
"givenName": "AAAA",
"familyName": "BBBB",
"initialsCode": "0001",
"initials": "Mr.",
"emailAddress": "aaaa.bbbb2@ksb.com",
"defaultPhoneNumber": "12345678998",
"otherPhoneNumber": "666666",
"cityName": "",
"streetName": "",
"postalCode": "",
"countryCode": "AF",
"country": "Afghanistan",
"regionCode": "",
"region": null
}]HTTP status code 400
Bad request, when trying to search using invalid organization name
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessages": {
"type": "array",
"items": {
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"EntitiesNotFound": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The system could not find a business partner for the specified organization name.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
get
This endpoint allows you get number of Company Profile locations.
get /company/profile(orgName)/locations/$count
This endpoint allows you get number of Company Profile locations.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves number of locations based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('Germany', locationName) eq true)
HTTP status code 200
Returns the number of locations based on query parameters
Body
Type: application/json
Example:
19HTTP status code 400
Bad request, when trying to search using invalid organization name
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessages": {
"type": "array",
"items": {
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"EntitiesNotFound": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The system could not find a business partner for the specified organization name.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
/company/profile(orgName)/subsidiaries
get
This endpoint allows you get information about the Company Profile Subsidiaries.
get /company/profile(orgName)/subsidiaries
This endpoint allows you get information about the Company Profile Subsidiaries.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves the subsidiaries information based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('Subsidiary', organizationName) eq true)
HTTP status code 200
Gets Subsidiaries based on query parameters
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"type": "array",
"items": {
"organizationID": {
"type": "string"
},
"communicationDataID": {
"type": "string"
},
"organizationName": {
"type": "string"
},
"organizationShortName": {
"type": "string"
},
"isAcquisition": {
"type": "integer"
},
"acquisitionDate": {
"type": "date"
},
"logoDocumentID": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"webUrl": {
"type": "string"
},
"cityName": {
"type": "string"
},
"streetName": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"country": {
"type": "string"
},
"regionCode": {
"type": "string"
},
"region": {
"type": "string"
}
}
}
}Example:
[{
"organizationID": "A43F7C7670FA495AB4ABA19A8ADFE837",
"communicationDataID": "A4917DA19A6A43BC84D3C03691D263B3",
"organizationName": "Qwerty12348743875",
"organizationShortName": null,
"isAcquisition": 0,
"acquisitionDate": null,
"logoDocumentID": "",
"phoneNumber": "",
"webUrl": "www.qwer.com",
"cityName": "",
"streetName": "",
"postalCode": "",
"countryCode": "AD",
"country": "Andorra",
"regionCode": "",
"region": null
}, {
"organizationID": "360CFBB3EB4D4644A01D578891F5BE34",
"communicationDataID": "5A9DA55CBB25416787D0616B116CBE03",
"organizationName": "Qwerty1234656",
"organizationShortName": null,
"isAcquisition": 0,
"acquisitionDate": null,
"logoDocumentID": "A0BDB88ADD444678B210E4D386ED1B3E",
"phoneNumber": "13245677",
"webUrl": "www.and.com",
"cityName": "",
"streetName": "",
"postalCode": "",
"countryCode": "AD",
"country": "Andorra",
"regionCode": "",
"region": null
}, {
"organizationID": "A5712E205FD54D6DB0A8093F2D369B98",
"communicationDataID": "D3D7F537A46342A5BC2C5CF1817D898B",
"organizationName": "Qwerty1234",
"organizationShortName": null,
"isAcquisition": 0,
"acquisitionDate": null,
"logoDocumentID": "53CE9B960698472F937274B5301A7EC7",
"phoneNumber": "1234567",
"webUrl": "www.qwerty1.com",
"cityName": "",
"streetName": "",
"postalCode": "",
"countryCode": "DZ",
"country": "Algeria",
"regionCode": "",
"region": null
}, {
"organizationID": "74165402182E4CC0A99C917EF6CECAAA",
"communicationDataID": "E9283EB034F645ADAA20DAFF82903474",
"organizationName": "qwerty21344",
"organizationShortName": null,
"isAcquisition": 0,
"acquisitionDate": null,
"logoDocumentID": "",
"phoneNumber": "3412653",
"webUrl": "www.dsadsad.com",
"cityName": "",
"streetName": "",
"postalCode": "",
"countryCode": "AD",
"country": "Andorra",
"regionCode": "",
"region": null
}]HTTP status code 400
Bad request, when trying to search using invalid organization name
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessages": {
"type": "array",
"items": {
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"EntitiesNotFound": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The system could not find a business partner for the specified organization name.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
get
This endpoint allows you get the count of Company Profile subsidiaries.
get /company/profile(orgName)/subsidiaries/$count
This endpoint allows you get the count of Company Profile subsidiaries.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves number of subsidiaries based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('Subsidiary', organizationName) eq true)
HTTP status code 200
Returns the number of subsidiaries based on query parameters
Body
Type: application/json
Example:
19HTTP status code 400
Bad request, when trying to search using invalid organization name
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessages": {
"type": "array",
"items": {
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"EntitiesNotFound": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The system could not find a business partner for the specified organization name.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}Secured by basic
/company/profile/enumerations
get
This endpoint allows you get enumerations associated with company profile.
get /company/profile/enumerations
This endpoint allows you get enumerations associated with company profile.
Secured by basic
REST API supports Basic Authentication
HTTP status code 200
Get enumerations associated with company profile.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 5000
},
"languageISOCode": {
"type": "string",
"maxLength": 2
}
}
}Example:
{
"accountType": [
{
"type": "AccountType",
"code": "1",
"languageISOCode": "en",
"description": "Premium"
},
{
"type": "AccountType",
"code": "2",
"languageISOCode": "en",
"description": "Basic"
},
{
"type": "AccountType",
"code": "3",
"languageISOCode": "en",
"description": "Invitee"
},
{
"type": "AccountType",
"code": "4",
"languageISOCode": "en",
"description": "Subsidiary"
},
{
"type": "AccountType",
"code": "5",
"languageISOCode": "en",
"description": "UnInvited/Non Onboarded Organization"
}
],
"titleCode": [
{
"type": "TitleCode",
"code": "0001",
"languageISOCode": "en",
"description": "Mr."
},
{
"type": "TitleCode",
"code": "0002",
"languageISOCode": "en",
"description": "Ms."
},
{
"type": "TitleCode",
"code": "0003",
"languageISOCode": "en",
"description": "Dr."
}
],
"roles": [
{
"type": "Roles",
"code": "1",
"languageISOCode": "en",
"description": "Manufacturer"
},
{
"type": "Roles",
"code": "2",
"languageISOCode": "en",
"description": "Service Provider"
},
{
"type": "Roles",
"code": "3",
"languageISOCode": "en",
"description": "Operator"
},
{
"type": "Roles",
"code": "4",
"languageISOCode": "en",
"description": "Supplier/Dealer"
},
{
"type": "Roles",
"code": "5",
"languageISOCode": "en",
"description": "Insurer"
},
{
"type": "Roles",
"code": "6",
"languageISOCode": "en",
"description": "Regulator/Authority"
}
]
} HTTP status code 403
Access is Denied.Invalid Endpoint.
Secured by basic
/organizations/byrole
get
This endpoint allows you get all the organizations present based on their role.
get /organizations/byrole
This endpoint allows you get all the organizations present based on their role.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- roleid: (string)
Role id of the role associated to that organization.For Eg:1(Manufacturer),2(Service Provider),3(Operator)
HTTP status code 200
Get all the organization based on the role associated.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"manufacturerSearchTerms": {
"type": "string"
},
"role": {
"type": "string"
},
"roleid": {
"type": "string"
}
}
}Example:
[
{
"id": "26BA974B34A943CBA321DE9EBD86742A",
"manufacturer": "sub",
"preview": null,
"manufacturerSearchTerms": "subsidiary,sub",
"role": "Manufacturer",
"roleID": "1"
},
{
"id": "933C2112919049DFA811911A7F534B63",
"manufacturer": "sub--2",
"preview": null,
"manufacturerSearchTerms": "subsidiary--2,sub--2",
"role": "Manufacturer",
"roleID": "1"
},
{
"id": "9AEDDB039DBF49CE9E5BE36E50BEF91B",
"manufacturer": "googl",
"preview": null,
"manufacturerSearchTerms": "Google,googl",
"role": "Manufacturer",
"roleID": "1"
},
{
"id": "A21D5E0227E4491689AF0B31B64B8B14",
"manufacturer": "test_ranjith_short",
"preview": null,
"manufacturerSearchTerms": "test_ranjith,test_ranjith_short",
"role": "Manufacturer",
"roleID": "1"
},
{
"id": "5DC521ECA35B4D0EAB1C99211EB4E76D",
"manufacturer": "PE Test 1610",
"preview": null,
"manufacturerSearchTerms": "PE Test 1610",
"role": "Manufacturer",
"roleID": "1"
},
{
"id": "2814EBC494C845968CA0A1D172A675E0",
"manufacturer": "cmp1",
"preview": null,
"manufacturerSearchTerms": "cmp_001,cmp1",
"role": "Manufacturer",
"roleID": "1"
}
] HTTP status code 400
Bad request, when trying to search using invalid roleid.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessages": {
"type": "array",
"items": {
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"EntitiesNotFound": {
"type": "array",
"items": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The system could not find a business partner for the specified organization name.",
"repeatedEntities": [],
"EntitiesNotFound": []
}
]
}