getOrganizationRequests
get
/ccagent/v1/organizationRequests/{id}
Get Organization Request. This operation is used to get the Organization request information of a customer from Oracle Commerce Cloud.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the requested Organization Request
Query Parameters
-
expand(optional): string
Expand query param : currently used to expand profile, organization and orgAddress Info.(Allowed Values: profile - profile static data, profileAll - profile static & dynamic data, organization - organization static data, organizationAll - organization static & dynamic data, requestAll - organizationRequest static & dynamic data, organizationAddresses).
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getOrganizationRequests_response
Type:
Show Source
object-
approverComments(optional):
string
Org request approver comments
-
id(optional):
string
Id of Organization Request
-
name(optional):
string
Organization request name given by the requester
-
organization(optional):
object organization
Organization
-
profile(optional):
object profile
Profile
- relatedOrganizationName(optional): string
-
requesterComments(optional):
string
Requester comments given at time of creating request
-
siteId(optional):
string
Site captured during request creation
-
status(optional):
string
Status of Organization Request
Nested Schema : organization
Type:
objectOrganization
Show Source
-
customerType(optional):
string
Customer Type for Organization
-
dunsNumber(optional):
string
dunsNumber of organization
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Repository Id of the Organization
-
name(optional):
string
The name for Organization
-
secondaryAddresses(optional):
array secondaryAddresses
List of all the addresses associated with an Organization.
-
taxReferenceNumber(optional):
string
taxReferenceNumberof organization
-
type(optional):
string
Type of Organization
-
uniqueId(optional):
string
Unique Id of the Organization
-
vatReferenceNumber(optional):
string
Vat reference number for the organization
Nested Schema : profile
Type:
objectProfile
Show Source
-
customerContactId(optional):
string
The external customer contact id.
-
email(optional):
string
emailid of profile
-
firstName(optional):
string
first name of the profile
-
id(optional):
string
Repository Id of the profile
-
lastName(optional):
string
Last name of the profile
Nested Schema : secondaryAddresses
Type:
arrayList of all the addresses associated with an Organization.
Show Source
Nested Schema : items
Type:
Show Source
object-
address(optional):
object address
Address created for the Organization.
-
addressType(optional):
string
Address type represents nick name of account if present else repository ID of address item.
Nested Schema : address
Type:
objectAddress created for the Organization.
Show Source
-
address1(optional):
string
The address1 of the secondary address
-
address2(optional):
string
The address2 of the secondary address
-
city(optional):
string
The city of the secondary address
-
companyName(optional):
string
Company name of the secondary address
-
country(optional):
string
The country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
Phone Number of the address
-
postalCode(optional):
string
Postal Code of the address
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
The State of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Example Response (application/json)
{
"approverComments":"Request is approved",
"requesterOrganization":null,
"profile":{
"id":"100001"
},
"organization":{
"id":"150002"
},
"name":"My account",
"siteId":"siteUS",
"id":100001,
"requesterComments":"None",
"parentOrgName":"Oracle Global",
"status":"approved"
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100000|If input passed is invalid|
|101001|If there was no organization request found with the given id.
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code