GET api/ServiceReferral?brn={brn}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
brn

string

Required

Body Parameters

None.

Response Information

Resource Description

ServiceReferralResponse
NameDescriptionTypeAdditional information
success

boolean

None.

error

Error

None.

referrals

Collection of Referral

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "error": {
    "status": "sample string 1",
    "message": "sample string 2"
  },
  "referrals": [
    {
      "ccaccode": "sample string 1",
      "ccacdesc": "sample string 2",
      "voncode": "sample string 3",
      "vondesc": "sample string 4",
      "brn": "sample string 5",
      "sa": "176254d4-c4d9-4680-815c-f731ff118fc9",
      "contract": "sample string 7",
      "service": "sample string 8",
      "dept": "sample string 9",
      "instance": "sample string 10",
      "client": {
        "firstname": "sample string 1",
        "name": "sample string 2",
        "building": "sample string 3",
        "suite": "sample string 4",
        "number": "sample string 5",
        "street": "sample string 6",
        "city": "sample string 7",
        "province": "sample string 8",
        "postalcode": "sample string 9",
        "country": "sample string 10"
      }
    },
    {
      "ccaccode": "sample string 1",
      "ccacdesc": "sample string 2",
      "voncode": "sample string 3",
      "vondesc": "sample string 4",
      "brn": "sample string 5",
      "sa": "176254d4-c4d9-4680-815c-f731ff118fc9",
      "contract": "sample string 7",
      "service": "sample string 8",
      "dept": "sample string 9",
      "instance": "sample string 10",
      "client": {
        "firstname": "sample string 1",
        "name": "sample string 2",
        "building": "sample string 3",
        "suite": "sample string 4",
        "number": "sample string 5",
        "street": "sample string 6",
        "city": "sample string 7",
        "province": "sample string 8",
        "postalcode": "sample string 9",
        "country": "sample string 10"
      }
    }
  ]
}

application/xml, text/xml

Sample:
<ServiceReferralResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Von_Forms_Web.Models.ServiceReferral">
  <error xmlns:d2p1="http://schemas.datacontract.org/2004/07/Von_Forms_Web.Models.Requisition.Response">
    <d2p1:message>sample string 2</d2p1:message>
    <d2p1:status>sample string 1</d2p1:status>
  </error>
  <referrals>
    <Referral>
      <brn>sample string 5</brn>
      <ccaccode>sample string 1</ccaccode>
      <ccacdesc>sample string 2</ccacdesc>
      <client>
        <building>sample string 3</building>
        <city>sample string 7</city>
        <country>sample string 10</country>
        <firstname>sample string 1</firstname>
        <name>sample string 2</name>
        <number>sample string 5</number>
        <postalcode>sample string 9</postalcode>
        <province>sample string 8</province>
        <street>sample string 6</street>
        <suite>sample string 4</suite>
      </client>
      <contract>sample string 7</contract>
      <dept>sample string 9</dept>
      <instance>sample string 10</instance>
      <sa>176254d4-c4d9-4680-815c-f731ff118fc9</sa>
      <service>sample string 8</service>
      <voncode>sample string 3</voncode>
      <vondesc>sample string 4</vondesc>
    </Referral>
    <Referral>
      <brn>sample string 5</brn>
      <ccaccode>sample string 1</ccaccode>
      <ccacdesc>sample string 2</ccacdesc>
      <client>
        <building>sample string 3</building>
        <city>sample string 7</city>
        <country>sample string 10</country>
        <firstname>sample string 1</firstname>
        <name>sample string 2</name>
        <number>sample string 5</number>
        <postalcode>sample string 9</postalcode>
        <province>sample string 8</province>
        <street>sample string 6</street>
        <suite>sample string 4</suite>
      </client>
      <contract>sample string 7</contract>
      <dept>sample string 9</dept>
      <instance>sample string 10</instance>
      <sa>176254d4-c4d9-4680-815c-f731ff118fc9</sa>
      <service>sample string 8</service>
      <voncode>sample string 3</voncode>
      <vondesc>sample string 4</vondesc>
    </Referral>
  </referrals>
  <success>true</success>
</ServiceReferralResponse>