|
GET list
Parameters:
| detailed=true |
Optional |
Return detailed information of client. See GET get/[id] method for example of detailed client response. |
Example URL:
http://api.workflowmax.com/client.api/list?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response:
<Response>
<Status>OK</Status>
<Clients>
<Client>
<ID>255</ID>
<Name>XYZ Australia, NZ Business Unit</Name>
<Address />
<City />
<Region />
<PostCode />
<Country />
<PostalAddress>
Level 32, PWC Building
188 Quay Street
Auckland Central
</PostalAddress>
<PostalCity>Auckland</PostalCity>
<PostalRegion />
<PostalPostCode>1001</PostalPostCode>
<PostalCountry />
<Phone />
<Fax />
<Website />
<ReferralSource />
<ExportCode />
<IsProspect>No</IsProspect>
<AccountManager>
<ID>2</ID>
<Name>Jo Blogs</Name>
</AccountManager>
<Type>
<Name>20th of Month</Name>
<CostMarkup>30.00</CostMarkup>
<PaymentTerm>DayOfMonth</PaymentTerm> <!-- DayOfMonth or WithinDays -->
<PaymentDay>20</PaymentDay>
</Type>
<Contacts>
<Contact>
<ID>220</ID>
<Name>Samantha Benecke</Name>
<Salutation>Sam</Salutation>
<Addressee>Mrs S Benecke</Addressee>
<Mobile />
<Email />
<Phone />
<Position />
</Contact>
</Contacts>
</Client>
<Client>
<ID>697</ID>
<Name>A. Dutchess</Name>
<Address />
<City />
<Region />
<PostCode />
<Country />
<PostalAddress>P O Box 123</PostalAddress>
<PostalCity>Wellington</PostalCity>
<PostalRegion />
<PostalPostCode>6011</PostalPostCode>
<PostalCountry />
<Phone />
<Fax />
<Website />
<Contacts />
</Client>
</Clients>
</Response>
GET search
Parameters:
| query |
required |
Search query |
| detailed=true |
Optional |
Return detailed information of client. See GET get/[id] method for example of detailed client response. |
Example URL:
http://api.workflowmax.com/client.api/search?apiKey=[your API key]&accountKey=[WorkflowMax account key]&query=XYZ
Example Response:
<Response>
<Status>OK</Status>
<Clients>
<Client>
<ID>255</ID>
<Name>XYZ Australia, NZ Business Unit</Name>
<Address />
<City />
<Region />
<PostCode />
<Country />
<PostalAddress>
Level 32, PWC Building
188 Quay Street
Auckland Central
</PostalAddress>
<PostalCity>Auckland</PostalCity>
<PostalRegion />
<PostalPostCode>1001</PostalPostCode>
<PostalCountry />
<Phone />
<Fax />
<Website />
<ReferralSource />
<ExportCode />
<IsProspect>No</IsProspect>
<AccountManager>
<ID>2</ID>
<Name>Jo Blogs</Name>
</AccountManager>
<Type>
<Name>20th of Month</Name>
<CostMarkup>30.00</CostMarkup>
<PaymentTerm>DayOfMonth</PaymentTerm> <!-- DayOfMonth or WithinDays -->
<PaymentDay>20</PaymentDay>
</Type>
<Contacts>
<Contact>
<ID>220</ID>
<Name>Samantha Benecke</Name>
<Salutation>Sam</Salutation>
<Addressee>Mrs S Benecke</Addressee>
<Mobile />
<Email />
<Phone />
<Position />
</Contact>
</Contacts>
</Client>
<Client>
<ID>697</ID>
<Name>A. Dutchess</Name>
<Address />
<City />
<Region />
<PostCode />
<Country />
<PostalAddress>P O Box 123</PostalAddress>
<PostalCity>Wellington</PostalCity>
<PostalRegion />
<PostalPostCode>6011</PostalPostCode>
<PostalCountry />
<Phone />
<Fax />
<Website />
<Contacts />
</Client>
</Clients>
</Response>
GET get/[id]
Example URL:
http://api.workflowmax.com/client.api/get/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response:
<Response>
<Status>OK</Status>
<Client>
<ID>218</ID>
<Name>Acmer Pty Ltd</Name>
<Address />
<City />
<Region />
<PostCode />
<Country />
<PostalAddress>
Level 32, PWC Building
188 Quay Street
Auckland Central
</PostalAddress>
<PostalCity>Auckland</PostalCity>
<PostalRegion />
<PostalPostCode>1001</PostalPostCode>
<PostalCountry />
<Phone>(02) 1723 5265</Phone>
<Fax />
<Website />
<ReferralSource />
<ExportCode />
<IsProspect>No</IsProspect>
<AccountManager>
<ID>2</ID>
<Name>Jo Blogs</Name>
</AccountManager>
<Type>
<Name>20th of Month</Name>
<CostMarkup>30.00</CostMarkup>
<PaymentTerm>DayOfMonth</PaymentTerm> <!-- DayOfMonth or WithinDays -->
<PaymentDay>20</PaymentDay>
</Type>
<Contacts>
<Contact>
<ID>193</ID>
<Name>Wyett E Coyote</Name>
<Salutation />
<Addressee />
<Mobile />
<Email />
<Phone />
<Position />
</Contact>
</Contacts>
<Notes>
<Note>
<Title>note title</Title>
<Text>subject of the note</Text>
<Folder />
<Date>2008-09-12T13:00:00</Date>
<CreatedBy>Jo Bloggs</CreatedBy>
</Note>
</Notes>
</Client>
</Response>
POST add
Example URL:
POST http://api.workflowmax.com/client.api/add?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message:
<Client>
<Name>Bloggs Electrical Ltd</Name>
<Address></Address> <!-- optional -->
<City></City> <!-- optional -->
<Region></Region> <!-- optional -->
<PostCode></PostCode> <!-- optional -->
<Country></Country> <!-- optional -->
<PostalAddress></PostalAddress> <!-- optional -->
<PostalCity></PostalCity> <!-- optional -->
<PostalRegion></PostalRegion> <!-- optional -->
<PostalPostCode></PostalPostCode> <!-- optional -->
<PostalCountry></PostalCountry> <!-- optional -->
<Phone></Phone> <!-- optional -->
<Fax></Fax> <!-- optional -->
<WebSite></WebSite> <!-- optional -->
<ReferralSource></ReferralSource> <!-- optional -->
<ExportCode></ExportCode> <!-- optional -->
<IsProspect>No</IsProspect> <!-- Yes | No -->
<Contacts>
<Contact>
<Name>Jo Bloggs</Name>
<Salutation></Phone> <!-- optional -->
<Addressee></Phone> <!-- optional -->
<Phone></Phone> <!-- optional -->
<Mobile></Mobile> <!-- optional -->
<Email></Email> <!-- optional -->
<Position></Position> <!-- optional -->
</Contact>
</Contacts>
</Client>
The response will include the detailed information of the client as per the GET get/[id] method
PUT update
Example URL:
PUT http://api.workflowmax.com/client.api/update?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message:
<Client>
<ID>1234</ID>
<Name>Bloggs Electrical Ltd</Name>
<Address></Address> <!-- optional -->
<City></City> <!-- optional -->
<Region></Region> <!-- optional -->
<PostCode></PostCode> <!-- optional -->
<Country></Country> <!-- optional -->
<PostalAddress></PostalAddress> <!-- optional -->
<PostalCity></PostalCity> <!-- optional -->
<PostalRegion></PostalRegion> <!-- optional -->
<PostalPostCode></PostalPostCode> <!-- optional -->
<PostalCountry></PostalCountry> <!-- optional -->
<Phone></Phone> <!-- optional -->
<Fax></Fax> <!-- optional -->
<WebSite></WebSite> <!-- optional -->
<ReferralSourcee></ReferralSource> <!-- optional -->
</Client>
The response will include the detailed information of the client as per the GET get/[id] method
PUT archive
Example URL:
PUT http://api.workflowmax.com/client.api/archive?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message:
<Client>
<ID>1234</ID>
</Client>
The response will include the detailed information of the client as per the GET get/[id] method
POST delete
Example URL:
POST http://api.workflowmax.com/client.api/delete?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message:
<Client>
<ID>1234</ID>
</Client>
GET contact/[id]
Example URL:
http://api.workflowmax.com/client.api/contact/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Response:
<Response>
<Status>OK</Status>
<Contact>
<ID>123</ID>
<Name>Wyett E Coyote</Name>
<Salutation />
<Addressee />
<Mobile />
<Email />
<Phone />
<Position />
</Contact>
</Response>
PUT contact/[id]
Example URL:
PUT http://api.workflowmax.com/client.api/contact/123?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message:
<Contact>
<Name>Wyett E Coyote</Name>
<Salutation />
<Addressee />
<Mobile />
<Email />
<Phone />
<Position />
</Contact>
The response will include the detailed information of the contact as per the GET contact/[id] method
POST contact
Example URL:
POST http://api.workflowmax.com/client.api/contact?apiKey=[your API key]&accountKey=[WorkflowMax account key]
Example Message:
<Contact>
<Client>
<ID>142</ID>
</Client>
<Name>Wyett E Coyote</Name>
<Salutation />
<Addressee />
<Mobile />
<Email />
<Phone />
<Position />
</Contact>
The response will include the detailed information of the contact as per the GET contact/[id] method
DELETE contact
Example URL:
DELETE http://api.workflowmax.com/client.api/contact/[id]?apiKey=[your API key]&accountKey=[WorkflowMax account key]
|
