Get service request details by ID
Applies to: Partner Center | Partner Center for Microsoft Cloud for US Government
How to retrieve the details of an existing customer service request using the service request identifier.
Prerequisites
Credentials as described in Partner Center authentication. This scenario supports authentication with App+User credentials only.
A service request ID.
C#
To retrieve the details of an existing customer service request, call the IServiceRequestCollection.ById method, and pass in a ServiceRequest.Id to identify and return an interface to the specific ServiceRequest object.
// IAggregatePartner partnerOperations;
// ServiceRequest existingServiceRequest as ServiceRequest;
ServiceRequest serviceRequestDetails = partnerOperations.ServiceRequests.ById(existingServiceRequest.Id).Get();
Console.WriteLine(string.Format("The primary contact for the service request {0} is {1} {2}.",
serviceRequestDetails.Title,
serviceRequestDetails.PrimaryContact.FirstName,
serviceRequestDetails.PrimaryContact.LastName,
));
REST request
Request syntax
Method | Request URI |
---|---|
GET | {baseURL}/v1/servicerequests/{servicerequest-id} HTTP/1.1 |
URI parameter
Use the following URI parameter to get the specified service request.
Name | Type | Required | Description |
---|---|---|---|
servicerequest-id | string | Y | An alphanumeric value that identifies the service request. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
IncludeOrganizationRequests | string | N | A header that, when present, will authorize the user for the Support Request Admin role before attempting to gain service request details. |
For more information, see Partner Center REST headers.
Request body
None
Request example
GET https://api.partnercenter.microsoft.com/v1/servicerequests/616122292874576 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: f9a030bd-e492-4c1a-9c70-021f18234981
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 0
REST response
If successful, this method returns a Service Request resource in the response body.
Response success and error codes
Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. For the full list, see Partner Center REST Error Codes.
Response example
HTTP/1.1 200 OK
Content-Length: 566
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: f9a030bd-e492-4c1a-9c70-021f18234981
MS-CV: rjLONPum/Uq94UQA.0
MS-ServerId: 030011719
Date: Mon, 09 Jan 2017 23:31:15 GMT
{
"title": "TrialSR",
"description": "Ignore this SR",
"severity": "critical",
"supportTopicId": "32444671",
"supportTopicName": "Cannot manage my profile",
"id": "616122292874576",
"status": "open",
"organization": {
"id": "3b33e682-00c3-41ee-9dd2-a548adf56438",
"name": "TEST_TEST_BugBash1"
},
"productId": "15960",
"createdDate": "2016-12-22T20:31:17.24Z",
"lastModifiedDate": "2017-01-09T23:31:15.373Z",
"lastClosedDate": "0001-01-01T00:00:00",
"notes": [{
"createdByName": "Account",
"createdDate": "2017-01-09T23:31:15.373",
"text": "Sample Note"
}
],
"attributes": {
"objectType": "ServiceRequest"
}
}