Trendsic Platform Service

<back to all web services

AgentAutoShipConfigRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/AgentAutoShip/{NewStatus}
AgentAutoShipConfigRequest Parameters:
NameParameterData TypeRequiredDescription
NewStatuspathstringNo
AgentAutoShipStatusResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AutoShipEnabledformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/AgentAutoShip/{NewStatus} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NewStatus: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	AutoShipEnabled: False
}