POST api/ApiIntegration/SBApiAddNotesToJob

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
JobKey	globally unique identifier	None.
Notes	Collection of ApiJobNoteInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "jobKey": "7453162b-8971-491e-9d1c-5ed780144a22",
  "notes": [
    {
      "noteText": "sample string 1"
    },
    {
      "noteText": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiAddNotesToJobParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <JobKey>7453162b-8971-491e-9d1c-5ed780144a22</JobKey>
  <Notes>
    <ApiJobNoteInfo>
      <NoteText>sample string 1</NoteText>
    </ApiJobNoteInfo>
    <ApiJobNoteInfo>
      <NoteText>sample string 1</NoteText>
    </ApiJobNoteInfo>
  </Notes>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiAddNotesToJobParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiAddNotesToJobResponse

Name	Type	Additional information
NoteKeys	Collection of globally unique identifier	None.
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.
ErrorString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "noteKeys": [
    "f9335bbc-e822-4a99-91e0-69c6b4aeb1cf",
    "bf9e7c0a-5f68-4f91-86be-9b71f77f9cec"
  ],
  "responseCode": 1,
  "returnKey": "a461b483-e243-41b3-8836-5c3e20243ef0",
  "responseNote": "sample string 2",
  "errorString": "sample string 3"
}

application/xml, text/xml

Sample:

<ApiAddNotesToJobResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ErrorString>sample string 3</ErrorString>
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>a461b483-e243-41b3-8836-5c3e20243ef0</ReturnKey>
  <NoteKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>f9335bbc-e822-4a99-91e0-69c6b4aeb1cf</d2p1:guid>
    <d2p1:guid>bf9e7c0a-5f68-4f91-86be-9b71f77f9cec</d2p1:guid>
  </NoteKeys>
</ApiAddNotesToJobResponse>