CardService

DEPRECATED: Note that this topic is deprecated. To know the latest and valid KanbanCardServices APIs, visit KanbanCardService page. For further queries, contact us at This e-mail address is being protected from spambots. You need JavaScript enabled to view it. .

Service Description: CardService
Service EPR: https://login.swift-kanban.com/axis2/services/CardService
Service Status: Active

Available Operations:

 

addCard


Input Elements
 

DescriptionAdds a card onto the Board
Operation typeRequest-response.The endpoint receives a message and sends a correlated message.
SOAP actionurn:addCard
  • If successful returns the addCardResponse with the id of the new card.
  • If the projectId is invalid, the response returns an error message with Status=Failed and StatusMsg="No workspace found for the project id: <project_id>"
  • If the cardType is invalid, the response returns an error message with Status=Failed and StatusMsg="Invalid cardType defined"

 

Input: addCardInputMessage (soap:body, use = literal)
part1type addCardDetails
projectId - nillable ; type string
cardType - nillable ; type string
FieldNames - optional , unbounded , nillable ; type string
FieldValues - optional , unbounded , nillable ; type string

 

 projectId PURPOSESpecifies the workspace/project for which the operation is to be performed.
  RULEThe project referenced by the projectId must exist. The user initiating the request must be a member of the project.
  IGNORABLEFalse

 

 cardType PURPOSESpecifies the Kanban work type or one of the configured card types.
  RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
  IGNORABLE False
 
FieldNames PURPOSEPopulates the initial attributes for the given card type.
  RULEThe parameter value must be the field as specified in the field_name column of the base_field table. Please see the lookup table for a list of fields.
  IGNORABLETrue

 

Input Request Example

 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:addCardDetails>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:FieldNames>name</card:FieldNames>
<card:FieldValues>Test Web Services</card:FieldValues>
<card:FieldNames>description</card:FieldNames>
<card:FieldValues>Test Web Services</card:FieldValues>
</card:addCardDetails>
</soap:Body>
</soap:Envelope>

 

 

Output: addCardResponseMessage (soap:body, use = literal)

A successful response returns the Ids of the newly created card with "Successful" status.

type addCardResponse
ExternalCardId - nillable ; type string
CardId - nillable ; type string
Status - nillable ; type string
StatusMsg - nillable ; type string
 

ExternalCardIdPURPOSEThis the universally referenceable Id of the card by external systems.
CardIdPURPOSEThis is the internal system Id of the newly created card. Not meant for end-user identification of the card.
StatusPURPOSEReturns "Successful" if a card was created. Otherwise, returns "Failed".
StatusMsgPURPOSEReturns "Successful" if a card was created. Otherwise, returns the cause of failure.

 

Output Response Example

 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<ns:addCardResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/">
<ns:ExternalCardId>UST21</ns:ExternalCardId>
<ns:CardId>520557</ns:CardId>
<ns:Status>Successful</ns:Status>
<ns:StatusMsg>Successful</ns:StatusMsg>
</ns:addCardResponse>
</soapenv:Body>
</soapenv:Envelope>

 

updateCard

 

DescriptionUpdates a card on the Board
  
Operation typeRequest-response. The endpoint receives a message, and sends a correlated message.
SOAP action 
urn:updateCard
  • If successful, returns the updateCardResponse with the id of the new card.
    If the projectId is invalid, the response returns an error message with result="No workspace found for the project id: <project_id>".
  • If the cardType is invalid, the response returns an error message with result="Invalid cardType defined".
  • If the cardSequenceNumber is invalid, the response returns a message with the result "Invalid data entered.Please, correct and submit the request again: No card found for the Sequence Number: <sequence number>".

 

Input: updateCardInputMessage (soap:body, use = literal)
part1type updateCardDetails
projectId - nillable ; type string
cardType - nillable ; type string
cardSequenceNumber - nillable ; type string
FieldNames - optional , unbounded , nillable ; type string
FieldValues - optional , unbounded , nillable ; type string
 
 projectId PURPOSE Specifies the workspace/project for which the operation is to be performed.
  RULE The project referenced by the projectId must exist. The user initiating the request must be a member of the project.
  IGNORABLE False
 
cardType PURPOSESpecifies the Kanban work type or one of the configured card types.
  RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
  IGNORABLE False
 
cardSequenceNumber PURPOSESpecifies the target card id for which the specified field(s) must be updated.
  RULEThe card referenced by the cardSequenceNumber must exist. If deleted, the update will fail.
 
FieldNames PURPOSEUpdates the attributes for the given card type.
  RULEThe parameter value must be the field as specified in the field_name column of the base_field table. Please see the lookup table for a list of fields.
  IGNORABLE True

 

