API Destination.CreateNew

102 views
Skip to first unread message

Scott

unread,
Aug 15, 2018, 6:13:21 PM8/15/18
to XMPie Interest Group
I am trying to use the API to create a new destination in uProduce.  The SDK gives details for most of the properties except a few.  Here is the SOAP

POST /XmpieWSAPI/Destination_SSP.asmx HTTP/1.1
Host: 10.10.10.XXX
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateNew xmlns="XMPieWSAPI">
      <inUsername>string</inUsername>
      <inPassword>string</inPassword>
      <inName>string</inName>
      <inType>string</inType>
      <inAddress>string</inAddress>
      <inProps>
        <Property>
          <m_Name>string</m_Name>
          <m_Value>string</m_Value>
        </Property>
        <Property>
          <m_Name>string</m_Name>
          <m_Value>string</m_Value>
        </Property>
      </inProps>
    </CreateNew>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateNewResponse xmlns="XMPieWSAPI">
      <CreateNewResult>string</CreateNewResult>
    </CreateNewResponse>
  </soap12:Body>
</soap12:Envelope>

What do I enter for "Content-Length"?  Content-Length: length
What do I enter for these values (replace string)

<Property>
          <m_Name>string</m_Name>
          <m_Value>string</m_Value>
        </Property>
        <Property>
          <m_Name>string</m_Name>
          <m_Value>string</m_Value>
        </Property>
 
Thank you in advance

scott


couch

unread,
Aug 15, 2018, 6:16:00 PM8/15/18
to XMPie Interest Group
Refer to the uProduce API SDK documentation:

api.jpg


If you don't have the docs request them from XMPie support.


James Harrod

unread,
Aug 15, 2018, 6:19:40 PM8/15/18
to xmpie...@googlegroups.com
Hi Scott,

Which programming language are you using to write this? C#, VB.Net, ASP.Net?

I’ve developed applications in both C# and VB6 which creates new destinations.

I never used Content-Length in either. My code is either a simple API call in C# or it starts with the “<?xml”

Thanks

--
You received this message because you are subscribed to the Google Groups "XMPie Interest Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to xmpie-users...@googlegroups.com.
To post to this group, send email to xmpie...@googlegroups.com.
Visit this group at https://groups.google.com/group/xmpie-users.
For more options, visit https://groups.google.com/d/optout.

Scott Tate

unread,
Aug 15, 2018, 6:19:45 PM8/15/18
to xmpie...@googlegroups.com
I have the uProduce API SDK documentation but it doesn't give information on what to put in those two places, or at least I'm not finding it.  If you can point to where in the documentation that is shown I would be greatly appreciative.

Thanks!!!



____________________________________________________

Scott Tate | I.T. Director | Boone Graphics

local 805.683.2349 | cell 805.403.3063 | fax 805.683.2468 
Boone Graphics | 70 S. Kellogg Ave. | Goleta, CA 93117 
st...@boonegraphics.net www.boonegraphics.net

NOTICE: This email message, including any attachments, may contain information 
that is confidential and/or proprietary. If you are not an intended recipient, please 
be advised that any review, use, reproduction or distribution of this message is 
prohibited. If you have received this message in error, please completely destroy 
all electronic and hard copies, and contact the sender at 805.683.2349 



--
You received this message because you are subscribed to a topic in the Google Groups "XMPie Interest Group" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/xmpie-users/22lETnSXM7Y/unsubscribe.
To unsubscribe from this group and all its topics, send an email to xmpie-users...@googlegroups.com.

Scott Tate

unread,
Aug 15, 2018, 6:29:41 PM8/15/18
to xmpie...@googlegroups.com
James,
You'll have to forgive my ignorance, I really don't know what I'm doing. 

In the DSK documentation, they give you sample SOAP xml files for different tasks which you can pass to the server.  We have ESKO Automation Engine that passes the SOAP xml to the XMPie Server.

In the example code provided there are a number of placeholders that you have to fill in with information relevant to your situation.  The SDK does a good job of defining those placeholders except for a few.  see screen shot below

Screen Shot 2018-08-15 at 3.27.21 PM.png

____________________________________________________

Scott Tate | I.T. Director | Boone Graphics

local 805.683.2349 | cell 805.403.3063 | fax 805.683.2468 
Boone Graphics | 70 S. Kellogg Ave. | Goleta, CA 93117 
st...@boonegraphics.net www.boonegraphics.net

