Nuget sync submission method

It will fetch & sync the receipt status which are submitted before.

Nuget export receipts method Search receipts method

Overview

It will sync all the submitted status receipts which were submitted before. It will fetch all the submitted status receipts.

The process of synchronizing receipts will be as follows:
• The system will be regularly checking the status from the external submission API. It will capture the status(valid/invalid) and update the local receipts status accordingly.
• If submission is invalid, system will get error info and store it locally.
• If submission is valid, system will mark those receipts in the local storage as “synchronized”.
• If the toolkit is offline, the submission is cached until the internet connection is restored.

Signature

Signature: SyncSubmissionResponseDto response = await _toolkitHandler.SyncSubmission(syncSubmissionRequestDto)

public class SyncSubmissionRequestDto
{
 public bool All { get; set; }
 public List<string>? SubmissionUuids { get; set; }
}

public class SyncSubmissionResponseDto : BaseResponseDto
{
 public List<SubmissionSyncResultDto>? Submissions { get; set; }
 public List<string>? NotFoundSubmissionUuids { get; set; }
}
public class SubmissionSyncResultDto
{
 public string SubmissionUuid { get; set; } = null!;
 public string Status { get; set; } = null!;
 public List<ReceiptSyncResultDto>? Receipts { get; set; }
}
public class ReceiptSyncResultDto
{
 public string Uuid { get; set; } = null!;
 public ReceiptStatus Status { get; set; }
 public List<ReceiptErrorDto>? Errors { get; set; }
}
public class BaseResponseDto {
 public string? CorrelationId { get; set; }
 public string? Target { get; set; }
 public string? Code { get; set; }
 public string? Message { get; set; }
 public object? Details { get; set; }
}

Inputs

syncSubmissionRequestDto object takes below inputs:

Input parameter Type Description Value example
All bool   true / false
SubmissionUuids[] String    

Outputs

Upon successful submission, it will return submissions object with the below mentioned output parameters.

Output parameter Type Description Value example
submissions[] complex submissions array object contains the submission uuids which are synched.  
notFoundSubmissionUuids[] String notFoundSubmissionUuids array object  
correlationId String Correlation id of the successful sync events  
target String Success field information  
code String Success code 200 Ok / 201 Created etc.,
message String Success message  
details String Additional details  

submissions

Output parameter Type Description Value example
submissionUuid String uuid value of the submission 563ec0af-767a-46b0-a6ca-ce2f97d888c2
status String submission status. Submitted
receipts[] complex receipts array object of the submissions object  

receipts

Output parameter Type Description Value example
uuid String receipt uuid value 563ec0af-767a-46b0-a6ca-ce2f97d888c4
status String Current status of the reciept valid/invalid
errors[] complex error array object of the receipts object  

errors

Output parameter Type Description Value example
stepId String step id of the receipt errors object  
stepName String step name of the receipt errors object  
stepNameAr String step name argument the receipt errors object  
error complex error object of the receipt errors object  

error

Output parameter Type Description Value example
propertyPath String property path of the receipt error object  
errorCode String error code of the receipt error object  
error String error message of the receipt error object  
errorAr String error ar of the receipt error object  
metadata String meta data of the receipt error object  
innerError[] complex Inner error array object of the receipt error object  

innerError

Output parameter Type Description Value example
propertyPath String property path of the receipt inner error object  
errorCode String error code of the receipt inner error object  
error String error message of the receipt inner error object  
errorAr String error ar of the receipt inner error object  
metadata String meta data of the receipt inner error object  
innerError[] String Inner error array object of the receipt inner error object  
Back to homepage