Input Request Example

 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:updateCardDetails>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:cardSequenceNumber>UST1</card:cardSequenceNumber>
<card:FieldNames>priority</card:FieldNames>
<card:FieldValues>High</card:FieldValues>
<card:FieldNames>rank</card:FieldNames>
<card:FieldValues>3</card:FieldValues>
</card:updateCardDetails>
</soap:Body>
</soap:Envelope>

Output: updateCardResponseMessage (soap:body, use = literal)

If successful , the response contains a result field with value "Successful".
 

part1type updateCardResponse
result - nillable ; type string
 
result   PURPOSEReturns "Successful" if the card was created. Otherwise, returns the cause of failure.

 

Output Response Example


<soapenv:Body><ns:addCardResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/"><ns:ExternalCardId>UST21</ns:ExternalCardId>
<ns:CardId>520557</ns:CardId>
<ns:Status>Successful</ns:Status>
<ns:StatusMsg>Successful</ns:StatusMsg>
</ns:addCardResponse>
</soapenv:Body>
</soapenv:Envelope>

 

 

addCommentToCard

 

DescriptionAdds a comment to a card on the Board
Operation typeRequest-response.The endpoint receives a message and sends a correlated message.
SOAP action 
urn: saveCommentToCard
  • If successful, returns the addCommentToCardResponse with the comment id of the comment added to card. It also includes the card Id
  • If the projectId is invalid, the response returns an error message with result="No workspace found for the project id : <project_id>"
  • If the cardType is invalid, the response returns an error message with result="Invalid cardType defined"
  • If the cardSequenceNumber is invalid, the response returns a message with result "Invalid data entered.Please correct and submit request again: No card found for the Sequence Number : <sequence number>"

 

 

Input:addCommentToCardRequest (soap:body, use = literal)

 

part1type addCommentToCardInput
  • projectId - nillable ; type string
  • cardType - nillable ; type string
  • cardId - nillable ; type string
  • comment - nillable ; type string

 

projectId  PURPOSESpecifies the workspace/project for which the operation is to be performed.
 RULEThe project referenced by the projectId must exist. The user initiating the request must be a member of the project.
 IGNORABLEFalse
   
cardType  PURPOSESpecifies the Kanban work type or one of the configured card types
 RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
 IGNORABLEFalse

 

Input Request Example

 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:addCommentToCardDetails>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:cardSequenceNumber>UST12</card:cardSequenceNumber>
</card:addCommentToCardDetails>
</soap:Body>
</soap:Envelope>

 

Output: addCommentToCardResponse (soap:body, use = literal)

 
A successful response returns the Ids of the newly created comment with "Successful" status.
 

part1type addCommentToCardOutput
  • projectId - nillable ; type string
  • cardType - nillable ; type string
  • cardId - nillable ; type string
  • commentId - nillable ; type long
 
commentIdPURPOSEReturns the comment id of the newly added comment. This can be used for replying to the comment later.

 

Output Response Example

 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<ns:addCommentToCardResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/"><ns:result>Successful</ns:result>
</ns:addCommentToCardResponse>
</soapenv:Body>
</soapenv:Envelope>

 

replyToComment

 

DescriptionReplies to a comment on a card on the Board
Operation typeRequest-response.The endpoint receives a message, and sends a correlated message.
SOAP action 
urn:saveCommentToCard
  • If successful, returns the addCommentToCardResponse with the id of the new comment.
  • If the projectId is invalid, the response returns an error message with result="No workspace found for the project id : <project_id>"
  • If the cardType is invalid, the response returns an error message with result="Invalid cardType defined"
  • If the cardSequenceNumber is invalid, the response returns a message with result "Invalid data entered.Please correct and submit request again: No card found for the Sequnece Number : <sequence number>"
  • If successful, returns the replyToCommentResponse with the comment id of the comment added to card. It also includes the card Id
  • If the projectId is invalid, the response returns an error message with result="No workspace found for the project id : <project_id>"
  • If the cardType is invalid, the response returns an error message with result="Invalid cardType defined"If the cardSequenceNumber is invalid, the response returns a message with result "Invalid data entered.Please correct and submit request again: No card found for the Sequnece Number : <sequence number>"

 

 

Input: replyToCommentRequest (soap:body, use = literal)
 
part1 type replyToCommentInput
    projectId - nillable ; type string
    cardType - nillable ; type string
    cardId - nillable ; type string
    commentExternalId - nillable ; type string
    comment - nillable ; type string
    commentBy - nillable ; type string
 
 projectId PURPOSE Specifies the workspace/project for which the operation is to be performed.
  RULE The project referenced by the projectId must exist. The user initiating the request must be a member of the project.
  IGNORABLE False
 
 cardType PURPOSESpecifies the Kanban work type or one of the configured card types.
  RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
  IGNORABLE False

 

