API - Usage Methods
Job Methods
Sequoia v1.74
AddReferenceToJob
Adds a miscellaneous reference to a Job in Sequoia, specifying the reference type and reference.
Payload | Schema / Return value |
---|---|
Request: | LinkJobToExternalReference.Xsd |
Response (success): | A string representing the job reference |
Response (failure): | See Error Reporting above |
Sequoia v1.74
CreateJob
Creates a Job record in Sequoia.
Payload | Schema / Return value |
---|---|
Request: | JobHeader.xsd |
Response (success): | A string representing the job reference |
Response (failure): | See Error Reporting above |
Transactions
Transactions are supported by specifying a TransactionId within the request.
Sequoia v1.74
CreateJobReferenceType
Saves a Job Reference Type record in Sequoia.
Payload | Schema / Return value |
---|---|
Request: | JobReferenceType.xsd |
Response (success): | A string representing the job reference type code |
Response (failure): | See Error Reporting above |
Sequoia v1.74
DeleteJob
Deletes a Job record in Sequoia. Note, this will not remove the record from the database, but marks the record as deleted so that it is no longer usable.
Payload | Schema / Return value |
---|---|
Request: | JobIdentifier.xsd |
Response (success): | True |
Response (failure): | See Error Reporting above |
Transactions
Transactions are supported by specifying a TransactionId on the request.
Sequoia v1.74
GetJob
Retrieves Job data identified from the specified job reference.
Payload | Schema / Return value |
---|---|
Request: | JobIdentifier.xsd |
Response (success): | Payload matching the JobHeader.xsd |
Response (failure): | See Error Reporting above |
Transactions
Transactions are not supported
Sequoia v1.74
UpdateJob
Updates an existing Job record in Sequoia.
Payload | Schema / Return value |
---|---|
Request: | JobHeader.xsd |
Response (success): | A string representing the job reference. |
Response (failure): | See Error Reporting above |
Transactions
Transactions are supported by specifying a TransactionId on the request.
Sequoia v1.74