Examples - Supplier operations service Supplier

Accept, update terms and conditions, book and rebook appointment

Supplier operations service
@host=https://api.themovingportal.dev
@auth=BASICAUTHHEADER

@tmpReference=TMP123456

###
# @name getinstruction
GET {{host}}/instruction/{{tmpReference}}
Authorization: Basic {{auth}}

### Accept case
PUT {{host}}/instruction/{{tmpReference}}/accept
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "yourFeeInclVAT": "{{getinstruction.response.body.$.fee.YOURFEEINCLVAT}}"
}

### Terms and conditions - mark sent
PUT {{host}}/instruction/{{tmpReference}}/terms
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "termsSent": true,
  "termsReceived": false
}

### Terms and conditions - mark received
PUT {{host}}/instruction/{{tmpReference}}/terms
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "termsSent": false,
  "termsReceived": true
}

### Book appointment
POST {{host}}/instruction/{{tmpReference}}/appointment
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "appointmentDate": "{{$datetime iso8601}}",
  "appointmentTimeslotCode": "MORNING",
  "supplierConfirmedTermsAndConditionsAgreed": true
}

### Rebook appointment
PATCH {{host}}/instruction/{{tmpReference}}/appointment
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "appointmentDate": "{{$datetime iso8601}}",
  "appointmentTimeslotCode": "AFTERNOON",
  "supplierConfirmedTermsAndConditionsAgreed": true,
  "reasonCode": "VENDORREQUESTED",
  "otherReason": ""
}

Decline instruction

Supplier operations service
@host=https://api.themovingportal.dev
@auth=BASICAUTHHEADER

@tmpReference=TMP123456

### Decline case
PUT {{host}}/instruction/{{tmpReference}}/decline
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "reasonCode": "NOCOVERAGE",
  "otherReason": ""
}

Upload and replace report

Supplier operations service
@host=https://api.themovingportal.dev
@auth=BASICAUTHHEADER

@tmpReference=TMP123456

###
POST {{host}}/instruction/{{tmpReference}}/report
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "ReportHasBeenEmailed": false,
  "FileContent" : "JVBERi0xLjAKMSAwIG9iajw8L1BhZ2VzIDIgMCBSPj5lbmRvYmogMiAwIG9iajw8L0tpZHNbMyAw\nIFJdL0NvdW50IDE+PmVuZG9iaiAzIDAgb2JqPDwvTWVkaWFCb3hbMCAwIDMgM10+PmVuZG9iagp0\ncmFpbGVyPDwvUm9vdCAxIDAgUj4+Cg==",
  "RecommendedProductCodes" : [ ]
}

###
PATCH {{host}}/instruction/{{tmpReference}}/report
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "ReportHasBeenEmailed": false,
  "FileContent" : "JVBERi0xLjAKMSAwIG9iajw8L1BhZ2VzIDIgMCBSPj5lbmRvYmogMiAwIG9iajw8L0tpZHNbMyAw\nIFJdL0NvdW50IDE+PmVuZG9iaiAzIDAgb2JqPDwvTWVkaWFCb3hbMCAwIDMgM10+PmVuZG9iagp0\ncmFpbGVyPDwvUm9vdCAxIDAgUj4+Cg==",
  "RecommendedProductCodes" : [ ]
}

Complete case (without uploading)

This example if where a case is completed without uploading a file. Cases should normally be completed by uploading a file. This option is only available depending on introducer, product and supplier configurations.

Supplier operations service
@host=https://api.themovingportal.dev
@auth=BASICAUTHHEADER

@tmpReference=TMP123456

###
PUT {{host}}/instruction/{{tmpReference}}/complete
Authorization: Basic {{auth}}
Content-Type: application/json

{
  "ReportHasBeenEmailed": true,
  "RecommendedProductCodes" : [ ]
}