Input Request Example


<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:replyToCommentInput>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:cardId>UST15</card:cardId>
<card:commentExternalId>1533215</card:commentExternalId>
<card:comment>still making no sense</card:comment>
<card:commentBy> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </card:commentBy>
</card:replyToCommentInput>
</soap:Body>
</soap:Envelope>

Output:replyToCommentResponse (soap:body, use = literal)

 
A successful response returns the Ids of the newly created comment with "Successful" status
 

part1 type addCommentToCardOutput
    projectId - nillable ; type string
    cardType - nillable ; type string
    cardId - nillable ; type string
    commentId - nillable ; type long
 
commentId PURPOSEReturns the comment id of the newly added comment. This can be used for replying to the comment later.
 

Output Response Example

 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<ns:replyToCommentResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/">
<ns:result>Successful</ns:result>
</ns:replyToCommentResponse>
</soapenv:Body>
</soapenv:Envelope>

 

 

unblockCard

 

DescriptionUnblocks a card on the Board
Operation typeRequest-response.The endpoint receives a message, and sends a correlated message.
SOAP actionurn:unblockCard

o    If successful, returns the addCardResponse with the id of the new card.
o    If the projectId is invalid, the response returns an error message with Status=Failed and StatusMsg="No workspace found for the project id : <project_id>"
o    If the cardType is invalid, the response returns an error message with Status=Failed and StatusMsg="Invalid cardType defined"
o    If the cardSequenceNumber is invalid, the response returns a message with result "Invalid data entered.Please correct and submit request again: No card found for the Sequence Number : <sequence number>"
 
part1type unblockCardDetails
  • projectId - nillable ; type string
  • cardType - nillable ; type string
  • cardSequenceNumber - nillable ; type string
  • unblockComment - nillable ; type string
 
projectId  PURPOSESpecifies the workspace/project for which the operation is to be performed.
 RULEThe project referenced by the projectId must exist. The user initiating the request must be a member of the project.
 IGNORABLEFalse
   
cardType  PURPOSESpecifies the Kanban work type or one of the configured card types
 RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
 IGNORABLEFalse
   
cardSequenceNumberPURPOSESpecifies the target card id for which the specified field(s) must be archived.
 RULEThe card referenced by the cardSequenceNumber must exist. If already archived, the archive still returns result="Successful".
 IGNORABLEFalse

 

Input Request Example

 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:unblockCardDetails>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:cardSequenceNumber>UST12</card:cardSequenceNumber>
</card:unblockCardDetails>
</soap:Body>
</soap:Envelope>

 

 

Output:unblockCardResponseMessage (soap:body, use = literal)

 
If successful, the response contains a result field with value "Successful".
 

part1type unblockCardResponse
  • result - nillable; type string
result  PURPOSEReturns "Successful" if the card was archived. Otherwise, returns the cause of failure.
     

 

Output Response Example

 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body><ns:unblockCardResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/"><ns:result>Successful</ns:result>
</ns:unblockCardResponse>
</soapenv:Body>
</soapenv:Envelope>


 

moveCardToBacklog

 

DescriptionMoves a card to the Backlog
Operation typeRequest-response.The endpoint receives a message and sends a correlated message.
SOAP action 
urn: moveCardToBacklog
  • If successful, returns the moveCardToBacklogResponse with result="Successful"
  • If the projectId is invalid, the response returns an error message with result="No workspace found for the project id : <project_id>"
  • If the cardType is invalid, the response returns an error message with result="Invalid cardType defined"
  • If the cardSequenceNumber is invalid, the response returns a message with result "Invalid data entered.Please correct and submit request again: No card found for the Sequnece Number : <sequence number>"
  • If the blockComment is invalid, the response returns a message with result="Invalid data entered.Please correct and submit request again: Block Comment is not entered"

Input: moveCardToBacklogInputMessage (soap:body, use = literal)

part1type moveCardToBacklogDetails
  • projectId - nillable ; type string
  • cardType - nillable ; type string
  • cardSequenceNumber - nillable ; type string
 
projectId  PURPOSESpecifies the workspace/project for which the operation is to be performed.
 RULEThe project referenced by the projectId must exist. The user initiating the request must be a member of the project.
 IGNORABLEFalse
   
cardType  PURPOSESpecifies the Kanban work type or one of the configured card types
 RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
 IGNORABLEFalse
   
