Advertising API

Section: Orders

This section performs operations against Orders

Available Resource List

Action Type	Resource	Description
Create Order	http://api.dmds.com/api/v1/ad/orders	Resource for creating a new order
Create Long Form Order	http://api.dmds.com/api/v1/ad/longformorders	Resource for creating a new long form order
Order Detail (GET)	http://api.dmds.com/api/v1/ad/orders/{orderID}	Resource for operations on a specific orderID
Delete Order (DELETE)	http://api.dmds.com/api/v1/ad/orders/{orderID}	Resource for removing a specific orderID
Publish Order	http://api.dmds.com/api/v1/ad/orders/{orderID}/publish	Resource for publishing a draft orderID
Proof of Delivery Report	http://api.dmds.com/api/v1/ad/orders/{orderID}/proofofdelivery	Resource for retrieving a proof of delivery report on a specific orderID
Proof of Delivery Reports	http://api.dmds.com/api/v1/ad/orders/proofofdelivery?fromDate={fromDate}&toDate={toDate}&orderID={orderID}	Resource for retrieving a list of Proof of Delivery reports between the date range of fromDate and toDate, if orderID is specify it will ignore the date range. If all parameters are empty it will use get all the Proof of Delivery Reports for the last 7 days.
Traffic Confirmation Report	http://api.dmds.com/api/v1/ad/orders/{orderID}/trafficconfirmation	Resource for retrieving a traffic confirmation report on a specific orderID
Destinations	http://api.dmds.com/api/v1/ad/orders/{orderID}/destinations	Resource for retrieving an order with destinations on a specific orderID
Create Comment	http://api.dmds.com/api/v1/ad/orders/{orderID}/comments	Resource for creating a comment on a specific orderID
Create Approval	http://api.dmds.com/api/v1/ad/orders/{orderID}/approvals	Resource for creating an approval on a specific orderID
Set Organization Asset Status	http://api.dmds.com/api/v1/ad/orders/{orderID}/files/{fileID}/organizationassetstatus	Resource for setting an organization asset status (review status) specific to the orderID, fileID, and organization (derived from your API Key).
Set House ID	http://api.dmds.com/api/v1/ad/orders/{orderID}/files/{fileID}/houseid	Resource for setting a house ID specific to the orderID, fileID, and organization (derived from your API Key).
Order States	http://api.dmds.com/api/v1/ad/orders/orderstates	Resource for retrieving a list of DMDS order states
POD States	http://api.dmds.com/api/v1/ad/orders/podstates	Resource for retrieving a list of DMDS POD (Proof of Delivery) states

Create Order

Http Operations Supported

POST

HTTP Resource URI

POST http://api.dmds.com/api/v1/ad/orders

Supported Http Request Accept Types

application/xml
text/xml

Request Resources

Name (Click to view)	Description
Standard - Schema	The XML Schema Definition (XSD) for the create order request
Standard - Simple Sample XML	Very basic create order request containing minimal data fields
Standard - Advanced Sample XML	Create order request contained all available data fields
Radio - Schema	The XML Schema Definition (XSD) for the RADIO create order request
Radio - Simple Sample XML	Very basic RADIO create order request containing minimal data fields
Radio - Advanced Sample XML	RADIO Create order request contained all available data fields

Validation Warnings/Errors

http://api.dmds.com/api/v1/help/errorcodes

Output Schema

http://api.dmds.com/api/v1/schemas/order

Resource Parameters

Parameter	Parameter Type	Description	Examples
orderID	Numeric	The orderID of the order to get or delete	11, 123

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/order

Create Long Form Order

Http Operations Supported

POST

HTTP Resource URI

POST http://api.dmds.com/api/v1/ad/longformorders

Supported Http Request Accept Types

application/xml
text/xml

Request Resources

Name (Click to view)	Description
Standard - Schema	The XML Schema Definition (XSD) for the create order request
Standard - Simple Sample XML	Very basic create order request containing minimal data fields
Standard - Advanced Sample XML	Create order request contained all available data fields

