SIF Infrastructure (Global) 3.2

createResponse

http://www.sifassociation.org/infrastructure/3.2

Documentation

An HTTP Response with a status of 200 and a payload consisting of a single “createResponse” element. This includes, for each requested object successfully created, an internal status of 201 and the service-assigned refId. Any requested object that failed to be created is indicated by an error statusCode and a corresponding error payload.

Tree

createResponse0@id1@advisoryId2@statusCode3@id4code5scope6message7description8error8--38--48--58--68--79create9--09--19--29--810creates10--911createResponse11--10

Download: .dot .svg .png

Table

Name Mandatory Characteristics Type Description XPath Format
@id token ​/createResponse​/creates​/create​/@id
@advisoryId token ​/createResponse​/creates​/create​/@advisoryId
@statusCode string ​/createResponse​/creates​/create​/@statusCode [24-5][0-9]{2}
@id token ​/createResponse​/creates​/create​/error​/@id
code * M unsigned​Int Corresponds to the value contained in the HTTPS Header Status-Code” field in which the Error Object is the payload. ​/createResponse​/creates​/create​/error​/code
scope * M string Attempted operation. Ex: “Modify Student” ​/createResponse​/creates​/create​/error​/scope
message * M string A simple, easy to understand, compact description of the error. The primary consumer of this message is the application user. Example: "Unable to open database." ​/createResponse​/creates​/create​/error​/message
description M string An optional error description that is more complete and technical in nature. It is to be used as a diagnostic message in trouble-shooting procedures. Example: "The 'Students' table is opened in exclusive mode by user 'ADM1' (dbm.cpp, line 300)." ​/createResponse​/creates​/create​/error​/description

Download: .xlsx

XML Structure

<createResponse xmlns="http://www.sifassociation.org/infrastructure/3.2"> <creates> <create id="" advisoryId="" statusCode=""> <error id=""> <code/> <scope/> <message/> <description/> </error> </create> </creates> </createResponse>

Download: .xml