cardSequenceNumberPURPOSESpecifies the target card id that needs to be moved back to backlog
 RULEThe card referenced by the cardSequenceNumber must exist. If already in backlog, the move operation will fail.
 IGNORABLEFalse

Input Request Example

 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:moveCardToBackLogDetails>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:cardSequenceNumber>UST12</card:cardSequenceNumber>
</card:moveCardToBackLogDetails>
</soap:Body>
</soap:Envelope>


Output: moveCardToBacklogResponseMessage (soap:body, use = literal)
 
A successful response returns the Ids of the newly created comment with "Successful" status.
 

part1type moveCardToBacklogResponse
  • result - nillable ; type string
 
result  PURPOSEReturns "Successful" if the card was created. Otherwise, returns the cause of failure.

Output Response Example

 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<ns:moveCardToBackLogResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/">
<ns:result>Successful</ns:result>
</ns:moveCardToBackLogResponse>
</soapenv:Body>
</soapenv:Envelope>


 

getCard

 

DescriptionFetches a card onto the Board
  
Operation typeRequest-response.The endpoint receives a message and sends a correlated message.
SOAP action 
urn:getCard
  • If successful returns the getCardResponse with the attributes of the requested card.
  • If the projectId is invalid, the response is empty
  • If the cardType is invalid, the response is empty
  • If the cardSequenceNumber is invalid, the response is empty

Input   getCardInputMessage (soap:body, use = literal)

part1type getCardDetails
projectId - nillable ; type string
cardSequenceNumber - nillable ; type string
cardType - nillable ; type string
 
 projectId PURPOSESpecifies the workspace/project for which the operation is to be performed
  RULE The project referenced by the projectId must exist. The user initiating the request must be a member of the project.
  IGNORABLE False
 
 cardSequenceNumber PURPOSESpecifies the target card id for which the specified field(s) must be fetched
  RULE The card referenced by the cardSequenceNumber must exist.
  IGNORABLE False
 
 cardType PURPOSESpecifies the Kanban work type or one of the configured card types.
  RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
  IGNORABLE False

Input Request Example

 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:getCardDetails>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:cardSequenceNumber>UST12</card:cardSequenceNumber>
</card:getCardDetails>
</soap:Body>
</soap:Envelope>


Output: getCardResponseMessage (soap:body, use = literal)
 
 If successful, the response contains a result with details of the card.

part1type getCardResponse

Output Response Example
 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<ns:getCardResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/">
<ns:loggedOn>NULL</ns:loggedOn>
<ns:loggedBy>NULL</ns:loggedBy>
<ns:issueNumber>ISS1</ns:issueNumber>
<ns:name>ISS1</ns:name>
<ns:description>&lt;br></ns:description>
<ns:priority>Medium</ns:priority>
<ns:classOfService>Standard Class</ns:classOfService>
<ns:cardSize>M</ns:cardSize>
<ns:rank>0</ns:rank>
<ns:severity>NULL</ns:severity>
<ns:estimates>0.0</ns:estimates>
<ns:dueDate>NULL</ns:dueDate>
<ns:release>NULL</ns:release>
<ns:currentOwner>Parth Kadam</ns:currentOwner>
<ns:currentQueue>Ready</ns:currentQueue>
<ns:currentState>Active</ns:currentState>
<ns:waitTime>NULL</ns:waitTime>
<ns:workTime>NULL</ns:workTime>
<ns:blockedTime>NULL</ns:blockedTime>
<ns:leadTime>NULL</ns:leadTime>
<ns:cycleTime>NULL</ns:cycleTime>
<ns:workType>KanbanIssue</ns:workType>
<ns:workspaceId>1541988</ns:workspaceId>
<ns:workspaceType>KanbanProject</ns:workspaceType>
<ns:createdBy>20142</ns:createdBy>
<ns:createdDate>2012-01-10 19:52:19.0</ns:createdDate>
<ns:modifiedBy>20142</ns:modifiedBy>
<ns:modifiedDate>2012-01-10 19:52:19.0</ns:modifiedDate>
<ns:id>517803</ns:id>
<ns:rootCause>NULL</ns:rootCause>
<ns:resolvedBy>NULL</ns:resolvedBy>
<ns:dateResolved>NULL</ns:dateResolved>
<ns:resolution>NULL</ns:resolution>
<ns:IDfield>NULL</ns:IDfield>
<ns:MNfield>NULL</ns:MNfield>
<ns:todoEstimates>NULL</ns:todoEstimates>
<ns:percentComplete>NULL</ns:percentComplete>
<ns:summaryType>leaf</ns:summaryType>
</ns:getCardResponse>
</soapenv:Body>
</soapenv:Envelope>

 

