Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.04 KB

DELETE_Document_Contact.md

File metadata and controls

59 lines (43 loc) · 2.04 KB

DELETE /Document/{DocId}/Contact

Description

Deletes an existing document contact

  • Requires API Key: Yes
  • Requires System Administrator: No
  • Requires Counterpoint Registration option: Yes

Sample Request

URI

DELETE https://localhost:81/Document/{DocId}/Contact

Headers

  • Authorization : Basic UUFUZXN0R29sZi5NR1I6cGFzc3dvcmQx
  • Accept : application/json

Parameters

Name Parameter Type Data Type Required Description
DocId path string true The DOC_ID of the document to add a contact to.
ContactId query string true The PS_DOC_CONTACT.CONTACT_ID of the note to update. 1=Bill to contact, 2=Ship to contact

Response Codes

  • 200 OK The request was successful, the result of the call will be in the response body.
  • 401 Unauthorized The request could not be fulfilled. Likely due to a missing or invalid authorization header.
  • 500 Internal Server Error The request could not be fulfilled due to an unexpected internal error. This could be caused by a bug in the system, an unavailable database, or any other unexpected internal problem processing the request.

Error Codes

The following error codes may be returned from requests to this endpoint:

  • SUCCESS: The request was successful and the customer information is present under the SystemInfo section of the response body.
  • ERROR_RECORD_NOT_FOUND: The requested System Info was not present. Restarting the server should regenerate the information

Sample Response Body

{
  "SystemInfo": {
    "SystemDBCreatedDateTime": "2015-05-19T13:36:51.3570000-04:00",
    "ServerLastStartedDateTime": "2015-05-20T09:36:58.8644532-04:00",
    "ServerCodeVersion": "1.0.0.0",
    "ServerOS": "Microsoft Windows NT 6.1.7601 Service Pack 1",
    "Is64bitOS": true,
    "ServerUser": "CORP\\mr185122"
  },
  "ErrorCode": "SUCCESS"
}

Response Body

SystemInfo object

Element Datatype Description