diff --git a/proxies/live/apiproxy/targets/target.xml b/proxies/live/apiproxy/targets/target.xml index c9c0bfdd3..2fe629d5a 100644 --- a/proxies/live/apiproxy/targets/target.xml +++ b/proxies/live/apiproxy/targets/target.xml @@ -18,10 +18,14 @@ true - - - - {requestpath} + {% if ENVIRONMENT_TYPE == 'sandbox' %} + + + + {requestpath} + {% else %} + https://comms-apim.de-rake4.communications.national.nhs.uk + {% endif %} 29000 diff --git a/proxies/shared/policies/AssignMessage.MessageBatches.Create.Request.xml b/proxies/shared/policies/AssignMessage.MessageBatches.Create.Request.xml index 3dfbc673b..a269ec338 100644 --- a/proxies/shared/policies/AssignMessage.MessageBatches.Create.Request.xml +++ b/proxies/shared/policies/AssignMessage.MessageBatches.Create.Request.xml @@ -16,10 +16,17 @@ target.copy.pathsuffix false - - requestpath - /api/v1/send - + {% if ENVIRONMENT_TYPE == 'sandbox' %} + + requestpath + /api/v1/send + + {% else %} + + target.url + https://comms-apim.de-rake4.communications.national.nhs.uk/api/v1/send + + {% endif %} %data.payload# diff --git a/proxies/shared/policies/AssignMessage.Messages.Create.Request.xml b/proxies/shared/policies/AssignMessage.Messages.Create.Request.xml index 2a8e9cd5c..8344269f8 100644 --- a/proxies/shared/policies/AssignMessage.Messages.Create.Request.xml +++ b/proxies/shared/policies/AssignMessage.Messages.Create.Request.xml @@ -16,10 +16,17 @@ target.copy.pathsuffix false - - requestpath - /api/v1/messages - + {% if ENVIRONMENT_TYPE == 'sandbox' %} + + requestpath + /api/v1/messages + + {% else %} + + target.url + https://comms-apim.de-rake4.communications.national.nhs.uk/api/v1/messages + + {% endif %} %data.payload# diff --git a/proxies/shared/policies/AssignMessage.Messages.GetSingle.Request.xml b/proxies/shared/policies/AssignMessage.Messages.GetSingle.Request.xml index ce54ec959..da2298f8c 100644 --- a/proxies/shared/policies/AssignMessage.Messages.GetSingle.Request.xml +++ b/proxies/shared/policies/AssignMessage.Messages.GetSingle.Request.xml @@ -16,10 +16,17 @@ target.copy.pathsuffix false - - requestpath - - + {% if ENVIRONMENT_TYPE == 'sandbox' %} + + requestpath + + + {% else %} + + target.url + https://comms-apim.de-rake4.communications.national.nhs.uk/api/v1/messages/{data.messageId} + + {% endif %}
{backendCorrelationId}
diff --git a/proxies/shared/policies/AssignMessage.NhsAppAccounts.Get.Request.xml b/proxies/shared/policies/AssignMessage.NhsAppAccounts.Get.Request.xml index 6d71f721a..ee362d0b9 100644 --- a/proxies/shared/policies/AssignMessage.NhsAppAccounts.Get.Request.xml +++ b/proxies/shared/policies/AssignMessage.NhsAppAccounts.Get.Request.xml @@ -16,10 +16,17 @@ target.copy.pathsuffix false - - requestpath - /api/channels/nhsapp/accounts - + {% if ENVIRONMENT_TYPE == 'sandbox' %} + + requestpath + /api/channels/nhsapp/accounts + + {% else %} + + target.url + https://comms-apim.de-rake4.communications.national.nhs.uk/api/channels/nhsapp/accounts + + {% endif %}
{backendCorrelationId}
diff --git a/specification/schemas/components/Message.yaml b/specification/schemas/components/Message.yaml index 5414b8fa5..432b7a3ed 100644 --- a/specification/schemas/components/Message.yaml +++ b/specification/schemas/components/Message.yaml @@ -7,6 +7,8 @@ properties: description: This reference needs to be unique per message within this batch. If there are duplicate values then a 400 exception will be thrown highlighting the values that have been duplicated. format: uuid example: 703b8008-545d-4a04-bb90-1f2946ce1575 + billingReference: + $ref: ../../snippets/BillingReferenceSnippet.yaml recipient: $ref: Recipient.yaml originator: diff --git a/specification/schemas/requests/CreateMessage.yaml b/specification/schemas/requests/CreateMessage.yaml index 3c724bc95..32cade016 100644 --- a/specification/schemas/requests/CreateMessage.yaml +++ b/specification/schemas/requests/CreateMessage.yaml @@ -31,6 +31,8 @@ properties: This value is used internally to de-duplicate messages. If you send the same value through multiple times only one of the requests will be actioned. example: da0b1495-c7cb-468c-9d81-07dee089d728 + billingReference: + $ref: ../../snippets/BillingReferenceSnippet.yaml recipient: $ref: ../components/Recipient.yaml originator: diff --git a/specification/snippets/BillingReferenceSnippet.yaml b/specification/snippets/BillingReferenceSnippet.yaml new file mode 100644 index 000000000..9af3f3f6d --- /dev/null +++ b/specification/snippets/BillingReferenceSnippet.yaml @@ -0,0 +1,3 @@ +type: string +description: Optional reference for billing purposes. Can be any string. +example: billing-ref-1 \ No newline at end of file