archiveCard

 

DescriptionArchives a card on the Board
  
Operation typeRequest-response.The endpoint receives a message and sends a correlated message.
SOAP action 
urn:archiveCard
  • If successful, returns the archiveCardResponse with result="Successful".
  • If the projectId is invalid, the response returns an error message with result="No workspace found for the project id : <project_id>"
  • If the cardType is invalid, the response returns an error message with result="Invalid cardType defined"
  • If the cardSequenceNumber is invalid, the response returns a message with result "Invalid data entered.Please correct and submit request again: No card found for the Sequence Number : <sequence number>"

Input: archiveCardInputMessage (soap:body, use = literal)

part1type archiveCardDetails
  • projectId - nillable ; type string
  • cardType - nillable ; type string
  • cardSequenceNumber - nillable ; type string
 
projectId  PURPOSESpecifies the workspace/project for which the operation is to be performed.
 RULEThe project referenced by the projectId must exist. The user initiating the request must be a member of the project.
 IGNORABLEFalse
   
cardType  PURPOSESpecifies the Kanban work type or one of the configured card types
 RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
 IGNORABLEFalse
   
cardSequenceNumberPURPOSESpecifies the target card id for which the specified field(s) must be archived.
 RULEThe card referenced by the cardSequenceNumber must exist. If already archived, the archive still return result="Successful".
 IGNORABLEFalse

part1type archiveCardResponse
result - nillable; type string

Input Request Sample


<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:archiveCardDetails>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:cardSequenceNumber>UST12</card:cardSequenceNumber>
</card:archiveCardDetails>
</soap:Body>
</soap:Envelope>


Output: archiveCardResponseMessage (soap:body, use = literal)
 
If successful, the response contains a result field with value "Successful".
 

result  PURPOSEReturns "Successful" if the card was archived. Otherwise, returns the cause of failure.

Output Response Example

 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<ns:archiveCardResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/">
<ns:result>Successful</ns:result>
</ns:archiveCardResponse>
</soapenv:Body>
</soapenv:Envelope>

 

deleteCard

 

DescriptionDeletes a card on the Board
Operation typeRequest-response.The endpoint receives a message, and sends a correlated message.
SOAP action 
urn:deleteCard
  • If successful, returns the deleteCardResponse with result="Successful".
    If the projectId is invalid, the response returns an error message with result="No workspace found for the project id : <project_id>"
  • If the cardType is invalid, the response returns an error message with result="Invalid cardType defined"
  • If the cardSequenceNumber is invalid, the response returns a message with result "Invalid data entered.Please correct and submit request again: No card found for the Sequence Number : <sequence number>"

Input: deleteCardInputMessage (soap:body, use = literal)

part1type deleteCardDetails
projectId - nillable ; type string
cardType - nillable ; type string
cardSequenceNumber - nillable ; type string
 
 projectId PURPOSESpecifies the workspace/project for which the operation is to be performed.
  RULEThe project referenced by the projectId must exist. The user initiating the request must be a member of the project.
  IGNORABLE False
 
cardType PURPOSESpecifies the Kanban work type or one of the configured card types.
  RULEMust be one of the acceptable Kanban Work Types configured for the project. For example: UserStory, KanbanIssue, KanbanDefect, etc. Note that the card type parameter value is NOT it's code (UST, DEF, ISS) or the name of the type (User Story, Issue), but for custom card types, the short code needs to be passed as card type.
  IGNORABLE False
 
cardSequenceNumber PURPOSESpecifies the target card id for which the specified field(s) must be deleted.
  RULEThe card referenced by the cardSequenceNumber must exist. If already deleted, the delete still returns result="Successful".

Input Request Example

 

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:card="http://card.webservices.kanban.app.digite.com/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602">
<wsse:Username> This e-mail address is being protected from spambots. You need JavaScript enabled to view it. </wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<card:deleteCardDetails>
<card:projectId>29</card:projectId>
<card:cardType>UserStory</card:cardType>
<card:cardSequenceNumber>UST12</card:cardSequenceNumber>
</card:deleteCardDetails>
</soap:Body>
</soap:Envelope>


Output:deleteCardResponseMessage (soap:body, use = literal)

If successful, the response contains a result field with value "Successful".
 

part1type deleteCardResponse
result - nillable ; type string
 
result   PURPOSEReturns "Successful" if a card was created. Otherwise, returns the cause of failure.

Output Response Example

 

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
    <ns:deleteCardResponse xmlns:ns="http://card.webservices.kanban.app.digite.com/">
    <ns:result>Successful</ns:result>
    </ns:deleteCardResponse>
    </soapenv:Body>
    </soapenv:Envelope>