Refresh Status V3

Description
Request URL
Path and Query Parameters
Sample Requests and Responses
cURL Examples
Error Codes

Description

The refreshstatus Service is a read only resource that returns the status and time of last data refresh.

HTTP Method and Request URL

GET

http://api.macys.com/v3/job/refreshjobstatus

Path and Query Parameters

HTTP Header Parameters

Parameter

Description

Mandatory

Sample Value

Specifies the output format. Can be application/json or application/xml.

Yes

application/json

application/xml

x-macys-webservice-client-id

Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Click here for a list of your API keys.

Yes

xmj9js4jkdpe1983fmwu98gh

Query Parameters

Parameter	Description	Mandatory	Sample Value
callback	If sent, the format is JSONP (JSON with Padding) with the callback returned with the JSON response. You can put anything in the callback parameter and whatever you send is returned.	No	magicofmacysapi

Sample Requests and Responses

Sample Request

Request URL:

GET

http://api.macys.com/v3/job/refreshjobstatus

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

Success:

{
jobName: "SDPDataRefresh"
startTime: "2014-07-05T02:27:42.546-04:00"
endTime: "2014-07-05T04:26:08.324-04:00"
status: "SUCCESS"
}

Failure:

 {
"jobName": "jobSyncCombined",
"instanceId": 5903,
"executionId": 5903,
"startTime": "2012-12-10T04:00:00.325-05:00",
"endTime": "2012-12-10T04:06:32.725-05:00",
"status": "FAILED",
"exitCode": "FAILED",
"exitDescription": "",
"clusterName": "wssg-cellA"
}

cURL Example

curl -X GET -H "x-macys-webservice-client-id: xxxxxxxxxx" -H "Accept: application/json" "http://api.macys.com/v3/job/refreshjobstatus"

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

version 24 as of 9 years ago by Unknown