Validation Warnings/Errors

http://api.dmds.com/api/v1/help/errorcodes

Output Schema

http://api.dmds.com/api/v1/schemas/order

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/order

Order Detail/Delete

Http Operations Supported

GET
DELETE

HTTP Resource URI

GET http://api.dmds.com/api/v1/ad/orders/{orderID}
DELETE http://api.dmds.com/api/v1/ad/orders/{orderID}

Supported Http Request Accept Types

application/xml
text/xml
application/json

Resource Parameters

Parameter	Parameter Type	Description	Examples
orderID	Numeric	The orderID of the order to get or delete	11, 123

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/order

Publish Order

Http Operations Supported

PUT

HTTP Resource URI

PUT http://api.dmds.com/api/v1/ad/orders/{orderID}/publish

Supported Http Request Accept Types

application/xml
text/xml
application/json

Resource Parameters

Parameter	Parameter Type	Description	Examples
orderID	Numeric	The orderID to be published. The order must be in draft status or an error will be returned	11, 123

Supported Response Types

application/xml
text/xml
application/json

Validation Warnings/Errors

http://api.dmds.com/api/v1/help/errorcodes

Output Schema

http://api.dmds.com/api/v1/schemas/apixml

Proof of Delivery Report

Http Operations Supported

GET

HTTP GET Resource URI

GET http://api.dmds.com/api/v1/ad/orders/{orderID}/proofofdelivery

Supported Http Request Accept Types

application/xml
text/xml
application/json

Resource Parameters

Parameter	Parameter Type	Description	Examples
orderID	Numeric	The orderID of the proof of delivery report to get	11, 123

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/proofOfDelivery

Proof of Delivery Reports

Http Operations Supported

GET

HTTP GET Resource URI

GET http://api.dmds.com/api/v1/ad/orders/proofofdelivery?fromDate={fromDate}&toDate={toDate}&orderID={orderID}

Supported Http Request Accept Types

application/xml
text/xml
application/json

Resource Parameters

Parameter	Parameter Type	Default Value	Description	Examples
fromDate (Optional)	Datetime	7 days before the current date	The starting date range of the list of Proof of Delivery Report to get.	01/01/2014
toDate (Optional)	Datetime	the current date	The ending date range of the list of Proof of Delivery Report to get.	12/01/2014
orderID (Optional)	Numeric	Null	The orderID of the proof of delivery report to get. If this value is set the fromDate and toDate parameter will be ignore. Default value is null.	11, 123

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/proofOfDelivery

Traffic Confirmation Report

Http Operations Supported

GET

HTTP GET Resource URI

GET http://api.dmds.com/api/v1/ad/orders/{orderID}/trafficconfirmation

Supported Http Request Accept Types

application/xml
text/xml
application/json

Resource Parameters

Parameter	Parameter Type	Description	Examples
orderID	Numeric	The orderID of the traffic confirmation report to get	11, 123

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/trafficConfirmation

Order with Destinations

Http Operations Supported

GET

HTTP GET Resource URI

GET http://api.dmds.com/api/v1/ad/orders/{orderID}/destinations

Supported Http Request Accept Types

application/xml
text/xml
application/json

Resource Parameters

Parameter	Parameter Type	Description	Examples
orderID	Numeric	The orderID of the proof of delivery report to get	11, 123

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/order

Create Comment

Http Operations Supported

POST

HTTP POST Resource URI

POST http://api.dmds.com/api/v1/ad/orders/{orderID}/comments

Supported Http Request Accept Types

application/xml
text/xml
application/json

Resource Parameters

Parameter	Location	Parameter Type	Description	Examples
orderID	URI	Numeric	The orderID to create the comment for	11, 123
CommentPosterName	POST Data	String	The optional commenter name. Defaults to the contact or organization name associated with the API Key. Max. of 50 Characters.	John Smith, Jane Brown
CommentPosterText	POST Data	String	The comment text data. Basic HTML tags are supported. Max. of 4000 characters.	This is a test <em>comment<em>, Please <b>update<b> captions

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/comments