NOTICE: This email message, including any attachments, may contain information 
that is confidential and/or proprietary. If you are not an intended recipient, please 
be advised that any review, use, reproduction or distribution of this message is 
prohibited. If you have received this message in error, please completely destroy 
all electronic and hard copies, and contact the sender at 805.683.2349 


You received this message because you are subscribed to a topic in the Google Groups "XMPie Interest Group" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/xmpie-users/22lETnSXM7Y/unsubscribe.
To unsubscribe from this group and all its topics, send an email to xmpie-users...@googlegroups.com.

James Harrod

unread,
Aug 15, 2018, 6:43:29 PM8/15/18
to xmpie...@googlegroups.com
Hi Scott,

Does the ESKO Automation Engine indicate the Content-Length as a required field to send the SOAP command?

Could you attach a screenshot of what the SOAP command in ESKO looks like?

I’ve had a quick look at the software documentation and it seems workflow based. Are there different nodes you need to add to build the SOAP command?

Thanks

Scott Tate

unread,
Aug 15, 2018, 6:57:55 PM8/15/18
to xmpie...@googlegroups.com
According to the ESKO documentation, you only need to add one parameter SOAP ACTION and then attach the xml (SOAP).  Here is a screen shot.

Screen Shot 2018-08-15 at 3.47.50 PM.png

____________________________________________________

Scott Tate | I.T. Director | Boone Graphics

local 805.683.2349 | cell 805.403.3063 | fax 805.683.2468 
Boone Graphics | 70 S. Kellogg Ave. | Goleta, CA 93117 
st...@boonegraphics.net www.boonegraphics.net

NOTICE: This email message, including any attachments, may contain information 
that is confidential and/or proprietary. If you are not an intended recipient, please 
be advised that any review, use, reproduction or distribution of this message is 
prohibited. If you have received this message in error, please completely destroy 
all electronic and hard copies, and contact the sender at 805.683.2349 


James Harrod

unread,
Aug 15, 2018, 7:16:51 PM8/15/18
to xmpie...@googlegroups.com
Hi Scott,

If this can wait, I can look at what I’ve done with my C# app.

I think you can leave the Content-Length as it is.

For network destinations, I’m sure the name/value pair is:

M_name = Name
M_value = Name of destination folder

M_name = Path
M_value = Path of destination folder

But I’ll confirm that tomorrow.

As for the bottom bit. You don’t put anything into that. It’s merely the result of the API Call. That’s if you want to read whether or not the destination was created successfully in XMPie.

Thanks

couch

unread,
Aug 15, 2018, 7:19:17 PM8/15/18
to XMPie Interest Group
1) The content-length is the size of the request in bytes. The content-length is normally calculated by the process that is sending the request and added automatically. If you are physically creating the request, then you need to measure the size of the request body in bytes and use that figure.

2 and 3) refer to the uProduce API SDK documentation for the parameters required to setup your specific output destination.

4) this is the reply of from the API giving the response - you don't put anything there - you read what is returned. 

Scott Tate

unread,
Aug 15, 2018, 7:21:41 PM8/15/18
to xmpie...@googlegroups.com
Thanks James

I think that the [Name of destination folder] is controlled by the inName and the [Path of destination folder] is inAddress.

I look forward to seeing what you find out.  Thanks again.


____________________________________________________

Scott Tate | I.T. Director | Boone Graphics

local 805.683.2349 | cell 805.403.3063 | fax 805.683.2468 
Boone Graphics | 70 S. Kellogg Ave. | Goleta, CA 93117 
st...@boonegraphics.net www.boonegraphics.net

NOTICE: This email message, including any attachments, may contain information 
that is confidential and/or proprietary. If you are not an intended recipient, please 
be advised that any review, use, reproduction or distribution of this message is 
prohibited. If you have received this message in error, please completely destroy 
all electronic and hard copies, and contact the sender at 805.683.2349 


James Harrod

unread,
Aug 16, 2018, 8:57:15 AM8/16/18
to xmpie...@googlegroups.com
Hi Scott,

I believe that with the inProps, you can just put <inProps/> and the SOAP command will ignore that element, as you already have values for the other 3.

Also, the content length is counted from the <soap-env:Envelope...> to </soap-env:Envelope>.

I can see that you have hard-coded values in the inName, inType and inAddress tags. Will they remain hard-coded or will they change at some point?

Thanks
Reply all
Reply to author
Forward
0 new messages