Qodex.ai

Returns a single Application using the received application id

GET {{baseUrl}}/applications/:id?historyLength=0&includeApplicationFlag=false&includeApplicationDocuments=false&includeApplicationScore=false

Required OAuth scopes for authentication: Public.Application.Read

Request Params

KeyDatatypeRequiredDescription
historyLengthnumberthe number of application status historical items to include (ordered by date descending) - optional
includeApplicationFlagbooleanset to true if the response includes application flags - optional
includeApplicationDocumentsbooleanset to true if the response includes the application documents - optional
includeApplicationScorebooleanset to true if the response includes the application score - optional

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"id":"\u003cinteger\u003e","jobId":"\u003cinteger\u003e","applicantId":"\u003cinteger\u003e","formId":"\u003cinteger\u003e","formInstanceGuid":"\u003cuuid\u003e","flag1":"\u003cstring\u003e","flag2":"\u003cstring\u003e","flag3":"\u003cstring\u003e","flag4":"\u003cstring\u003e","flag5":"\u003cstring\u003e","flag6":"\u003cstring\u003e","flag7":"\u003cstring\u003e","flag8":"\u003cstring\u003e","flag9":"\u003cstring\u003e","flag10":"\u003cstring\u003e","flag11":"\u003cstring\u003e","flag12":"\u003cstring\u003e","orderOfMerit":"\u003cinteger\u003e","applicationStatusDescription":"\u003cstring\u003e","applicationStatusCode":"\u003cstring\u003e","applicationPublicStatusDescription":"\u003cstring\u003e","applicationScore":"\u003cinteger\u003e","applicationDocuments":[{"name":"\u003cstring\u003e","category":"\u003cstring\u003e","systemDocumentCategory":"\u003cstring\u003e","uploadDate":"\u003cdateTime\u003e"},{"name":"\u003cstring\u003e","category":"\u003cstring\u003e","systemDocumentCategory":"\u003cstring\u003e","uploadDate":"\u003cdateTime\u003e"}],"applicationStatusHistory":[{"applicationStatusTo":"\u003cstring\u003e","applicationStatusPublicDescriptionTo":"\u003cstring\u003e","applicationStatusFrom":"\u003cstring\u003e","applicationStatusPublicDescriptionFrom":"\u003cstring\u003e","dateFrom":"\u003cdateTime\u003e","dateTo":"\u003cdateTime\u003e"},{"applicationStatusTo":"\u003cstring\u003e","applicationStatusPublicDescriptionTo":"\u003cstring\u003e","applicationStatusFrom":"\u003cstring\u003e","applicationStatusPublicDescriptionFrom":"\u003cstring\u003e","dateFrom":"\u003cdateTime\u003e","dateTo":"\u003cdateTime\u003e"}],"applicationStatusFlags":[{"description":"\u003cstring\u003e","order":"\u003cinteger\u003e","image":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"description":"\u003cstring\u003e","order":"\u003cinteger\u003e","image":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"jobSourceType":"\u003cstring\u003e","applicationSource":"\u003cstring\u003e","applicationSubSource":"\u003cstring\u003e","created":"\u003cdateTime\u003e","audit":"\u003cdateTime\u003e","applicantPrivacyAcceptance":{"keyGuid":"\u003cstring\u003e","acceptedUtc":"\u003cdateTime\u003e","privacyStatementId":"\u003cinteger\u003e","languageCode":"\u003cstring\u003e","ipAddress":"\u003cstring\u003e"}}