Create Approval

Http Operations Supported

POST

HTTP POST Resource URI

POST http://api.dmds.com/api/v1/ad/orders/{releaseID}/approvals

Supported Http Request Accept Types

application/xml
text/xml
application/json

Resource Parameters

Parameter	Location	Parameter Type	Description	Examples
orderID	URI	Numeric	The orderID to create the approval for	11, 123
CommentPosterName	POST Data	String	The optional approver name. Defaults to the contact or organization name associated with the API Key. Max. of 50 Characters.	John Smith, Jane Brown
CommentPosterText	POST Data	String	The approval text data. Basic HTML tags are supported. Max. of 4000 characters.	This is a test <em>approval<em>, This video is <b>approved<b>

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/comments

Set Organization Asset Status

Http Operations Supported

PUT

HTTP PUT Resource URI

PUT http://api.dmds.com/api/v1/ad/orders/{orderID}/files/{fileID}/organizationassetstatus

Resource Parameters

Parameter	Location	Parameter Type	Description	Examples
orderID	URI	Numeric	The orderID to set the organization asset status for	11, 123
fileID	URI	Numeric	The fileID (DMDS ID) to set the organization asset status for	11, 123
Status	POST Data	String	The organization asset status being set. Must match an existing configured status in DMDS. Max. of 100 Characters.	Reviewed, Submitted
Organizations (optional)	POST Data	String array	The organization(s) to set the organization asset status for. Specified organizations must be set up for group access in DMDS. If not specified then it will be default to the organization directly associated with your API Key.	Yangaroo, DMDS

Example Organization Asset Status XML Post Data

Posting status "Cleared" for organizations "Yangaroo" and "DMDS"

 
    <OrganizationAssetStatus>
	    <Status>Cleared</Status>
	    <Organizations>
		    <Organization>Yangaroo</Organization>
		    <Organization>DMDS</Organization>
	    </Organizations>
    </OrganizationAssetStatus>

Posting status "Accepted" without specifying an organization

 
    <OrganizationAssetStatus>
	    <Status>Accepted</Status>
    </OrganizationAssetStatus>

Set House ID

Http Operations Supported

PUT

HTTP PUT Resource URI

PUT http://api.dmds.com/api/v1/ad/orders/{orderID}/files/{fileID}/houseid

Resource Parameters

Parameter	Location	Parameter Type	Description	Examples
orderID	URI	Numeric	The orderID to set the House ID for	11, 123
fileID	URI	Numeric	The fileID (DMDS ID) to set the House ID for	11, 123
houseID	POST Data	String	The House ID being set. Max. of 25 Characters.	Z12345678, ASDF1234
Organizations (optional)	POST Data	String array	The organization(s) to set the house ID for. Specified organizations must be set up for group access in DMDS. If not specified then it will be default to the organization directly associated with your API Key.	Yangaroo, DMDS

Example House ID XML Post Data

Posting house ID "ABC12345" for organizations "Yangaroo" and "DMDS"

 
    <HouseIDData>
	    <HouseID>ABC12345</HouseID>
	    <Organizations>
		    <Organization>Yangaroo</Organization>
		    <Organization>DMDS</Organization>
	    </Organizations>
    </HouseIDData>

Posting house ID "DEF09876" without specifying an organization

 
    <HouseIDData>
	    <HouseID>DEF09876</HouseID>
    </HouseIDData>

Order States List

Http Operations Supported

GET

HTTP GET Resource URI

GET http://api.dmds.com/api/v1/ad/orders/orderstates

Supported Http Request Accept Types

application/xml
text/xml
application/json

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/referencedata

POD (Proof of Delivery) States List

Http Operations Supported

GET

HTTP GET Resource URI

GET http://api.dmds.com/api/v1/ad/orders/podstates

Supported Http Request Accept Types

application/xml
text/xml
application/json

Supported Response Types

application/xml
text/xml
application/json

Output Schema

http://api.dmds.com/api/v1/schemas/referencedata